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

WiMOD_SAP_DEVMGMT_ProLink_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.3
36 * FOR FIRMWARE: LoRaWAN PROLINK
37 *
38 * SEE FILE: ProLink_LoRaWAN_EndNode_Modem_HCI_Spec_v1_3.pdf for detailed information
39 */
40
41
42 #ifndef ARDUINO_SAP_WIMOD_SAP_DEVMGMT_PROLINK_IDS_H_
43 #define ARDUINO_SAP_WIMOD_SAP_DEVMGMT_PROLINK_IDS_H_
44
45
46
47 // Message IDs
48 #define PROLINK_DEVMGMT_MSG_GET_DEVICE_STATUS_REQ 0x17
49 #define PROLINK_DEVMGMT_MSG_GET_DEVICE_STATUS_RSP 0x18
50
51 #define PROLINK_DEVMGMT_MSG_SET_DEVICE_CONFIG_REQ 0x25
52 #define PROLINK_DEVMGMT_MSG_SET_DEVICE_CONFIG_RSP 0x26
53
54 #define PROLINK_DEVMGMT_MSG_GET_DEVICE_CONFIG_REQ 0x27
55 #define PROLINK_DEVMGMT_MSG_GET_DEVICE_CONFIG_RSP 0x28
56
57 #define PROLINK_DEVMGMT_MSG_RESET_DEVICE_CONFIG_REQ 0x29
58 #define PROLINK_DEVMGMT_MSG_RESET_DEVICE_CONFIG_RSP 0x2A
59
60 #define PROLINK_DEVMGMT_MSG_SET_RADIO_STACK_REQ 0x39
61 #define PROLINK_DEVMGMT_MSG_SET_RADIO_STACK_RSP 0x3A
62
63 #define PROLINK_DEVMGMT_MSG_GET_RADIO_STACK_REQ 0x3B
64 #define PROLINK_DEVMGMT_MSG_GET_RADIO_STACK_RSP 0x3C
65
66 //------------------------------------------------------------------------------
67
71 typedef enum TRadioStack_Mode
72 {
73 RadioStack_LoRaWAN = 0,
74 RadioStack_PROPRIETARY_LR_BASE
76 } TRadioStack_Mode;
77
78
79 // bit field for Misc.Options in TProLinkDeviceConfig structure
80 #define PROLINK_DEVICE_CFG_MISC_HCI_PWR_UP_IND_ENABLED (1 << 3)
81
82 typedef struct TProLinkDeviceConfig
83 {
84 /* reserved 1*/
85 UINT8 PowerSavingMode;
86 /* reserved 2*/
87 UINT8 MiscOptions;
89 }TProLinkDeviceConfig;
90
91
92
93
94 typedef struct TProLinkDeviceStatus
95 {
96 /*common part*/
97 UINT8 Status;
98 UINT8 SysTickResolution;
99 UINT32 SysTickCounter;
100 UINT32 RtcTime;
101 UINT16 NvmStatus;
102 UINT16 BatteryStatus;
103 UINT16 ExtraStatus;
105 /*LoRaWAN part*/
106 UINT32 LoRaWAN_TxUDataPackets;
107 UINT32 LoRaWAN_TxCDataPackets;
108 UINT32 LoRaWAN_TxError;
109 UINT32 LoRaWAN_Rx1UDataPackets;
110 UINT32 LoRaWAN_Rx1CDataPackets;
111 UINT32 LoRaWAN_Rx1MicError;
112 UINT32 LoRaWAN_Rx2UDataPackets;
113 UINT32 LoRaWAN_Rx2CDataPackets;
114 UINT32 LoRaWAN_Rx2MicError;
115 UINT32 LoRaWAN_TxJoin;
116 UINT32 LoRaWAN_RxAccept;
118 /*proprietary part (LR-BASE)*/
119 UINT32 LRBASE_RxPackets;
120 UINT32 LRBASE_RxAddressMatch;
121 UINT32 LRBASE_RxCRCError;
122 UINT32 LRBASE_TxPackets;
123 UINT32 LRBASE_TxError;
124 UINT32 LRBASE_TxMediaBusyEvents;
126 } TProLinkDeviceStatus;
127
128
129 #endif /* ARDUINO_SAP_WIMOD_SAP_DEVMGMT_PROLINK_IDS_H_ */
TProLinkDeviceStatus::LoRaWAN_Rx1CDataPackets
UINT32 LoRaWAN_Rx1CDataPackets
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:110
TProLinkDeviceStatus
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:94
TProLinkDeviceStatus::NvmStatus
UINT16 NvmStatus
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:101
TProLinkDeviceStatus::LoRaWAN_TxUDataPackets
UINT32 LoRaWAN_TxUDataPackets
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:106
TProLinkDeviceStatus::LoRaWAN_Rx2MicError
UINT32 LoRaWAN_Rx2MicError
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:114
TProLinkDeviceStatus::LRBASE_TxError
UINT32 LRBASE_TxError
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:123
TProLinkDeviceStatus::LRBASE_TxPackets
UINT32 LRBASE_TxPackets
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:122
TProLinkDeviceStatus::LoRaWAN_Rx1UDataPackets
UINT32 LoRaWAN_Rx1UDataPackets
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:109
RadioStack_PROPRIETARY_LR_BASE
@ RadioStack_PROPRIETARY_LR_BASE
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:74
TProLinkDeviceStatus::BatteryStatus
UINT16 BatteryStatus
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:102
TProLinkDeviceStatus::LoRaWAN_TxJoin
UINT32 LoRaWAN_TxJoin
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:115
TProLinkDeviceStatus::LRBASE_TxMediaBusyEvents
UINT32 LRBASE_TxMediaBusyEvents
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:124
TProLinkDeviceStatus::LoRaWAN_Rx1MicError
UINT32 LoRaWAN_Rx1MicError
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:111
TProLinkDeviceStatus::ExtraStatus
UINT16 ExtraStatus
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:103
TProLinkDeviceConfig::MiscOptions
UINT8 MiscOptions
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:87
TProLinkDeviceStatus::LoRaWAN_Rx2UDataPackets
UINT32 LoRaWAN_Rx2UDataPackets
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:112
TProLinkDeviceStatus::LoRaWAN_RxAccept
UINT32 LoRaWAN_RxAccept
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:116
TProLinkDeviceStatus::LoRaWAN_Rx2CDataPackets
UINT32 LoRaWAN_Rx2CDataPackets
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:113
TProLinkDeviceStatus::SysTickCounter
UINT32 SysTickCounter
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:99
TRadioStack_Mode
TRadioStack_Mode
Radio Stack Mode(only for ProLink)
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:71
TProLinkDeviceConfig::PowerSavingMode
UINT8 PowerSavingMode
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:85
RadioStack_LoRaWAN
@ RadioStack_LoRaWAN
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:73
TProLinkDeviceConfig
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:82
TProLinkDeviceStatus::LRBASE_RxPackets
UINT32 LRBASE_RxPackets
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:119
TProLinkDeviceStatus::LRBASE_RxCRCError
UINT32 LRBASE_RxCRCError
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:121
TProLinkDeviceStatus::SysTickResolution
UINT8 SysTickResolution
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:98
TProLinkDeviceStatus::RtcTime
UINT32 RtcTime
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:100
TProLinkDeviceStatus::LoRaWAN_TxCDataPackets
UINT32 LoRaWAN_TxCDataPackets
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:107
TProLinkDeviceStatus::LRBASE_RxAddressMatch
UINT32 LRBASE_RxAddressMatch
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:120
TProLinkDeviceStatus::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:97
TProLinkDeviceStatus::LoRaWAN_TxError
UINT32 LoRaWAN_TxError
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:108