LoRaWANPacMan.h

#if !defined(_RADIOLIB_LORAWAN_PACMAN_H) && !RADIOLIB_EXCLUDE_LORAWAN
#define _RADIOLIB_LORAWAN_PACMAN_H
 
#include "LoRaWAN.h"
 
// Number of known TSxxx packages
#define RADIOLIB_LORAWAN_NUM_PACKAGES           (8)
 
// Package ID numbering as per TS008 (TS011 ID is made up)
#define RADIOLIB_LORAWAN_PACKAGE_TS003                          (1)
#define RADIOLIB_LORAWAN_PACKAGE_TS004                          (3)
#define RADIOLIB_LORAWAN_PACKAGE_TS005                          (2)
#define RADIOLIB_LORAWAN_PACKAGE_TS006                          (4)
#define RADIOLIB_LORAWAN_PACKAGE_TS007                          (0)
#define RADIOLIB_LORAWAN_PACKAGE_TS009                          (5)
#define RADIOLIB_LORAWAN_PACKAGE_TS011                          (6)
 
// Package FPort (specified or recommended)
#define RADIOLIB_LORAWAN_FPORT_TS003                            (202)
#define RADIOLIB_LORAWAN_FPORT_TS004                            (201)
#define RADIOLIB_LORAWAN_FPORT_TS005                            (200)
#define RADIOLIB_LORAWAN_FPORT_TS006                            (203)
#define RADIOLIB_LORAWAN_FPORT_TS007                            (225)
#define RADIOLIB_LORAWAN_FPORT_TS009                            (224)
#define RADIOLIB_LORAWAN_FPORT_TS011                            (226)
 
 
// Forward-declare the manager so it can be friended by LoRaWANPackage
class LoRaWANPackageManager;
 
enum LoRaWANTaskType_t {
  RADIOLIB_LORAWAN_TASK_NONE = 0,
  RADIOLIB_LORAWAN_TASK_ACTION,
  RADIOLIB_LORAWAN_TASK_UPLINK
};
 
struct LoRaWANTaskInfo {
  LoRaWANTaskType_t type;   // NONE / ACTION / UPLINK
  RadioLibTime_t time;      // Time of the task (0 = immediate / no deadline)
};
 
class LoRaWANPackage {
  public:
 
    typedef RadioLibTime_t (*GetSecondsCb_t)();
 
    // copy constructor is removed to prevent users from creating copies of this class
    LoRaWANPackage(const LoRaWANPackage& obj) = delete;
 
    virtual size_t processData(const uint8_t* data, size_t len, LoRaWANEvent_t* event);
 
    virtual LoRaWANTaskInfo hasTask();
 
    virtual void doAction();
 
    void getUplinkData(uint8_t* dataOut, size_t* lenOut);
 
    RadioLibTime_t getSeconds() {
      if(this->getSeconds_cb != NULL) {
        return(this->getSeconds_cb());
      }
      return(0);
    }
    
#if !RADIOLIB_GODMODE
  protected:
#endif
    
    LoRaWANPackage(uint8_t ts, LoRaWANPackageManager* pacMan, LoRaWANNode* node, GetSecondsCb_t secondsCb);
 
    uint8_t packageIdentifier;
    uint8_t packageVersion;
    uint8_t dataUp[255];
    size_t lenUp = 0;
 
    LoRaWANPackageManager* pacMan;
    LoRaWANNode* lorawanNode;
    GetSecondsCb_t getSeconds_cb;
 
    // allow LoRaWANPackageManager to access the protected members
    friend LoRaWANPackageManager;
};
 
class LoRaWANPackageManager {
  public:
 
    typedef RadioLibTime_t (*GetSecondsCb_t)();
    typedef void (*SetSecondsCb_t)(RadioLibTime_t seconds);
    typedef void (*DelaySecondsCb_t)(RadioLibTime_t seconds);
    typedef void (*UplinkIntervalCb_t)(RadioLibTime_t intervalSeconds);
    typedef void (*RebootCb_t)();
 
    LoRaWANPackageManager(LoRaWANNode* node, GetSecondsCb_t secondsCb);
 
    // Package enable methods
    int16_t enableTS003(uint8_t fPort, SetSecondsCb_t setSecondsFunc);
 
    // Package enablement methods
    int16_t enableTS009(PhysicalLayer* radio, DelaySecondsCb_t delayCb, UplinkIntervalCb_t intervalCb, RebootCb_t rebootCb);
 
    // TS003
    void requestAppTime();
    
    // TS009
    bool getConfirmed();
 
    int16_t processDownlink(const uint8_t* data, size_t len, LoRaWANEvent_t* eventDown);
 
    LoRaWANTaskInfo hasTask();
 
    bool getUplinkData(uint8_t* dataOut, size_t* lenOut, uint8_t* fPort);
 
    bool doAction();
 
    size_t processPackageManagerData(uint8_t* dataDown, size_t lenDown, uint8_t* ansOut, size_t* ansLen);
 
    bool isEnabledFPort(uint8_t fPort) {
      for(uint8_t i = 0; i < RADIOLIB_LORAWAN_NUM_PACKAGES; i++) {
        if(this->enabledPackages[i] && this->packagePorts[i] == fPort) {
          return(true);
        }
      }
      return(false);
    }
    
#if !RADIOLIB_GODMODE
  protected:
#endif
    
    LoRaWANNode* lorawanNode;
    LoRaWANPackage* packages[RADIOLIB_LORAWAN_NUM_PACKAGES];
    uint8_t packagePorts[RADIOLIB_LORAWAN_NUM_PACKAGES];
    bool enabledPackages[RADIOLIB_LORAWAN_NUM_PACKAGES];
 
    // Time handler functions
    GetSecondsCb_t getSecondsCb;
    
};
 
#endif