RUI API Documentation
# RAKwireless Unified Interface V3 (RUI3)
# Overview
The RAKwireless Unified Interface V3 (RUI3) is designed to help IoT developers make their IoT products faster. It is compatible to RAK LPWAN modules. It supports the standard AT Commands which is known to many people, as well as the Binary Mode. The Binary mode is an improved version of the AT command with its efficient byte-array based protocol and implementation of checksum. RUI3 also allows you to create your own custom firmware using RUI3 APIs that are compatible to popular IDEs like Arduino and Visual Studio. With custom firmware, you will not need any external host microcontroller or microprocessor which can save you cost, circuit board space and current consumption.
# Hardware Compatibility
RUI3 is compatible to the following RAK LPWAN modules:
| RAK Devices |
|---|
| RAK4630 |
| RAK4631-R |
| RAK3172 |
| RAK3272S |
| RAK3372 / RAK3172 Evaluation Board |
| RAK3172-SiP |
| RAK3272-SiP |
The interfaces of RUI3 to the RAK modules are via UART, USB, BLE, and NFC. The physical and wireless RUI3 interfaces are abstracted to behave as Serial Port where three RUI3 Serial Operating Modes can be configured by the user. You can check on the modules above to see the quick start guide and datasheet of the specific module.
# RUI3 Software Guide
RAKwireless Unified Interface V3 (RUI3) features are utilized by using its RUI3 API.
The RUI3 API is well explained with examples codes in this documentation.
For you to compile and upload to the RAK module the RUI3 codes, you need to have an Arduino IDE or Visual Studio IDE in your PC or laptop. The guide on doing this is on the quick start guide of the specific module you are using which is mentioned in the Hardware Compatibility section of this document.
The RAK LPWAN modules with RUI3 can also be interfaced to external host via AT command mode and Binary command mode. Custom serial interface can also be created by the user using Custom Mode.