| Demo HCI Implementation for WiMOD-LR Devices V1.3.1

- Main Page
- Classes
- Files

- File List
- File Members

Classes | Macros | Typedefs | Enumerations
WiMOD_SAP_LORAWAN_IDs.h File Reference

Supporting IDs and definitions for the LoRaWAN ServiceAccessPoint. More...

`#include "utils/WMDefs.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...

## Macros
#define | LORAWAN_SAP_ID 0x10

## Typedefs
typedef enum TLoRaWANStatus | TLoRaWANStatus
| Status code enumeration for LoRaWAN SAP of the WiMOD EndNode Modem firmware.
typedef enum TLoRaWANDataRate | TLoRaWANDataRate
| LoRa data rate definitions.
typedef enum TLoRaWAN_Channel_EU | TLoRaWAN_Channel_EU
| Channel definition for EU 868MHz Band.
typedef enum TLoRaWAN_Channel_India | TLoRaWAN_Channel_India
| Channel definition for India.
typedef enum TLoRaWAN_FreqBand | TLoRaWAN_FreqBand
| Channel definition for New Zealand. More...
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 TWiMOD_OptIndInfos | TWiMOD_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.

## 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 | TLoRaWANDataRate { LoRaWAN_DataRate_LoRa_SF12_125kHz = 0, LoRaWAN_DataRate_LoRa_SF11_125kHz, LoRaWAN_DataRate_LoRa_SF10_125kHz, LoRaWAN_DataRate_LoRa_SF9_125kHz, LoRaWAN_DataRate_LoRa_SF8_125kHz, LoRaWAN_DataRate_LoRa_SF7_125kHz, LoRaWAN_DataRate_LoRa_SF7_250kHz, LoRaWAN_DataRate_LoRa_FSK }
| LoRa data rate definitions. More...
enum | TLoRaWAN_Channel_EU { LoRaWAN_Channel_EU_868_1_Mhz = 0, LoRaWAN_Channel_EU_868_3_Mhz = 1, LoRaWAN_Channel_EU_868_5_Mhz = 2, LoRaWAN_Channel_EU_869_525_Mhz = 128 }
| Channel definition for EU 868MHz Band. More...
enum | TLoRaWAN_Channel_India { LoRaWAN_Channel_India_865_062_5_Mhz = 0, LoRaWAN_Channel_India_865_402_5_Mhz = 1, LoRaWAN_Channel_India_868_5_Mhz = 2, LoRaWAN_Channel_India_866_550_Mhz = 128 }
| Channel definition for India. More...
enum | TLoRaWAN_FreqBand { LoRaWAN_FreqBand_EU_868 = 1, LoRaWAN_FreqBand_Reserved = 2, LoRaWAN_FreqBand_India_865 = 3, LoRaWAN_FreqBand_EU_868_RX2_SF9 = 129 }
| Channel definition for New Zealand. 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 | TWiMOD_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...

## Detailed Description

Supporting IDs and definitions for the LoRaWAN ServiceAccessPoint.

Version
  0.1

Author
  (FB), IMST

## Macro Definition Documentation

#define LORAWAN_SAP_ID 0x10

SAP ID for the LoRaWAN service

## Typedef Documentation

typedef enum TLoRaWAN_FreqBand TLoRaWAN_FreqBand

Channel definition for New Zealand.

Channel definition for Singapore Channel Band Selection

## Enumeration Type Documentation

enum TLoRaWAN_Channel_EU

Channel definition for EU 868MHz Band.

Enumerator
LoRaWAN_Channel_EU_868_1_Mhz | carrier frequency of 868.100 MHz
LoRaWAN_Channel_EU_868_3_Mhz | carrier frequency of 868.300 MHz
LoRaWAN_Channel_EU_868_5_Mhz | carrier frequency of 868.500 MHz
LoRaWAN_Channel_EU_869_525_Mhz | carrier frequency of 869.525 MHz

enum TLoRaWAN_Channel_India

Channel definition for India.

Enumerator
LoRaWAN_Channel_India_865_062_5_Mhz | carrier frequency of 865.062 500 MHz
LoRaWAN_Channel_India_865_402_5_Mhz | carrier frequency of 865.402 500 MHz
LoRaWAN_Channel_India_868_5_Mhz | carrier frequency of 868.500 MHz
LoRaWAN_Channel_India_866_550_Mhz | carrier frequency of 866.550 MHz

enum TLoRaWAN_FreqBand

Channel definition for New Zealand.

Channel definition for Singapore Channel Band Selection

Enumerator
LoRaWAN_FreqBand_EU_868 | default EU 868 MHz band
LoRaWAN_FreqBand_Reserved | reserved
LoRaWAN_FreqBand_India_865 | India
LoRaWAN_FreqBand_EU_868_RX2_SF9 | alternative EU band, using SF9 for 2nd RX window

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

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)

enum TLoRaWANDataRate

LoRa data rate definitions.

Enumerator
LoRaWAN_DataRate_LoRa_SF12_125kHz | LoRa Spreading factor 12 using 125kHz bandwidth
LoRaWAN_DataRate_LoRa_SF11_125kHz | LoRa Spreading factor 11 using 125kHz bandwidth
LoRaWAN_DataRate_LoRa_SF10_125kHz | LoRa Spreading factor 10 using 125kHz bandwidth
LoRaWAN_DataRate_LoRa_SF9_125kHz | LoRa Spreading factor 9 using 125kHz bandwidth
LoRaWAN_DataRate_LoRa_SF8_125kHz | LoRa Spreading factor 8 using 125kHz bandwidth
LoRaWAN_DataRate_LoRa_SF7_125kHz | LoRa Spreading factor 7 using 125kHz bandwidth
LoRaWAN_DataRate_LoRa_SF7_250kHz | LoRa Spreading factor 7 using 250kHz bandwidth
LoRaWAN_DataRate_LoRa_FSK | FSK modulation; LoRa settings not applicable

enum TLoRaWANStatus

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

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

enum TWiMOD_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