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

WiMOD_SAP_DEVMGMT_PLUS.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
31 //------------------------------------------------------------------------------
32
33
34 #ifndef ARDUINO_SAP_WIMOD_SAP_DEVMGMT_PLUS_H_
35 #define ARDUINO_SAP_WIMOD_SAP_DEVMGMT_PLUS_H_
36
37 //------------------------------------------------------------------------------
38 //
39 // Section Includes Files
40 //
41 //------------------------------------------------------------------------------
42
43 #include "WiMOD_SAP_DEVMGMT.h"
44 #include "WiMOD_SAP_DEVMGMT_PLUS_IDs.h"
45 //------------------------------------------------------------------------------
46 //
47 // Section class
48 //
49 //------------------------------------------------------------------------------
50
54 class WiMOD_SAP_DevMgmt_Plus : public WiMOD_SAP_DevMgmt
55 {
56 public:
57 WiMOD_SAP_DevMgmt_Plus(TWiMODLRHCI* hci, UINT8* buffer, UINT16 bufferSize);
58 virtual ~WiMOD_SAP_DevMgmt_Plus(void);
59
60 virtual TWiMODLRResultCodes GetRadioConfig(TWiMODLR_DevMgmt_RadioConfig* radioCfg, UINT8* statusRsp);
61 virtual TWiMODLRResultCodes GetRadioConfig(TWiMODLR_DevMgmt_RadioConfigPlus* radioCfg, UINT8* statusRsp);
62
63 virtual TWiMODLRResultCodes SetRadioConfig(const TWiMODLR_DevMgmt_RadioConfig* radioCfg, UINT8* statusRsp);
64 virtual TWiMODLRResultCodes SetRadioConfig(const TWiMODLR_DevMgmt_RadioConfigPlus* radioCfg, UINT8* statusRsp, UINT8 wrgParamBM[] = NULL);
65
66 virtual TWiMODLRResultCodes GetSystemStatus(TWiMODLR_DevMgmt_SystemStatus* info, UINT8* statusRsp);
67 virtual TWiMODLRResultCodes GetSystemStatus(TWiMODLR_DevMgmt_SystemStatusPlus* info, UINT8* statusRsp);
68
69 protected:
70 virtual TWiMODLRResultCodes unsupportedCmd(UINT8* statusRsp);
71
72 private:
73 };
74
75
76 #endif /* ARDUINO_SAP_WIMOD_SAP_DEVMGMT_PLUS_H_ */
TWiMODLR_DevMgmt_RadioConfigPlus::Modulation
TRadioCfg_ModulationPlus Modulation
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:305
TWiMODLR_DevMgmt_SystemStatusPlus::SysTickResolution
UINT8 SysTickResolution
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:334
WiMOD_SAP_DEVMGMT_PLUS_IDs.h
TWiMODLR_DevMgmt_SystemStatusPlus::RxCRCError
UINT32 RxCRCError
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:342
TRadioCfg_RadioModePlus
TRadioCfg_RadioModePlus
general operation mode of the radio part (only for LR-BASE_PLUS)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:91
TRadioCfg_FLRCErrorCodingPlus
TRadioCfg_FLRCErrorCodingPlus
ErrorCoding settings (for FLRC modulation) (only for LR-BASE_PLUS)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:202
TWiMODLR_DevMgmt_RadioConfigPlus::MiscOptions
UINT8 MiscOptions
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:320
TWiMODLR_DevMgmt_SystemStatusPlus::SysTickCounter
UINT32 SysTickCounter
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:335
DEVMGMT_SAP_ID
#define DEVMGMT_SAP_ID
Definition: WiMOD_SAP_DEVMGMT_IDs.h:61
TWiMODLR_DevMgmt_RadioConfigPlus::FSKBandWidth
TRadioCfg_FSKBandwidthPlus FSKBandWidth
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:311
TWiMODLR_DevMgmt_RadioConfigPlus::TxDeviceAddress
UINT16 TxDeviceAddress
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:304
TWiMODLR_DevMgmt_RadioConfigPlus
Structure containing the radio (stack) config parameters of the WiMOD (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:292
TRadioCfg_FSKBandwidthPlus
TRadioCfg_FSKBandwidthPlus
Bitrate/Bandwidth settings for the FSK modulation (only for LR-BASE_PLUS)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:148
TRadioCfg_LoRaBandwidthPlus
TRadioCfg_LoRaBandwidthPlus
Bandwidth settings for the LoRa modulation (only for LR-BASE_PLUS)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:116
WiMOD_SAP_DevMgmt
Implementation for the ServiceAccessPoint DeviceManagement.
Definition: WiMOD_SAP_DEVMGMT.h:109
TWiMODLR_DevMgmt_SystemStatusPlus::TxError
UINT32 TxError
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:344
TRadioCfg_TxControlPlus
TRadioCfg_TxControlPlus
TX Operation modes (only for LR-BASE_PLUS)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:273
TWiMODLRHCI
Internal helper class for processing SLIP frames.
Definition: WiMODLRHCI.h:235
TWiMODLR_DevMgmt_SystemStatusPlus::TxMediaBusyEvents
UINT32 TxMediaBusyEvents
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:345
TWiMODLR_DevMgmt_RadioConfigPlus::FLRCBandWidth
TRadioCfg_FLRCBandwidthPlus FLRCBandWidth
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:310
WiMODLR_RESULT_TRANMIT_ERROR
@ WiMODLR_RESULT_TRANMIT_ERROR
Definition: WiMODLRHCI.h:154
TRadioCfg_RxControlPlus
TRadioCfg_RxControlPlus
RX Operation modes (only for LR-BASE_PLUS)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:262
TRadioCfg_PowerSavingModePlus
TRadioCfg_PowerSavingModePlus
Settings general PowerSaving mode (aka. Sleep mode) (only for LR-BASE_PLUS)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:282
TRadioCfg_PowerLevelPlus
enum TRadioCfg_TxPowerLevelPlus TRadioCfg_PowerLevelPlus
TxPowerLevel settings (only for LR-BASE_PLUS)
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
WiMOD_SAP_DEVMGMT.h
TWiMODLR_DevMgmt_RadioConfigPlus::TxGroupAddress
UINT8 TxGroupAddress
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:302
LRBASE_PLUS_Modulation_FLRC
@ LRBASE_PLUS_Modulation_FLRC
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:104
TWiMODLR_DevMgmt_RadioConfigPlus::RfFreq_MSB
UINT8 RfFreq_MSB
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:308
WiMOD_SAP_DevMgmt_Plus::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_PLUS.cpp:338
TWiMODLR_DevMgmt_SystemStatusPlus
Basic information about system status of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:331
TWiMODLR_DevMgmt_RadioConfigPlus::LbtThreshold
INT16 LbtThreshold
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:322
TWiMODLR_DevMgmt_SystemStatusPlus::TxPackets
UINT32 TxPackets
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:343
TWiMODLR_DevMgmt_SystemStatusPlus::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:333
TWiMODLR_HCIMessage::Length
UINT16 Length
Definition: WiMODLRHCI.h:123
TWiMODLR_DevMgmt_RadioConfigPlus::StoreNwmFlag
UINT8 StoreNwmFlag
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:298
TWiMODLR_HCIMessage::Payload
UINT8 Payload[WIMODLR_HCI_MSG_PAYLOAD_SIZE]
Definition: WiMODLRHCI.h:132
TRadioCfg_FLRCBandwidthPlus
TRadioCfg_FLRCBandwidthPlus
Bandwidth settings for the LoRa modulation (only for LR-BASE_PLUS)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:132
TWiMODLR_DevMgmt_RadioConfigPlus::GroupAddress
UINT8 GroupAddress
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:301
LRBASE_PLUS_LoRaBandwith_200kHz
@ LRBASE_PLUS_LoRaBandwith_200kHz
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:118
TWiMODLR_DevMgmt_SystemStatusPlus::RxAddressMatch
UINT32 RxAddressMatch
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:341
TRadioCfg_LoRaErrorCodingPlus
TRadioCfg_LoRaErrorCodingPlus
ErrorCoding settings (for LoRa modulation) (only for LR-BASE_PLUS)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:182
TWiMODLR_DevMgmt_SystemStatusPlus::RxPackets
UINT32 RxPackets
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:340
TWiMODLR_DevMgmt_RadioConfigPlus::DeviceAddress
UINT16 DeviceAddress
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:303
TWiMODLR_DevMgmt_RadioConfigPlus::LoRaBandWidth
TRadioCfg_LoRaBandwidthPlus LoRaBandWidth
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:309
TWiMODLR_DevMgmt_RadioConfigPlus::LoRaErrorCoding
TRadioCfg_LoRaErrorCodingPlus LoRaErrorCoding
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:313
LRBASE_PLUS_FLRC_ErrorCoding_1_2
@ LRBASE_PLUS_FLRC_ErrorCoding_1_2
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:204
TRadioCfg_ModulationPlus
TRadioCfg_ModulationPlus
Modulation technique supported by the WiMOD (only for LR-BASE_PLUS)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:101
TWiMODLR_DevMgmt_RadioConfigPlus::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:295
TWiMODLR_DevMgmt_RadioConfigPlus::RxControl
TRadioCfg_RxControlPlus RxControl
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:317
LRBASE_PLUS_Modulation_LoRa
@ LRBASE_PLUS_Modulation_LoRa
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:103
LRBASE_PLUS_Modulation_FSK
@ LRBASE_PLUS_Modulation_FSK
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:105
TWiMODLR_DevMgmt_RadioConfigPlus::TxControl
TRadioCfg_TxControlPlus TxControl
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:316
TWiMODLR_DevMgmt_SystemStatusPlus::ExtraStatus
UINT16 ExtraStatus
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:339
LRBASE_PLUS_LoRa_ErrorCoding_4_5
@ LRBASE_PLUS_LoRa_ErrorCoding_4_5
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:184
TWiMODLR_DevMgmt_SystemStatusPlus::RtcTime
UINT32 RtcTime
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:336
TWiMODLR_DevMgmt_RadioConfigPlus::RfFreq_LSB
UINT8 RfFreq_LSB
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:306
TWiMODLR_DevMgmt_RadioConfigPlus::RfFreq_MID
UINT8 RfFreq_MID
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:307
WiMOD_SAP_DEVMGMT_PLUS.h
TWiMODLR_DevMgmt_RadioConfigPlus::RadioMode
TRadioCfg_RadioModePlus RadioMode
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:300
TWiMODLR_DevMgmt_RadioConfigPlus::PowerSavingMode
TRadioCfg_PowerSavingModePlus PowerSavingMode
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:321
TWiMODLRResultCodes
TWiMODLRResultCodes
Result codes for the local serial communication itself.
Definition: WiMODLRHCI.h:149
TWiMODLR_DevMgmt_RadioConfigPlus::LoRaSpreadingFactor
TRadioCfg_LoRaSpreadingFactorPlus LoRaSpreadingFactor
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:312
WiMOD_SAP_DevMgmt_Plus::~WiMOD_SAP_DevMgmt_Plus
virtual ~WiMOD_SAP_DevMgmt_Plus(void)
Destructor.
Definition: WiMOD_SAP_DEVMGMT_PLUS.cpp:69
TWiMODLR_DevMgmt_SystemStatusPlus::BatteryStatus
UINT16 BatteryStatus
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:338
WiMOD_SAP_DevMgmt_Plus::WiMOD_SAP_DevMgmt_Plus
WiMOD_SAP_DevMgmt_Plus(TWiMODLRHCI *hci, UINT8 *buffer, UINT16 bufferSize)
Constructor.
Definition: WiMOD_SAP_DEVMGMT_PLUS.cpp:59
TWiMODLR_DevMgmt_RadioConfigPlus::PowerLevel
TRadioCfg_PowerLevelPlus PowerLevel
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:315
TWiMODLR_DevMgmt_RadioConfig
Structure containing the radio (stack) config parameters of the WiMOD (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:406
TWiMODLR_DevMgmt_RadioConfigPlus::LedControl
UINT8 LedControl
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:319
LRBASE_PLUS_FLRCBandwith_0_260MBs_0_3_MHz_DSB
@ LRBASE_PLUS_FLRCBandwith_0_260MBs_0_3_MHz_DSB
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:134
TWiMODLR_DevMgmt_SystemStatus
Basic information about system status of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:234
WiMOD_SAP_DevMgmt_Plus::SetRadioConfig
virtual TWiMODLRResultCodes SetRadioConfig(const TWiMODLR_DevMgmt_RadioConfig *radioCfg, UINT8 *statusRsp)
SetRadioConfig Cmd - Set the radio settings of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_PLUS.cpp:205
WiMOD_SAP_DevMgmt_Plus
Implementation for the ServiceAccessPoint DeviceManagement.
Definition: WiMOD_SAP_DEVMGMT_PLUS.h:54
WiMOD_SAP_DevMgmt_Plus::GetRadioConfig
virtual TWiMODLRResultCodes GetRadioConfig(TWiMODLR_DevMgmt_RadioConfig *radioCfg, UINT8 *statusRsp)
GetRadioConfig Cmd - Get the radio settings of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_PLUS.cpp:79
TRadioCfg_LoRaSpreadingFactorPlus
TRadioCfg_LoRaSpreadingFactorPlus
SpreadingFactors for LoRa modulation (only for LR-BASE_PLUS)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:162
TWiMODLR_DevMgmt_RadioConfigPlus::FLRCErrorCoding
TRadioCfg_FLRCErrorCodingPlus FLRCErrorCoding
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:314
TWiMODLR_DevMgmt_RadioConfigPlus::RxWindowTime
UINT16 RxWindowTime
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:318
TWiMODLR_DevMgmt_SystemStatusPlus::NvmStatus
UINT16 NvmStatus
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:337
LRBASE_PLUS_FSKBandwith_2_0MBs_2_4_MHz
@ LRBASE_PLUS_FSKBandwith_2_0MBs_2_4_MHz
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:150