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

WiMOD_SAP_DEVMGMT_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.8
36 * FOR FIRMWARE: LR-BASE
37 *
38 * SEE FILE: WiMOD_LR_Base_HCI_Spec_V1_8.pdf for detailed information
39 */
40
41
42 #ifndef ARDUINO_WIMOD_SAP_DEVMGMT_IDS_H_
43 #define ARDUINO_WIMOD_SAP_DEVMGMT_IDS_H_
44
45 //------------------------------------------------------------------------------
46 //
47 // Section Includes Files
48 //
49 //------------------------------------------------------------------------------
50
51 #include "utils/WMDefs.h"
52
53
54 //------------------------------------------------------------------------------
55 //
56 // Service Access Point Identifier
57 //
58 //------------------------------------------------------------------------------
59
61 #define DEVMGMT_SAP_ID 0x01
62
63
64
65 //------------------------------------------------------------------------------
66 //
67 // Device Management Message Identifier
68 //
69 //------------------------------------------------------------------------------
71
72 // Status Codes
73 #define DEVMGMT_STATUS_OK 0x00
74 #define DEVMGMT_STATUS_ERROR 0x01
75 #define DEVMGMT_STATUS_CMD_NOT_SUPPORTED 0x02
76 #define DEVMGMT_STATUS_WRONG_PARAMETER 0x03
77 #define DEVMGMT_STATUS_WRONG_DEVICE_MODE 0x04
78 #define DEVMGMT_STATUS_DEVICE_BUSY 0x06
79
80 // Message IDs
81 #define DEVMGMT_MSG_PING_REQ 0x01
82 #define DEVMGMT_MSG_PING_RSP 0x02
83
84 #define DEVMGMT_MSG_GET_DEVICEINFO_REQ 0x03
85 #define DEVMGMT_MSG_GET_DEVICEINFO_RSP 0x04
86
87 #define DEVMGMT_MSG_GET_FW_VERSION_REQ 0x05
88 #define DEVMGMT_MSG_GET_FW_VERSION_RSP 0x06
89
90 #define DEVMGMT_MSG_RESET_REQ 0x07
91 #define DEVMGMT_MSG_RESET_RSP 0x08
92
93 #define DEVMGMT_MSG_SET_OPMODE_REQ 0x09
94 #define DEVMGMT_MSG_SET_OPMODE_RSP 0x0A
95
96 #define DEVMGMT_MSG_GET_OPMODE_REQ 0x0B
97 #define DEVMGMT_MSG_GET_OPMODE_RSP 0x0C
98
99 #define DEVMGMT_MSG_SET_RTC_REQ 0x0D
100 #define DEVMGMT_MSG_SET_RTC_RSP 0x0E
101 #define DEVMGMT_MSG_GET_RTC_REQ 0x0F
102 #define DEVMGMT_MSG_GET_RTC_RSP 0x10
103
104 #define DEVMGMT_MSG_SET_RADIO_CONFIG_REQ 0x11
105 #define DEVMGMT_MSG_SET_RADIO_CONFIG_RSP 0x12
106 #define DEVMGMT_MSG_GET_RADIO_CONFIG_REQ 0x13
107 #define DEVMGMT_MSG_GET_RADIO_CONFIG_RSP 0x14
108
109 #define DEVMGMT_MSG_RESET_RADIO_CONFIG_REQ 0x15
110 #define DEVMGMT_MSG_RESET_RADIO_CONFIG_RSP 0x16
111
112 #define DEVMGMT_MSG_GET_SYSTEM_STATUS_REQ 0x17
113 #define DEVMGMT_MSG_GET_SYSTEM_STATUS_RSP 0x18
114
115 #define DEVMGMT_MSG_SET_RADIO_MODE_REQ 0x19
116 #define DEVMGMT_MSG_SET_RADIO_MODE_RSP 0x1A
117
118 #define DEVMGMT_MSG_SET_PSV_MODE_REQ 0x1B
119 #define DEVMGMT_MSG_SET_PSV_MODE_RSP 0x1C
120
121 #define DEVMGMT_MSG_POWER_UP_IND 0x20
122
123 #define DEVMGMT_MSG_SET_AES_KEY_REQ 0x21
124 #define DEVMGMT_MSG_SET_AES_KEY_RSP 0x22
125
126 #define DEVMGMT_MSG_GET_AES_KEY_REQ 0x23
127 #define DEVMGMT_MSG_GET_AES_KEY_RSP 0x24
128
129 #define DEVMGMT_MSG_SET_RTC_ALARM_REQ 0x31
130 #define DEVMGMT_MSG_SET_RTC_ALARM_RSP 0x32
131
132 #define DEVMGMT_MSG_CLEAR_RTC_ALARM_REQ 0x33
133 #define DEVMGMT_MSG_CLEAR_RTC_ALARM_RSP 0x34
134
135 #define DEVMGMT_MSG_GET_RTC_ALARM_REQ 0x35
136 #define DEVMGMT_MSG_GET_RTC_ALARM_RSP 0x36
137
138 #define DEVMGMT_MSG_RTC_ALARM_IND 0x38
139
140
141 // new Message IDs (only part of LR-BASE PLUS & LoRaWAN EndNode FW)
142
144 #define DEVMGMT_MSG_SET_HCI_CFG_REQ 0x41
145 #define DEVMGMT_MSG_SET_HCI_CFG_RSP 0x42
146 #define DEVMGMT_MSG_GET_HCI_CFG_REQ 0x43
147 #define DEVMGMT_MSG_GET_HCI_CFG_RSP 0x44
148
150
151
153 //------------------------------------------------------------------------------
154 //
155 // misc. defines
156 //
157 //------------------------------------------------------------------------------
159
160 #define DEVMGMT_AES_KEY_LEN 16 // 128 bit
161
163
164 //------------------------------------------------------------------------------
165 //
166 // structures
167 //
168 //------------------------------------------------------------------------------
172 typedef struct TWiMODLR_DevMgmt_DevInfo
173 {
174 UINT8 Status;
175 UINT8 ModuleType;
176 UINT16 DevAdr;
177 UINT8 GroupAdr;
178 UINT32 DevID;
179 } TWiMODLR_DevMgmt_DevInfo;
180
182
183 #define WIMOD_DEVMGMT_BUILDDATE_LEN (10)
184 #define WIMOD_DEVMGMT_MAX_BUILDDATE_LEN (WIMOD_DEVMGMT_BUILDDATE_LEN+1)
185 #define WIMOD_DEVMGMT_FIRMWARE_NAME_LEN (40)
186 #define WIMOD_DEVMGMT_MAX_FIRMWARE_NAME_LEN (WIMOD_DEVMGMT_FIRMWARE_NAME_LEN+1)
187
188 // @endcond
189
190
191 // WiMOD Module Types
193 #define WIMOD_MODULE_TYPE_IM880B (0x98)
194
196
200 typedef enum TWiMOD_ModuleType
201 {
202 ModuleType_iM880A = 0x90,
203 ModuleType_iM880A_L = 0x92,
204 ModuleType_iU880A = 0x93,
205 ModuleType_iM880B = 0x98,
206 ModuleType_iU880B = 0x99,
207 ModuleType_iM980A = 0x9A,
208 ModuleType_iU980A = 0x9B,
209 ModuleType_iM980B = 0x9C,
210 ModuleType_iM881A = 0xA0,
211 ModuleType_iU881A = 0xA1,
212 ModuleType_iM282A = 0xB0
213 } TWiMOD_ModuleType;
214
215
216
220 typedef struct TWiMODLR_DevMgmt_FwInfo
221 {
222 UINT8 Status;
223 UINT8 FirmwareMinorVersion;
224 UINT8 FirmwareMayorVersion;
225 UINT16 BuildCount;
226 UINT8 BuildDateStr[WIMOD_DEVMGMT_MAX_BUILDDATE_LEN];
227 UINT8 FirmwareName[WIMOD_DEVMGMT_MAX_FIRMWARE_NAME_LEN];
228 } TWiMODLR_DevMgmt_FwInfo;
229
230
234 typedef struct TWiMODLR_DevMgmt_SystemStatus
235 {
236 UINT8 Status;
237 UINT8 SysTickResolution;
238 UINT32 SysTickCounter;
239 UINT32 RtcTime;
240 UINT16 NvmStatus;
241 UINT16 BatteryStatus;
242 UINT16 ExtraStatus;
243 UINT32 RxPackets;
244 UINT32 RxAddressMatch;
245 UINT32 RxCRCError;
246 UINT32 TxPackets;
247 UINT32 TxError;
248 UINT32 TxMediaBusyEvents;
249 } TWiMODLR_DevMgmt_SystemStatus;
250
251
255 typedef enum TRadioCfg_RadioMode
256 {
257 RadioMode_Standard = 0,
258 RadioMode_Reserved,
259 RadioMode_Sniffer,
260 } TRadioCfg_RadioMode;
261
262
266 typedef enum TRadioCfg_Modulation
267 {
268 Modulation_LoRa = 0,
269 Modulation_FSK,
270 } TRadioCfg_Modulation;
271
275 typedef enum TRadioCfg_LoRaBandwidth
276 {
277 LoRaBandwith_125kHz = 0,
278 LoRaBandwith_250kHz,
279 LoRaBandwith_500kHz
280 } TRadioCfg_LoRaBandwidth;
281
285 typedef enum TRadioCfg_LoRaSpreadingFactor
286 {
287 LoRa0_SF7 = 0,
288 LoRa1_SF7,
289 LoRa2_SF7,
290 LoRa3_SF7,
291 LoRa4_SF7,
292 LoRa5_SF7,
293 LoRa6_SF7,
294 LoRa7_SF7,
295 LoRa8_SF8,
296 LoRa9_SF9,
297 LoRa10_SF10,
298 LoRa11_SF11,
299 LoRa12_SF12,
300 } TRadioCfg_LoRaSpreadingFactor;
301
305 typedef enum TRadioCfg_ErrorCoding
306 {
307 ErrorCoding0_4_5 = 0,
308 ErrorCoding1_4_5,
309 ErrorCoding2_4_6,
310 ErrorCoding3_4_7,
311 ErrorCoding4_4_8,
312 } TRadioCfg_ErrorCoding;
313
317 typedef enum TRadioCfg_TxPowerLevel
318 {
319 TxPowerLevel_5_dBm = 5,
320 TxPowerLevel_6_dBm,
321 TxPowerLevel_7_dBm,
322 TxPowerLevel_8_dBm,
323 TxPowerLevel_9_dBm,
324 TxPowerLevel_10_dBm,
325 TxPowerLevel_11_dBm,
326 TxPowerLevel_12_dBm,
327 TxPowerLevel_13_dBm,
328 TxPowerLevel_14_dBm,
329 TxPowerLevel_15_dBm,
330 TxPowerLevel_16_dBm,
331 TxPowerLevel_17_dBm,
332 TxPowerLevel_18_dBm,
333 TxPowerLevel_19_dBm,
334 TxPowerLevel_20_dBm,
335 } TRadioCfg_PowerLevel;
336
337
338 // bit field for TxControl field of RadioConfig structure
340 #define DEVMGMT_RADIO_CFG_TX_CTRL_TX_NARROW_FILTER_ON (1 << 0)
341 #define DEVMGMT_RADIO_CFG_TX_CTRL_LBT_ON (1 << 1)
342
347 typedef enum TRadioCfg_RxControl
348 {
349 RxCtrl_Receiver_Off = 0,
350 RxCtrl_Receiver_AlwaysOn,
351 RxCtrl_Receiver_RxWindowed,
352 } TRadioCfg_RxControl;
353
355
356 // bit field for LedControl in RadioConfig structure
357 #define DEVMGMT_RADIO_CFG_LED_CTRL_LED3_RX_IND_ON (1 << 0)
358 #define DEVMGMT_RADIO_CFG_LED_CTRL_LED2_TX_IND_ON (1 << 1)
359 #define DEVMGMT_RADIO_CFG_LED_CTRL_LED4_ALIVE_IND_ON (1 << 2)
360 #define DEVMGMT_RADIO_CFG_LED_CTRL_LED1_BUTTON_IND_ON (1 << 3)
361 // update in HCI spec V1.3++
362 #define DEVMGMT_RADIO_CFG_LED_CTRL_LED3_RX_STATE_ON (1 << 4) // overrides Bit0 if enabled
363 #define DEVMGMT_RADIO_CFG_LED_CTRL_LED2_TX_STATE_ON (1 << 5) // overrides Bit1 if enabled
364
365
366 // bit field for Misc.Options in RadioConfig structure
367 #define DEVMGMT_RADIO_CFG_MISC_EXTENDED_HCI_OUTPUT_FORMAT (1 << 0)
368 #define DEVMGMT_RADIO_CFG_MISC_RTC_ENABLED (1 << 1)
369 #define DEVMGMT_RADIO_CFG_MISC_HCI_TX_IND_ENABLED (1 << 2)
370 #define DEVMGMT_RADIO_CFG_MISC_HCI_PWR_UP_IND_ENABLED (1 << 3)
371 #define DEVMGMT_RADIO_CFG_MISC_HCI_BTN_PRESS_IND_ENABLED (1 << 4)
372 #define DEVMGMT_RADIO_CFG_MISC_HCI_ENCTRYPTION_ENABLED (1 << 5)
373
375
379 typedef enum TRadioCfg_FskDatarate
380 {
381 FskDatarate_50kbps = 0,
382 FskDatarate_100kbps,
383 FskDatarate_250kbps,
384 } TRadioCfg_FskDatarate;
385
386
387 // power saving mode field of the RadioConfig structure
389 #define DEVMGMT_RADIO_CFG_POWER_SAVING_MODE_OFF 0
390 #define DEVMGMT_RADIO_CFG_POWER_SAVING_MODE_ON 1
391
393
397 typedef enum TRadioCfg_PowerSavingMode
398 {
399 PowerSaving_Off = 0,
400 PowerSaving_On = 1,
401 } TRadioCfg_PowerSavingMode;
402
406 typedef struct TWiMODLR_DevMgmt_RadioConfig
407 {
408 // only for reading
409 UINT8 Status;
411 // only for writing
412 UINT8 StoreNwmFlag;
414 TRadioCfg_RadioMode RadioMode;
415 UINT8 GroupAddress;
416 UINT8 TxGroupAddress;
417 UINT16 DeviceAddress;
418 UINT16 TxDeviceAddress;
419 TRadioCfg_Modulation Modulation;
420 UINT8 RfFreq_LSB;
421 UINT8 RfFreq_MID;
422 UINT8 RfFreq_MSB;
423 TRadioCfg_LoRaBandwidth LoRaBandWidth;
424 TRadioCfg_LoRaSpreadingFactor LoRaSpreadingFactor;
425 TRadioCfg_ErrorCoding ErrorCoding;
426 TRadioCfg_PowerLevel PowerLevel;
427 UINT8 TxControl;
428 TRadioCfg_RxControl RxControl;
429 UINT16 RxWindowTime;
430 UINT8 LedControl;
431 UINT8 MiscOptions;
432 TRadioCfg_FskDatarate FskDatarate;
433 TRadioCfg_PowerSavingMode PowerSavingMode;
434 INT16 LbtThreshold;
435 } TWiMODLR_DevMgmt_RadioConfig;
436
440 typedef enum TWiMOD_OperationMode
441 {
442 OperationMode_Application = 0,
443 OperationMode_Test,
444 OperationMode_Reserved2 = 2,
445 OperationMode_Customer = 3,
446 } TWiMOD_OperationMode;
447
448
449
450 // RTC alarm status
452 #define DEVMGMT_RTC_ALARM_STATUS_NO_ALARM_SET 0
453 #define DEVMGMT_RTC_ALARM_STATUS_ALARM_SET 1
454
459 typedef enum TWiMOD_RtcAlarmStatus
460 {
461 RTC_Alarm_No_Alarm_Set = 0,
462 RTC_Alarm_Alarm_Set,
463 } TWiMOD_RtcAlarmStatus;
464
465
466 // RTC alarm options / alarm type
468 #define DEVMGMT_RTC_ALARM_TYPE_SIGNLE 0
469 #define DEVMGMT_RTC_ALARM_TYPE_DAILY_REPEATED 1
470
475 typedef enum TWiMOD_RtcAlarmType
476 {
477 RTC_Alarm_Single = 0,
478 RTC_Alarm_DailyRepeated,
479 } TWiMOD_RtcAlarmType;
480
484 typedef struct TWiMODLR_DevMgmt_RtcAlarm
485 {
486 // RX only
487 TWiMOD_RtcAlarmStatus AlarmStatus;
489 TWiMOD_RtcAlarmType Options;
490 UINT8 Hour;
491 UINT8 Minutes;
492 UINT8 Seconds;
493 } TWiMODLR_DevMgmt_RtcAlarm;
494
495
496
497
501 typedef enum TWiMOD_HCI_Baudrate
502 {
503 WimodHciBaudrate_9600 = 0x00,
504 WimodHciBaudrate_19200 = 0x01,
505 WimodHciBaudrate_38400 = 0x02,
506 WimodHciBaudrate_57600 = 0x03,
507 WimodHciBaudrate_115200 = 0x04,
508 WimodHciBaudrate_230400 = 0x05,
509 WimodHciBaudrate_460800 = 0x06,
510 } TWiMOD_HCI_Baudrate;
511
512
513
514
519 typedef struct TWiMODLR_DevMgmt_HciConfig
520 {
521 // only for writing
522 UINT8 StoreNwmFlag;
523 // only for reading
524 UINT8 Status;
525 TWiMOD_HCI_Baudrate BaudrateID;
526 UINT16 NumWakeUpChars;
527 UINT8 TxHoldTime;
528 UINT8 RxHoldTime;
530 } TWiMODLR_DevMgmt_HciConfig;
531
532
533 //------------------------------------------------------------------------------
534 //
535 // Section Macros
536 //
537 //------------------------------------------------------------------------------
538
540 #define WiMOD_RTC_YEAR_OFFSET 2000
541
543 #define WIMOD_RTC_GET_SECONDS(t) (t & 0x3F)
544
545 #define WIMOD_RTC_GET_MINUTES(t) ((t >> 6) & 0x3F)
546
547 #define WIMOD_RTC_GET_MONTHS(t) ((t >> 12) & 0x0F)
548
549 #define WIMOD_RTC_GET_HOURS(t) ((t >> 16) & 0x1F)
550
551 #define WIMOD_RTC_GET_DAYS(t) ((t >> 21) & 0x1F)
552
553 #define WIMOD_RTC_GET_YEARS(t) (((t >> 26) & 0x3F) + WiMOD_RTC_YEAR_OFFSET)
554
556 #define WIMOD_RTC_MAKE_DATETIME_U32(s,m,h,dd,mm,yy) \
557 (((UINT32)s) | ((UINT32)m << 6) \
558 | ((UINT32)mm << 12) \
559 | ((UINT32)h << 16) \
560 | ((UINT32)dd << 21) \
561 | ((UINT32)(yy-WiMOD_RTC_YEAR_OFFSET) << 26))
562
563
564
565 #endif /* ARDUINO_WIMOD_SAP_DEVMGMT_IDS_H_ */
WimodHciBaudrate_115200
@ WimodHciBaudrate_115200
Definition: WiMOD_SAP_DEVMGMT_IDs.h:507
TWiMODLR_DevMgmt_FwInfo::BuildDateStr
UINT8 BuildDateStr[WIMOD_DEVMGMT_MAX_BUILDDATE_LEN]
Definition: WiMOD_SAP_DEVMGMT_IDs.h:226
OperationMode_Test
@ OperationMode_Test
Definition: WiMOD_SAP_DEVMGMT_IDs.h:443
TWiMODLR_DevMgmt_SystemStatus::RtcTime
UINT32 RtcTime
Definition: WiMOD_SAP_DEVMGMT_IDs.h:239
TWiMODLR_DevMgmt_HciConfig::TxHoldTime
UINT8 TxHoldTime
Definition: WiMOD_SAP_DEVMGMT_IDs.h:527
TRadioCfg_FskDatarate
TRadioCfg_FskDatarate
Settings for the FSK data rate (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:379
TWiMODLR_DevMgmt_RadioConfig::PowerLevel
TRadioCfg_PowerLevel PowerLevel
Definition: WiMOD_SAP_DEVMGMT_IDs.h:426
TxPowerLevel_14_dBm
@ TxPowerLevel_14_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:328
TxPowerLevel_5_dBm
@ TxPowerLevel_5_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:319
LoRa8_SF8
@ LoRa8_SF8
Definition: WiMOD_SAP_DEVMGMT_IDs.h:295
TWiMODLR_DevMgmt_DevInfo::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:174
TWiMOD_ModuleType
TWiMOD_ModuleType
This enum describes the WiMOD module types.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:200
ModuleType_iM880B
@ ModuleType_iM880B
Definition: WiMOD_SAP_DEVMGMT_IDs.h:205
TWiMODLR_DevMgmt_SystemStatus::RxAddressMatch
UINT32 RxAddressMatch
Definition: WiMOD_SAP_DEVMGMT_IDs.h:244
ErrorCoding1_4_5
@ ErrorCoding1_4_5
Definition: WiMOD_SAP_DEVMGMT_IDs.h:308
ModuleType_iU880B
@ ModuleType_iU880B
Definition: WiMOD_SAP_DEVMGMT_IDs.h:206
TWiMODLR_DevMgmt_RadioConfig::LedControl
UINT8 LedControl
Definition: WiMOD_SAP_DEVMGMT_IDs.h:430
TxPowerLevel_18_dBm
@ TxPowerLevel_18_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:332
TWiMODLR_DevMgmt_RtcAlarm::AlarmStatus
TWiMOD_RtcAlarmStatus AlarmStatus
Definition: WiMOD_SAP_DEVMGMT_IDs.h:487
ModuleType_iU980A
@ ModuleType_iU980A
Definition: WiMOD_SAP_DEVMGMT_IDs.h:208
ModuleType_iM880A_L
@ ModuleType_iM880A_L
Definition: WiMOD_SAP_DEVMGMT_IDs.h:203
ErrorCoding4_4_8
@ ErrorCoding4_4_8
Definition: WiMOD_SAP_DEVMGMT_IDs.h:311
ModuleType_iM880A
@ ModuleType_iM880A
Definition: WiMOD_SAP_DEVMGMT_IDs.h:202
LoRa3_SF7
@ LoRa3_SF7
Definition: WiMOD_SAP_DEVMGMT_IDs.h:290
RxCtrl_Receiver_Off
@ RxCtrl_Receiver_Off
Definition: WiMOD_SAP_DEVMGMT_IDs.h:349
LoRa10_SF10
@ LoRa10_SF10
Definition: WiMOD_SAP_DEVMGMT_IDs.h:297
TWiMODLR_DevMgmt_RadioConfig::RxWindowTime
UINT16 RxWindowTime
Definition: WiMOD_SAP_DEVMGMT_IDs.h:429
TWiMODLR_DevMgmt_RtcAlarm
struct TWiMODLR_DevMgmt_RtcAlarm TWiMODLR_DevMgmt_RtcAlarm
Structure containing the RTC Alarm config parameters of the WiMOD.
TWiMOD_RtcAlarmStatus
TWiMOD_RtcAlarmStatus
This enum describes the possible RTC alarm status types.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:459
TWiMODLR_DevMgmt_HciConfig::BaudrateID
TWiMOD_HCI_Baudrate BaudrateID
Definition: WiMOD_SAP_DEVMGMT_IDs.h:525
LoRaBandwith_125kHz
@ LoRaBandwith_125kHz
Definition: WiMOD_SAP_DEVMGMT_IDs.h:277
TRadioCfg_RxControl
TRadioCfg_RxControl
RX Operation modes (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:347
TWiMOD_HCI_Baudrate
TWiMOD_HCI_Baudrate
This enum describes the Baudrate Settings for the HCI configuration (LR-BASE PLUS & LoRaWAN)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:501
ModuleType_iM980B
@ ModuleType_iM980B
Definition: WiMOD_SAP_DEVMGMT_IDs.h:209
TWiMODLR_DevMgmt_FwInfo
Basic information about the current firmware of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:220
TRadioCfg_TxPowerLevel
TRadioCfg_TxPowerLevel
TxPowerLevel settings (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:317
TWiMODLR_DevMgmt_FwInfo::BuildCount
UINT16 BuildCount
Definition: WiMOD_SAP_DEVMGMT_IDs.h:225
LoRaBandwith_500kHz
@ LoRaBandwith_500kHz
Definition: WiMOD_SAP_DEVMGMT_IDs.h:279
TRadioCfg_PowerSavingMode
TRadioCfg_PowerSavingMode
Settings general PowerSaving mode (aka. Sleep mode)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:397
TWiMODLR_DevMgmt_DevInfo::DevAdr
UINT16 DevAdr
Definition: WiMOD_SAP_DEVMGMT_IDs.h:176
TWiMODLR_DevMgmt_RtcAlarm
Structure containing the RTC Alarm config parameters of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:484
TWiMODLR_DevMgmt_RadioConfig::TxGroupAddress
UINT8 TxGroupAddress
Definition: WiMOD_SAP_DEVMGMT_IDs.h:416
LoRa6_SF7
@ LoRa6_SF7
Definition: WiMOD_SAP_DEVMGMT_IDs.h:293
TWiMODLR_DevMgmt_SystemStatus::SysTickCounter
UINT32 SysTickCounter
Definition: WiMOD_SAP_DEVMGMT_IDs.h:238
RxCtrl_Receiver_RxWindowed
@ RxCtrl_Receiver_RxWindowed
Definition: WiMOD_SAP_DEVMGMT_IDs.h:351
TWiMOD_OperationMode
TWiMOD_OperationMode
This enum describes the possible operation modes of the WiMOD (only for LR-BASE).
Definition: WiMOD_SAP_DEVMGMT_IDs.h:440
ModuleType_iU880A
@ ModuleType_iU880A
Definition: WiMOD_SAP_DEVMGMT_IDs.h:204
TxPowerLevel_7_dBm
@ TxPowerLevel_7_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:321
RTC_Alarm_Single
@ RTC_Alarm_Single
Definition: WiMOD_SAP_DEVMGMT_IDs.h:477
LoRa5_SF7
@ LoRa5_SF7
Definition: WiMOD_SAP_DEVMGMT_IDs.h:292
TWiMODLR_DevMgmt_RtcAlarm::Hour
UINT8 Hour
Definition: WiMOD_SAP_DEVMGMT_IDs.h:490
ErrorCoding2_4_6
@ ErrorCoding2_4_6
Definition: WiMOD_SAP_DEVMGMT_IDs.h:309
TWiMODLR_DevMgmt_RadioConfig::Modulation
TRadioCfg_Modulation Modulation
Definition: WiMOD_SAP_DEVMGMT_IDs.h:419
FskDatarate_250kbps
@ FskDatarate_250kbps
Definition: WiMOD_SAP_DEVMGMT_IDs.h:383
LoRa9_SF9
@ LoRa9_SF9
Definition: WiMOD_SAP_DEVMGMT_IDs.h:296
WimodHciBaudrate_38400
@ WimodHciBaudrate_38400
Definition: WiMOD_SAP_DEVMGMT_IDs.h:505
LoRa7_SF7
@ LoRa7_SF7
Definition: WiMOD_SAP_DEVMGMT_IDs.h:294
TxPowerLevel_17_dBm
@ TxPowerLevel_17_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:331
TxPowerLevel_9_dBm
@ TxPowerLevel_9_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:323
TWiMODLR_DevMgmt_DevInfo::GroupAdr
UINT8 GroupAdr
Definition: WiMOD_SAP_DEVMGMT_IDs.h:177
TWiMODLR_DevMgmt_RadioConfig::LoRaSpreadingFactor
TRadioCfg_LoRaSpreadingFactor LoRaSpreadingFactor
Definition: WiMOD_SAP_DEVMGMT_IDs.h:424
TWiMODLR_DevMgmt_RadioConfig::RfFreq_MSB
UINT8 RfFreq_MSB
Definition: WiMOD_SAP_DEVMGMT_IDs.h:422
TxPowerLevel_12_dBm
@ TxPowerLevel_12_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:326
TWiMODLR_DevMgmt_SystemStatus::ExtraStatus
UINT16 ExtraStatus
Definition: WiMOD_SAP_DEVMGMT_IDs.h:242
RxCtrl_Receiver_AlwaysOn
@ RxCtrl_Receiver_AlwaysOn
Definition: WiMOD_SAP_DEVMGMT_IDs.h:350
Modulation_LoRa
@ Modulation_LoRa
Definition: WiMOD_SAP_DEVMGMT_IDs.h:268
WimodHciBaudrate_57600
@ WimodHciBaudrate_57600
Definition: WiMOD_SAP_DEVMGMT_IDs.h:506
WimodHciBaudrate_19200
@ WimodHciBaudrate_19200
Definition: WiMOD_SAP_DEVMGMT_IDs.h:504
TRadioCfg_Modulation
TRadioCfg_Modulation
Modulation technique supported by the WiMOD (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:266
TWiMODLR_DevMgmt_SystemStatus::NvmStatus
UINT16 NvmStatus
Definition: WiMOD_SAP_DEVMGMT_IDs.h:240
OperationMode_Customer
@ OperationMode_Customer
Definition: WiMOD_SAP_DEVMGMT_IDs.h:445
TxPowerLevel_8_dBm
@ TxPowerLevel_8_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:322
TRadioCfg_RadioMode
TRadioCfg_RadioMode
general operation mode of the radio part (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:255
TWiMODLR_DevMgmt_FwInfo::FirmwareMinorVersion
UINT8 FirmwareMinorVersion
Definition: WiMOD_SAP_DEVMGMT_IDs.h:223
PowerSaving_Off
@ PowerSaving_Off
Definition: WiMOD_SAP_DEVMGMT_IDs.h:399
TWiMODLR_DevMgmt_DevInfo::ModuleType
UINT8 ModuleType
Definition: WiMOD_SAP_DEVMGMT_IDs.h:175
TWiMODLR_DevMgmt_RadioConfig::ErrorCoding
TRadioCfg_ErrorCoding ErrorCoding
Definition: WiMOD_SAP_DEVMGMT_IDs.h:425
FskDatarate_50kbps
@ FskDatarate_50kbps
Definition: WiMOD_SAP_DEVMGMT_IDs.h:381
RadioMode_Sniffer
@ RadioMode_Sniffer
Definition: WiMOD_SAP_DEVMGMT_IDs.h:259
TRadioCfg_LoRaSpreadingFactor
TRadioCfg_LoRaSpreadingFactor
SpreadingFactors for LoRa modulation (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:285
TWiMODLR_DevMgmt_RadioConfig::PowerSavingMode
TRadioCfg_PowerSavingMode PowerSavingMode
Definition: WiMOD_SAP_DEVMGMT_IDs.h:433
OperationMode_Reserved2
@ OperationMode_Reserved2
Definition: WiMOD_SAP_DEVMGMT_IDs.h:444
RadioMode_Standard
@ RadioMode_Standard
Definition: WiMOD_SAP_DEVMGMT_IDs.h:257
TWiMODLR_DevMgmt_SystemStatus::SysTickResolution
UINT8 SysTickResolution
Definition: WiMOD_SAP_DEVMGMT_IDs.h:237
TWiMODLR_DevMgmt_RtcAlarm::Seconds
UINT8 Seconds
Definition: WiMOD_SAP_DEVMGMT_IDs.h:492
TWiMODLR_DevMgmt_RadioConfig::LbtThreshold
INT16 LbtThreshold
Definition: WiMOD_SAP_DEVMGMT_IDs.h:434
TWiMODLR_DevMgmt_SystemStatus::TxPackets
UINT32 TxPackets
Definition: WiMOD_SAP_DEVMGMT_IDs.h:246
TxPowerLevel_20_dBm
@ TxPowerLevel_20_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:334
TWiMODLR_DevMgmt_FwInfo::FirmwareName
UINT8 FirmwareName[WIMOD_DEVMGMT_MAX_FIRMWARE_NAME_LEN]
Definition: WiMOD_SAP_DEVMGMT_IDs.h:227
TxPowerLevel_16_dBm
@ TxPowerLevel_16_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:330
TWiMODLR_DevMgmt_RadioConfig::RfFreq_LSB
UINT8 RfFreq_LSB
Definition: WiMOD_SAP_DEVMGMT_IDs.h:420
RadioMode_Reserved
@ RadioMode_Reserved
Definition: WiMOD_SAP_DEVMGMT_IDs.h:258
TRadioCfg_LoRaBandwidth
TRadioCfg_LoRaBandwidth
Bandwidth settings for the LoRa modulation (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:275
TWiMODLR_DevMgmt_RtcAlarm::Minutes
UINT8 Minutes
Definition: WiMOD_SAP_DEVMGMT_IDs.h:491
TWiMODLR_DevMgmt_SystemStatus::TxError
UINT32 TxError
Definition: WiMOD_SAP_DEVMGMT_IDs.h:247
FskDatarate_100kbps
@ FskDatarate_100kbps
Definition: WiMOD_SAP_DEVMGMT_IDs.h:382
LoRa4_SF7
@ LoRa4_SF7
Definition: WiMOD_SAP_DEVMGMT_IDs.h:291
LoRaBandwith_250kHz
@ LoRaBandwith_250kHz
Definition: WiMOD_SAP_DEVMGMT_IDs.h:278
TWiMODLR_DevMgmt_RadioConfig::TxDeviceAddress
UINT16 TxDeviceAddress
Definition: WiMOD_SAP_DEVMGMT_IDs.h:418
TWiMODLR_DevMgmt_SystemStatus::BatteryStatus
UINT16 BatteryStatus
Definition: WiMOD_SAP_DEVMGMT_IDs.h:241
TWiMODLR_DevMgmt_RadioConfig::GroupAddress
UINT8 GroupAddress
Definition: WiMOD_SAP_DEVMGMT_IDs.h:415
Modulation_FSK
@ Modulation_FSK
Definition: WiMOD_SAP_DEVMGMT_IDs.h:269
TWiMODLR_DevMgmt_DevInfo
Structure containing basic information about the WiMOD device.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:172
TWiMODLR_DevMgmt_HciConfig::RxHoldTime
UINT8 RxHoldTime
Definition: WiMOD_SAP_DEVMGMT_IDs.h:528
TWiMODLR_DevMgmt_DevInfo
struct TWiMODLR_DevMgmt_DevInfo TWiMODLR_DevMgmt_DevInfo
Structure containing basic information about the WiMOD device.
TxPowerLevel_13_dBm
@ TxPowerLevel_13_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:327
LoRa2_SF7
@ LoRa2_SF7
Definition: WiMOD_SAP_DEVMGMT_IDs.h:289
TWiMODLR_DevMgmt_FwInfo
struct TWiMODLR_DevMgmt_FwInfo TWiMODLR_DevMgmt_FwInfo
Basic information about the current firmware of the WiMOD.
RTC_Alarm_No_Alarm_Set
@ RTC_Alarm_No_Alarm_Set
Definition: WiMOD_SAP_DEVMGMT_IDs.h:461
TxPowerLevel_6_dBm
@ TxPowerLevel_6_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:320
TWiMODLR_DevMgmt_SystemStatus::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:236
TWiMODLR_DevMgmt_SystemStatus::TxMediaBusyEvents
UINT32 TxMediaBusyEvents
Definition: WiMOD_SAP_DEVMGMT_IDs.h:248
TWiMODLR_DevMgmt_RadioConfig::DeviceAddress
UINT16 DeviceAddress
Definition: WiMOD_SAP_DEVMGMT_IDs.h:417
TWiMODLR_DevMgmt_HciConfig::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:524
TRadioCfg_ErrorCoding
TRadioCfg_ErrorCoding
ErrorCoding settings (for LoRa modulation) (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:305
TWiMODLR_DevMgmt_RadioConfig::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:409
TRadioCfg_PowerLevel
enum TRadioCfg_TxPowerLevel TRadioCfg_PowerLevel
TxPowerLevel settings (only for LR-BASE)
TWiMODLR_DevMgmt_HciConfig
struct TWiMODLR_DevMgmt_HciConfig TWiMODLR_DevMgmt_HciConfig
HCI Configuration Parameters.
ModuleType_iM980A
@ ModuleType_iM980A
Definition: WiMOD_SAP_DEVMGMT_IDs.h:207
RTC_Alarm_DailyRepeated
@ RTC_Alarm_DailyRepeated
Definition: WiMOD_SAP_DEVMGMT_IDs.h:478
LoRa1_SF7
@ LoRa1_SF7
Definition: WiMOD_SAP_DEVMGMT_IDs.h:288
TWiMODLR_DevMgmt_RadioConfig::FskDatarate
TRadioCfg_FskDatarate FskDatarate
Definition: WiMOD_SAP_DEVMGMT_IDs.h:432
TWiMODLR_DevMgmt_DevInfo::DevID
UINT32 DevID
Definition: WiMOD_SAP_DEVMGMT_IDs.h:178
TWiMODLR_DevMgmt_RadioConfig::LoRaBandWidth
TRadioCfg_LoRaBandwidth LoRaBandWidth
Definition: WiMOD_SAP_DEVMGMT_IDs.h:423
TWiMODLR_DevMgmt_RadioConfig::RfFreq_MID
UINT8 RfFreq_MID
Definition: WiMOD_SAP_DEVMGMT_IDs.h:421
TWiMODLR_DevMgmt_FwInfo::FirmwareMayorVersion
UINT8 FirmwareMayorVersion
Definition: WiMOD_SAP_DEVMGMT_IDs.h:224
LoRa0_SF7
@ LoRa0_SF7
Definition: WiMOD_SAP_DEVMGMT_IDs.h:287
TWiMODLR_DevMgmt_SystemStatus
struct TWiMODLR_DevMgmt_SystemStatus TWiMODLR_DevMgmt_SystemStatus
Basic information about system status of the WiMOD.
TWiMODLR_DevMgmt_SystemStatus::RxCRCError
UINT32 RxCRCError
Definition: WiMOD_SAP_DEVMGMT_IDs.h:245
TWiMODLR_DevMgmt_RadioConfig::StoreNwmFlag
UINT8 StoreNwmFlag
Definition: WiMOD_SAP_DEVMGMT_IDs.h:412
TWiMODLR_DevMgmt_RadioConfig::RadioMode
TRadioCfg_RadioMode RadioMode
Definition: WiMOD_SAP_DEVMGMT_IDs.h:414
ErrorCoding0_4_5
@ ErrorCoding0_4_5
Definition: WiMOD_SAP_DEVMGMT_IDs.h:307
TWiMODLR_DevMgmt_HciConfig
HCI Configuration Parameters.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:519
TWiMODLR_DevMgmt_RadioConfig
struct TWiMODLR_DevMgmt_RadioConfig TWiMODLR_DevMgmt_RadioConfig
Structure containing the radio (stack) config parameters of the WiMOD (only for LR-BASE)
LoRa12_SF12
@ LoRa12_SF12
Definition: WiMOD_SAP_DEVMGMT_IDs.h:299
TWiMODLR_DevMgmt_HciConfig::NumWakeUpChars
UINT16 NumWakeUpChars
Definition: WiMOD_SAP_DEVMGMT_IDs.h:526
TWiMODLR_DevMgmt_RadioConfig
Structure containing the radio (stack) config parameters of the WiMOD (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:406
TxPowerLevel_19_dBm
@ TxPowerLevel_19_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:333
TWiMODLR_DevMgmt_HciConfig::StoreNwmFlag
UINT8 StoreNwmFlag
Definition: WiMOD_SAP_DEVMGMT_IDs.h:522
LoRa11_SF11
@ LoRa11_SF11
Definition: WiMOD_SAP_DEVMGMT_IDs.h:298
TWiMODLR_DevMgmt_RadioConfig::TxControl
UINT8 TxControl
Definition: WiMOD_SAP_DEVMGMT_IDs.h:427
TWiMODLR_DevMgmt_FwInfo::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:222
ModuleType_iM881A
@ ModuleType_iM881A
Definition: WiMOD_SAP_DEVMGMT_IDs.h:210
TWiMODLR_DevMgmt_RadioConfig::MiscOptions
UINT8 MiscOptions
Definition: WiMOD_SAP_DEVMGMT_IDs.h:431
TWiMODLR_DevMgmt_SystemStatus
Basic information about system status of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:234
TWiMODLR_DevMgmt_RadioConfig::RxControl
TRadioCfg_RxControl RxControl
Definition: WiMOD_SAP_DEVMGMT_IDs.h:428
RTC_Alarm_Alarm_Set
@ RTC_Alarm_Alarm_Set
Definition: WiMOD_SAP_DEVMGMT_IDs.h:462
PowerSaving_On
@ PowerSaving_On
Definition: WiMOD_SAP_DEVMGMT_IDs.h:400
TWiMODLR_DevMgmt_SystemStatus::RxPackets
UINT32 RxPackets
Definition: WiMOD_SAP_DEVMGMT_IDs.h:243
TxPowerLevel_11_dBm
@ TxPowerLevel_11_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:325
ErrorCoding3_4_7
@ ErrorCoding3_4_7
Definition: WiMOD_SAP_DEVMGMT_IDs.h:310
TWiMOD_RtcAlarmType
TWiMOD_RtcAlarmType
This enum describes the possible RTC alarm types.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:475
OperationMode_Application
@ OperationMode_Application
Definition: WiMOD_SAP_DEVMGMT_IDs.h:442
TxPowerLevel_15_dBm
@ TxPowerLevel_15_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:329
TxPowerLevel_10_dBm
@ TxPowerLevel_10_dBm
Definition: WiMOD_SAP_DEVMGMT_IDs.h:324
TWiMODLR_DevMgmt_RtcAlarm::Options
TWiMOD_RtcAlarmType Options
Definition: WiMOD_SAP_DEVMGMT_IDs.h:489
WimodHciBaudrate_9600
@ WimodHciBaudrate_9600
Definition: WiMOD_SAP_DEVMGMT_IDs.h:503