Skip to main content

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. 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

To start creating your custom RUI3 firmware, check the links of the individual RUI3 modules Quick Start Guides. There is a detailed documentation of RUI3 Arduino API as well.

RUI3 is compatible to the following RAK LPWAN modules:

RAK DevicesQuick Start Guides
RAK4630RAK4630 RUI3 Guide
RAK4631-RRAK4631-R RUI3 Guide
RAK3172RAK3172 RUI3 Guide
RAK3272SRAK3272S RUI3 Guide
RAK3372 / RAK3172 Evaluation BoardRAK3172 Evaluation Board RUI3 Guide
RAK3172-SiPRAK3172-SiP RUI3 Guide
RAK3272-SiPRAK3272-SiP RUI3 Guide
RAK11720RAK11720 RUI3 Guide
RAK11721
RAK11722

RUI3 Software Guide

Writing RUI3 Custom Firmware

RAKwireless Unified Interface V3 (RUI3) features are utilized by using its RUI3 API.

NOTE

RUI3 Board Support Package JSON URL

https://raw.githubusercontent.com/RAKWireless/RAKwireless-Arduino-BSP-Index/main/package_rakwireless.com_rui_index.json.

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, Visual Studio Code 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.

Use of RUI3 Serial Commands (AT)

The RAK LPWAN modules with RUI3 can also be interfaced with an external host via AT command mode (default). A custom serial interface can be created by the user using Custom Mode. When the serial interface is configured for Custom mode, the standard AT commands are disabled and will not be accepted anymore by the module unless switched again to AT mode.

The interfaces of RUI3 are via UART, USB, BLE, and NFC. The physical and wireless RUI3 interfaces are abstracted to behave as Serial Port, where the three RUI3 Serial Operating Modes can be configured by the user.

NOTE

RUI3 Serial Mode default configuration is AT Command and still available even with RUI3 Custom Firmware.

WisToolBox is also a compatible software tool with RUI3-powered devices. It can set up the LoRa/LoRaWAN parameters and configurations of the device and can also manage firmware updates.

RUI3 Supported IDE