WiMOD_SAP_LORAWAN_ProLink_IDs.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
 
/*
 * THIS IS AN EXAMPLE IMPLEMENTATION ACCORDING THE THE HCI SPEC: V2.0
 * FOR FIRMWARE: ProLink_
 *
 * SEE FILE: ProLink_LoRaWAN_EndNode_Modem_HCI_Spec.pdf (version 2.0)
 * for detailed information
 *
 */
 
 
#ifndef ARDUINO_SAP_WIMOD_SAP_LORAWAN_PROLINK_IDS_H_
#define ARDUINO_SAP_WIMOD_SAP_LORAWAN_PROLINK_IDS_H_
 
#include "utils/WMDefs.h"
 
#include "WiMOD_SAP_LORAWAN_IDs.h"
 
#include "WiMOD_SAP_LORAWAN_IDs_EU868.h"  /* Europe       */
#include "WiMOD_SAP_LORAWAN_IDs_RU868.h"  /* Russia       */
#include "WiMOD_SAP_LORAWAN_IDs_IN865.h"  /* India        */
#include "WiMOD_SAP_LORAWAN_IDs_AS923.h"  /* Asia/Pacific */
#include "WiMOD_SAP_LORAWAN_IDs_IL915.h"  /* Israel       */
#include "WiMOD_SAP_LORAWAN_IDs_US915.h"  /* US           */
#include "WIMOD_SAP_LORAWAN_IDs_AU915.h"  /* Australia    */
 
typedef enum TProLinkLoRaWAN_FreqBand
{
    ProLink_LoRaWAN_FreqBand_EU_868            = LORAWAN_BAND_EU_868,                   
    ProLink_LoRaWAN_FreqBand_IN_865            = LORAWAN_BAND_IN_865,                   
    ProLink_LoRaWAN_FreqBand_US_915            = LORAWAN_BAND_US_915,                   
    ProLink_LoRaWAN_FreqBand_AU_915            = LORAWAN_BAND_AU_915,                   
    ProLink_LoRaWAN_FreqBand_AS_923_1          = LORAWAN_BAND_AS_923_1,                   
    ProLink_LoRaWAN_FreqBand_AS_923_2          = LORAWAN_BAND_AS_923_2,                   
    ProLink_LoRaWAN_FreqBand_AS_923_3          = LORAWAN_BAND_AS_923_3,                   
    ProLink_LoRaWAN_FreqBand_RU_868            = LORAWAN_BAND_EU_868,                   
    ProLink_LoRaWAN_FreqBand_EU_868_RX2_SF9    = LORAWAN_BAND_EU_868_RX2_SF9,           
    ProLink_LoRaWAN_FreqBand_IN_865_RX2_SF8    = LORAWAN_BAND_IN_865_RX2_SF8,           
    ProLink_LoRaWAN_FreqBand_WW2G4             = GLOBALLINK24_BAND_WW_2G4,              
    ProLink_LoRaWAN_FreqBand_WW2G4_RX2         = GLOBALLINK24_BAND_WW_2G4_RX2,          
} TProLinkLoRaWAN_FreqBand;
 
 
typedef struct TWiMODProLinkLORAWAN_TX_Data
{
    UINT8       Port;                                                           
    UINT8       Length;                                                         
    UINT8       Payload[WiMODLORAWAN_APP_PAYLOAD_LEN];                          
    // only for RX
    UINT32      ChannelBlockTime;                                               
} TWiMODProLinkLORAWAN_TX_Data;
 
 
typedef struct TWiMODLORAWAN_DevTimeReqInfo
{
//    UINT8       Status;
    UINT32      ChannelBlockTime;                                               
} TWiMODLORAWAN_DevTimeReqInfo;
 
 
typedef struct TWiMODLORAWAN_DevTimeAnsInfo
{
    UINT8       Status;
    UINT32      GpsTime;                                                        
} TWiMODLORAWAN_DevTimeAnsInfo;
 
 
typedef struct TWiMODLORAWAN_McastConfig
{
    UINT8       MulticastIndex;
    UINT32      DeviceAddress;                                                  
    /* only for GET-Operations */
    UINT8       MulticastStatus;                                                
    /* only for SET-Operations */
    UINT8       NwkSKey[WiMODLORAWAN_NWK_SESSION_KEY_LEN];                      
    UINT8       AppSKey[WiMODLORAWAN_APP_SESSION_KEY_LEN];                      
} TWiMODLORAWAN_McastConfig;
 
 
 
typedef struct TWiMODLORAWAN_McastData
{
    // only for RX
    UINT8       StatusFormat;                                                   
    UINT32      DeviceAddress;                                                  
    UINT8       LoRaWANPort;                                                    
    UINT8       AppPayload[WiMODLORAWAN_APP_PAYLOAD_LEN];                       ;
    UINT8       Length;
 
    // optional - see StatusFormat code
    UINT8       ChannelIndex;                                                   
    UINT8       DataRateIndex;                                                  
    INT8        RSSI;                                                           
    INT8        SNR;                                                            
    UINT8       RxSlot;                                                         
    bool        OptionalInfoAvaiable;                                           
} TWiMODLORAWAN_McastData;
 
 
/* bit fields for Multicast error indications */
#define PROLINK_MCAST_ERR_WRONG_MTYPE           (1 << 0)
#define PROLINK_MCAST_ERR_WRONG_DEV_ADR         (1 << 1)
#define PROLINK_MCAST_ERR_WRONG_MIC             (1 << 2)
#define PROLINK_MCAST_ERR_UNEXPTECTED_FCNT      (1 << 3)
#define PROLINK_MCAST_ERR_RX_MAC_CMD            (1 << 4)
#define PROLINK_MCAST_ERR_WRONG_DOWNLINK        (1 << 5)
#define PROLINK_MCAST_ERR_MCAST_DOWNLINK_ERR    (1 << 6)
 
 
typedef struct TWiMODLORAWAN_McastNoData
{
    // only for RX
    UINT8       StatusFormat;                                                   
    UINT8       ErrorCode;                                                      
    UINT32      DeviceAddress;                                                  
} TWiMODLORAWAN_McastNoData;
 
 
typedef struct TWiMODProLinkLORAWAN_RadioStackConfig
{
    UINT8       DataRateIndex;                                                  
    UINT8       TXPowerLevel;                                                   
    UINT8       Options;                                                        
    UINT8       Retransmissions;                                                
    UINT8       BandIndex;                                                      
    UINT8       HeaderMacCmdCapacity;                                           
    // US915/AU915 Firmware only
    UINT8       SubBandMask1;                                                   
    UINT8       SubBandMask2;                                                   
    // optional for SetRadioStack cmd
    UINT8       WrongParamErrCode;                                              
} TWiMODProLinkLORAWAN_RadioStackConfig;
 
 
 
#endif /* ARDUINO_SAP_WIMOD_SAP_LORAWAN_PROLINK_IDS_H_ */