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

WiMOD_SAP_LORAWAN_IDs.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
31 //------------------------------------------------------------------------------
32
33
34 /*
35 * THIS IS AN EXAMPLE IMPLEMENTATION ACCORDING THE THE HCI SPEC: V1.26
36 * FOR FIRMWARE: LoRaWAN_EndNode_Modem
37 *
38 * SEE FILE: WiMOD_LoRaWAN_EndNode_Modem_HCI_Spec_V1_26.pdf
39 * for detailed information
40 *
41 */
42
43
44 #ifndef ARDUINO_WIMOD_SAP_LORAWAN_IDS_H_
45 #define ARDUINO_WIMOD_SAP_LORAWAN_IDS_H_
46
47 //------------------------------------------------------------------------------
48 //
49 // Section Includes Files
50 //
51 //------------------------------------------------------------------------------
52
53 #include "utils/WMDefs.h"
54
55 #include "WiMOD_SAP_LORAWAN_IDs_EU868.h" /* Europe */
56 #include "WiMOD_SAP_LORAWAN_IDs_RU868.h" /* Russia */
57 #include "WiMOD_SAP_LORAWAN_IDs_IN865.h" /* India */
58 #include "WiMOD_SAP_LORAWAN_IDs_AS923.h" /* Asia/Pacific */
59 #include "WiMOD_SAP_LORAWAN_IDs_IL915.h" /* Israel */
60 #include "WiMOD_SAP_LORAWAN_IDs_US915.h" /* US */
61
62 #include "WiMOD_SAP_GlobalLink24_IDs_WW2G4.h" /* prorieaty 2.4 GHz WorldWide */
63
64 //------------------------------------------------------------------------------
65 //
66 // Service Access Point Identifier
67 //
68 //------------------------------------------------------------------------------
69
72 #define LORAWAN_SAP_ID 0x10
74
76
77 //------------------------------------------------------------------------------
78 //
79 // LoRaWAN Message Identifier
80 //
81 //------------------------------------------------------------------------------
83
84 // Status Codes
85
86 #define LORAWAN_STATUS_OK 0x00 //Operation successful
87 #define LORAWAN_STATUS_ERROR 0x01 //Operation failed
88 #define LORAWAN_STATUS_CMD_NOT_SUPPORTED 0x02 //Command is not supported
89 #define LORAWAN_STATUS_WRONG_PARAMETER 0x03 //HCI message contains wrong parameter
90 #define LORAWAN_STATUS_WRONG_DEVICE_MODE 0x04 //Stack is running in a wrong mode
91 #define LORAWAN_STATUS_DEVICE_NOT_ACTIVATED 0x05 //Device is not activated
92 #define LORAWAN_STATUS_DEVICE_BUSY 0x06 //Device is busy, command rejected
93 #define LORAWAN_STATUS_QUEUE_FULL 0x07 //Message queue is full, command rejected
94 #define LORAWAN_STATUS_LENGTH_ERROR 0x08 //HCI message length is invalid or radio payload size is too large
95 #define LORAWAN_STATUS_NO_FACTORY_SETTINGS 0x09 //Factory Settings EEPROM block missing or incompatible with current firmware version
96 #define LORAWAN_STATUS_CHANNEL_BLOCKED 0x0A //Channel blocked by Duty Cycle
97 #define LORAWAN_STATUS_CHANNEL_NOT_AVAILABLE 0x0B //No channel available (e.g. no channel defined for the configured spreading factor)
98
100
104 typedef enum TLoRaWANStatus
105 {
106 LoRaWAN_Status_Ok = 0,
107 LoRaWAN_Status_Error,
108 LoRaWAN_Status_Cmd_Not_Supported,
109 LoRaWAN_Status_Wrong_parameter,
110 LoRaWAN_Status_Wrong_DeviceMode,
111 LoRaWAN_Status_Device_Not_Activated,
112 LoRaWAN_Status_Device_Busy,
113 LoRaWAN_Status_Queue_Full,
114 LoRaWAN_Status_Length_Error,
115 LoRaWAN_Status_No_Factory_Settings,
116 LoRaWAN_Status_Channel_Blocked,
117 LoRaWAN_Status_Channel_Not_Available,
118 } TLoRaWANStatus;
119
121
122 // These codes are used for a Join Network Indication
123
124 #define LORAWAN_JOIN_NWK_IND_FORMAT_STATUS_JOIN_OK 0x00
125 #define LORAWAN_JOIN_NWK_IND_FORMAT_STATUS_JOIN_OK_CH_INFO 0x01
127
129
132 typedef enum TLoraWANJoinNwkIndStatusFormat
133 {
134 LoRaWAN_JoinNkwInd_Satus_Format_Join_Ok = 0x00,
135 LoRaWAN_JoinNkwInd_Satus_Format_Join_Ok_Ch_Info = 0x01,
136 } TLoRaWanJoinNwkIndStatusFormat;
137
138
140
141 // These codes are used for a UDATA / CDATA TX Indications
142
143 #define LORAWAN_DATA_TX_IND_FORMAT_STATUS_OK 0x00
144 #define LORAWAN_DATA_TX_IND_FORMAT_STATUS_OK_CH_INFO 0x01
145 #define LORAWAN_DATA_TX_IND_FORMAT_STATUS_ERR_MAX_RETRANS 0x02
146 #define LORAWAN_DATA_TX_IND_FORMAT_STATUS_ERR_PAYLOAD 0x04
148
150
153 typedef enum TLoraWANTxDataIndStatusFormat
154 {
155 /* for udata + cdata indications */
156 LoRaWAN_TxDataInd_Satus_TX_Ok = 0x00,
157 LoRaWAN_TxDataInd_Satus_TX_Ok_Ch_Info = 0x01,
158 /*only for cdata indications */
159 LoRaWAN_TxDataInd_Satus_TX_Err_Max_Retrans = 0x02,
160 LoRaWAN_TxDataInd_Satus_TX_Err_Payload = 0x04,
161 } TLoRaWanTxDataIndStatusFormat;
162
163
164
165
166
168
169
170 // Status Format Codes
171 // This is a bit mask field!
172 #define LORAWAN_FORMAT_OK 0x00
173 #define LORAWAN_FORMAT_EXT_HCI_OUT_ACTIVE 0x01
174 #define LORAWAN_FORMAT_ACK_RECEIVED 0x02
175 #define LORAWAN_FORMAT_FP_RECEIVED 0x04
177 // Message IDs
178
180 #define LORAWAN_MSG_ACTIVATE_DEVICE_REQ 0x01
181 #define LORAWAN_MSG_ACTIVATE_DEVICE_RSP 0x02
182 #define LORAWAN_MSG_SET_JOIN_PARAM_REQ 0x05
183 #define LORAWAN_MSG_SET_JOIN_PARAM_RSP 0x06
184 #define LORAWAN_MSG_JOIN_NETWORK_REQ 0x09
185 #define LORAWAN_MSG_JOIN_NETWORK_RSP 0x0A
186 #define LORAWAN_MSG_JOIN_NETWORK_TX_IND 0x0B
187 #define LORAWAN_MSG_JOIN_NETWORK_IND 0x0C
188 #define LORAWAN_MSG_SEND_UDATA_REQ 0x0D
189 #define LORAWAN_MSG_SEND_UDATA_RSP 0x0E
190 #define LORAWAN_MSG_SEND_UDATA_TX_IND 0x0F
191 #define LORAWAN_MSG_RECV_UDATA_IND 0x10
192 #define LORAWAN_MSG_SEND_CDATA_REQ 0x11
193 #define LORAWAN_MSG_SEND_CDATA_RSP 0x12
194 #define LORAWAN_MSG_SEND_CDATA_TX_IND 0x13
195 #define LORAWAN_MSG_RECV_CDATA_IND 0x14
196 #define LORAWAN_MSG_RECV_ACK_IND 0x15
197 #define LORAWAN_MSG_RECV_NO_DATA_IND 0x16
198 #define LORAWAN_MSG_SET_RSTACK_CONFIG_REQ 0x19
199 #define LORAWAN_MSG_SET_RSTACK_CONFIG_RSP 0x1A
200 #define LORAWAN_MSG_GET_RSTACK_CONFIG_REQ 0x1B
201 #define LORAWAN_MSG_GET_RSTACK_CONFIG_RSP 0x1C
202 #define LORAWAN_MSG_REACTIVATE_DEVICE_REQ 0x1D
203 #define LORAWAN_MSG_REACTIVATE_DEVICE_RSP 0x1E
204 #define LORAWAN_MSG_DEACTIVATE_DEVICE_REQ 0x21
205 #define LORAWAN_MSG_DEACTIVATE_DEVICE_RSP 0x22
206 #define LORAWAN_MSG_FACTORY_RESET_REQ 0x23
207 #define LORAWAN_MSG_FACTORY_RESET_RSP 0x24
208 #define LORAWAN_MSG_SET_DEVICE_EUI_REQ 0x25
209 #define LORAWAN_MSG_SET_DEVICE_EUI_RSP 0x26
210 #define LORAWAN_MSG_GET_DEVICE_EUI_REQ 0x27
211 #define LORAWAN_MSG_GET_DEVICE_EUI_RSP 0x28
212 #define LORAWAN_MSG_GET_NWK_STATUS_REQ 0x29
213 #define LORAWAN_MSG_GET_NWK_STATUS_RSP 0x2A
214 #define LORAWAN_MSG_SEND_MAC_CMD_REQ 0x2B
215 #define LORAWAN_MSG_SEND_MAC_CMD_RSP 0x2C
216 #define LORAWAN_MSG_RECV_MAC_CMD_IND 0x2D
217 #define LORAWAN_MSG_SET_BATTERY_LEVEL_REQ 0x2E
218 #define LORAWAN_MSG_SET_BATTERY_LEVEL_RSP 0x2F
219 #define LORAWAN_MSG_SET_CUSTOM_CFG_REQ 0x31
220 #define LORAWAN_MSG_SET_CUSTOM_CFG_RSP 0x32
221 #define LORAWAN_MSG_GET_CUSTOM_CFG_REQ 0x33
222 #define LORAWAN_MSG_GET_CUSTOM_CFG_RSP 0x34
223 #define LORAWAN_MSG_GET_SUPPORTED_BANDS_REQ 0x35
224 #define LORAWAN_MSG_GET_SUPPORTED_BANDS_RSP 0x36
225
226 #define LORAWAN_MSG_SET_TXPOWER_LIMIT_CONFIG_REQ 0x37
227 #define LORAWAN_MSG_SET_TXPOWER_LIMIT_CONFIG_RSP 0x38
228 #define LORAWAN_MSG_GET_TXPOWER_LIMIT_CONFIG_REQ 0x39
229 #define LORAWAN_MSG_GET_TXPOWER_LIMIT_CONFIG_RSP 0x3A
230
231 //#define LORAWAN_MSG_SET_LINKADRREQ_CONFIG_REQ 0x3B
232 //#define LORAWAN_MSG_SET_LINKADRREQ_CONFIG_RSP 0x3C
233 //#define LORAWAN_MSG_GET_LINKADRREQ_CONFIG_REQ 0x3D
234 //#define LORAWAN_MSG_GET_LINKADRREQ_CONFIG_RSP 0x3E
235
236 #define LORAWAN_MSG_LINK_DISCONNECT_IND 0x40
237
238 #define LORAWAN_MSG_SET_MCAST_CONFIG_REQ 0x41
239 #define LORAWAN_MSG_SET_MCAST_CONFIG_RSP 0x42
240 #define LORAWAN_MSG_GET_MCAST_CONFIG_REQ 0x43
241 #define LORAWAN_MSG_GET_MCAST_CONFIG_RSP 0x44
242 #define LORAWAN_MSG_DEL_MCAST_CONFIG_REQ 0x45
243 #define LORAWAN_MSG_DEL_MCAST_CONFIG_RSP 0x46
244
245 #define LORAWAN_MSG_RECV_MCAST_DATA_IND 0x48
246 #define LORAWAN_MSG_RECV_MCAST_NO_DATA_IND 0x4A
247
248
249 #define LORAWAN_MSG_DEVNONCE_RESET_IND 0x60
250 #define LORAWAN_MSG_SET_DEVNONCE_REQ 0x61
251 #define LORAWAN_MSG_SET_DEVNONCE_RSP 0x62
252 #define LORAWAN_MSG_GET_DEVNONCE_REQ 0x63
253 #define LORAWAN_MSG_GET_DEVNONCE_RSP 0x64
254 #define LORAWAN_MSG_SET_JOINNONCE_REQ 0x65
255 #define LORAWAN_MSG_SET_JOINNONCE_RSP 0x66
256 #define LORAWAN_MSG_GET_JOINNONCE_REQ 0x67
257 #define LORAWAN_MSG_GET_JOINNONCE_RSP 0x68
258
259 #define LORAWAN_MSG_SEND_DEVICETIMEREQ_REQ 0x71
260 #define LORAWAN_MSG_SEND_DEVICETIMEREQ_RSP 0x72
261 #define LORAWAN_MSG_DEVICETIMEANS_IND 0x74
262
263
265
266 // Radio Stack Config Options; bit field
267
268 #define LORAWAN_STK_OPTION_ADR (0x01 << 0)
269 #define LORAWAN_STK_OPTION_DUTY_CYCLE_CTRL (0x01 << 1)
270 #define LORAWAN_STK_OPTION_DEV_CLASS_C (0x01 << 2)
271 #define LORAWAN_STK_OPTION_POWER_UP_IND (0x01 << 4)
272 #define LORAWAN_STK_OPTION_PRIVATE_NETOWRK (0x01 << 5)
273 #define LORAWAN_STK_OPTION_EXT_PKT_FORMAT (0x01 << 6)
274 #define LORAWAN_STK_OPTION_MAC_CMD (0x01 << 7)
286 // Radio Stack Error Codes; bit field
287
288 #define LORAWAN_STK_PARAM_ERR_WRONG_DATARATE (0x01 << 0)
289 #define LORAWAN_STK_PARAM_ERR_WRONG_TX_PWRLEVEL (0x01 << 1)
290 #define LORAWAN_STK_PARAM_ERR_WRONG_TX_BANDIDX (0x01 << 5)
292 // Radio Tx Power Limit Error Codes; bit field
293 #define LORAWAN_TX_PWR_LIMIT_ERR_WRONG_SUBBAND (0x01 << 0)
294 #define LORAWAN_TX_PWR_LIMIT_ERR_WRONG_TX_PWR_VAL (0x01 << 2)
301
303
305
306
311 typedef enum TLoRaWAN_FreqBand
312 {
313 LoRaWAN_FreqBand_EU_868 = LORAWAN_BAND_EU_868,
315 LoRaWAN_FreqBand_US_915 = LORAWAN_BAND_US_915,
317 LoRaWAN_FreqBand_India_865 = LORAWAN_BAND_IN_865,
319 LoRaWAN_FreqBand_AS_923_Brunei = LORAWAN_BAND_AS_923_BN_923,
320 LoRaWAN_FreqBand_AS_923_Cambodia = LORAWAN_BAND_AS_923_KH_923,
321 LoRaWAN_FreqBand_AS_923_Indonesia = LORAWAN_BAND_AS_923_ID_923,
322 LoRaWAN_FreqBand_AS_923_Japan = LORAWAN_BAND_AS_923_JP_920,
323 LoRaWAN_FreqBand_AS_923_Laos = LORAWAN_BAND_AS_923_LA_920,
324 LoRaWAN_FreqBand_AS_923_NewZealand = LORAWAN_BAND_AS_923_LA_915,
325 LoRaWAN_FreqBand_AS_923_Singapore = LORAWAN_BAND_AS_923_SG_920,
326 LoRaWAN_FreqBand_AS_923_Taiwan = LORAWAN_BAND_AS_923_TW_922,
327 LoRaWAN_FreqBand_AS_923_Thailand = LORAWAN_BAND_AS_923_TH_920,
328 LoRaWAN_FreqBand_AS_923_Vietnam = LORAWAN_BAND_AS_923_VN_920,
329 LoRaWAN_FreqBand_RU_868_V1 = LORAWAN_BAND_RU1_868,
330 LoRaWAN_FreqBand_RU_868_V2 = LORAWAN_BAND_RU2_868,
331 LoRaWAN_FreqBand_RU_868_V3 = LORAWAN_BAND_RU3_868,
332 LoRaWAN_FreqBand_RU_868_V4 = LORAWAN_BAND_RU4_868,
333 LoRaWAN_FreqBand_RU_868_V5 = LORAWAN_BAND_RU5_868,
334 LoRaWAN_FreqBand_RU_868_V6 = LORAWAN_BAND_RU6_868,
335 LoRaWAN_FreqBand_RU_868_V7 = LORAWAN_BAND_RU7_868,
337 LoRaWAN_FreqBand_EU_868_RX2_SF9 = LORAWAN_BAND_EU_868_RX2_SF9,
338 LoRaWAN_FreqBand_IN_865_RX2_SF8 = LORAWAN_BAND_IN_865_RX2_SF8,
340 LoRaWAN_FreqBand_WW2G4 = GLOBALLINK24_BAND_WW_2G4,
341 LoRaWAN_FreqBand_WW2G4_RX2 = GLOBALLINK24_BAND_WW_2G4_RX2,
342 } TLoRaWAN_FreqBand;
343
344
346 // LoRa Radio Power Level
347
348 #define LORAWAN_TX_POWER_LEVEL_MIN 0
349 #define LORAWAN_TX_POWER_LEVEL_MAX 20
350
351 #define IS_LORAWAN_TX_POWER_LEVEL(x) ( ((x) >= LORAWAN_TX_POWER_LEVEL_MIN) && \
352 ((x) <= LORAWAN_TX_POWER_LEVEL_MAX) )
353
354
355 // LoRa Radio Power Saving Mode
356
357 #define LORAWAN_POWER_SAVING_MODE_OFF 0
358 #define LORAWAN_POWER_SAVING_MODE_AUTO 1
359
361
365 typedef enum TLoRaWAN_PowerSaving
366 {
367 LoRaWAN_PowerSaving_Off = 0,
368 LoRaWAN_PowerSaving_On = 1,
369 } TLoRaWAN_PowerSaving;
370
371
373 // LoRaWAN Network Status
374
375 #define LORAWAN_NWK_STATUS_INACTIVE 0
376 #define LORAWAN_NWK_STATUS_ACTIVE_ABP 1
377 #define LORAWAN_NWK_STATUS_ACTIVE_OTAA 2
378 #define LORAWAN_NWK_STATUS_JOINING_OTAA 3
379
381
385 typedef enum TLoRaWAN_NwkStatus
386 {
387 LoRaWAN_NwkStatus_Inactive = 0,
388 LoRaWAN_NwkStatus_Active_ABP = 1,
389 LoRaWAN_NwkStatus_Active_OTAA = 2,
390 LoRaWAN_NwkStatus_Joining_OTAA = 3,
391 } TLoRaWAN_NwkStatus;
392
394
395 // LoRaWAN MAC Commands
396
397 #define LORAWAN_MAC_DATA_SERVICE_TYPE_U_DATA 0
398 #define LORAWAN_MAC_DATA_SERVICE_TYPE_C_DATA 1
399
401
402
404 /*
405 * Header MAC command capatity
406 */
407 #define LORAWAN_HEADER_MAC_CMD_CAP_MIN 0
408 #define LORAWAN_HEADER_MAC_CMD_CAP_MAX 15
409
411
412 //------------------------------------------------------------------------------
413 //
414 // misc. defines
415 //
416 //------------------------------------------------------------------------------
418
419 #define WiMODLORAWAN_NWK_SESSION_KEY_LEN 16 // 128 bit
420 #define WiMODLORAWAN_APP_SESSION_KEY_LEN 16 // 128 bit
421
422 #define WiMODLORAWAN_DEV_EUI_LEN 8 // 64 bit
423 #define WiMODLORAWAN_JOIN_EUI_LEN 8 // 64 bit
424 #define WiMODLORAWAN_APP_KEY_LEN 16 // 128 bit
425
426 #define WiMODLORAWAN_MAC_CMD_PAYLOAD_LENGTH 30
427
429
430 //------------------------------------------------------------------------------
431 //
432 // structures
433 //
434 //------------------------------------------------------------------------------
435
439 typedef struct TWiMODLORAWAN_ActivateDeviceData
440 {
441 UINT32 DeviceAddress;
442 UINT8 NwkSKey[WiMODLORAWAN_NWK_SESSION_KEY_LEN];
443 UINT8 AppSKey[WiMODLORAWAN_APP_SESSION_KEY_LEN];
444 } TWiMODLORAWAN_ActivateDeviceData;
445
446
450 typedef struct TWiMODLORAWAN_JoinParams
451 {
452 UINT8 JoinEUI[WiMODLORAWAN_JOIN_EUI_LEN];
453 UINT8 AppKey[WiMODLORAWAN_APP_KEY_LEN];
454 } TWiMODLORAWAN_JoinParams;
455
456
460 typedef enum TWiMODLORAWAN_OptIndInfos
461 {
462 LORAWAN_OPT_TX_IND_INFOS_NOT_AVAILABLE = 0,
463 LORAWAN_OPT_TX_IND_INFOS_EXCL_PKT_CNT = 1,
464 LORAWAN_OPT_TX_IND_INFOS_INCL_PKT_CNT = 2,
465 } TWiMODLORAWAN_OptIndInfos;
466
467
468
472 typedef struct TWiMODLORAWAN_TxIndData
473 {
474 TWiMODLORAWAN_OptIndInfos FieldAvailability;
476 UINT8 StatusFormat;
477 // optional - see StatusFormat code
478 UINT8 ChannelIndex;
479 // optional - see StatusFormat code
480 UINT8 DataRateIndex;
481 // optional - see StatusFormat code
482 UINT8 NumTxPackets;
483 // new in V1.14 optional
484 UINT8 PowerLevel;
485 // new in V1.14 optional
486 UINT32 RfMsgAirtime;
487 } TWiMODLORAWAN_TxIndData;
488
489 /*
490 * Number of payload bytes for a user defined message
491 *
492 * Note: the actual number of payload bytes can be less, if the air frame
493 * contains a list of MAC commands.
494 */
496 #define WiMODLORAWAN_APP_PAYLOAD_LEN 128
497
502 typedef struct TWiMODLORAWAN_TX_Data
503 {
504 UINT8 Port;
505 UINT8 Length;
506 UINT8 Payload[WiMODLORAWAN_APP_PAYLOAD_LEN];
507 // only for RX
508 } TWiMODLORAWAN_TX_Data;
509
510
514 typedef struct TWiMODLORAWAN_RX_Data
515 {
516 UINT8 StatusFormat;
517 UINT8 Port;
518 UINT8 Length;
519 UINT8 Payload[WiMODLORAWAN_APP_PAYLOAD_LEN];
521 // optional RX info
522 UINT8 ChannelIndex;
523 UINT8 DataRateIndex;
524 INT8 RSSI;
525 INT8 SNR;
526 UINT8 RxSlot;
527 bool OptionalInfoAvaiable;
528 } TWiMODLORAWAN_RX_Data;
529
530
534 typedef struct TWiMODLORAWAN_RX_MacCmdData
535 {
536 UINT8 Length;
537 UINT8 MacCmdData[WiMODLORAWAN_APP_PAYLOAD_LEN];
539 // optional RX info
540 UINT8 ChannelIndex;
541 UINT8 DataRateIndex;
542 INT8 RSSI;
543 INT8 SNR;
544 UINT8 RxSlot;
545 bool OptionalInfoAvaiable;
546 } TWiMODLORAWAN_RX_MacCmdData;
547
551 typedef struct TWiMODLORAWAN_RX_JoinedNwkData
552 {
553 UINT8 StatusFormat;
554 UINT32 DeviceAddress;
556 // optional RX info
557 UINT8 ChannelIndex;
558 UINT8 DataRateIndex;
559 INT8 RSSI;
560 INT8 SNR;
561 UINT8 RxSlot;
562 bool OptionalInfoAvaiable;
563 } TWiMODLORAWAN_RX_JoinedNwkData;
564
568 typedef struct TWiMODLORAWAN_RadioStackConfig
569 {
570 UINT8 DataRateIndex;
571 UINT8 TXPowerLevel;
572 UINT8 Options;
573 UINT8 PowerSavingMode;
574 UINT8 Retransmissions;
575 UINT8 BandIndex;
576 UINT8 HeaderMacCmdCapacity;
578 // US915 Firmware only
579 UINT8 SubBandMask1;
580 UINT8 SubBandMask2;
582 // optional for SetRadioStack cmd
583 UINT8 WrongParamErrCode;
585 } TWiMODLORAWAN_RadioStackConfig;
586
590 typedef struct TWiMODLORAWAN_MacCmd
591 {
592 UINT8 DataServiceType; // see LORAWAN_MAC_DATA_SERVICE_TYPE
593 UINT8 MacCmdID; // see LoRaWAN Spec for command IDs
594 UINT8 Payload[WiMODLORAWAN_MAC_CMD_PAYLOAD_LENGTH];
595 UINT8 Length;
596 } TWiMODLORAWAN_MacCmd;
597
598
602 typedef struct TWiMODLORAWAN_RX_ACK_Data
603 {
604 UINT8 StatusFormat;
606 // optional RX info
607 UINT8 ChannelIndex;
608 UINT8 DataRateIndex;
609 INT8 RSSI;
610 INT8 SNR;
611 UINT8 RxSlot;
612 bool OptionalInfoAvaiable;
613 } TWiMODLORAWAN_RX_ACK_Data;
614
615
619 typedef struct TWiMODLORAWAN_NwkStatus_Data
620 {
621 UINT8 NetworkStatus;
622 UINT32 DeviceAddress;
623 UINT8 DataRateIndex;
624 UINT8 PowerLevel;
625 UINT8 MaxPayloadSize;
626 UINT8 NumMacTransmissions;
627 } TWiMODLORAWAN_NwkStatus_Data;
628
629
631
632 /*
633 * Error Code used by NoData Indication
634 */
635 #define LORAWAN_NODATA_ERR_WRONG_MTYPE (0x01 << 0)
636 #define LORAWAN_NODATA_ERR_WRONG_DEVICE_ADDRESS (0x01 << 1)
637 #define LORAWAN_NODATA_ERR_WRONG_MIC (0x01 << 2)
638 #define LORAWAN_NODATA_ERR_UNEXPECTED_FCNT (0x01 << 3)
639 #define LORAWAN_NODATA_ERR_WRONG_MAC_CMD (0x01 << 4)
640 #define LORAWAN_NODATA_ERR_WRONG_DOWNLINK (0x01 << 5)
641 #define LORAWAN_NODATA_ERR_EXPECTED_ACK_MISSING (0x01 << 6)
642
644
648 typedef struct TWiMODLORAWAN_NoData_Data
649 {
650 UINT8 StatusFormat;
652 // optional info
653 UINT8 ErrorCode;
655 bool OptionalInfoAvaiable;
657 } TWiMODLORAWAN_NoData_Data;
658
659
663 typedef struct TWiMODLORAWAN_SupportedBands
664 {
665 UINT8 NumOfEntries;
666 UINT8 BandIndex[(WiMODLORAWAN_APP_PAYLOAD_LEN / 2)] ;
667 UINT8 MaxEIRP[(WiMODLORAWAN_APP_PAYLOAD_LEN / 2)];
668 } TWiMODLORAWAN_SupportedBands;
669
670
674 typedef struct TWiMODLORAWAN_TxPwrLimitConfig
675 {
676 UINT8 NumOfEntries;
677 UINT8 SubBandIndex[(WiMODLORAWAN_APP_PAYLOAD_LEN / 3)];
678 UINT8 TxPwrLimitFlag[(WiMODLORAWAN_APP_PAYLOAD_LEN / 3)];
679 UINT8 TxPwrLimitValue[(WiMODLORAWAN_APP_PAYLOAD_LEN / 3)];
681 // only uses as response code for set operation
682 UINT8 WrongParamErrCode;
683 } TWiMODLORAWAN_TxPwrLimitConfig;
684
685
687
688 /*
689 * LinkAdrReq Options
690 */
691 #define LORAWAN_LINKADR_CFG_OPTION_LORAWAN_V102 0
692 #define LORAWAN_LINKADR_CFG_OPTION_SEMTECH 1
693 #define LORAWAN_LINKADR_CFG_OPTION_KPN_ACTILITY 2
694
696
698
700 // * @brief LinkAdr behavior options
701 // */
702 //typedef enum TWiMODLORAWAN_LinkAdrReqConfig
703 //{
704 // LinkAdrCfg_Option_LoRaWAN_V1_0_2 = 0, /*!< vanilla LoRaWAN V1.0.2 */
705 // LinkAdrCfg_Option_Semtech_Proposal = 1, /*!< Semtech proposal */
706 // LinkAdrCfg_Option_KPN_Actility_Proposal = 2, /*!< KPN / Actility proposal*/
707 //} TWiMODLORAWAN_LinkAdrReqConfig;
708
710
711
712
713 #endif /* ARDUINO_WIMOD_SAP_LORAWAN_IDS_H_ */
TLoRaWAN_FreqBand
TLoRaWAN_FreqBand
Channel Band Selection.
Definition: WiMOD_SAP_LORAWAN_IDs.h:311
TLoRaWAN_PowerSaving
TLoRaWAN_PowerSaving
Power Saving modes.
Definition: WiMOD_SAP_LORAWAN_IDs.h:365
LoRaWAN_FreqBand_RU_868_V7
@ LoRaWAN_FreqBand_RU_868_V7
Definition: WiMOD_SAP_LORAWAN_IDs.h:335
TWiMODLORAWAN_RX_JoinedNwkData::StatusFormat
UINT8 StatusFormat
Definition: WiMOD_SAP_LORAWAN_IDs.h:553
LoRaWAN_NwkStatus_Inactive
@ LoRaWAN_NwkStatus_Inactive
Definition: WiMOD_SAP_LORAWAN_IDs.h:387
LoRaWAN_FreqBand_RU_868_V5
@ LoRaWAN_FreqBand_RU_868_V5
Definition: WiMOD_SAP_LORAWAN_IDs.h:333
TWiMODLORAWAN_RadioStackConfig::HeaderMacCmdCapacity
UINT8 HeaderMacCmdCapacity
Definition: WiMOD_SAP_LORAWAN_IDs.h:576
TWiMODLORAWAN_RadioStackConfig::DataRateIndex
UINT8 DataRateIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:570
TWiMODLORAWAN_TxIndData::PowerLevel
UINT8 PowerLevel
Definition: WiMOD_SAP_LORAWAN_IDs.h:484
TWiMODLORAWAN_RX_JoinedNwkData
Structure containing data of the joined network indication.
Definition: WiMOD_SAP_LORAWAN_IDs.h:551
TWiMODLORAWAN_RX_Data
Structure containing RX (user) payload data.
Definition: WiMOD_SAP_LORAWAN_IDs.h:514
LoRaWAN_FreqBand_EU_868
@ LoRaWAN_FreqBand_EU_868
Definition: WiMOD_SAP_LORAWAN_IDs.h:313
TWiMODLORAWAN_SupportedBands::BandIndex
UINT8 BandIndex[(WiMODLORAWAN_APP_PAYLOAD_LEN/2)]
Definition: WiMOD_SAP_LORAWAN_IDs.h:666
TWiMODLORAWAN_SupportedBands
struct TWiMODLORAWAN_SupportedBands TWiMODLORAWAN_SupportedBands
data structure for supported bands
TWiMODLORAWAN_SupportedBands::NumOfEntries
UINT8 NumOfEntries
Definition: WiMOD_SAP_LORAWAN_IDs.h:665
TWiMODLORAWAN_TxPwrLimitConfig::WrongParamErrCode
UINT8 WrongParamErrCode
Definition: WiMOD_SAP_LORAWAN_IDs.h:682
LoRaWAN_Status_Length_Error
@ LoRaWAN_Status_Length_Error
Definition: WiMOD_SAP_LORAWAN_IDs.h:114
LoRaWAN_FreqBand_AS_923_Japan
@ LoRaWAN_FreqBand_AS_923_Japan
Definition: WiMOD_SAP_LORAWAN_IDs.h:322
TWiMODLORAWAN_ActivateDeviceData::AppSKey
UINT8 AppSKey[WiMODLORAWAN_APP_SESSION_KEY_LEN]
Definition: WiMOD_SAP_LORAWAN_IDs.h:443
TWiMODLORAWAN_NoData_Data
Structure containing infos of a NoData Indication message.
Definition: WiMOD_SAP_LORAWAN_IDs.h:648
LoRaWAN_FreqBand_WW2G4_RX2
@ LoRaWAN_FreqBand_WW2G4_RX2
Definition: WiMOD_SAP_LORAWAN_IDs.h:341
TWiMODLORAWAN_RX_ACK_Data::StatusFormat
UINT8 StatusFormat
Definition: WiMOD_SAP_LORAWAN_IDs.h:604
TWiMODLORAWAN_NwkStatus_Data
struct TWiMODLORAWAN_NwkStatus_Data TWiMODLORAWAN_NwkStatus_Data
Structure containing all data about LoRaWAN network status.
TWiMODLORAWAN_RX_Data::RxSlot
UINT8 RxSlot
Definition: WiMOD_SAP_LORAWAN_IDs.h:526
TWiMODLORAWAN_MacCmd::Length
UINT8 Length
Definition: WiMOD_SAP_LORAWAN_IDs.h:595
TWiMODLORAWAN_RX_Data::Length
UINT8 Length
Definition: WiMOD_SAP_LORAWAN_IDs.h:518
LoRaWAN_FreqBand_RU_868_V6
@ LoRaWAN_FreqBand_RU_868_V6
Definition: WiMOD_SAP_LORAWAN_IDs.h:334
LORAWAN_OPT_TX_IND_INFOS_EXCL_PKT_CNT
@ LORAWAN_OPT_TX_IND_INFOS_EXCL_PKT_CNT
Definition: WiMOD_SAP_LORAWAN_IDs.h:463
TWiMODLORAWAN_TxIndData
Activation data structure for LoRa network activation.
Definition: WiMOD_SAP_LORAWAN_IDs.h:472
TWiMODLORAWAN_RX_MacCmdData::DataRateIndex
UINT8 DataRateIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:541
TLoRaWanTxDataIndStatusFormat
enum TLoraWANTxDataIndStatusFormat TLoRaWanTxDataIndStatusFormat
Status code enumeration for LoRaWAN Join Network Indications.
LORAWAN_OPT_TX_IND_INFOS_INCL_PKT_CNT
@ LORAWAN_OPT_TX_IND_INFOS_INCL_PKT_CNT
Definition: WiMOD_SAP_LORAWAN_IDs.h:464
TWiMODLORAWAN_RX_ACK_Data::OptionalInfoAvaiable
bool OptionalInfoAvaiable
Definition: WiMOD_SAP_LORAWAN_IDs.h:612
LoRaWAN_NwkStatus_Active_ABP
@ LoRaWAN_NwkStatus_Active_ABP
Definition: WiMOD_SAP_LORAWAN_IDs.h:388
TWiMODLORAWAN_TxPwrLimitConfig::TxPwrLimitFlag
UINT8 TxPwrLimitFlag[(WiMODLORAWAN_APP_PAYLOAD_LEN/3)]
Definition: WiMOD_SAP_LORAWAN_IDs.h:678
TWiMODLORAWAN_TxPwrLimitConfig::TxPwrLimitValue
UINT8 TxPwrLimitValue[(WiMODLORAWAN_APP_PAYLOAD_LEN/3)]
Definition: WiMOD_SAP_LORAWAN_IDs.h:679
TWiMODLORAWAN_NwkStatus_Data::NetworkStatus
UINT8 NetworkStatus
Definition: WiMOD_SAP_LORAWAN_IDs.h:621
TWiMODLORAWAN_JoinParams
struct TWiMODLORAWAN_JoinParams TWiMODLORAWAN_JoinParams
JOIN data structure for LoRa network activation.
LoRaWAN_FreqBand_WW2G4
@ LoRaWAN_FreqBand_WW2G4
Definition: WiMOD_SAP_LORAWAN_IDs.h:340
TWiMODLORAWAN_NwkStatus_Data::NumMacTransmissions
UINT8 NumMacTransmissions
Definition: WiMOD_SAP_LORAWAN_IDs.h:626
TWiMODLORAWAN_RX_Data::StatusFormat
UINT8 StatusFormat
Definition: WiMOD_SAP_LORAWAN_IDs.h:516
TWiMODLORAWAN_NwkStatus_Data
Structure containing all data about LoRaWAN network status.
Definition: WiMOD_SAP_LORAWAN_IDs.h:619
TWiMODLORAWAN_RX_ACK_Data::RSSI
INT8 RSSI
Definition: WiMOD_SAP_LORAWAN_IDs.h:609
TWiMODLORAWAN_TxPwrLimitConfig::SubBandIndex
UINT8 SubBandIndex[(WiMODLORAWAN_APP_PAYLOAD_LEN/3)]
Definition: WiMOD_SAP_LORAWAN_IDs.h:677
TWiMODLORAWAN_TxIndData
struct TWiMODLORAWAN_TxIndData TWiMODLORAWAN_TxIndData
Activation data structure for LoRa network activation.
TLoRaWanJoinNwkIndStatusFormat
enum TLoraWANJoinNwkIndStatusFormat TLoRaWanJoinNwkIndStatusFormat
Status code enumeration for LoRaWAN Join Network Indications.
TWiMODLORAWAN_TxPwrLimitConfig::NumOfEntries
UINT8 NumOfEntries
Definition: WiMOD_SAP_LORAWAN_IDs.h:676
TWiMODLORAWAN_MacCmd
struct TWiMODLORAWAN_MacCmd TWiMODLORAWAN_MacCmd
LoRaWAN MAC command structure.
TWiMODLORAWAN_RX_MacCmdData::Length
UINT8 Length
Definition: WiMOD_SAP_LORAWAN_IDs.h:536
TWiMODLORAWAN_JoinParams::AppKey
UINT8 AppKey[WiMODLORAWAN_APP_KEY_LEN]
Definition: WiMOD_SAP_LORAWAN_IDs.h:453
LoRaWAN_Status_Channel_Blocked
@ LoRaWAN_Status_Channel_Blocked
Definition: WiMOD_SAP_LORAWAN_IDs.h:116
TWiMODLORAWAN_RX_ACK_Data::DataRateIndex
UINT8 DataRateIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:608
LoRaWAN_Status_Error
@ LoRaWAN_Status_Error
Definition: WiMOD_SAP_LORAWAN_IDs.h:107
TWiMODLORAWAN_TxIndData::NumTxPackets
UINT8 NumTxPackets
Definition: WiMOD_SAP_LORAWAN_IDs.h:482
TWiMODLORAWAN_RadioStackConfig::PowerSavingMode
UINT8 PowerSavingMode
Definition: WiMOD_SAP_LORAWAN_IDs.h:573
TWiMODLORAWAN_SupportedBands
data structure for supported bands
Definition: WiMOD_SAP_LORAWAN_IDs.h:663
TWiMODLORAWAN_SupportedBands::MaxEIRP
UINT8 MaxEIRP[(WiMODLORAWAN_APP_PAYLOAD_LEN/2)]
Definition: WiMOD_SAP_LORAWAN_IDs.h:667
LoRaWAN_NwkStatus_Active_OTAA
@ LoRaWAN_NwkStatus_Active_OTAA
Definition: WiMOD_SAP_LORAWAN_IDs.h:389
LoRaWAN_FreqBand_AS_923_Brunei
@ LoRaWAN_FreqBand_AS_923_Brunei
Definition: WiMOD_SAP_LORAWAN_IDs.h:319
TWiMODLORAWAN_TX_Data
struct TWiMODLORAWAN_TX_Data TWiMODLORAWAN_TX_Data
Structure containing all data necessary to transmitting a data message.
TWiMODLORAWAN_JoinParams
JOIN data structure for LoRa network activation.
Definition: WiMOD_SAP_LORAWAN_IDs.h:450
WiMOD_SAP_LORAWAN_IDs_AS923.h
LoRaWAN_JoinNkwInd_Satus_Format_Join_Ok_Ch_Info
@ LoRaWAN_JoinNkwInd_Satus_Format_Join_Ok_Ch_Info
Definition: WiMOD_SAP_LORAWAN_IDs.h:135
TWiMODLORAWAN_RadioStackConfig::TXPowerLevel
UINT8 TXPowerLevel
Definition: WiMOD_SAP_LORAWAN_IDs.h:571
LoRaWAN_TxDataInd_Satus_TX_Err_Max_Retrans
@ LoRaWAN_TxDataInd_Satus_TX_Err_Max_Retrans
Definition: WiMOD_SAP_LORAWAN_IDs.h:159
TWiMODLORAWAN_RX_MacCmdData
struct TWiMODLORAWAN_RX_MacCmdData TWiMODLORAWAN_RX_MacCmdData
Structure containing a received MAC command.
LoRaWAN_Status_Channel_Not_Available
@ LoRaWAN_Status_Channel_Not_Available
Definition: WiMOD_SAP_LORAWAN_IDs.h:117
TWiMODLORAWAN_RX_MacCmdData::SNR
INT8 SNR
Definition: WiMOD_SAP_LORAWAN_IDs.h:543
WiMOD_SAP_LORAWAN_IDs_IL915.h
TWiMODLORAWAN_MacCmd::MacCmdID
UINT8 MacCmdID
Definition: WiMOD_SAP_LORAWAN_IDs.h:593
TWiMODLORAWAN_RX_MacCmdData::RSSI
INT8 RSSI
Definition: WiMOD_SAP_LORAWAN_IDs.h:542
TWiMODLORAWAN_RadioStackConfig
Radio stack configuration related to to LoRaWAN specific options.
Definition: WiMOD_SAP_LORAWAN_IDs.h:568
LoRaWAN_FreqBand_AS_923_Taiwan
@ LoRaWAN_FreqBand_AS_923_Taiwan
Definition: WiMOD_SAP_LORAWAN_IDs.h:326
TWiMODLORAWAN_RX_Data::RSSI
INT8 RSSI
Definition: WiMOD_SAP_LORAWAN_IDs.h:524
TWiMODLORAWAN_RX_JoinedNwkData::OptionalInfoAvaiable
bool OptionalInfoAvaiable
Definition: WiMOD_SAP_LORAWAN_IDs.h:562
TWiMODLORAWAN_MacCmd::DataServiceType
UINT8 DataServiceType
Definition: WiMOD_SAP_LORAWAN_IDs.h:592
TWiMODLORAWAN_RX_ACK_Data::RxSlot
UINT8 RxSlot
Definition: WiMOD_SAP_LORAWAN_IDs.h:611
TWiMODLORAWAN_TxPwrLimitConfig
data structure for TX Power Limits
Definition: WiMOD_SAP_LORAWAN_IDs.h:674
TWiMODLORAWAN_JoinParams::JoinEUI
UINT8 JoinEUI[WiMODLORAWAN_JOIN_EUI_LEN]
Definition: WiMOD_SAP_LORAWAN_IDs.h:452
TWiMODLORAWAN_RX_ACK_Data
Data structure for received Acknowledgment data.
Definition: WiMOD_SAP_LORAWAN_IDs.h:602
WiMOD_SAP_GlobalLink24_IDs_WW2G4.h
TWiMODLORAWAN_RX_JoinedNwkData::RxSlot
UINT8 RxSlot
Definition: WiMOD_SAP_LORAWAN_IDs.h:561
TWiMODLORAWAN_RX_MacCmdData::RxSlot
UINT8 RxSlot
Definition: WiMOD_SAP_LORAWAN_IDs.h:544
LoRaWAN_FreqBand_AS_923_Thailand
@ LoRaWAN_FreqBand_AS_923_Thailand
Definition: WiMOD_SAP_LORAWAN_IDs.h:327
LoRaWAN_FreqBand_AS_923_Singapore
@ LoRaWAN_FreqBand_AS_923_Singapore
Definition: WiMOD_SAP_LORAWAN_IDs.h:325
TWiMODLORAWAN_NoData_Data::StatusFormat
UINT8 StatusFormat
Definition: WiMOD_SAP_LORAWAN_IDs.h:650
TWiMODLORAWAN_TxIndData::DataRateIndex
UINT8 DataRateIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:480
LoRaWAN_Status_Device_Not_Activated
@ LoRaWAN_Status_Device_Not_Activated
Definition: WiMOD_SAP_LORAWAN_IDs.h:111
LoRaWAN_FreqBand_AS_923_Cambodia
@ LoRaWAN_FreqBand_AS_923_Cambodia
Definition: WiMOD_SAP_LORAWAN_IDs.h:320
TWiMODLORAWAN_RX_ACK_Data::SNR
INT8 SNR
Definition: WiMOD_SAP_LORAWAN_IDs.h:610
LoRaWAN_TxDataInd_Satus_TX_Err_Payload
@ LoRaWAN_TxDataInd_Satus_TX_Err_Payload
Definition: WiMOD_SAP_LORAWAN_IDs.h:160
TWiMODLORAWAN_RadioStackConfig::BandIndex
UINT8 BandIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:575
TWiMODLORAWAN_TxPwrLimitConfig
struct TWiMODLORAWAN_TxPwrLimitConfig TWiMODLORAWAN_TxPwrLimitConfig
data structure for TX Power Limits
TWiMODLORAWAN_RX_JoinedNwkData::SNR
INT8 SNR
Definition: WiMOD_SAP_LORAWAN_IDs.h:560
TWiMODLORAWAN_TxIndData::RfMsgAirtime
UINT32 RfMsgAirtime
Definition: WiMOD_SAP_LORAWAN_IDs.h:486
LoRaWAN_PowerSaving_Off
@ LoRaWAN_PowerSaving_Off
Definition: WiMOD_SAP_LORAWAN_IDs.h:367
TWiMODLORAWAN_NoData_Data
struct TWiMODLORAWAN_NoData_Data TWiMODLORAWAN_NoData_Data
Structure containing infos of a NoData Indication message.
TWiMODLORAWAN_TxIndData::StatusFormat
UINT8 StatusFormat
Definition: WiMOD_SAP_LORAWAN_IDs.h:476
LoRaWAN_Status_Cmd_Not_Supported
@ LoRaWAN_Status_Cmd_Not_Supported
Definition: WiMOD_SAP_LORAWAN_IDs.h:108
LoRaWAN_TxDataInd_Satus_TX_Ok_Ch_Info
@ LoRaWAN_TxDataInd_Satus_TX_Ok_Ch_Info
Definition: WiMOD_SAP_LORAWAN_IDs.h:157
LoRaWAN_JoinNkwInd_Satus_Format_Join_Ok
@ LoRaWAN_JoinNkwInd_Satus_Format_Join_Ok
Definition: WiMOD_SAP_LORAWAN_IDs.h:134
TWiMODLORAWAN_RadioStackConfig::WrongParamErrCode
UINT8 WrongParamErrCode
Definition: WiMOD_SAP_LORAWAN_IDs.h:583
TWiMODLORAWAN_RX_JoinedNwkData::DataRateIndex
UINT8 DataRateIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:558
WiMOD_SAP_LORAWAN_IDs_EU868.h
TWiMODLORAWAN_NoData_Data::OptionalInfoAvaiable
bool OptionalInfoAvaiable
Definition: WiMOD_SAP_LORAWAN_IDs.h:655
TWiMODLORAWAN_MacCmd
LoRaWAN MAC command structure.
Definition: WiMOD_SAP_LORAWAN_IDs.h:590
WiMOD_SAP_LORAWAN_IDs_IN865.h
LoRaWAN_FreqBand_AS_923_Laos
@ LoRaWAN_FreqBand_AS_923_Laos
Definition: WiMOD_SAP_LORAWAN_IDs.h:323
TWiMODLORAWAN_RX_MacCmdData::ChannelIndex
UINT8 ChannelIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:540
LoRaWAN_FreqBand_EU_868_RX2_SF9
@ LoRaWAN_FreqBand_EU_868_RX2_SF9
Definition: WiMOD_SAP_LORAWAN_IDs.h:337
LoRaWAN_FreqBand_AS_923_NewZealand
@ LoRaWAN_FreqBand_AS_923_NewZealand
Definition: WiMOD_SAP_LORAWAN_IDs.h:324
TWiMODLORAWAN_RX_Data::Port
UINT8 Port
Definition: WiMOD_SAP_LORAWAN_IDs.h:517
WiMOD_SAP_LORAWAN_IDs_RU868.h
TWiMODLORAWAN_RX_Data
struct TWiMODLORAWAN_RX_Data TWiMODLORAWAN_RX_Data
Structure containing RX (user) payload data.
LoRaWAN_Status_Ok
@ LoRaWAN_Status_Ok
Definition: WiMOD_SAP_LORAWAN_IDs.h:106
LoRaWAN_FreqBand_RU_868_V2
@ LoRaWAN_FreqBand_RU_868_V2
Definition: WiMOD_SAP_LORAWAN_IDs.h:330
TWiMODLORAWAN_TxIndData::FieldAvailability
TWiMODLORAWAN_OptIndInfos FieldAvailability
Definition: WiMOD_SAP_LORAWAN_IDs.h:474
TWiMODLORAWAN_RX_Data::OptionalInfoAvaiable
bool OptionalInfoAvaiable
Definition: WiMOD_SAP_LORAWAN_IDs.h:527
TWiMODLORAWAN_RX_ACK_Data::ChannelIndex
UINT8 ChannelIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:607
TWiMODLORAWAN_RX_Data::SNR
INT8 SNR
Definition: WiMOD_SAP_LORAWAN_IDs.h:525
TWiMODLORAWAN_RX_MacCmdData::OptionalInfoAvaiable
bool OptionalInfoAvaiable
Definition: WiMOD_SAP_LORAWAN_IDs.h:545
TWiMODLORAWAN_RX_Data::Payload
UINT8 Payload[WiMODLORAWAN_APP_PAYLOAD_LEN]
Definition: WiMOD_SAP_LORAWAN_IDs.h:519
LoRaWAN_TxDataInd_Satus_TX_Ok
@ LoRaWAN_TxDataInd_Satus_TX_Ok
Definition: WiMOD_SAP_LORAWAN_IDs.h:156
TWiMODLORAWAN_RadioStackConfig::SubBandMask1
UINT8 SubBandMask1
Definition: WiMOD_SAP_LORAWAN_IDs.h:579
TWiMODLORAWAN_RX_MacCmdData
Structure containing a received MAC command.
Definition: WiMOD_SAP_LORAWAN_IDs.h:534
TWiMODLORAWAN_RadioStackConfig::Options
UINT8 Options
Definition: WiMOD_SAP_LORAWAN_IDs.h:572
LoRaWAN_NwkStatus_Joining_OTAA
@ LoRaWAN_NwkStatus_Joining_OTAA
Definition: WiMOD_SAP_LORAWAN_IDs.h:390
LoRaWAN_FreqBand_US_915
@ LoRaWAN_FreqBand_US_915
Definition: WiMOD_SAP_LORAWAN_IDs.h:315
LoRaWAN_Status_Device_Busy
@ LoRaWAN_Status_Device_Busy
Definition: WiMOD_SAP_LORAWAN_IDs.h:112
TWiMODLORAWAN_ActivateDeviceData
Activation data structure for LoRa network activation.
Definition: WiMOD_SAP_LORAWAN_IDs.h:439
TWiMODLORAWAN_NwkStatus_Data::DataRateIndex
UINT8 DataRateIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:623
TWiMODLORAWAN_NwkStatus_Data::DeviceAddress
UINT32 DeviceAddress
Definition: WiMOD_SAP_LORAWAN_IDs.h:622
LoRaWAN_Status_No_Factory_Settings
@ LoRaWAN_Status_No_Factory_Settings
Definition: WiMOD_SAP_LORAWAN_IDs.h:115
TWiMODLORAWAN_RX_Data::DataRateIndex
UINT8 DataRateIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:523
TWiMODLORAWAN_NwkStatus_Data::PowerLevel
UINT8 PowerLevel
Definition: WiMOD_SAP_LORAWAN_IDs.h:624
TLoRaWANStatus
TLoRaWANStatus
Status code enumeration for LoRaWAN SAP of the WiMOD EndNode Modem firmware.
Definition: WiMOD_SAP_LORAWAN_IDs.h:104
TWiMODLORAWAN_RadioStackConfig
struct TWiMODLORAWAN_RadioStackConfig TWiMODLORAWAN_RadioStackConfig
Radio stack configuration related to to LoRaWAN specific options.
TWiMODLORAWAN_NoData_Data::ErrorCode
UINT8 ErrorCode
Definition: WiMOD_SAP_LORAWAN_IDs.h:653
TWiMODLORAWAN_RX_Data::ChannelIndex
UINT8 ChannelIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:522
WiMOD_SAP_LORAWAN_IDs_US915.h
LoRaWAN_FreqBand_RU_868_V3
@ LoRaWAN_FreqBand_RU_868_V3
Definition: WiMOD_SAP_LORAWAN_IDs.h:331
TWiMODLORAWAN_RX_JoinedNwkData::RSSI
INT8 RSSI
Definition: WiMOD_SAP_LORAWAN_IDs.h:559
TWiMODLORAWAN_ActivateDeviceData::DeviceAddress
UINT32 DeviceAddress
Definition: WiMOD_SAP_LORAWAN_IDs.h:441
TWiMODLORAWAN_RadioStackConfig::Retransmissions
UINT8 Retransmissions
Definition: WiMOD_SAP_LORAWAN_IDs.h:574
LoRaWAN_Status_Wrong_parameter
@ LoRaWAN_Status_Wrong_parameter
Definition: WiMOD_SAP_LORAWAN_IDs.h:109
LoRaWAN_FreqBand_AS_923_Indonesia
@ LoRaWAN_FreqBand_AS_923_Indonesia
Definition: WiMOD_SAP_LORAWAN_IDs.h:321
TWiMODLORAWAN_TX_Data
Structure containing all data necessary to transmitting a data message.
Definition: WiMOD_SAP_LORAWAN_IDs.h:502
LoRaWAN_Status_Wrong_DeviceMode
@ LoRaWAN_Status_Wrong_DeviceMode
Definition: WiMOD_SAP_LORAWAN_IDs.h:110
TWiMODLORAWAN_ActivateDeviceData::NwkSKey
UINT8 NwkSKey[WiMODLORAWAN_NWK_SESSION_KEY_LEN]
Definition: WiMOD_SAP_LORAWAN_IDs.h:442
TWiMODLORAWAN_RX_JoinedNwkData::ChannelIndex
UINT8 ChannelIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:557
LoRaWAN_FreqBand_AS_923_Vietnam
@ LoRaWAN_FreqBand_AS_923_Vietnam
Definition: WiMOD_SAP_LORAWAN_IDs.h:328
TWiMODLORAWAN_TX_Data::Length
UINT8 Length
Definition: WiMOD_SAP_LORAWAN_IDs.h:505
TWiMODLORAWAN_TX_Data::Port
UINT8 Port
Definition: WiMOD_SAP_LORAWAN_IDs.h:504
LORAWAN_OPT_TX_IND_INFOS_NOT_AVAILABLE
@ LORAWAN_OPT_TX_IND_INFOS_NOT_AVAILABLE
Definition: WiMOD_SAP_LORAWAN_IDs.h:462
LoRaWAN_FreqBand_IN_865_RX2_SF8
@ LoRaWAN_FreqBand_IN_865_RX2_SF8
Definition: WiMOD_SAP_LORAWAN_IDs.h:338
LoRaWAN_FreqBand_India_865
@ LoRaWAN_FreqBand_India_865
Definition: WiMOD_SAP_LORAWAN_IDs.h:317
TWiMODLORAWAN_RX_JoinedNwkData
struct TWiMODLORAWAN_RX_JoinedNwkData TWiMODLORAWAN_RX_JoinedNwkData
Structure containing data of the joined network indication.
TWiMODLORAWAN_RX_MacCmdData::MacCmdData
UINT8 MacCmdData[WiMODLORAWAN_APP_PAYLOAD_LEN]
Definition: WiMOD_SAP_LORAWAN_IDs.h:537
TWiMODLORAWAN_TxIndData::ChannelIndex
UINT8 ChannelIndex
Definition: WiMOD_SAP_LORAWAN_IDs.h:478
TWiMODLORAWAN_TX_Data::Payload
UINT8 Payload[WiMODLORAWAN_APP_PAYLOAD_LEN]
Definition: WiMOD_SAP_LORAWAN_IDs.h:506
LoRaWAN_Status_Queue_Full
@ LoRaWAN_Status_Queue_Full
Definition: WiMOD_SAP_LORAWAN_IDs.h:113
TWiMODLORAWAN_RadioStackConfig::SubBandMask2
UINT8 SubBandMask2
Definition: WiMOD_SAP_LORAWAN_IDs.h:580
TLoraWANTxDataIndStatusFormat
TLoraWANTxDataIndStatusFormat
Status code enumeration for LoRaWAN Join Network Indications.
Definition: WiMOD_SAP_LORAWAN_IDs.h:153
TWiMODLORAWAN_NwkStatus_Data::MaxPayloadSize
UINT8 MaxPayloadSize
Definition: WiMOD_SAP_LORAWAN_IDs.h:625
LoRaWAN_FreqBand_RU_868_V4
@ LoRaWAN_FreqBand_RU_868_V4
Definition: WiMOD_SAP_LORAWAN_IDs.h:332
TWiMODLORAWAN_MacCmd::Payload
UINT8 Payload[WiMODLORAWAN_MAC_CMD_PAYLOAD_LENGTH]
Definition: WiMOD_SAP_LORAWAN_IDs.h:594
TWiMODLORAWAN_OptIndInfos
TWiMODLORAWAN_OptIndInfos
Optional TX information flag.
Definition: WiMOD_SAP_LORAWAN_IDs.h:460
LoRaWAN_PowerSaving_On
@ LoRaWAN_PowerSaving_On
Definition: WiMOD_SAP_LORAWAN_IDs.h:368
TWiMODLORAWAN_ActivateDeviceData
struct TWiMODLORAWAN_ActivateDeviceData TWiMODLORAWAN_ActivateDeviceData
Activation data structure for LoRa network activation.
TLoraWANJoinNwkIndStatusFormat
TLoraWANJoinNwkIndStatusFormat
Status code enumeration for LoRaWAN Join Network Indications.
Definition: WiMOD_SAP_LORAWAN_IDs.h:132
TLoRaWAN_NwkStatus
TLoRaWAN_NwkStatus
Network Status Status defines.
Definition: WiMOD_SAP_LORAWAN_IDs.h:385
TWiMODLORAWAN_RX_ACK_Data
struct TWiMODLORAWAN_RX_ACK_Data TWiMODLORAWAN_RX_ACK_Data
Data structure for received Acknowledgment data.
TWiMODLORAWAN_RX_JoinedNwkData::DeviceAddress
UINT32 DeviceAddress
Definition: WiMOD_SAP_LORAWAN_IDs.h:554
LoRaWAN_FreqBand_RU_868_V1
@ LoRaWAN_FreqBand_RU_868_V1
Definition: WiMOD_SAP_LORAWAN_IDs.h:329