rui3_at.h

Go to the documentation of this file.

 
#ifndef _RUI3_H_
#define _RUI3_H_
#include "Arduino.h"
 
#define NO_RESPONSE 255
 
#define ARRAY_SIZE(array) (sizeof((array)) / sizeof((array[0])))
 
#define CLASS_A 0
#define CLASS_B 1
#define CLASS_C 2
 
#define LoRaWAN 1
#define LoRaP2P 0
 
#define OTAA 1
#define ABP 0
 
#define EU433 0
#define CN470 1
#define RU864 2
#define IN865 3
#define EU868 4
#define US915 5
#define AU915 6
#define KR920 7
#define AS923 8
#define AS923_1 8
#define AS923_2 9
#define AS923_3 10
#define AS923_4 11
#define LA915 12
 
#define CONF 1
#define UNCONF 0
 
#define LPM_LVL_1 1
#define LPM_LVL_2 2
 
#define LPM_OFF 0
#define LPM_ON 1
 
#define MAX_CMD_LEN (32)
#define MAX_ARGUMENT 25
 
// Debug output set to 0 to disable app debug output
#ifndef DEBUG_MODE
#define DEBUG_MODE 0
#endif
 
#if DEBUG_MODE > 0
#define MYLOG(tag, ...)                  \
    do                                   \
    {                                    \
        if (tag)                         \
            Serial.printf("[%s] ", tag); \
        Serial.printf(__VA_ARGS__);      \
        Serial.printf("\n");             \
        Serial.flush();                  \
    } while (0)
#else
#define MYLOG(...)
#endif
 
typedef struct _stParam
{
    char *argv[MAX_ARGUMENT];
    int argc;
} stParam;
 
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;
 
// #define DEBUG_MODE
 
class RUI3
{
public:
    RUI3(Stream &serial1, Stream &serial = Serial);
 
    bool setLPM(int mode);
 
    uint8_t getLPM(void);
 
    bool setLPMLevel(int mode);
 
    uint8_t getLPMLevel(void);
 
    bool setWorkingMode(int mode);
 
    uint8_t getWorkingMode(void);
 
    bool setDataRate(int rate);
 
    uint8_t getDataRate(void);
 
    bool setClass(int classMode);
 
    uint8_t getClass(void);
 
    bool setRegion(int region);
 
    uint8_t getRegion(void);
 
    bool setJoinMode(int mode);
 
    uint8_t getJoinMode(void);
 
    bool setConfirmed(int type);
 
    uint8_t getConfirmed(void);
 
    bool initOTAA(String devEUI, String appEUI, String appKEY);
 
    bool getDevEUI(char *eui, uint16_t array_len);
 
    bool getAppEUI(char *eui, uint16_t array_len);
 
    bool getAppKey(char *key, uint16_t array_len);
 
    bool initABP(String devADDR, String nwksKEY, String appsKEY);
 
    uint32_t getDevAddress(void);
 
    bool getAppsKey(char *key, uint16_t array_len);
 
    bool getNwsKey(char *key, uint16_t array_len);
 
    bool joinLoRaNetwork(int timeout = 15);
 
    bool getVersion(void);
 
    bool getJoinStatus(void);
 
    String getChannelList(void);
 
    bool sendData(int port, char *datahex);
 
    bool initP2P(p2p_settings *p2p_settings);
 
    bool getP2P(p2p_settings *p2p_settings);
 
    bool sendP2PData(char *datahex);
 
    bool setP2PCAD(bool enable);
 
    bool getP2PCAD(void);
 
    bool recvResponse(uint32_t timeout = 10000);
 
    void recvRX(uint32_t timeout);
 
    void flushRX(uint32_t timeout = 5000);
 
    bool sleep(int mode);
 
    void reset(void);
 
    bool setUARTConfig(int Baud);
 
    bool sendRawCommand(char *command);
 
    bool byteArrayToAscii(char *b_array, char *a_array, uint16_t b_array_len, uint16_t a_array_len);
 
    bool asciiArrayToByte(char *b_array, char *a_array, uint16_t b_array_len, uint16_t a_array_len);
 
    char ret[1024] = {0};
 
    stParam param;
 
private:
    Stream &_serial;
 
    Stream &_serial1;
 
    String _devADDR = "00112233";
 
    String _devEUI = "60C5A8FFFE000001";
 
    String _appEUI = "60C5A8FFFE000001";
 
    String _nwksKEY = "60C5A8FFFE00000160C5A8FFFE000001";
 
    String _appKEY = "60C5A8FFFE00000160C5A8FFFE000001";
 
    String _appsKEY = "60C5A8FFFE00000160C5A8FFFE000001";
};
#endif // _RUI3_H_