⚠️ BETA! ⚠️

This library is still in testing phase!

RUI3 AT command library for WisDuo modules

This library is a helper for the AT command communication between a RUI3 based RAKwireless WisDuo module and an Arduino based host MCU.

⚠️ This library works in Class A, B and C, however receiving downlinks in Class B and C are not yet supported. ⚠️

⚠️ The UART interface of the WisDuo modules is only 3.3V. If connecting to an Arduino Board or other MCU boards, make sure its voltage levels on RX and TX are 3.3V only and not 5V ⚠️

Documentation

Installation

In Arduino IDE open Sketch->Include Library->Manage Libraries then search for RUI3-Arduino-Library.

In PlatformIO open PlatformIO Home, switch to libraries and search for RUI3-Arduino-Library. Or install the library project dependencies by adding

lib_deps =
  beegee-tokyo/RUI3-Arduino-Library

into platformio.ini

For manual installation download the archive, unzip it and place the RUI3-Arduino-Library folder into the library directory. In Arduino IDE this is usually /libraries/ In PlatformIO this is usually <user/.platformio/lib>

Usage

The library provides a RUI3 class, which allows communication with RUI3 based Wisduo modules over UART with AT commands.

Example

RUI3-AT-ABP ArduinoIDE example to use a WisDuo RAK3172 with AT commands in LoRaWAN ABP mode. Setup, join network and send data
RUI3-AT-OTAA ArduinoIDE example to use a WisDuo RAK3172 with AT commands in LoRaWAN OTAA mode. Setup, join network and send data
RUI3-AT-P2P ArduinoIDE example to use a WisDuo RAK3172 with AT commands in LoRa P2P mode. Setup, enable RX and send data
RUI3-AT-ABP-PIO PlatformIO example to use a WisDuo RAK3172 with AT commands in LoRaWAN ABP mode. Setup, join network and send data
RUI3-AT-OTAA-PIO PlatformIO example to use a WisDuo RAK3172 with AT commands in LoRaWAN OTAA mode. Setup, join network and send data
RUI3-AT-P2P-PIO PlatformIO example to use a WisDuo RAK3172 with AT commands in LoRa P2P mode. Setup, enable RX and send data

This library provides the following methods:

Construct a new RUI3 object

A simplified constructor taking only a Stream ({Software/Hardware}Serial) object.
The serial port should already be initialised when initialising this library. Serial is used for debug output: host MCU <==> debug console

RUI3(Stream &serial1, Stream &serial = Serial);

Parameters:

@param serial1 Serial for communication with RUI3 module: WisDuo <==> host MCU
@param serial Serial for debug: host MCU <==> debug console -- Defaults to Serial

Usage:

RUI3 wisduo(Serial1);

Enable/Disable Low power mode

See AT+LPM

bool setLPM(int mode);

Parameters:

@param mode 0 = LPM off, 1 = LPM on
@return true Success
@return false No response or error response

Usage:

if (!wisduo.setLPM(LPM_ON)) // set device LPM on     
{     
        Serial.println("Error setting LPM mode.");     
}

Get Low power mode status

See AT+LPM

uint8_t getLPM(void);

Parameters:

@return 0 - LPM off, 1 = LPM on, 255 no response from WisDuo

Usage:

uint8_t q_result = wisduo.getLPM();     
if (q_result != NO_RESPONSE)     
{     
        Serial.printf("LPM %d = %s\r\n", q_result, q_result == 0 ? "off" : "on");     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Set the LPM level

See AT+LPMLVL

bool setLPMLevel(int mode);

Parameters:

@param mode 1 = STOP1 mode, 2 = STOP2 mode (lowest power consumption)
@return true Success
@return false No response or error response

Usage:

if (!wisduo.setLPMLevel(LPM_LVL_2)) // set device LPM level 2     
{     
        Serial.println("Error setting LPM level.");     
}

Get the current LPM level

See AT+LPMLVL

uint8_t getLPMLevel(void);

Parameters:

@return uint8_t 1 = LPM level 1, 2 = LPM level 2, 255 no response from WisDuo

Usage:

uint8_t q_result = wisduo.getLPMLevel();     
if (q_result != NO_RESPONSE)     
{     
        Serial.printf("LPM level %d\r\n", q_result);     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Set the device to LoRaWAN mode or LoRa P2P mode

See AT+NWM
When switching the device mode, the device will perform a reset

bool setWorkingMode(int mode);

Parameters:

@param mode 0 = LoRa P2P, 1 = LoRaWAN mode
@return true Success
@return false No response or error response

Usage:

if (!wisduo.setWorkingMode(LoRaWAN)) // set WisNode work_mode to LoRaWAN.     
{     
        Serial.println("set work_mode failed, please reset module.");     
}

Get the Working Mode status

See AT+NWM

uint8_t getWorkingMode(void);

Parameters:

@return uint8_t 0 = LoRa P2P, 1 = LoRaWAN mode 255 = no response from WisDuo

Usage:

uint8_t q_result = wisduo.getWorkingMode();     
if (q_result != NO_RESPONSE)     
{     
        Serial.printf("Mode %d = %s\r\n", q_result, q_result == 0 ? "P2P" : "LoRaWAN");     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Set the Data Rate

See AT+DR

bool setDataRate(int rate);

Parameters:

@param rate datarate between 0 and 15 see Data Rate by Region for available data rates per LoRaWAN region
@return true Success
@return false No response or error response

Usage:

if (!wisduo.setDataRate(3)) // set datarate 3     
{     
        Serial.println("Set data rate failed.");     
}

Get the data rate

See AT+DR

int8_t getDataRate(void);

Parameters:

@return uint8_t datarate 0 - 15, 255 = no response from WisDuo

Usage:

uint8_t q_result = wisduo.getDataRate();     
if (q_result != NO_RESPONSE)     
{     
        Serial.printf("Datarate %d\r\n", q_result);     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Set the LoRaWAN device Class

See AT+CLASS

bool setClass(int classMode);

Parameters:

@param classMode 0 -> Class A, 1 -> Class B, 2 -> Class C
@return true Success
@return false No response or error response

Usage:

if (!wisduo.setClass(CLASS_A)) // set Class A     
{     
        Serial.println("Set class failed.");     
}

Get the class

See AT+CLASS

uint8_t getClass(void);

Parameters:

@return uint8_t class 0 -> Class A, 1 -> Class B, 2 -> Class C, 255 = no response from WisDuo

Usage:

uint8_t q_result = wisduo.getClass();     
if (q_result != NO_RESPONSE)     
{     
        Serial.printf("Class %d (0=A, 1=B, 2=C)\r\n", q_result);     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Set the LoRaWAN Region

See AT+BAND

bool setRegion(int region);

Parameters:

@param region

EU433 0
CN470 1
RU864 2
IN865 3
EU868 4
US915 5
AU915 6
KR920 7
AS923 8
AS923_1 8
AS923_2 9
AS923_3 10
AS923_4 11
LA915 12
@return true Success
@return false No response or error response

Usage:

if (!wisduo.setRegion(AS923_3)) // set region AS923 variant 3     
{     
        Serial.println("Set Region failed.");     
}

Get the Region

See AT+BAND

uint8_t getRegion(void);

Parameters:

@return uint8_t Region 0 to 12, 255 = no response from WisDuo

Usage:

uint8_t q_result = wisduo.getRegion();     
if (q_result != NO_RESPONSE)     
{     
        Serial.printf("Region %d\r\n", q_result);     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Set network join mode OTAA or ABP

See AT+NJM

bool setJoinMode(int mode);

Parameters:

@param mode 0: join a network using over the air activation, 1: join a network using personalization
@return true Success
@return false No response or error response

Usage:

if (!wisduo.setJoinMode(OTAA)) // set OTAA network join mode     
{     
        Serial.println("Set join mode failed.");     
}

Get the network join mode

See AT+NJM

uint8_t getJoinMode(void);

Parameters:

@return uint8_t mode 0: join a network using over the air activation, 1: join a network using personalization, 255 = no response from WisDuo

Usage:

uint8_t q_result = wisduo.getJoinMode();     
if (q_result != NO_RESPONSE)     
{     
        Serial.printf("Join mode %d = %s\r\n", q_result, q_result == OTAA ? "OTAA" : "ABP");     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Set package transmission mode

In confirmed mode, the LNS will acknowledge the packet, in unconfirmed mode is no acknowledgement
See AT+CFM

bool setConfirmed(int type);

Parameters:

@param type 0->unconfirm, 1->confirm
@return true Success
@return false No response or error response

Usage:

if (!wisduo.setConfirmed(CONF)) // set Confirmed transmission mode     
{     
        Serial.println("Set confirmed mode failed.");     
}

Get the Confirmed/Unconfirmed packet status

In confirmed mode, the LNS will acknowledge the packet, in unconfirmed mode is no acknowledgement
See AT+CFM

uint8_t getConfirmed(void);

Parameters:

@return uint8_t type 0->unconfirm, 1->confirm

Usage:

uint8_t q_result = wisduo.getConfirmed();     
if (q_result != NO_RESPONSE)     
{     
        Serial.printf("Confirm mode %d = %s\r\n", q_result, q_result == CONF ? "confirmed" : "unconfirmed");     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Set LoRaWAN credentials for OTAA join mode

Before using this command, you must call setJoinMode(0)

bool initOTAA(String devEUI, String appEUI, String appKEY);

Parameters:

@param devEUI device EUI as string see AT+DEVEUI
@param appEUI application EUI as string see AT+APPEUI
@param appKEY application key as string see AT+APPKEY
@return true Success
@return false No response or error response

Usage:

String DevEUI = "AC1F09FFFE000000";     
String AppEUI = "AC1F09FFFE000000";     
String AppKey = "EFADFF0000004829ACF71E1A6E000000";     
if (!wisduo.initOTAA(DevEUI, AppEUI, AppKey))     
{     
        Serial.println("Set OTAA credentials failed.");     
}

Get the DevEUI

See AT+DEVEUI

bool getDevEUI(char *eui, uint16_t array_len);

Parameters:

@param eui byte array for DevEUI
@param array_len length of byte array (8 at least)
@return true if DevEUI could be obtained
@return false No response or error response

Usage:

char eui_key[34];     
if (wisduo.getDevEUI(eui_key, ARRAY_SIZE(eui_key)))     
{     
        Serial.print("DevEUI: ");     
        for (int idx = 0; idx < 8; idx++)     
        {     
            Serial.printf("%02X", eui_key[idx]);     
        }     
        Serial.println("\r\n");     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Get the App EUI

See AT+APPEUI

bool getAppEUI(char *eui, uint16_t array_len);

Parameters:

@param eui byte array for AppEUI
@param array_len length of byte array (8 at least)
@return true if AppEUI could be obtained
@return false No response or error response

Usage:

char eui_key[34];     
if (wisduo.getAppEUI(eui_key, ARRAY_SIZE(eui_key)))     
{     
        Serial.print("AppEUI: ");     
        for (int idx = 0; idx < 8; idx++)     
        {     
            Serial.printf("%02X", eui_key[idx]);     
        }     
        Serial.println("\r\n");     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Get the AppKey

See AT+APPKEY

bool getAppKey(char *key, uint16_t array_len);

Parameters:

@param key byte array for AppKey
@param array_len length of byte array (16 at least)
@return true if AppKey could be obtained
@return false No response or error response

Usage:

char eui_key[34];     
if (wisduo.getAppKey(eui_key, ARRAY_SIZE(eui_key)))     
{     
        Serial.print("AppKey: ");     
        for (int idx = 0; idx < 16; idx++)     
        {     
            Serial.printf("%02X", eui_key[idx]);     
        }     
        Serial.println("\r\n");     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Set credentials for ABP join mode

Before using this command, you must call setJoinMode(1)

bool initABP(String devADDR, String nwksKEY, String appsKEY);

Parameters:

@param devADDR device address as HEX string see AT+DEVADDR
@param nwksKEY network Session Key as a HEX string see AT+NWKSKEY
@param appsKEY application Session Key as a HEX string see AT+APPSKEY
@return true Success
@return false No response or error response

Usage:

String DevAddr = "01360085";     
String AppSKey = "f55a71bcc94ec6498511007c64a06c02";     
String NwSKey = "616a6b21d7fcb25012d62b38a5829725";     
if (!wisduo.initABP(DevAddr, NwSKey, AppSKey))     
{     
        Serial.println("Set ABP credentials failed.");     
}

Get the DevAddr

See AT+DEVADDR

uint32_t getDevAddress(void);

Parameters:

@return uint32_t device address, NO_RESPONSE if device address could not be obtained

Usage:

uint32_t dev_addr = wisduo.getDevAddress();     
{     
    Serial.printf("Device Address: %08X\r\n", dev_addr);     
}     
else     
{     
    Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Get the AppsKey

See AT+APPSKEY

bool getAppsKey(char *key, uint16_t array_len);

Parameters:

@param key byte array for AppsKey
@param array_len length of byte array (16 at least)
@return true if AppsKey could be obtained
@return false No response or error response

Usage:

char eui_key[34];     
if (wisduo.getAppsKey(eui_key, ARRAY_SIZE(eui_key)))     
{     
        Serial.print("AppsKey: ");     
        for (int idx = 0; idx < 16; idx++)     
        {     
            Serial.printf("%02X", eui_key[idx]);     
        }     
        Serial.println("\r\n");     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Get the NwsKey

See AT+NWKSKEY

bool getNwsKey(char *key, uint16_t array_len);

Parameters:

@param key byte array for AppsKey
@param array_len length of byte array (16 at least)
@return true if NwsKey could be obtained
@return false No response or error response

Usage:

char eui_key[34];     
if (wisduo.getNwsKey(eui_key, ARRAY_SIZE(eui_key)))     
{     
        Serial.print("NwsKey: ");     
        for (int idx = 0; idx < 16; idx++)     
        {     
            Serial.printf("%02X", eui_key[idx]);     
        }     
        Serial.println("\r\n");     
}     
else     
{     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Join the network

See AT+JOIN

bool joinLoRaNetwork(int timeout = 15);

Parameters:

@param timeout in seconds
@return true Success
@return false No response or error response

Usage:

if (!wisduo.joinLoRaNetwork(60))     
{     
        Serial.println("Join request error, please make sure settings are correct.");     
}     
else     
{     
        Serial.println("Network join requested");     
}

Get the firmware version number of the module.

See AT+VER

bool getVersion(void);

Parameters:

@return true Success
@return false No response or error response

Usage:

wisduo.getVersion(); // get RUI3 firmware version     
wisduo.recvResponse(5000);     
str_ptr = strstr(wisduo.ret, "=");     
if (str_ptr != NULL)     
{     
        Serial.printf("Ver: %s\r\n", str_ptr + 1);     
}     
else     
{     
        Serial.printf("Response: %s\r\n", wisduo.ret);     
}

Get the Join Status

See AT+NJS

bool getJoinStatus(void);

Parameters:

@return true if device has joined LoRaWAN network
@return false if device has not joined LoRaWAN network

Usage:

if (!wisduo.getJoinStatus())     
{     
str_ptr = strstr(wisduo.ret, "=");     
if (str_ptr != NULL)     
{     
        Serial.println("Network not yet joined");     
}     
else     
{     
        Serial.println("Network joined");     
}

Get the current channel list settings

This feature works only in Regions US915, AU915 or CN470
See AT+MASK

String getChannelList(void);

Parameters:

@return String List of enabled channels

Send data in LoRaWAN mode

See AT+SEND

bool sendData(int port, char *datahex);

Parameters:

@param port fPort number.(1-223)
@param datahex payload in byte array
@return true Success
@return false No response or error response

Usage:

char buffer[] = "0174016e06688c0767011a087327560902fd98";     
if (wisduo.sendData(1, buffer))     
{     
    // Wait for TX finished or error     
    if (wisduo.recvResponse(60000))     
    {     
        Serial.printf("TX success - RX: %s\r\n", wisduo.ret);     
    }     
    else     
    {     
        Serial.printf("TX failed: %s\r\n", wisduo.ret);     
    }     
}     
else     
{     
    Serial.println("Error while trying to send a packet");     
}

Initialize LoRa P2P mode

See AT+P2P

P2P configuration is set in a structure:

typedef struct _p2p_settings     
{     
    uint32_t freq; // Frequency in Hz, 150000000-960000000 Hz     
    uint16_t sf;   // Spreading factor 6 - 12     
    uint16_t bw;   // Bandwidth 0=125kHz, 1=250kHz, 2=500kHz, 3=7.8kHz, 4=10.4kHz, 5=15.63kHz, 6=20.83kHz, 7=31.25kHz, 8=41.67kHz, 9=62.5kHz     
    uint16_t cr;   // Coding Rate 0 = 4/5, 1 = 4/6, 2 = 4/7, 3 = 4/8     
    uint16_t ppl;  // Preamble length 2-65535     
    uint16_t txp;  // TX power 5 - 22     
} p2p_settings;

bool initP2P(p2p_settings *p2p_settings);

Parameters:

@param p2p_settings Pointer to the structure with the P2P settings
@return true Success
@return false No response or error response

Usage:

p2p_settings p2p_sett;     
p2p_sett.freq = 916100000;  // Frequency 916100000 MHz     
p2p_sett.sf = 7;                // Spreading factor 7     
p2p_sett.bw = 0;                // Bandwidth 125kHz     
p2p_sett.cr = 1;                // Coding rate 4/5     
p2p_sett.ppl = 8;           // Preamble length 8     
p2p_sett.txp = 22;          // TX power 22 dBi     
if (!wisduo.initP2P(&p2p_sett))     
{     
    Serial.printf("Response: %d\r\n", wisduo.ret);     
}     
else     
{     
    Serial.printf("P2P setup done\r\n");     
}

Get current P2P settings

See AT+P2P

P2P configuration is returned in structure:

typedef struct _p2p_settings     
{     
    uint32_t freq; // Frequency in Hz, 150000000-960000000 Hz     
    uint16_t sf;   // Spreading factor 6 - 12     
    uint16_t bw;   // Bandwidth 0=125kHz, 1=250kHz, 2=500kHz, 3=7.8kHz, 4=10.4kHz, 5=15.63kHz, 6=20.83kHz, 7=31.25kHz, 8=41.67kHz, 9=62.5kHz     
    uint16_t cr;   // Coding Rate 0 = 4/5, 1 = 4/6, 2 = 4/7, 3 = 4/8     
    uint16_t ppl;  // Preamble length 2-65535     
    uint16_t txp;  // TX power 5 - 22     
} p2p_settings;

@param p2p_settings pointer to settings for P2P configuration
@return true Success
@return false No response or error response

Usage:

p2p_settings p2p_sett;     
if (wisduo.getP2P(&p2p_sett))     
{     
    Serial.printf("Freq: %d\r\n", p2p_sett.freq);     
    Serial.printf("SF:   %d\r\n", p2p_sett.sf);     
    Serial.printf("BW:   %d\r\n", p2p_sett.bw);     
    Serial.printf("CR:   %d\r\n", p2p_sett.cr);     
    Serial.printf("PPL:  %d\r\n", p2p_sett.ppl);     
    Serial.printf("TXP:  %d\r\n", p2p_sett.txp);     
    }     
    else     
    {     
        Serial.printf("Response: %d\r\n", wisduo.ret);     
    }     
}     
else     
{     
    Serial.println("Error while trying to send a packet");     
}

Send a data packet over LoRa P2P

See AT+PSEND

bool sendP2PData(char *datahex);

Parameters:

@param datahex payload in byte array
@return true Success
@return false No response or error response

Usage:

char buffer[] = "0174016e06688c0767011a087327560902fd98";     
if (wisduo.sendData(1, buffer))     
{     
    // Wait for TX finished or error     
    if (wisduo.recvResponse(60000))     
    {     
        Serial.printf("TX success - RX: %s\r\n", wisduo.ret);     
    }     
    else     
    {     
        Serial.printf("TX failed: %s\r\n", wisduo.ret);     
    }     
}     
else     
{     
    Serial.println("Error while trying to send a packet");     
}

Enable or disable P2P Channel Activitity Detection

See AT+CAD

@param enable true = CAD enabled, false = CAD disabled
@return true Success
@return false No response or error response

Usage:

if (wisduo.setP2PCAD(true))     
{     
    Serial.printf("CAD enabled\r\n");     
}     
else     
{     
    Serial.printf("Response: %d\r\n", wisduo.ret);     
}

Get CAD status (enabled/disabled)

@return true CAD enabled
@return false CAD disabled

Usage:

if (wisduo.getP2PCAD())     
{     
    Serial.printf("CAD enabled\r\n");     
}     
else     
{     
    Serial.printf("CAD disabled\r\n");     
}

Get response to an AT command from the device

The last response to an AT command is stored in RUI3::ret for further parsing. See the example codes for detailed usage.

bool recvResponse(uint32_t timeout = 10000);

Parameters:

@param timeout time to wait for a response
@return true Success
@return false No response or error response

Usage:

wisduo.getVersion(); // get RUI3 firmware version     
wisduo.recvResponse(5000);     
str_ptr = strstr(wisduo.ret, "=");     
if (str_ptr != NULL)     
{     
        Serial.printf("Ver: %s\r\n", str_ptr + 1);     
}     
else     
{     
        Serial.printf("Response: %s\r\n", wisduo.ret);     
}

Get RX packet after LoRaWAN TX or LoRa P2P receive command

The last received RX packet is stored in RUI3::ret for further parsing. See the example codes for detailed usage.
In case of LoRa P2P, recvRX() can be used to catch any received packet during the specified timeout.
In case of LoRaWAN Class A, the received data is in RUI3::ret after the recvResponse() call.
LoRaWAN Class B and C RX is not implemented, but would work similar to LoRa P2P

void recvRX(uint32_t timeout);

Parameters:

@param timeout max wait time for the RX packet *

Usage:

LoRa P2P

Serial.printf("Listen for 30 seconds\r\n");     
wisduo.recvRX(30000);     
if (strstr(wisduo.ret, "+EVT:RX") != NULL)     
{     
    Serial.printf("RX!\r\n");     
    Serial.printf("%s\r\n", wisduo.ret);     
}     
else     
{     
    Serial.println("No data received");     
}

LoRaWAN Class A

Received data is included in the response of the send command

if (wisduo.sendData(1, buffer))     
{     
    // Wait for TX finished or error     
    Serial.println("Wait for TX/RX result");     
    if (wisduo.recvResponse(60000))     
    {     
        Serial.printf("TX success - RX: %s\r\n", wisduo.ret); // Shows received packet if any     
    }     
    else     
    {     
        Serial.printf("TX failed: %s\r\n", wisduo.ret);     
    }     
}

Flush the RX buffer in case there is something left

void flushRX(uint32_t timeout = 5000);

Parameters:

@param timeout time to wait for a response

Set the module in sleep mode. not required if low power mode is enabled)

When the module is in sleep mode, the host can send any character to wake it up.
When the module is awakened, the event response will automatically return through the serial information.
See AT+SLEEP

void sleep(int mode);

Parameters:

@param mode 0 == sleep until new commands is received, > 1 sleep time in milliseconds

Usage:

wisduo.sleep(60000); // force sleep mode for 1 minute

Reset the RUI3 module

Communication with the module will be lost
See ATZ

void reset(void);

Usage:

bool wait_for_response(uint32_t timeout)     
{     
    uint32_t start_time = millis();     
    bool got_response = false;     
    while (1)     
    {     
        if (Serial1.available())     
        {     
            got_response = true;     
            break;     
        }     
        if ((millis() - start_time) > timeout)     
        {     
            break;     
        }     
    }     
    return got_response;     
}

wisduo.reset(); // force sleep mode     
if (wait_for_response(30000))     
{     
    wisduo.recvResponse(5000);     
    Serial.printf("Response:\r\n>>>\r\n%s\r\n<<<\r\n", wisduo.ret);     
}     
else     
{     
    Serial.println("WisDuo module didn't send any response in 30 seconds");     
}

Change RUI3 communication baud rate

See AT+BAUD

bool setUARTConfig(int Baud);

Parameters:

@param Baud Serial baud rate.Supports baud rate: 9600 19200 38400 57600 115200 230400 460800 921600.
@return true Success
@return false No response or error response

Send a raw command to the RUI3 module.

See RUI3 AT command manual

bool sendRawCommand(char *command);

Parameters:

@param command char array with any of the RUI3 AT commands
@return true Success
@return false No response or error response

Usage:

char buffer[128] = ;     
sprintf(buffer, "AT\r\n"); // Want to send AT command     
wisduo.sendRawCommand(buffer);     
if (wait_for_response(30000))     
{     
    wisduo.recvResponse(5000);     
    Serial.printf("Response:\r\n>>>\r\n%s\r\n<<<\r\n", wisduo.ret);     
}     
else     
{     
    Serial.println("RAK3172 didn't send any response in 30 seconds");     
}

Convert a byte array into a ASCII HEX string array

bool byteArrayToAscii(char *b_array, char *a_array, uint16_t b_array_len, uint16_t a_array_len);

Parameters:

@param b_array byte array to be converted
@param a_array char array to be filled with the ASCII HEX values, MUST BE DOUBLE SIZE OF THE BYTE ARRAY
@param b_array_len length of the byte array
@param a_array_len length of the char array
@return true if buffer sizes do match
@return false if buffer sizes do not match

Usage:

uint8_t b_array[16] = {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15};     
char a_array[34];     
if (wisduo.byteArrayToAscii((char *)b_array, a_array, ARRAY_SIZE(b_array), ARRAY_SIZE(a_array)))     
{
     *  Serial.printf("Result: %s\r\n", a_array);     
}     
    Serial.printf("Result: %s\r\n", a_array);     
{     
    Serial.println("byteArrayToAscii throw error");     
}

Convert a ASCII HEX string array into a byte array

bool asciiArrayToByte(char *b_array, char *a_array, uint16_t b_array_len, uint16_t a_array_len);

Parameters:

@param b_array byte array to be filled with values
@param a_array char array to be converted
@param b_array_len length of the byte array
@param a_array_len length of char array
@return true if length of char array is even
@return false if length of char array is odd or the buffer sizes do not match

Usage:

uint8_t c_array[16];     
char d_array[34] = "000102030405060708090A0B0C0D0E0F";     
if (wisduo.asciiArrayToByte((char *)c_array, d_array, ARRAY_SIZE(d_array), ARRAY_SIZE(c_array)))     
{
     *  Serial.printf("Result: %s\r\n", a_array);
     *  for (int idx = 0; idx < 16; idx++)     
    {     
        Serial.printf("%02X,", c_array[idx]);     
    }     
    Serial.println("}");     
}     
else     
{     
    Serial.println("asciiArrayToByte throw error");     
}

LoRa® is a registered trademark or service mark of Semtech Corporation or its affiliates.

LoRaWAN® is a licensed mark.

beegee-tokyo / RUI3-Arduino-Library

readme

⚠️ BETA! ⚠️

RUI3 AT command library for WisDuo modules

Documentation

Installation

Usage

Example

This library provides the following methods:

Construct a new RUI3 object

Parameters:

Usage:

Enable/Disable Low power mode

Parameters:

Usage:

Get Low power mode status

Parameters:

Usage:

Set the LPM level

Parameters:

Usage:

Get the current LPM level

Parameters:

Usage:

Set the device to LoRaWAN mode or LoRa P2P mode

Parameters:

Usage:

Get the Working Mode status

Parameters:

Usage:

Set the Data Rate

Parameters:

Usage:

Get the data rate

Parameters:

Usage:

Set the LoRaWAN device Class

Parameters:

Usage:

Get the class

Parameters:

Usage:

Set the LoRaWAN Region

Parameters:

Usage:

Get the Region

Parameters:

Usage:

Set network join mode OTAA or ABP

Parameters:

Usage:

Get the network join mode

Parameters:

Usage:

Set package transmission mode

Parameters:

Usage:

Get the Confirmed/Unconfirmed packet status

Parameters:

Usage:

Set LoRaWAN credentials for OTAA join mode

Parameters:

Usage:

Get the DevEUI

Parameters:

Usage:

Get the App EUI

Parameters:

Usage:

Get the AppKey

Parameters:

Usage:

Set credentials for ABP join mode

Parameters:

Usage:

Get the DevAddr

Parameters:

Usage:

Get the AppsKey

Parameters: