| Demo HCI Implementation for WiMOD-LR Devices V2.0.3

Classes | Macros | Typedefs | Enumerations
WiMOD_SAP_LORAWAN_IDs.h File Reference
`#include "utils/WMDefs.h"`
`#include "WiMOD_SAP_LORAWAN_IDs_EU868.h"`
`#include "WiMOD_SAP_LORAWAN_IDs_RU868.h"`
`#include "WiMOD_SAP_LORAWAN_IDs_IN865.h"`
`#include "WiMOD_SAP_LORAWAN_IDs_AS923.h"`
`#include "WiMOD_SAP_LORAWAN_IDs_IL915.h"`
`#include "WiMOD_SAP_LORAWAN_IDs_US915.h"`
`#include "WiMOD_SAP_GlobalLink24_IDs_WW2G4.h"`
Include dependency graph for WiMOD_SAP_LORAWAN_IDs.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Classes
struct | TWiMODLORAWAN_ActivateDeviceData
| Activation data structure for LoRa network activation. More...
struct | TWiMODLORAWAN_JoinParams
| JOIN data structure for LoRa network activation. More...
struct | TWiMODLORAWAN_TxIndData
| Activation data structure for LoRa network activation. More...
struct | TWiMODLORAWAN_TX_Data
| Structure containing all data necessary to transmitting a data message. More...
struct | TWiMODLORAWAN_RX_Data
| Structure containing RX (user) payload data. More...
struct | TWiMODLORAWAN_RX_MacCmdData
| Structure containing a received MAC command. More...
struct | TWiMODLORAWAN_RX_JoinedNwkData
| Structure containing data of the joined network indication. More...
struct | TWiMODLORAWAN_RadioStackConfig
| Radio stack configuration related to to LoRaWAN specific options. More...
struct | TWiMODLORAWAN_MacCmd
| LoRaWAN MAC command structure. More...
struct | TWiMODLORAWAN_RX_ACK_Data
| Data structure for received Acknowledgment data. More...
struct | TWiMODLORAWAN_NwkStatus_Data
| Structure containing all data about LoRaWAN network status. More...
struct | TWiMODLORAWAN_NoData_Data
| Structure containing infos of a NoData Indication message. More...
struct | TWiMODLORAWAN_SupportedBands
| data structure for supported bands More...
struct | TWiMODLORAWAN_TxPwrLimitConfig
| data structure for TX Power Limits More...

## Macros
#define | LORAWAN_STK_OPTION_ADR (0x01 << 0)
#define | LORAWAN_STK_OPTION_DUTY_CYCLE_CTRL (0x01 << 1)
#define | LORAWAN_STK_OPTION_DEV_CLASS_C (0x01 << 2)
#define | LORAWAN_STK_OPTION_POWER_UP_IND (0x01 << 4)
#define | LORAWAN_STK_OPTION_PRIVATE_NETOWRK (0x01 << 5)
#define | LORAWAN_STK_OPTION_EXT_PKT_FORMAT (0x01 << 6)
#define | LORAWAN_STK_OPTION_MAC_CMD (0x01 << 7)
#define | LORAWAN_STK_PARAM_ERR_WRONG_DATARATE (0x01 << 0)
#define | LORAWAN_STK_PARAM_ERR_WRONG_TX_PWRLEVEL (0x01 << 1)
#define | LORAWAN_STK_PARAM_ERR_WRONG_TX_BANDIDX (0x01 << 5)
#define | LORAWAN_TX_PWR_LIMIT_ERR_WRONG_SUBBAND (0x01 << 0)
#define | LORAWAN_TX_PWR_LIMIT_ERR_WRONG_TX_PWR_VAL (0x01 << 2)

## Typedefs
typedef enum TLoRaWANStatus | TLoRaWANStatus
| Status code enumeration for LoRaWAN SAP of the WiMOD EndNode Modem firmware. More...
typedef enum TLoraWANJoinNwkIndStatusFormat | TLoRaWanJoinNwkIndStatusFormat
| Status code enumeration for LoRaWAN Join Network Indications.
typedef enum TLoraWANTxDataIndStatusFormat | TLoRaWanTxDataIndStatusFormat
| Status code enumeration for LoRaWAN Join Network Indications.
typedef enum TLoRaWAN_FreqBand | TLoRaWAN_FreqBand
| Channel Band Selection.
typedef enum TLoRaWAN_PowerSaving | TLoRaWAN_PowerSaving
| Power Saving modes.
typedef enum TLoRaWAN_NwkStatus | TLoRaWAN_NwkStatus
| Network Status Status defines.
typedef struct TWiMODLORAWAN_ActivateDeviceData | TWiMODLORAWAN_ActivateDeviceData
| Activation data structure for LoRa network activation.
typedef struct TWiMODLORAWAN_JoinParams | TWiMODLORAWAN_JoinParams
| JOIN data structure for LoRa network activation.
typedef enum TWiMODLORAWAN_OptIndInfos | TWiMODLORAWAN_OptIndInfos
| Optional TX information flag.
typedef struct TWiMODLORAWAN_TxIndData | TWiMODLORAWAN_TxIndData
| Activation data structure for LoRa network activation.
typedef struct TWiMODLORAWAN_TX_Data | TWiMODLORAWAN_TX_Data
| Structure containing all data necessary to transmitting a data message.
typedef struct TWiMODLORAWAN_RX_Data | TWiMODLORAWAN_RX_Data
| Structure containing RX (user) payload data.
typedef struct TWiMODLORAWAN_RX_MacCmdData | TWiMODLORAWAN_RX_MacCmdData
| Structure containing a received MAC command.
typedef struct TWiMODLORAWAN_RX_JoinedNwkData | TWiMODLORAWAN_RX_JoinedNwkData
| Structure containing data of the joined network indication.
typedef struct TWiMODLORAWAN_RadioStackConfig | TWiMODLORAWAN_RadioStackConfig
| Radio stack configuration related to to LoRaWAN specific options.
typedef struct TWiMODLORAWAN_MacCmd | TWiMODLORAWAN_MacCmd
| LoRaWAN MAC command structure.
typedef struct TWiMODLORAWAN_RX_ACK_Data | TWiMODLORAWAN_RX_ACK_Data
| Data structure for received Acknowledgment data.
typedef struct TWiMODLORAWAN_NwkStatus_Data | TWiMODLORAWAN_NwkStatus_Data
| Structure containing all data about LoRaWAN network status.
typedef struct TWiMODLORAWAN_NoData_Data | TWiMODLORAWAN_NoData_Data
| Structure containing infos of a NoData Indication message.
typedef struct TWiMODLORAWAN_SupportedBands | TWiMODLORAWAN_SupportedBands
| data structure for supported bands
typedef struct TWiMODLORAWAN_TxPwrLimitConfig | TWiMODLORAWAN_TxPwrLimitConfig
| data structure for TX Power Limits

## Enumerations
enum | TLoRaWANStatus { LoRaWAN_Status_Ok = 0, LoRaWAN_Status_Error, LoRaWAN_Status_Cmd_Not_Supported, LoRaWAN_Status_Wrong_parameter, LoRaWAN_Status_Wrong_DeviceMode, LoRaWAN_Status_Device_Not_Activated, LoRaWAN_Status_Device_Busy, LoRaWAN_Status_Queue_Full, LoRaWAN_Status_Length_Error, LoRaWAN_Status_No_Factory_Settings, LoRaWAN_Status_Channel_Blocked, LoRaWAN_Status_Channel_Not_Available }
| Status code enumeration for LoRaWAN SAP of the WiMOD EndNode Modem firmware. More...
enum | TLoraWANJoinNwkIndStatusFormat { LoRaWAN_JoinNkwInd_Satus_Format_Join_Ok = 0x00, LoRaWAN_JoinNkwInd_Satus_Format_Join_Ok_Ch_Info = 0x01 }
| Status code enumeration for LoRaWAN Join Network Indications. More...
enum | TLoraWANTxDataIndStatusFormat { LoRaWAN_TxDataInd_Satus_TX_Ok = 0x00, LoRaWAN_TxDataInd_Satus_TX_Ok_Ch_Info = 0x01, LoRaWAN_TxDataInd_Satus_TX_Err_Max_Retrans = 0x02, LoRaWAN_TxDataInd_Satus_TX_Err_Payload = 0x04 }
| Status code enumeration for LoRaWAN Join Network Indications. More...
enum | TLoRaWAN_FreqBand { LoRaWAN_FreqBand_EU_868 = LORAWAN_BAND_EU_868, LoRaWAN_FreqBand_US_915 = LORAWAN_BAND_US_915, LoRaWAN_FreqBand_India_865 = LORAWAN_BAND_IN_865, LoRaWAN_FreqBand_AS_923_Brunei = LORAWAN_BAND_AS_923_BN_923, LoRaWAN_FreqBand_AS_923_Cambodia = LORAWAN_BAND_AS_923_KH_923, LoRaWAN_FreqBand_AS_923_Indonesia = LORAWAN_BAND_AS_923_ID_923, LoRaWAN_FreqBand_AS_923_Japan = LORAWAN_BAND_AS_923_JP_920, LoRaWAN_FreqBand_AS_923_Laos = LORAWAN_BAND_AS_923_LA_920, LoRaWAN_FreqBand_AS_923_NewZealand = LORAWAN_BAND_AS_923_LA_915, LoRaWAN_FreqBand_AS_923_Singapore = LORAWAN_BAND_AS_923_SG_920, LoRaWAN_FreqBand_AS_923_Taiwan = LORAWAN_BAND_AS_923_TW_922, LoRaWAN_FreqBand_AS_923_Thailand = LORAWAN_BAND_AS_923_TH_920, LoRaWAN_FreqBand_AS_923_Vietnam = LORAWAN_BAND_AS_923_VN_920, LoRaWAN_FreqBand_RU_868_V1 = LORAWAN_BAND_RU1_868, LoRaWAN_FreqBand_RU_868_V2 = LORAWAN_BAND_RU2_868, LoRaWAN_FreqBand_RU_868_V3 = LORAWAN_BAND_RU3_868, LoRaWAN_FreqBand_RU_868_V4 = LORAWAN_BAND_RU4_868, LoRaWAN_FreqBand_RU_868_V5 = LORAWAN_BAND_RU5_868, LoRaWAN_FreqBand_RU_868_V6 = LORAWAN_BAND_RU6_868, LoRaWAN_FreqBand_RU_868_V7 = LORAWAN_BAND_RU7_868, LoRaWAN_FreqBand_EU_868_RX2_SF9 = LORAWAN_BAND_EU_868_RX2_SF9, LoRaWAN_FreqBand_IN_865_RX2_SF8 = LORAWAN_BAND_IN_865_RX2_SF8, LoRaWAN_FreqBand_WW2G4 = GLOBALLINK24_BAND_WW_2G4, LoRaWAN_FreqBand_WW2G4_RX2 = GLOBALLINK24_BAND_WW_2G4_RX2 }
| Channel Band Selection. More...
enum | TLoRaWAN_PowerSaving { LoRaWAN_PowerSaving_Off = 0, LoRaWAN_PowerSaving_On = 1 }
| Power Saving modes. More...
enum | TLoRaWAN_NwkStatus { LoRaWAN_NwkStatus_Inactive = 0, LoRaWAN_NwkStatus_Active_ABP = 1, LoRaWAN_NwkStatus_Active_OTAA = 2, LoRaWAN_NwkStatus_Joining_OTAA = 3 }
| Network Status Status defines. More...
enum | TWiMODLORAWAN_OptIndInfos { LORAWAN_OPT_TX_IND_INFOS_NOT_AVAILABLE = 0, LORAWAN_OPT_TX_IND_INFOS_EXCL_PKT_CNT = 1, LORAWAN_OPT_TX_IND_INFOS_INCL_PKT_CNT = 2 }
| Optional TX information flag. More...

## Macro Definition Documentation

## ◆ LORAWAN_STK_OPTION_ADR

#define LORAWAN_STK_OPTION_ADR (0x01 << 0)

Stack option ADR

## ◆ LORAWAN_STK_OPTION_DEV_CLASS_C

#define LORAWAN_STK_OPTION_DEV_CLASS_C (0x01 << 2)

Stack option ClassC device

## ◆ LORAWAN_STK_OPTION_DUTY_CYCLE_CTRL

#define LORAWAN_STK_OPTION_DUTY_CYCLE_CTRL (0x01 << 1)

Stack option Duty Cycle Control

## ◆ LORAWAN_STK_OPTION_EXT_PKT_FORMAT

#define LORAWAN_STK_OPTION_EXT_PKT_FORMAT (0x01 << 6)

Stack option extended format

## ◆ LORAWAN_STK_OPTION_MAC_CMD

#define LORAWAN_STK_OPTION_MAC_CMD (0x01 << 7)

Stack option forwad MAC commands

## ◆ LORAWAN_STK_OPTION_POWER_UP_IND

#define LORAWAN_STK_OPTION_POWER_UP_IND (0x01 << 4)

Stack option for sending a PowerUp Indication

## ◆ LORAWAN_STK_OPTION_PRIVATE_NETOWRK

#define LORAWAN_STK_OPTION_PRIVATE_NETOWRK (0x01 << 5)

Stack option for using a Private LoRaWAN Network; 0 = public LoRaWAN network

## ◆ LORAWAN_STK_PARAM_ERR_WRONG_DATARATE

#define LORAWAN_STK_PARAM_ERR_WRONG_DATARATE (0x01 << 0)

Stack Error. wrong parameter

## ◆ LORAWAN_STK_PARAM_ERR_WRONG_TX_BANDIDX

#define LORAWAN_STK_PARAM_ERR_WRONG_TX_BANDIDX (0x01 << 5)

Stack Error. wrong band index

## ◆ LORAWAN_STK_PARAM_ERR_WRONG_TX_PWRLEVEL

#define LORAWAN_STK_PARAM_ERR_WRONG_TX_PWRLEVEL (0x01 << 1)

Stack Error. wrong TX power level

## ◆ LORAWAN_TX_PWR_LIMIT_ERR_WRONG_SUBBAND

#define LORAWAN_TX_PWR_LIMIT_ERR_WRONG_SUBBAND (0x01 << 0)

Power Limit Error: Wrong sub-band

## ◆ LORAWAN_TX_PWR_LIMIT_ERR_WRONG_TX_PWR_VAL

#define LORAWAN_TX_PWR_LIMIT_ERR_WRONG_TX_PWR_VAL (0x01 << 2)

Power Limit Error: Wrong TX power value

## Typedef Documentation

## ◆ TLoRaWANStatus

typedef enum TLoRaWANStatus TLoRaWANStatus

Status code enumeration for LoRaWAN SAP of the WiMOD EndNode Modem firmware.

SAP ID for the LoRaWAN service

## Enumeration Type Documentation

## ◆ TLoRaWAN_FreqBand

enum TLoRaWAN_FreqBand

Channel Band Selection.

Enumerator
LoRaWAN_FreqBand_EU_868 | EU 868 MHz band
LoRaWAN_FreqBand_US_915 | US 915 MHz band
LoRaWAN_FreqBand_India_865 | India
LoRaWAN_FreqBand_AS_923_Brunei | Brunei
LoRaWAN_FreqBand_AS_923_Cambodia | Cambodia
LoRaWAN_FreqBand_AS_923_Indonesia | Indonesia
LoRaWAN_FreqBand_AS_923_Japan | Japan
LoRaWAN_FreqBand_AS_923_Laos | Laos
LoRaWAN_FreqBand_AS_923_NewZealand | New Zealand
LoRaWAN_FreqBand_AS_923_Singapore | Singapore
LoRaWAN_FreqBand_AS_923_Taiwan | Taiwan
LoRaWAN_FreqBand_AS_923_Thailand | Thailand
LoRaWAN_FreqBand_AS_923_Vietnam | Vietnam
LoRaWAN_FreqBand_RU_868_V1 | Russia
LoRaWAN_FreqBand_RU_868_V2 | Russia
LoRaWAN_FreqBand_RU_868_V3 | Russia
LoRaWAN_FreqBand_RU_868_V4 | Russia
LoRaWAN_FreqBand_RU_868_V5 | Russia
LoRaWAN_FreqBand_RU_868_V6 | Russia
LoRaWAN_FreqBand_RU_868_V7 | Russia
LoRaWAN_FreqBand_EU_868_RX2_SF9 | alternative EU band, using SF9 for 2nd RX window
LoRaWAN_FreqBand_IN_865_RX2_SF8 | alternative IN band, using SF8 for 2nd RX window
LoRaWAN_FreqBand_WW2G4 | proprietary extension for emulating LoRaWAN on 2.4 GHz
LoRaWAN_FreqBand_WW2G4_RX2 | proprietary extension for emulating LoRaWAN on 2.4 GHz with RX2 window using 2.422 GHz

## ◆ TLoRaWAN_NwkStatus

enum TLoRaWAN_NwkStatus

Network Status Status defines.

Enumerator
LoRaWAN_NwkStatus_Inactive | Device is not active ( = no Data transmission is allowed)
LoRaWAN_NwkStatus_Active_ABP | Device has been activated / registered via ABP procedure
LoRaWAN_NwkStatus_Active_OTAA | Device has been activated / registered via OTAA procedure
LoRaWAN_NwkStatus_Joining_OTAA | OTAA procedure is currently in progress

## ◆ TLoRaWAN_PowerSaving

enum TLoRaWAN_PowerSaving

Power Saving modes.

Enumerator
LoRaWAN_PowerSaving_Off | Power Saving is NOT used (=off)
LoRaWAN_PowerSaving_On | automatic Power Saving is enabled (=on)

## ◆ TLoraWANJoinNwkIndStatusFormat

enum TLoraWANJoinNwkIndStatusFormat

Status code enumeration for LoRaWAN Join Network Indications.

Enumerator
LoRaWAN_JoinNkwInd_Satus_Format_Join_Ok | device activated
LoRaWAN_JoinNkwInd_Satus_Format_Join_Ok_Ch_Info | device additional channel info attached

## ◆ TLoRaWANStatus

enum TLoRaWANStatus

Status code enumeration for LoRaWAN SAP of the WiMOD EndNode Modem firmware.

SAP ID for the LoRaWAN service

Enumerator
LoRaWAN_Status_Ok | OK; No error
LoRaWAN_Status_Error | general (un-specific) error
LoRaWAN_Status_Cmd_Not_Supported | Command is not supported (or unknown)
LoRaWAN_Status_Wrong_parameter | Wrong parameter applied
LoRaWAN_Status_Wrong_DeviceMode | Device is in wong device mode for specific command
LoRaWAN_Status_Device_Not_Activated | Device has NOT been activated; command has not been executed
LoRaWAN_Status_Device_Busy | There is another operation pending; and or duty cycle restriction is active
LoRaWAN_Status_Queue_Full | internal command queue is full
LoRaWAN_Status_Length_Error | some error related to the given length information
LoRaWAN_Status_No_Factory_Settings | Factory settings are not available
LoRaWAN_Status_Channel_Blocked | Selected channel is blocked (duty cycle?)
LoRaWAN_Status_Channel_Not_Available | Selected channel is not available

## ◆ TLoraWANTxDataIndStatusFormat

enum TLoraWANTxDataIndStatusFormat

Status code enumeration for LoRaWAN Join Network Indications.

Enumerator
LoRaWAN_TxDataInd_Satus_TX_Ok | radio packet sent
LoRaWAN_TxDataInd_Satus_TX_Ok_Ch_Info | radio packet sent + channel info attached
LoRaWAN_TxDataInd_Satus_TX_Err_Max_Retrans | error: max number retransmissions reached
LoRaWAN_TxDataInd_Satus_TX_Err_Payload | error: payload size exceeted for current data rate

## ◆ TWiMODLORAWAN_OptIndInfos

enum TWiMODLORAWAN_OptIndInfos

Optional TX information flag.

Enumerator
LORAWAN_OPT_TX_IND_INFOS_NOT_AVAILABLE | no TX informations attached / available
LORAWAN_OPT_TX_IND_INFOS_EXCL_PKT_CNT | ext. infos available, but without packet counter
LORAWAN_OPT_TX_IND_INFOS_INCL_PKT_CNT | ext. infos available inclusive packet counter