Metadata-Version: 2.4
Name: rui3pylib
Version: 0.1.1
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/).

It is used to test and create scripts for RUI3_AT compatible devices directly connected through a USB port.

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 authoritative source. The aforementioned docstrings were generated using LLMs, while the code is mostly handwritten.

The library is built around the 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 of 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.

If there are any commands that have not been implemented in the library, you can still write them directly to the device with the check_success(node, "<YOUR_COMMAND_HERE>") method. You can check whether your device has any non implemented commands with the at_help() method.

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
