WiMOD_SAP_LORAWAN.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
 
#ifndef ARDUINO_WIMOD_SAP_LORAWAN_H_
#define ARDUINO_WIMOD_SAP_LORAWAN_H_
 
/*
 * THIS IS AN EXAMPLE IMPLEMENTATION ACCORDING THE THE HCI SPEC: V2.1
 * FOR FIRMWARE: LoRaWAN_EndNode_Modem
 *
 * SEE FILE: WiMOD_LoRaWAN_EndNode_Modem_HCI_Spec_V2_1.pdf
 * for detailed information
 *
 */
 
 
//------------------------------------------------------------------------------
//
// Section Includes Files
//
//------------------------------------------------------------------------------
 
#include "WiMOD_SAP_LORAWAN_IDs.h"
#include "../HCI/WiMODLRHCI.h"
 
/*
 * C++11 supports a better way for function pointers / function objects
 * But C++11 mode is not supported by all platforms.
 */
#ifdef WIMOD_USE_CPP11
#include <functional>
#endif
//------------------------------------------------------------------------------
//
// Section defines
//
//------------------------------------------------------------------------------
 
#define WiMOD_LORAWAN_TX_PAYLOAD_SIZE               (WiMODLORAWAN_APP_PAYLOAD_LEN + 5)
 
 
typedef enum TLoRaWANregion
{
  LoRaWAN_Region_EU868,                                                       
  LoRaWAN_Region_US915,                                                       
  LoRaWAN_Region_IN865,                                                       
  LoRaWAN_Region_AS923,                                                       
  LoRaWAN_Region_IL915,                                                       
  LoRaWAN_Region_RU868,                                                       
  LoRaWAN_Region_proprietary_WW2G4,
} TLoRaWANregion;
 
 
 
//-----------------------------------------------------------------------------
//
// types for callback functions
//
//-----------------------------------------------------------------------------
 
// C++11 check
#ifdef WIMOD_USE_CPP11
/* C++11 function callback definitions */
 
    typedef std::function<void (void)> TResetDevNonceIndicationCallback;
 
    typedef std::function<void (void)> TLinkDisconnectIndicationCallback;
 
    typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TNwkDeviceTimeAnsIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TJoinTxIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TJoinedNwkIndicationCallback;
 
  typedef std::function<void (void)> TNoDataIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TTxCDataIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TTxUDataIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TRxUDataIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TRxCDataIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TRxMacCmdIndicationCallback;
 
  typedef std::function<void (TWiMODLR_HCIMessage& rxMsg)> TRxAckIndicationCallback;
 
#else
  /* pre C++11 function callback definitions */
 
    typedef void (*TResetDevNonceIndicationCallback)(void);
 
    typedef void (*TLinkDisconnectIndicationCallback)(void);
 
    typedef void (*TNwkDeviceTimeAnsIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TJoinTxIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TJoinedNwkIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TNoDataIndicationCallback)(void);
 
  typedef void (*TTxCDataIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TTxUDataIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TRxUDataIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TRxCDataIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TRxMacCmdIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
  typedef void (*TRxAckIndicationCallback)(TWiMODLR_HCIMessage& rxMsg);
 
#endif
 
 
//------------------------------------------------------------------------------
//
// Section class
//
//------------------------------------------------------------------------------
 
class WiMOD_SAP_LoRaWAN {
public:
 
    WiMOD_SAP_LoRaWAN(TWiMODLRHCI* hci, UINT8* buffer, UINT16 bufferSize);
    virtual ~WiMOD_SAP_LoRaWAN(void);
 
 
    virtual void setRegion(TLoRaWANregion regionalSetting);
 
    virtual TWiMODLRResultCodes ActivateDevice(TWiMODLORAWAN_ActivateDeviceData& activationData, UINT8* statusRsp);
    virtual TWiMODLRResultCodes ReactivateDevice(UINT32* devAdr, UINT8* statusRsp);
    virtual TWiMODLRResultCodes SetJoinParameter(TWiMODLORAWAN_JoinParams& joinParams, UINT8* statusRsp);
    virtual TWiMODLRResultCodes JoinNetwork(UINT8* statusRsp);
 
    virtual void   RegisterResetDevNonceIndicationClient(TResetDevNonceIndicationCallback cb);
    virtual void   RegisterLinkDisconnectIndicationClient(TLinkDisconnectIndicationCallback cb);
    virtual void   RegisterDeviceTimeAnsIndicationClient(TNwkDeviceTimeAnsIndicationCallback cb);
    virtual void   RegisterJoinTxIndicationClient(TJoinTxIndicationCallback cb);
 
//    bool               convert(TWiMODLR_HCIMessage& RxMsg, TWiMODLORAWAN_JoinNwkTxIndData* indicationData);
    bool               convert(TWiMODLR_HCIMessage& RxMsg, TWiMODLORAWAN_RX_Data* loraWanRxData);
//    bool               convert(TWiMODLR_HCIMessage& rxMsg, TWiMODLORAWAN_SendDataTxInd_Data* sendIndData);
    bool               convert(TWiMODLR_HCIMessage& rxMsg, TWiMODLORAWAN_TxIndData* sendIndData);
    bool               convert(TWiMODLR_HCIMessage& RxMsg, TWiMODLORAWAN_RX_MacCmdData* loraWanMacCmdData);
    bool               convert(TWiMODLR_HCIMessage& RxMsg, TWiMODLORAWAN_RX_JoinedNwkData* joinedNwkData);
    bool               convert(TWiMODLR_HCIMessage& RxMsg, TWiMODLORAWAN_RX_ACK_Data* ackData);
    bool               convert(TWiMODLR_HCIMessage& RxMsg, TWiMODLORAWAN_NoData_Data* info);
 
    void               RegisterNoDataIndicationClient(TNoDataIndicationCallback cb);
    void               RegisterTxCDataIndicationClient(TTxCDataIndicationCallback cb);
    void               RegisterTxUDataIndicationClient(TTxUDataIndicationCallback cb);
    void               RegisterRxUDataIndicationClient(TRxUDataIndicationCallback cb);
    void               RegisterRxCDataIndicationClient(TRxCDataIndicationCallback cb);
    void               RegisterRxMacCmdIndicationClient(TRxMacCmdIndicationCallback cb);
    void               RegisterJoinedNwkIndicationClient(TJoinedNwkIndicationCallback cb);
    void               RegisterRxAckIndicationClient(TRxAckIndicationCallback cb);
 
 
    virtual TWiMODLRResultCodes SendUData(const TWiMODLORAWAN_TX_Data* data, UINT8* statusRsp);
    virtual TWiMODLRResultCodes SendCData(const TWiMODLORAWAN_TX_Data* data, UINT8* statusRsp);
    virtual TWiMODLRResultCodes SetRadioStackConfig(TWiMODLORAWAN_RadioStackConfig* data, UINT8* statusRsp);
    virtual TWiMODLRResultCodes GetRadioStackConfig(TWiMODLORAWAN_RadioStackConfig* data, UINT8* statusRsp);
    virtual TWiMODLRResultCodes DeactivateDevice(UINT8* statusRsp);
    virtual TWiMODLRResultCodes FactoryReset(UINT8* statusRsp);
    virtual TWiMODLRResultCodes SetDeviceEUI(const UINT8* deviceEUI, UINT8* statusRsp);
    virtual TWiMODLRResultCodes GetDeviceEUI(UINT8* deviceEUI, UINT8* statusRsp);
    virtual TWiMODLRResultCodes GetNwkStatus(TWiMODLORAWAN_NwkStatus_Data* nwkStatus, UINT8* statusRsp);
 
    virtual TWiMODLRResultCodes SendMacCmd(const TWiMODLORAWAN_MacCmd* cmd, UINT8* statusRsp);
    virtual TWiMODLRResultCodes SetCustomConfig(const INT8 rfGain, UINT8* statusRsp);
    virtual TWiMODLRResultCodes GetCustomConfig(INT8* rfGain, UINT8* statusRsp);
    virtual TWiMODLRResultCodes GetSupportedBands(TWiMODLORAWAN_SupportedBands* supportedBands, UINT8* statusRsp);
    virtual TWiMODLRResultCodes GetTxPowerLimitConfig(TWiMODLORAWAN_TxPwrLimitConfig* txPwrLimitCfg, UINT8* statusRsp);
    virtual TWiMODLRResultCodes SetTxPowerLimitConfig(TWiMODLORAWAN_TxPwrLimitConfig& txPwrLimitCfg, UINT8* statusRsp);
 
//    TWiMODLRResultCodes       GetLinkAdrReqConfig(TWiMODLORAWAN_LinkAdrReqConfig* linkAdrReqCfg, UINT8* statusRsp);
//    TWiMODLRResultCodes SetLinkAdrReqConfig(TWiMODLORAWAN_LinkAdrReqConfig& linkAdrReqCfg, UINT8* statusRsp);
 
    virtual TWiMODLRResultCodes SetBatteryLevelStatus(UINT8 battStatus, UINT8* statusRsp);
 
    virtual void               DispatchLoRaWANMessage(TWiMODLR_HCIMessage& rxMsg);
protected:
    TResetDevNonceIndicationCallback    ResetDevNonceCallback;
    TLinkDisconnectIndicationCallback   LinkDisconnectCallback;
    TNwkDeviceTimeAnsIndicationCallback DeviceTimeAnsCallback;
    TJoinTxIndicationCallback           JoinTxIndCallback;
    TNoDataIndicationCallback           NoDataIndCallback;
    TTxCDataIndicationCallback          TxCDataIndCallback;
    TTxUDataIndicationCallback          TxUDataIndCallback;
    TRxUDataIndicationCallback          RxUDataIndCallback;
    TRxCDataIndicationCallback          RxCDataIndCallback;
    TRxMacCmdIndicationCallback         RxMacCmdIndCallback;
    TJoinedNwkIndicationCallback        JoinedNwkIndCallback;
    TRxAckIndicationCallback            RxAckIndCallback;
 
    UINT8*                           txPayload;
    UINT16                               txPayloadSize;
    TWiMODLRHCI*                         HciParser;
    TLoRaWANregion                               region;
private:
 
 
};
 
 
#endif /* ARDUINO_WIMOD_SAP_LORAWAN_H_ */