rui3pylib 0.1.0__tar.gz

rui3pylib-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniele Magnaterra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rui3pylib-0.1.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: rui3pylib
+Version: 0.1.0
+Summary: Python wrapper for the RUI3 AT command set (RAKwireless)
+Project-URL: Homepage, https://github.com/danielemagnaterradev/RUI3_AT-lib
+Project-URL: Repository, https://github.com/danielemagnaterradev/RUI3_AT-lib
+Project-URL: Issues, https://github.com/danielemagnaterradev/RUI3_AT-lib/issues
+Author-email: Daniele Magnaterra <dev.danielemagnaterra@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Daniele Magnaterra
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: at-commands,lorawan,rakwireless,rui3,serial
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.9
+Requires-Dist: pyserial>=3.5
+Description-Content-Type: text/markdown
+
+# RUI3_AT-lib
+
+
+This is a wrapper for the RUI3_AT API and was made strictly following the official API documentation: https://docs.rakwireless.com/product-categories/software-apis-and-libraries/rui3/at-command-manual/
+
+The docstrings inside the source code mimic quite precisely what is said in the documentation but, if you happen to have any doubts or there are some documentation clashes, always refer back to the official docs since they are the authorative source.
+
+The library is built around node class (RUI3Node) which, when instantiated, will automatically find and connect to, when available, **ONE AND ONLY ONE** RUI3_AT compatible device. Trying to connect multiple devices at once will result in errors and/or undefined behaviour.
+
+All the commands are wrapped inside methods for the RUI3Node class, with the names being as self-explanatory as possible.
+
+Since the API error messages are very generic and unclear, most of the checking for the correctness of the values passed to the methods will be done inside the library, with more descriptive error messages.
+
+While the entirety of the API commands provided in the official documentation has been implemented, not all of them are compatible with all the devices. I suggest running the at_help() method first to verify which commands are available for you particular device, and which ones have read and/or write permissions.
+
+I am in no way associated with RAK nor did I have any contact with them during the making of this library. This is entirely a personal project that I decided to publish.
+
+For any issue, you can contact me at: dev.danielemagnaterra@gmail.com

rui3pylib-0.1.0/README.md

@@ -0,0 +1,18 @@
+# RUI3_AT-lib
+
+
+This is a wrapper for the RUI3_AT API and was made strictly following the official API documentation: https://docs.rakwireless.com/product-categories/software-apis-and-libraries/rui3/at-command-manual/
+
+The docstrings inside the source code mimic quite precisely what is said in the documentation but, if you happen to have any doubts or there are some documentation clashes, always refer back to the official docs since they are the authorative source.
+
+The library is built around node class (RUI3Node) which, when instantiated, will automatically find and connect to, when available, **ONE AND ONLY ONE** RUI3_AT compatible device. Trying to connect multiple devices at once will result in errors and/or undefined behaviour.
+
+All the commands are wrapped inside methods for the RUI3Node class, with the names being as self-explanatory as possible.
+
+Since the API error messages are very generic and unclear, most of the checking for the correctness of the values passed to the methods will be done inside the library, with more descriptive error messages.
+
+While the entirety of the API commands provided in the official documentation has been implemented, not all of them are compatible with all the devices. I suggest running the at_help() method first to verify which commands are available for you particular device, and which ones have read and/or write permissions.
+
+I am in no way associated with RAK nor did I have any contact with them during the making of this library. This is entirely a personal project that I decided to publish.
+
+For any issue, you can contact me at: dev.danielemagnaterra@gmail.com

rui3pylib-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "rui3pylib"
+version = "0.1.0"
+description = "Python wrapper for the RUI3 AT command set (RAKwireless)"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.9"
+authors = [
+  { name = "Daniele Magnaterra", email = "dev.danielemagnaterra@gmail.com" }
+]
+keywords = ["rui3", "rakwireless", "lorawan", "serial", "at-commands"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Software Development :: Libraries",
+  "Topic :: System :: Hardware",
+]
+dependencies = [
+  "pyserial>=3.5",
+]
+
+[project.urls]
+Homepage = "https://github.com/danielemagnaterradev/RUI3_AT-lib"
+Repository = "https://github.com/danielemagnaterradev/RUI3_AT-lib"
+Issues = "https://github.com/danielemagnaterradev/RUI3_AT-lib/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/rui3pylib"]

rui3pylib-0.1.0/src/.gitignore

@@ -0,0 +1,2 @@
+__pycache__/
+.gitignore

rui3pylib-0.1.0/src/example.py

@@ -0,0 +1,15 @@
+import rui3pylib
+
+iface = rui3pylib.RUI3Node()
+try:
+
+    iface.set_device_eui("AC1F09FFFE285584")
+    iface.get_device_alias()
+    iface.get_device_eui()
+
+    iface.close()
+
+except rui3pylib.serial.serialutil.PortNotOpenError as e:
+    print(f"SerialException on {iface.port}: {e}")
+    if iface.is_open:
+        iface.close()

rui3pylib-0.1.0/src/requirements.txt

@@ -0,0 +1 @@
+pyserial==3.5

rui3pylib-0.1.0/src/rui3pylib/__init__.py

@@ -0,0 +1 @@
+from .rui3pylib import RUI3Node, send_command, check_success