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

WiMOD_SAP_DEVMGMT_ProLink.h
Go to the documentation of this file.
1 /*
2 * WiMOD_SAP_DEVMGMT_ProLink.h
3 *
4 * Created on: Jan 3, 2022
5 * Author: tux
6 */
7
8 //------------------------------------------------------------------------------
38 //------------------------------------------------------------------------------
39
40
41
42 #ifndef ARDUINO_SAP_WIMOD_SAP_DEVMGMT_PROLINK_H_
43 #define ARDUINO_SAP_WIMOD_SAP_DEVMGMT_PROLINK_H_
44
45
46 //------------------------------------------------------------------------------
47 //
48 // Section Includes Files
49 //
50 //------------------------------------------------------------------------------
51
52 #include "WiMOD_SAP_DEVMGMT_Lorawan.h"
53 #include "WiMOD_SAP_DEVMGMT_ProLink_IDs.h"
54
55 //------------------------------------------------------------------------------
56 //
57 // Section class
58 //
59 //------------------------------------------------------------------------------
60
64 class WiMOD_SAP_DevMgmt_ProLink : public WiMOD_SAP_DevMgmt_Lorawan
65 {
66 public:
67 WiMOD_SAP_DevMgmt_ProLink(TWiMODLRHCI* hci, UINT8* buffer, UINT16 bufferSize);
68 virtual ~WiMOD_SAP_DevMgmt_ProLink(void);
69
70
71 virtual TWiMODLRResultCodes SetRadioStack(const TRadioStack_Mode& stackMode, UINT8* statusRsp);
72 virtual TWiMODLRResultCodes GetRadioStack(TRadioStack_Mode* stackMode, UINT8* statusRsp);
73
74 virtual TWiMODLRResultCodes SetDeviceConfig(const TProLinkDeviceConfig& config, UINT8* statusRsp);
75 virtual TWiMODLRResultCodes GetDeviceConfig(TProLinkDeviceConfig* config, UINT8* statusRsp);
76
77 virtual TWiMODLRResultCodes ResetDeviceConfig(UINT8* statusRsp);
78
79 virtual TWiMODLRResultCodes GetDeviceStatus(TProLinkDeviceStatus* devStatus, UINT8* statusRsp);
80 /* deprecated / unsupported by now*/
81 virtual TWiMODLRResultCodes GetSystemStatus(TWiMODLR_DevMgmt_SystemStatus* info, UINT8* statusRsp);
82
83 protected:
84 TWiMODLRResultCodes unsupportedCmd(UINT8* statusRsp);
85
86
87 };
88
89
90
91 #endif /* ARDUINO_SAP_WIMOD_SAP_DEVMGMT_PROLINK_H_ */
TProLinkDeviceStatus::LoRaWAN_Rx1CDataPackets
UINT32 LoRaWAN_Rx1CDataPackets
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:110
TProLinkDeviceStatus
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:94
WiMOD_SAP_DEVMGMT_Lorawan.h
WiMOD_SAP_DEVMGMT_ProLink.h
TProLinkDeviceStatus::NvmStatus
UINT16 NvmStatus
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:101
DEVMGMT_SAP_ID
#define DEVMGMT_SAP_ID
Definition: WiMOD_SAP_DEVMGMT_IDs.h:61
TProLinkDeviceStatus::LoRaWAN_TxUDataPackets
UINT32 LoRaWAN_TxUDataPackets
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:106
TWiMODLRHCI
Internal helper class for processing SLIP frames.
Definition: WiMODLRHCI.h:235
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
WiMOD_SAP_DevMgmt_ProLink::~WiMOD_SAP_DevMgmt_ProLink
virtual ~WiMOD_SAP_DevMgmt_ProLink(void)
Destructor.
Definition: WIMOD_SAP_DEVMGMT_ProLink.cpp:69
WiMODLR_RESULT_TRANMIT_ERROR
@ WiMODLR_RESULT_TRANMIT_ERROR
Definition: WiMODLRHCI.h:154
TProLinkDeviceStatus::LRBASE_TxPackets
UINT32 LRBASE_TxPackets
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:122
TWiMODLR_HCIMessage
basic low level HCI message structure used for all serial messages to/from WiMOD
Definition: WiMODLRHCI.h:120
WiMODLR_RESULT_OK
@ WiMODLR_RESULT_OK
Definition: WiMODLRHCI.h:151
TProLinkDeviceStatus::LoRaWAN_Rx1UDataPackets
UINT32 LoRaWAN_Rx1UDataPackets
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:109
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
WiMOD_SAP_DevMgmt_ProLink::WiMOD_SAP_DevMgmt_ProLink
WiMOD_SAP_DevMgmt_ProLink(TWiMODLRHCI *hci, UINT8 *buffer, UINT16 bufferSize)
Constructor.
Definition: WIMOD_SAP_DEVMGMT_ProLink.cpp:59
TWiMODLR_HCIMessage::Payload
UINT8 Payload[WIMODLR_HCI_MSG_PAYLOAD_SIZE]
Definition: WiMODLRHCI.h:132
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
TWiMODLRResultCodes
TWiMODLRResultCodes
Result codes for the local serial communication itself.
Definition: WiMODLRHCI.h:149
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
TProLinkDeviceConfig
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:82
WiMOD_SAP_DevMgmt_ProLink::GetSystemStatus
virtual TWiMODLRResultCodes GetSystemStatus(TWiMODLR_DevMgmt_SystemStatus *info, UINT8 *statusRsp)
GetSystemStatus Cmd - Get basic info about the system status of WiMOD.
Definition: WIMOD_SAP_DEVMGMT_ProLink.cpp:200
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
WiMOD_SAP_DevMgmt_Lorawan
Implementation for the ServiceAccessPoint DeviceManagement.
Definition: WiMOD_SAP_DEVMGMT_Lorawan.h:63
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
TWiMODLR_DevMgmt_SystemStatus
Basic information about system status of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:234
WiMOD_SAP_DEVMGMT_ProLink_IDs.h
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
WiMOD_SAP_DevMgmt_ProLink
Implementation for the ServiceAccessPoint DeviceManagement.
Definition: WiMOD_SAP_DEVMGMT_ProLink.h:64