RAKLorawan.h

Go to the documentation of this file.

#ifndef __RAK_LORAWAN_H__
#define __RAK_LORAWAN_H__

#ifdef SUPPORT_LORA

#include <cstdint>
#include "WString.h"
#include <cstring>

#include "udrv_errno.h"
#include "service_lora.h"
#include "service_lora_test.h"
#include "service_lora_p2p.h"
#include "service_lora_multicast.h"
#include "service_battery.h"
#include "service_lora_arssi.h"

using namespace std;

typedef enum
{
  RAK_REGION_EU433 = 0, 
  RAK_REGION_CN470 = 1, 
  RAK_REGION_RU864 = 2, 
  RAK_REGION_IN865 = 3, 
  RAK_REGION_EU868 = 4, 
  RAK_REGION_US915 = 5, 
  RAK_REGION_AU915 = 6, 
  RAK_REGION_KR920 = 7, 
  RAK_REGION_AS923 = 8, 
  RAK_REGION_AS923_2 = 9, 
  RAK_REGION_AS923_3 = 10, 
  RAK_REGION_AS923_4 = 11, 
} RAK_LORA_BAND;

typedef enum
{
  RAK_LORA_ABP = 0, 
  RAK_LORA_OTAA = 1 
} RAK_LORA_JOIN_MODE;

typedef enum
{
  RAK_LORA_P2P = 0, 
  RAK_LORAWAN = 1,  
  RAK_LORA_FSK = 2, 
} RAK_LORA_WORK_MODE;

typedef enum
{
  RAK_LORA_NO_ACK = 0, 
  RAK_LORA_ACK = 1,    
} RAK_LORA_CONFIRM_MODE;

typedef enum
{
  RAK_LORA_CLASS_A = 0, 
  RAK_LORA_CLASS_B = 1, 
  RAK_LORA_CLASS_C = 2, 
} RAK_LORA_CLASS;

typedef enum RAKLoRaMacEventInfoStatus
{
    RAK_LORAMAC_STATUS_OK = 0,                          
    RAK_LORAMAC_STATUS_ERROR,                           
    RAK_LORAMAC_STATUS_TX_TIMEOUT,                      
    RAK_LORAMAC_STATUS_RX1_TIMEOUT,                     
    RAK_LORAMAC_STATUS_RX2_TIMEOUT,                     
    RAK_LORAMAC_STATUS_RX1_ERROR,                       
    RAK_LORAMAC_STATUS_RX2_ERROR,                       
    RAK_LORAMAC_STATUS_JOIN_FAIL,                       
    RAK_LORAMAC_STATUS_DOWNLINK_REPEATED,               
    RAK_LORAMAC_STATUS_TX_DR_PAYLOAD_SIZE_ERROR,        
    RAK_LORAMAC_STATUS_DOWNLINK_TOO_MANY_FRAMES_LOSS,   
    RAK_LORAMAC_STATUS_ADDRESS_FAIL,                    
    RAK_LORAMAC_STATUS_MIC_FAIL,                        
    RAK_LORAMAC_STATUS_MULTICAST_FAIL,                  
    RAK_LORAMAC_STATUS_BEACON_LOCKED,                   
    RAK_LORAMAC_STATUS_BEACON_LOST,                     
    RAK_LORAMAC_STATUS_BEACON_NOT_FOUND,                
}RAKLoRaMacEventInfoStatus_t;


typedef struct
{
  uint8_t McDevclass;     
  uint32_t McAddress;     
  uint8_t McAppSKey[16];  
  uint8_t McNwkSKey[16];  
  uint32_t McFrequency;   
  int8_t McDatarate;      
  uint16_t McPeriodicity; 
  int8_t McGroupID;       
  uint8_t entry;          
} RAK_LORA_McSession;

typedef struct
{
  uint32_t chan; 
  uint16_t mask; 
  int8_t rssi;   
} RAK_LORA_chan_rssi;

class RAKLorawan
{

public:
  RAKLorawan();

  bool join();
  bool join(uint8_t join_start, uint8_t auto_join, uint8_t auto_join_period, uint8_t auto_join_cnt);

  bool send(uint8_t length, uint8_t *payload, uint8_t fport, bool confirm, uint8_t retry);
  bool send(uint8_t length, uint8_t *payload, uint8_t fport, bool confirm);
  bool send(uint8_t length, uint8_t *payload, uint8_t fport);

  class rety
  {
  public:
    uint8_t get();

    bool set(uint8_t value);
  };

  bool lpsend(uint8_t port, bool ack, uint8_t *payload, int length);

  bool usend(uint8_t port, bool confirm, uint8_t retry, uint8_t *payload, uint8_t length);

  bool registerRecvCallback(service_lora_recv_cb callback);

  bool registerJoinCallback(service_lora_join_cb callback);

  bool registerSendCallback(service_lora_send_cb callback);

  bool registerPRecvCallback(service_lora_p2p_recv_cb_type callback);

  bool registerPSendCallback(service_lora_p2p_send_cb_type callback);
  bool registerPSendCADCallback(service_lora_p2p_send_CAD_cb_type callback);

  class appeui
  {
  public:
    bool get(uint8_t *buf, uint32_t len);

    bool set(uint8_t *buf, uint32_t len);
  };

  class appkey
  {
  public:
    bool get(uint8_t *buf, uint32_t len);

    bool set(uint8_t *buf, uint32_t len);
  };

  class appskey
  {
  public:
    bool get(uint8_t *buf, uint32_t len);

    bool set(uint8_t *buf, uint32_t len);
  };

  class daddr
  {
  public:
    bool get(uint8_t *buf, uint32_t len);

    bool set(uint8_t *buf, uint32_t len);
  };

  class deui
  {
  public:
    bool get(uint8_t *buf, uint32_t len);

    bool set(uint8_t *buf, uint32_t len);
  };

  class netid
  {
  public:
    bool get(uint8_t *buf, uint32_t len);
  };

  class nwkskey
  {
  public:
    bool get(uint8_t *buf, uint32_t len);

    bool set(uint8_t *buf, uint32_t len);
  };

  class cfm
  {
  public:
    bool get();

    bool set(bool value);
  };

  class cfs
  {
  public:
    bool get();
  };

  class njm
  {
  public:
    bool get();

    bool set(bool value);
  };

  class njs
  {
  public:
    bool get();
  };

  class adr
  {
  public:
    bool get();

    bool set(bool value);
  };

  class deviceClass
  {
  public:
    uint8_t get();

    bool set(uint8_t value);
  };

  class dcs
  {
  public:
    bool get();

    bool set(uint8_t dutyCycle);
  };

  class dr
  {
  public:
    uint8_t get();

    bool set(uint8_t value);
  };

  class jn1dl
  {
  public:
    int get();

    bool set(int value);
  };

  class jn2dl
  {
  public:
    int get();

    bool set(int value);
  };

  class pnm
  {
  public:
    bool get();

    bool set(bool value);
  };

  class rx1dl
  {
  public:
    int get();

    bool set(int value);
  };

  class rx2dl
  {
  public:
    int get();

    bool set(int value);
  };

  class rx2dr
  {
  public:
    uint8_t get();

    bool set(uint8_t value);
  };

  class rx2fq
  {
  public:
    long get();

    bool set(int value);
  };

  class txp
  {
  public:
    uint8_t get();

    bool set(uint8_t value);
  };

  class pgslot
  {
  public:
    uint8_t get();

    bool set(uint8_t value);
  };

  class bfreq
  {
  public:
    float get();
  };

  class btime
  {
  public:
    long get();
  };

  class bgw
  {
  public:
    beacon_bgw_t get();
  };

  class rssi
  {
  public:
    int get();
  };

  class snr
  {
  public:
    int get();
  };

  class ltime
  {
  public:
    String get();
  };

  class ver
  {
  public:
    String get();
  };

  class mask
  {
  public:
    bool get(uint16_t *buff);

    bool set(uint16_t *value);
  };

  class band
  {
  public:
    int32_t get();

    bool set(uint8_t value);
  };

  class linkcheck
  {
  public:
    uint32_t get();

    bool set(uint8_t value);
  };

  class nwm
  {
  public:
    int get();

    bool set(uint8_t value);
  };

  class pfreq
  {
  public:
    uint32_t get();

    bool set(uint32_t value);
  };

  class psf
  {
  public:
    uint8_t get();

    bool set(uint8_t value);
  };

  class pbw
  {
  public:
    uint32_t get();

    bool set(uint32_t value);
  };

  class pcr
  {
  public:
    uint8_t get();

    bool set(uint8_t value);
  };

  class ppl
  {
  public:
    uint16_t get();

    bool set(uint16_t value);
  };

  class ptp
  {
  public:
    uint8_t get();

    bool set(uint8_t value);
  };

  bool precv(uint32_t timeout);

  //instance
  rety rety;
  appeui appeui;
  appkey appkey;
  appskey appskey;
  daddr daddr;
  deui deui;
  netid netid;
  nwkskey nwkskey;
  cfm cfm;
  cfs cfs;
  njm njm;
  njs njs;
  adr adr;
  deviceClass deviceClass;
  dcs dcs;
  dr dr;
  jn1dl jn1dl;
  jn2dl jn2dl;
  pnm pnm;
  rx1dl rx1dl;
  rx2dl rx2dl;
  rx2dr rx2dr;
  rx2fq rx2fq;
  txp txp;
  pgslot pgslot;
  bfreq bfreq;
  btime btime;
  bgw bgw;
  rssi rssi;
  snr snr;
  ltime ltime;
  ver ver;
  mask mask;
  band band;
  linkcheck linkcheck;
  nwm nwm;
  pfreq pfreq;
  psf psf;
  pbw pbw;
  pcr pcr;
  ppl ppl;
  ptp ptp;

  bool psend(uint8_t length, uint8_t *payload);
  bool psend(uint8_t length, uint8_t *payload,bool cad_enable);

  class encry
  {
  public:
    bool get();

    bool set(bool value);
  };

  class enckey
  {
  public:
    bool get(uint8_t *buff, uint32_t len);

    bool set(uint8_t *buff, uint32_t len);
  };
  class enciv
  {
    public:
      bool get(uint8_t *buff, uint32_t len);
      bool set(uint8_t *buff, uint32_t len);
  };

  encry encry;
  enckey enckey;
  enciv  enciv;

  class pbr
  {
  public:
    uint32_t get();

    bool set(uint32_t value);
  };

  class pfdev
  {
  public:
    uint32_t get();

    bool set(uint32_t value);
  };

  pbr pbr;
  pfdev pfdev;

  bool addmulc(RAK_LORA_McSession session);

  bool rmvmulc(uint32_t devAddr);

  bool lstmulc(RAK_LORA_McSession *iterator);

  bool arssi(RAK_LORA_chan_rssi *iterator);
};

#endif

#endif //end lorawan.h