Demo HCI Implementation for WiMOD-LR Devices  V1.3.1
WiMOD_SAP_DEVMGMT_IDs.h File Reference

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

#include "utils/WMDefs.h"
Include dependency graph for WiMOD_SAP_DEVMGMT_IDs.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  TWiMODLR_DevMgmt_DevInfo
 Structure containing basic information about the WiMOD device. More...
 
struct  TWiMODLR_DevMgmt_FwInfo
 Basic information about the current firmware of the WiMOD. More...
 
struct  TWiMODLR_DevMgmt_SystemStatus
 Basic information about system status of the WiMOD. More...
 
struct  TWiMODLR_DevMgmt_RadioConfig
 Structure containing the radio (stack) config parameters of the WiMOD (only for LR-BASE) More...
 
struct  TWiMODLR_DevMgmt_RtcAlarm
 Structure containing the RTC Alarm config parameters of the WiMOD. More...
 

Macros

#define DEVMGMT_SAP_ID   0x01
 
#define WiMOD_RTC_YEAR_OFFSET   2000
 
#define WIMOD_RTC_GET_SECONDS(t)   (t & 0x3F)
 
#define WIMOD_RTC_GET_MINUTES(t)   ((t >> 6) & 0x3F)
 
#define WIMOD_RTC_GET_MONTHS(t)   ((t >> 12) & 0x0F)
 
#define WIMOD_RTC_GET_HOURS(t)   ((t >> 16) & 0x1F)
 
#define WIMOD_RTC_GET_DAYS(t)   ((t >> 21) & 0x1F)
 
#define WIMOD_RTC_GET_YEARS(t)   (((t >> 26) & 0x3F) + WiMOD_RTC_YEAR_OFFSET)
 
#define WIMOD_RTC_MAKE_DATETIME_U32(s, m, h, dd, mm, yy)
 

Typedefs

typedef struct TWiMODLR_DevMgmt_DevInfo TWiMODLR_DevMgmt_DevInfo
 Structure containing basic information about the WiMOD device.
 
typedef enum TWiMOD_ModuleType TWiMOD_ModuleType
 This enum describes the WiMOD module types.
 
typedef struct TWiMODLR_DevMgmt_FwInfo TWiMODLR_DevMgmt_FwInfo
 Basic information about the current firmware of the WiMOD.
 
typedef struct TWiMODLR_DevMgmt_SystemStatus TWiMODLR_DevMgmt_SystemStatus
 Basic information about system status of the WiMOD.
 
typedef enum TRadioCfg_RadioMode TRadioCfg_RadioMode
 general operation mode of the radio part (only for LR-BASE)
 
typedef enum TRadioCfg_Modulation TRadioCfg_Modulation
 Modulation technique supported by the WiMOD (only for LR-BASE)
 
typedef enum TRadioCfg_LoRaBandwidth TRadioCfg_LoRaBandwidth
 Bandwidth settings for the LoRa modulation (only for LR-BASE)
 
typedef enum TRadioCfg_LoRaSpreadingFactor TRadioCfg_LoRaSpreadingFactor
 SpreadingFactors for LoRa modulation (only for LR-BASE)
 
typedef enum TRadioCfg_ErrorCoding TRadioCfg_ErrorCoding
 ErrorCoding settings (for LoRa modulation) (only for LR-BASE)
 
typedef enum TRadioCdf_TxPowerLevel TRadioCfg_PowerLevel
 TxPowerLevel settings (only for LR-BASE)
 
typedef enum TRadioCfg_RxControl TRadioCfg_RxControl
 RX Operation modes (only for LR-BASE)
 
typedef enum TRadioCfg_FskDatarate TRadioCfg_FskDatarate
 Settings for the FSK data rate (only for LR-BASE)
 
typedef enum TRadioCfg_PowerSavingMode TRadioCfg_PowerSavingMode
 Settings general PowerSaving mode (aka. Sleep mode)
 
typedef struct TWiMODLR_DevMgmt_RadioConfig TWiMODLR_DevMgmt_RadioConfig
 Structure containing the radio (stack) config parameters of the WiMOD (only for LR-BASE)
 
typedef enum TWiMOD_OperationMode TWiMOD_OperationMode
 This enum describes the possible operation modes of the WiMOD (only for LR-BASE).
 
typedef enum TWiMOD_RtcAlarmStatus TWiMOD_RtcAlarmStatus
 This enum describes the possible RTC alarm status types.
 
typedef enum TWiMOD_RtcAlarmType TWiMOD_RtcAlarmType
 This enum describes the possible RTC alarm types.
 
typedef struct TWiMODLR_DevMgmt_RtcAlarm TWiMODLR_DevMgmt_RtcAlarm
 Structure containing the RTC Alarm config parameters of the WiMOD.
 

Enumerations

enum  TWiMOD_ModuleType { ModuleType_iM880B = 0x98 }
 This enum describes the WiMOD module types. More...
 
enum  TRadioCfg_RadioMode { RadioMode_Standard = 0, RadioMode_Echo, RadioMode_Sniffer }
 general operation mode of the radio part (only for LR-BASE) More...
 
enum  TRadioCfg_Modulation { Modulation_LoRa = 0, Modulation_FSK }
 Modulation technique supported by the WiMOD (only for LR-BASE) More...
 
enum  TRadioCfg_LoRaBandwidth { LoRaBandwith_125kHz = 0, LoRaBandwith_250kHz, LoRaBandwith_500kHz }
 Bandwidth settings for the LoRa modulation (only for LR-BASE) More...
 
enum  TRadioCfg_LoRaSpreadingFactor {
  LoRa0_SF7 = 0, LoRa1_SF7, LoRa2_SF7, LoRa3_SF7,
  LoRa4_SF7, LoRa5_SF7, LoRa6_SF7, LoRa7_SF7,
  LoRa8_SF8, LoRa9_SF9, LoRa10_SF10, LoRa11_SF11,
  LoRa12_S12
}
 SpreadingFactors for LoRa modulation (only for LR-BASE) More...
 
enum  TRadioCfg_ErrorCoding {
  ErrorCoding0_4_5 = 0, ErrorCoding1_4_5, ErrorCoding2_4_6, ErrorCoding3_4_7,
  ErrorCoding4_4_8
}
 ErrorCoding settings (for LoRa modulation) (only for LR-BASE) More...
 
enum  TRadioCdf_TxPowerLevel {
  TxPowerLevel_5_dBm = 5, TxPowerLevel_6_dBm, TxPowerLevel_7_dBm, TxPowerLevel_8_dBm,
  TxPowerLevel_9_dBm, TxPowerLevel_10_dBm, TxPowerLevel_11_dBm, TxPowerLevel_12_dBm,
  TxPowerLevel_13_dBm, TxPowerLevel_14_dBm, TxPowerLevel_15_dBm, TxPowerLevel_16_dBm,
  TxPowerLevel_17_dBm, TxPowerLevel_18_dBm, TxPowerLevel_19_dBm, TxPowerLevel_20_dBm
}
 TxPowerLevel settings (only for LR-BASE) More...
 
enum  TRadioCfg_RxControl { RxCtrl_Receiver_Off = 0, RxCtrl_Receiver_AlwaysOn, RxCtrl_Receiver_RxWindowed }
 RX Operation modes (only for LR-BASE) More...
 
enum  TRadioCfg_FskDatarate { FskDatarate_50kbps = 0, FskDatarate_100kbps, FskDatarate_250kbps }
 Settings for the FSK data rate (only for LR-BASE) More...
 
enum  TRadioCfg_PowerSavingMode { PowerSaving_Off = 0, PowerSaving_On = 1 }
 Settings general PowerSaving mode (aka. Sleep mode) More...
 
enum  TWiMOD_OperationMode { OperationMode_Application = 0, OperationMode_Test }
 This enum describes the possible operation modes of the WiMOD (only for LR-BASE). More...
 
enum  TWiMOD_RtcAlarmStatus { RTC_Alarm_No_Alarm_Set = 0, RTC_Alarm_Alarm_Set }
 This enum describes the possible RTC alarm status types. More...
 
enum  TWiMOD_RtcAlarmType { RTC_Alarm_Single = 0, RTC_Alarm_DailyRepeated }
 This enum describes the possible RTC alarm types. More...
 

Detailed Description

Supporting IDs and definitions for the DeviceManagement ServiceAccessPoint.

Version
0.1
Author
(FB), IMST

Macro Definition Documentation

#define DEVMGMT_SAP_ID   0x01

SAP ID for the DevMmgt service

#define WIMOD_RTC_GET_DAYS (   t)    ((t >> 21) & 0x1F)

RTC macro for extracting the "day" part out of the 32bit timestamp

#define WIMOD_RTC_GET_HOURS (   t)    ((t >> 16) & 0x1F)

RTC macro for extracting the "hour" part out of the 32bit timestamp

#define WIMOD_RTC_GET_MINUTES (   t)    ((t >> 6) & 0x3F)

RTC macro for extracting the "minute" part out of the 32bit timestamp

#define WIMOD_RTC_GET_MONTHS (   t)    ((t >> 12) & 0x0F)

RTC macro for extracting the "month" part out of the 32bit timestamp

#define WIMOD_RTC_GET_SECONDS (   t)    (t & 0x3F)

RTC macro for extracting the "second" part out of the 32bit timestamp

#define WIMOD_RTC_GET_YEARS (   t)    (((t >> 26) & 0x3F) + WiMOD_RTC_YEAR_OFFSET)

RTC macro for extracting the "year" part out of the 32bit timestamp

#define WIMOD_RTC_MAKE_DATETIME_U32 (   s,
  m,
  h,
  dd,
  mm,
  yy 
)
Value:
(((UINT32)s) | ((UINT32)m << 6) \
| ((UINT32)mm << 12) \
| ((UINT32)h << 16) \
| ((UINT32)dd << 21) \
| ((UINT32)(yy-WiMOD_RTC_YEAR_OFFSET) << 26))
#define WiMOD_RTC_YEAR_OFFSET
Definition: WiMOD_SAP_DEVMGMT_IDs.h:468

RTC macro for generating a 32 bit timestamp out of a human readable format

#define WiMOD_RTC_YEAR_OFFSET   2000

year offset for the RTC macros

Enumeration Type Documentation

TxPowerLevel settings (only for LR-BASE)

Enumerator
TxPowerLevel_5_dBm 

5 dBm

TxPowerLevel_6_dBm 

6 dBm

TxPowerLevel_7_dBm 

7 dBm

TxPowerLevel_8_dBm 

8 dBm

TxPowerLevel_9_dBm 

9 dBm

TxPowerLevel_10_dBm 

10 dBm

TxPowerLevel_11_dBm 

11 dBm

TxPowerLevel_12_dBm 

12 dBm

TxPowerLevel_13_dBm 

13 dBm

TxPowerLevel_14_dBm 

14 dBm

TxPowerLevel_15_dBm 

15 dBm

TxPowerLevel_16_dBm 

16 dBm

TxPowerLevel_17_dBm 

17 dBm

TxPowerLevel_18_dBm 

18 dBm

TxPowerLevel_19_dBm 

19 dBm

TxPowerLevel_20_dBm 

20 dBm

ErrorCoding settings (for LoRa modulation) (only for LR-BASE)

Enumerator
ErrorCoding0_4_5 

ErrorCoding 4/5

ErrorCoding1_4_5 

ErrorCoding 4/5

ErrorCoding2_4_6 

ErrorCoding 4/6

ErrorCoding3_4_7 

ErrorCoding 4/7

ErrorCoding4_4_8 

ErrorCoding 4/8

Settings for the FSK data rate (only for LR-BASE)

Enumerator
FskDatarate_50kbps 

FSK modulation using 50 kbps

FskDatarate_100kbps 

FSK modulation using 100 kbps

FskDatarate_250kbps 

FSK modulation using 250 kbps

Bandwidth settings for the LoRa modulation (only for LR-BASE)

Enumerator
LoRaBandwith_125kHz 

125 kHz

LoRaBandwith_250kHz 

250 kHz

LoRaBandwith_500kHz 

500 kHz

SpreadingFactors for LoRa modulation (only for LR-BASE)

Enumerator
LoRa0_SF7 

Spreading Factor 7

LoRa1_SF7 

Spreading Factor 7

LoRa2_SF7 

Spreading Factor 7

LoRa3_SF7 

Spreading Factor 7

LoRa4_SF7 

Spreading Factor 7

LoRa5_SF7 

Spreading Factor 7

LoRa6_SF7 

Spreading Factor 7

LoRa7_SF7 

Spreading Factor 7

LoRa8_SF8 

Spreading Factor 8

LoRa9_SF9 

Spreading Factor 9

LoRa10_SF10 

Spreading Factor 10

LoRa11_SF11 

Spreading Factor 11

LoRa12_S12 

Spreading Factor 12

Modulation technique supported by the WiMOD (only for LR-BASE)

Enumerator
Modulation_LoRa 

LoRa modulation

Modulation_FSK 

FSK modulation

Settings general PowerSaving mode (aka. Sleep mode)

Enumerator
PowerSaving_Off 

Entering sleep mode is disabled

PowerSaving_On 

Entering sleep mode is allowed; (may influence LED and radio RX settings

general operation mode of the radio part (only for LR-BASE)

Enumerator
RadioMode_Standard 

normal operation mode

RadioMode_Echo 

DO NOT USE

RadioMode_Sniffer 

DO NOT USE

RX Operation modes (only for LR-BASE)

Enumerator
RxCtrl_Receiver_Off 

Disable the RX operation completely

RxCtrl_Receiver_AlwaysOn 

RX operation is always ON

RxCtrl_Receiver_RxWindowed 

RX operation is only used in defined time windows

This enum describes the WiMOD module types.

Enumerator
ModuleType_iM880B 

iM880B

This enum describes the possible operation modes of the WiMOD (only for LR-BASE).

Enumerator
OperationMode_Application 

normal application mode; full function set available

OperationMode_Test 

test mode; only the test function set is avaiable

This enum describes the possible RTC alarm status types.

Enumerator
RTC_Alarm_No_Alarm_Set 

RTC Alarm feature is not active

RTC_Alarm_Alarm_Set 

RTC Alarm feature is active

This enum describes the possible RTC alarm types.

Enumerator
RTC_Alarm_Single 

Single alarm that is triggered only once

RTC_Alarm_DailyRepeated 

Alarm that is repeated on daily bases