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

WiMOD_SAP_DEVMGMT.h
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
31 //------------------------------------------------------------------------------
32
33
34 #ifndef ARDUINO_WIMOD_SAP_DEVMGMT_H_
35 #define ARDUINO_WIMOD_SAP_DEVMGMT_H_
36
37
38 /*
39 * THIS IS AN EXAMPLE IMPLEMENTATION ACCORDING THE THE HCI SPEC: V1.8
40 * FOR FIRMWARE: LR-BASE
41 *
42 * SEE FILE: WiMOD_LR_Base_HCI_Spec_V1_8.pdf for detailed information
43 *
44 */
45
46 //------------------------------------------------------------------------------
47 //
48 // Section Includes Files
49 //
50 //------------------------------------------------------------------------------
51
52 #include "WiMOD_SAP_DEVMGMT_IDs.h"
53 #include "../HCI/WiMODLRHCI.h"
54
55 /*
56 * C++11 supports a better way for function pointers / function objects
57 * But C++11 mode is not supported by all platforms.
58 */
59 #ifdef WIMOD_USE_CPP11
60 #include <functional>
61 #endif
62
63 //------------------------------------------------------------------------------
64 //
65 // Section defines
66 //
67 //------------------------------------------------------------------------------
69 #define WiMOD_DEVMGMT_MSG_SIZE (100)
70
71
72 //-----------------------------------------------------------------------------
73 //
74 // types for callback functions
75 //
76 //-----------------------------------------------------------------------------
77
78 // C++11 check
79 #ifdef WIMOD_USE_CPP11
80 /* C++11 function callback definitions */
81
83 typedef std::function<void (void)> TDevMgmtPowerUpCallback;
84
85
87 typedef std::function<void (void)> TDevMgmtRtcAlarmCallback;
88
89 #else
90 /* pre C++11 function callback definitions */
91
93 typedef void (*TDevMgmtPowerUpCallback)(void);
94
96 typedef void (*TDevMgmtRtcAlarmCallback)(void);
97
98 #endif
99
100 //------------------------------------------------------------------------------
101 //
102 // Section class
103 //
104 //------------------------------------------------------------------------------
105
109 class WiMOD_SAP_DevMgmt {
110 public:
111 WiMOD_SAP_DevMgmt(TWiMODLRHCI* hci, UINT8* buffer, UINT16 bufferSize);
112 virtual ~WiMOD_SAP_DevMgmt(void);
113
114 virtual TWiMODLRResultCodes Ping(UINT8* statusRsp);
115
116 virtual TWiMODLRResultCodes Reset(UINT8* statusRsp);
117
118 virtual TWiMODLRResultCodes GetDeviceInfo(TWiMODLR_DevMgmt_DevInfo* info, UINT8* statusRsp);
119
120 virtual TWiMODLRResultCodes GetFirmwareInfo(TWiMODLR_DevMgmt_FwInfo* info, UINT8* statusRsp);
121
122 virtual TWiMODLRResultCodes GetSystemStatus(TWiMODLR_DevMgmt_SystemStatus* info, UINT8* statusRsp);
123
124 virtual TWiMODLRResultCodes GetRtc(UINT32* rtcTime, UINT8* statusRsp);
125
126 virtual TWiMODLRResultCodes SetRtc(const UINT32 rtcTime, UINT8* statusRsp);
127
128 virtual TWiMODLRResultCodes GetRadioConfig(TWiMODLR_DevMgmt_RadioConfig* radioCfg, UINT8* statusRsp);
129
130 virtual TWiMODLRResultCodes SetRadioConfig(const TWiMODLR_DevMgmt_RadioConfig* radioCfg, UINT8* statusRsp);
131
132 virtual TWiMODLRResultCodes ResetRadioConfig(UINT8* statusRsp);
133
134 virtual TWiMODLRResultCodes GetOperationMode(TWiMOD_OperationMode* opMode, UINT8* statusRsp);
135
136 virtual TWiMODLRResultCodes SetOperationMode(const TWiMOD_OperationMode opMode, UINT8* statusRsp);
137
138 virtual TWiMODLRResultCodes SetRadioMode(const TRadioCfg_RadioMode radioMode, UINT8* statusRsp);
139
140 virtual TWiMODLRResultCodes SetAesKey(const UINT8* key, UINT8* statusRsp);
141
142 virtual TWiMODLRResultCodes GetAesKey(UINT8* key, UINT8* statusRsp);
143
144 virtual TWiMODLRResultCodes SetRtcAlarm(const TWiMODLR_DevMgmt_RtcAlarm* rtcAlarm, UINT8* statusRsp);
145
146 virtual TWiMODLRResultCodes GetRtcAlarm(TWiMODLR_DevMgmt_RtcAlarm* rtcAlarm, UINT8* statusRsp);
147
148 virtual TWiMODLRResultCodes ClearRtcAlarm(UINT8* statusRsp);
149
150 virtual TWiMODLRResultCodes SetHCIConfig(TWiMODLR_DevMgmt_HciConfig& hciConfig, UINT8* statusRsp);
151
152 virtual TWiMODLRResultCodes GetHCIConfig(TWiMODLR_DevMgmt_HciConfig* hciConfig, UINT8* statusRsp);
153
154 void RegisterPowerUpIndicationClient(TDevMgmtPowerUpCallback cb);
155
156 void RegisterRtcAlarmIndicationClient(TDevMgmtRtcAlarmCallback cb);
157
158 void DispatchDeviceMgmtMessage(TWiMODLR_HCIMessage& rxMsg);
159 protected:
161 TWiMODLRHCI* HciParser;
162 UINT8* txPayload;
163 UINT16 txyPayloadSize;
164
165 TDevMgmtPowerUpCallback PowerUpCallack;
166 TDevMgmtRtcAlarmCallback RtcAlarmCallback;
168 private:
170
171
173 };
174
175
176 #endif /* ARDUINO_WIMOD_SAP_DEVMGMT_H_ */
WiMOD_SAP_LoRaWAN::SetDeviceEUI
virtual TWiMODLRResultCodes SetDeviceEUI(const UINT8 *deviceEUI, UINT8 *statusRsp)
Sets a new DeviceEUI (aka. IEEE-Address) to the WiMOD.
Definition: WiMOD_SAP_LORAWAN.cpp:1057
WiMODLRBASE_PLUS::GetSystemStatus
bool GetSystemStatus(TWiMODLR_DevMgmt_SystemStatusPlus *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the bas SystemStatus info from WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:340
TJoinedNwkIndicationCallback
void(* TJoinedNwkIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:154
WiMODProLink::SapGeneric
WiMOD_SAP_Generic SapGeneric
Definition: WiMODProLink.h:293
TWiMODLR_DevMgmt_FwInfo::BuildDateStr
UINT8 BuildDateStr[WIMOD_DEVMGMT_MAX_BUILDDATE_LEN]
Definition: WiMOD_SAP_DEVMGMT_IDs.h:226
WiMODLRBASE::Reset
bool Reset(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset Cmd - Do a local reboot of the WiMOD module.
Definition: WiMODLR_BASE.cpp:220
TWiMODLORAWAN_DevTimeAnsInfo
info data structure for LoRa device time request MAC command
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:114
LoRaWAN_NwkStatus_Inactive
@ LoRaWAN_NwkStatus_Inactive
Definition: WiMOD_SAP_LORAWAN_IDs.h:387
TProLinkDeviceStatus
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:94
WiMODLRBASE_PLUS::SetRtcAlarm
bool SetRtcAlarm(const TWiMODLR_DevMgmt_RtcAlarm *rtcAlarm, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets and enables the RTC alarm feature of the WiMOD.
Definition: WiMODLR_BASE_PLUS.cpp:805
WiMODLoRaWAN::Reset
bool Reset(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset Cmd - Reboots the WiMOD module.
Definition: WiMODLoRaWAN.cpp:465
WiMODProLink::GetLastResponseStatus
UINT8 GetLastResponseStatus(void)
Gets the last response code of the WiMOD of the last executed command.
Definition: WiMODProLink.cpp:3605
WiMODLoRaWAN::GetDeviceEUI
bool GetDeviceEUI(UINT8 *deviceEUI, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the DeviceEUI (aka. IEEE-Address) of the WiMOD.
Definition: WiMODLoRaWAN.cpp:2227
WiMODLoRaWAN::~WiMODLoRaWAN
~WiMODLoRaWAN(void)
Desctructor.
Definition: WiMODLoRaWAN.cpp:88
WiMODLRBASE_PLUS::Ping
bool Ping(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Ping Cmd - Checks serial connetion to WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:190
WiMODLoRaWAN::ConvertAppSKeyStrToArray
void ConvertAppSKeyStrToArray(char *appSKeyStr, uint8_t *appSKeyArray)
Converts a string containing an AppSKey string into a given byte array.
Definition: WiMODLoRaWAN.cpp:375
WiMODLRBASE::SetRadioConfig
bool SetRadioConfig(const TWiMODLR_DevMgmt_RadioConfig *radioCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the current configuration for the radio of the WiMOD module.
Definition: WiMODLR_BASE.cpp:521
TWiMODLR_DevMgmt_SystemStatus::RtcTime
UINT32 RtcTime
Definition: WiMOD_SAP_DEVMGMT_IDs.h:239
WiMODLRBASE_PLUS::RegisterAckRxTimeoutClient
void RegisterAckRxTimeoutClient(TRadioLinkAckRxTimeoutIndicationCallback cb)
Register a callback function for the Ack Timeout Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1750
WiMOD_SAP_LoRaWAN::RegisterRxUDataIndicationClient
void RegisterRxUDataIndicationClient(TRxUDataIndicationCallback cb)
Register a callback function for the event "RX U-Data Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:808
WiMODLRBASE_PLUS::RegisterCDataRxClient
void RegisterCDataRxClient(TRadioLinkCDataRxIndicationCallback cb)
Register a callback function for the RX C-Data Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1607
WiMOD_SAP_DevMgmt::SetRtc
virtual TWiMODLRResultCodes SetRtc(const UINT32 rtcTime, UINT8 *statusRsp)
SetRtc Cmd - Set the current RTC time/date of WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:322
TWiMODLR_DevMgmt_HciConfig::TxHoldTime
UINT8 TxHoldTime
Definition: WiMOD_SAP_DEVMGMT_IDs.h:527
WiMODLoRaWAN::RegisterTxUDataIndicationClient
void RegisterTxUDataIndicationClient(TTxUDataIndicationCallback cb)
Register a callback function for the event "TX U Data Indication".
Definition: WiMODLoRaWAN.cpp:1786
WiMODLoRaWAN::RegisterRxMacCmdIndicationClient
void RegisterRxMacCmdIndicationClient(TRxMacCmdIndicationCallback cb)
Register a callback function for the event "RX MAC Cmd Indication".
Definition: WiMODLoRaWAN.cpp:1849
WiMODProLink::SendRadioLinkUData
bool SendRadioLinkUData(const TWiMODLR_RadioLink_Msg *data, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to send transmit U-Data to a peer using proprietary LoRa mode.
Definition: WiMODProLink.cpp:3341
WiMODLRBASE_PLUS::SetRtc
bool SetRtc(const UINT32 rtcTime, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the current RTC values to WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:426
TRadioCfg_FskDatarate
TRadioCfg_FskDatarate
Settings for the FSK data rate (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:379
ProLink_LoRaWAN_Region_AU915
@ ProLink_LoRaWAN_Region_AU915
Definition: WiMOD_SAP_LORAWAN_ProLink.h:77
WiMOD_SAP_LoRaWAN::RegisterNoDataIndicationClient
void RegisterNoDataIndicationClient(TNoDataIndicationCallback cb)
Register a callback function for the event "TX Join Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:763
WiMODLoRaWAN::GetFirmwareInfo
bool GetFirmwareInfo(TWiMODLR_DevMgmt_FwInfo *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
GetFirmwareInfo Cmd - Gets the basic information about the firmware of the WiMOD.
Definition: WiMODLoRaWAN.cpp:544
TWiMODLR_DevMgmt_RadioConfig::PowerLevel
TRadioCfg_PowerLevel PowerLevel
Definition: WiMOD_SAP_DEVMGMT_IDs.h:426
TWiMODLORAWAN_RX_JoinedNwkData
Structure containing data of the joined network indication.
Definition: WiMOD_SAP_LORAWAN_IDs.h:551
TRxUDataIndicationCallback
void(* TRxUDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:166
TWiMODLORAWAN_RX_Data
Structure containing RX (user) payload data.
Definition: WiMOD_SAP_LORAWAN_IDs.h:514
TLoRaWANregion
TLoRaWANregion
LoRaWAN Region support.
Definition: WiMOD_SAP_LORAWAN.h:79
WiMODLoRaWAN::RegisterNoDataIndicationClient
void RegisterNoDataIndicationClient(TNoDataIndicationCallback cb)
Register a callback function for the event "TX Join Indication".
Definition: WiMODLoRaWAN.cpp:1691
TWiMODLORAWAN_SupportedBands::BandIndex
UINT8 BandIndex[(WiMODLORAWAN_APP_PAYLOAD_LEN/2)]
Definition: WiMOD_SAP_LORAWAN_IDs.h:666
TWiMODLORAWAN_SupportedBands::NumOfEntries
UINT8 NumOfEntries
Definition: WiMOD_SAP_LORAWAN_IDs.h:665
WiMODProLink::GetRadioStackConfig
bool GetRadioStackConfig(TWiMODProLinkLORAWAN_RadioStackConfig *data, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current radio config parameter set of the WiMOD.
Definition: WiMODProLink.cpp:2329
WiMODLoRaWAN::GetCustomConfig
bool GetCustomConfig(INT8 *rfGain, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the current offet for tx power level; expert level only.
Definition: WiMODLoRaWAN.cpp:2361
WiMODProLink::RegisterPowerUpIndicationClient
void RegisterPowerUpIndicationClient(TDevMgmtPowerUpCallback cb)
Register a callback function for the PowerUp Indication - optional -.
Definition: WiMODProLink.cpp:797
TWiMODLR_DevMgmt_DevInfo::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:174
WiMODLRBASE_PLUS::GetHciConfig
bool GetHciConfig(TWiMODLR_DevMgmt_HciConfig *hciConfig, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current HCI configuration of the WiMOD.
Definition: WiMODLR_BASE_PLUS.cpp:991
WiMODProLink::GetFirmwareInfo
bool GetFirmwareInfo(TWiMODLR_DevMgmt_FwInfo *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
GetFirmwareInfo Cmd - Gets the basic information about the firmware of the WiMOD.
Definition: WiMODProLink.cpp:546
WiMOD_SAP_LoRaWAN::FactoryReset
virtual TWiMODLRResultCodes FactoryReset(UINT8 *statusRsp)
Reset all internal settings to default values (incl. DevEUI)
Definition: WiMOD_SAP_LORAWAN.cpp:1024
DEVMGMT_SAP_ID
#define DEVMGMT_SAP_ID
Definition: WiMOD_SAP_DEVMGMT_IDs.h:61
WiMODProLink::SetJoinParameter
bool SetJoinParameter(TWiMODLORAWAN_JoinParams &joinParams, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the parameters used for the OTAA activation procedure.
Definition: WiMODProLink.cpp:1342
WiMODLRBASE_PLUS::calcFreqToRegister
void calcFreqToRegister(uint32_t freq, uint8_t *msb, uint8_t *mid, uint8_t *lsb)
Convert a frequency in Hz to the corresponding low level register values.
Definition: WiMODLR_BASE_PLUS.cpp:1809
WiMODLoRaWAN::DeactivateDevice
bool DeactivateDevice(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Deactivate the device (logical disconnect from lora network)
Definition: WiMODLoRaWAN.cpp:2114
TWiMODLR_DevMgmt_SystemStatus::RxAddressMatch
UINT32 RxAddressMatch
Definition: WiMOD_SAP_DEVMGMT_IDs.h:244
WiMODLoRaWAN::GetLastHciResult
TWiMODLRResultCodes GetLastHciResult(void)
Gets the last HCI result code from the last executed command.
Definition: WiMODLoRaWAN.cpp:2621
WiMODLRBASE::GetRadioConfig
bool GetRadioConfig(TWiMODLR_DevMgmt_RadioConfig *radioCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current configuration of the radio of the WiMOD module.
Definition: WiMODLR_BASE.cpp:471
WiMODProLink::GetRadioLinkRadioConfig
bool GetRadioLinkRadioConfig(TWiMODLR_ProLinkRadioLink_RadioConfig *radioCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the current RadioConfig used for the proprietary LoRa communication feature.
Definition: WiMODProLink.cpp:3153
WiMODLRBASE_PLUS::StopRadioLinkTest
bool StopRadioLinkTest(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to stop a running Radio Link Test.
Definition: WiMODLR_BASE_PLUS.cpp:2129
WiMOD_SAP_Generic::ExecuteGenericCmd
TWiMODLRResultCodes ExecuteGenericCmd(TWiMODLR_Generic_CmdInfo *info, UINT8 *statusRsp)
Reset Cmd - Do a reset / reboot of the WiMOD.
Definition: WiMOD_SAP_Generic.cpp:87
WiMODProLink::ConvertAppSKeyStrToArray
void ConvertAppSKeyStrToArray(char *appSKeyStr, uint8_t *appSKeyArray)
Converts a string containing an AppSKey string into a given byte array.
Definition: WiMODProLink.cpp:377
WiMODLoRaWAN::ClearRtcAlarm
bool ClearRtcAlarm(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Clears pending RTC Alarms of the WiMOD.
Definition: WiMODLoRaWAN.cpp:885
WiMODLRBASE::GetLastResponseStatus
UINT8 GetLastResponseStatus(void)
Gets the value of the last status response value of the WiMOD.
Definition: WiMODLR_BASE.cpp:1838
TWiMODLORAWAN_McastNoData
Structure containing a MultiCast Data.
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:176
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
WiMOD_SAP_LoRaWAN::JoinNetwork
virtual TWiMODLRResultCodes JoinNetwork(UINT8 *statusRsp)
Start joining the network via the OTAA procedure. Asynchronous process.
Definition: WiMOD_SAP_LORAWAN.cpp:246
WiMODLoRaWAN::ConvertAppKeyStrToArray
void ConvertAppKeyStrToArray(char *appKeyStr, uint8_t *appKeyArray)
Converts a string containing an App Key string into a given byte array.
Definition: WiMODLoRaWAN.cpp:336
ProLink_LoRaWAN_Region_AS923
@ ProLink_LoRaWAN_Region_AS923
Definition: WiMOD_SAP_LORAWAN_ProLink.h:78
WiMODLRBASE_PLUS::SapRadioLink
WiMOD_SAP_RadioLink SapRadioLink
Definition: WiMODLR_BASE_PLUS.h:223
TWiMODLORAWAN_NoData_Data
Structure containing infos of a NoData Indication message.
Definition: WiMOD_SAP_LORAWAN_IDs.h:648
WiMOD_SAP_RLT::StartRadioLinkTest
virtual TWiMODLRResultCodes StartRadioLinkTest(const TWiMODLR_RLT_Parameter *params, UINT8 *statusRsp)
Starts the integrated Radio Link Test mode/feature.
Definition: WiMOD_SAP_RLT.cpp:98
WiMODLRBASE_PLUS::GetSensorAppConfig
bool GetSensorAppConfig(TWiMODLR_SensorApp_Config *config, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to get the current config of the integrated Sensor App feature of the WiMOD.
Definition: WiMODLR_BASE_PLUS.cpp:2387
WiMOD_SAP_RadioLink::RegisterAckRxTimeoutClient
virtual void RegisterAckRxTimeoutClient(TRadioLinkAckRxTimeoutIndicationCallback cb)
Register a callback function for the Ack Timeout Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:623
WiMODLRBASE::~WiMODLRBASE
~WiMODLRBASE(void)
Destructor.
Definition: WiMODLR_BASE.cpp:88
TWiMODLR_DevMgmt_RadioConfig::LedControl
UINT8 LedControl
Definition: WiMOD_SAP_DEVMGMT_IDs.h:430
ProLink_LoRaWAN_Region_US915
@ ProLink_LoRaWAN_Region_US915
Definition: WiMOD_SAP_LORAWAN_ProLink.h:75
WiMOD_SAP_DevMgmt::SetHCIConfig
virtual TWiMODLRResultCodes SetHCIConfig(TWiMODLR_DevMgmt_HciConfig &hciConfig, UINT8 *statusRsp)
SetHCIConfig Cmd - Sets the HCI config options for the LR-BASE_PLUS firmware.
Definition: WiMOD_SAP_DEVMGMT.cpp:741
WiMODLRBASE_PLUS::RegisterPowerUpIndicationClient
void RegisterPowerUpIndicationClient(TDevMgmtPowerUpCallback cb)
Register a callback function for the PowerUp Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:916
WiMODLoRaWAN::SetJoinParameter
bool SetJoinParameter(TWiMODLORAWAN_JoinParams &joinParams, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the parameters used for the OTAA activation procedure.
Definition: WiMODLoRaWAN.cpp:1225
WiMODLRBASE_PLUS::RegisterBtnPressedClient
void RegisterBtnPressedClient(TRemoteCtrlBtnPressedIndicationCallback cb)
Register a callback function for the RemoteCtrl Btn Pressed Indication.
Definition: WiMODLR_BASE_PLUS.cpp:2638
WiMODLRBASE_PLUS::SetRadioConfig
bool SetRadioConfig(const TWiMODLR_DevMgmt_RadioConfigPlus *radioCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the current configuration for the radio of the WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:523
TWiMODLR_DevMgmt_RtcAlarm::AlarmStatus
TWiMOD_RtcAlarmStatus AlarmStatus
Definition: WiMOD_SAP_DEVMGMT_IDs.h:487
WiMODLoRaWAN::SetRadioStackConfig
bool SetRadioStackConfig(TWiMODLORAWAN_RadioStackConfig *data, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets a new radio config parameter set of the WiMOD.
Definition: WiMODLoRaWAN.cpp:2043
TWiMODLORAWAN_TxIndData
Activation data structure for LoRa network activation.
Definition: WiMOD_SAP_LORAWAN_IDs.h:472
WiMODLoRaWAN::FactoryReset
bool FactoryReset(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset all internal settings to default values (incl. DevEUI !!!)
Definition: WiMODLoRaWAN.cpp:2147
WiMOD_SAP_LoRaWAN_ProLink::RegisterLinkDisconnectIndicationClient
void RegisterLinkDisconnectIndicationClient(TLinkDisconnectIndicationCallback cb)
Register a callback function for the event "Link Disconnect Indication".
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:780
WiMODLoRaWAN::ConvertAppEuiStrToArray
void ConvertAppEuiStrToArray(char *appEuiStr, uint8_t *appEuiArray)
Converts a string containing an App EUI string into a given byte array.
Definition: WiMODLoRaWAN.cpp:317
WiMODLoRaWAN::SetDeviceEUI
bool SetDeviceEUI(const UINT8 *deviceEUI, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets a new DeviceEUI (aka. IEEE-Address) to the WiMOD.
Definition: WiMODLoRaWAN.cpp:2190
WiMODLoRaWAN::SapLoRaWan
WiMOD_SAP_LoRaWAN SapLoRaWan
Definition: WiMODLoRaWAN.h:223
WiMODLRBASE_PLUS::GetFirmwareInfo
bool GetFirmwareInfo(TWiMODLR_DevMgmt_FwInfo *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the basic FirmwareInfo from WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:301
WiMODLRBASE::Ping
bool Ping(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Ping Cmd - Checks serial connetion to WiMOD module.
Definition: WiMODLR_BASE.cpp:187
WiMODLoRaWAN::GetTxPowerLimitConfig
bool GetTxPowerLimitConfig(TWiMODLORAWAN_TxPwrLimitConfig *txPwrLimitCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the configured TX limits for all sub-bands.
Definition: WiMODLoRaWAN.cpp:2409
WiMOD_SAP_DevMgmt
Implementation for the ServiceAccessPoint DeviceManagement.
Definition: WiMOD_SAP_DEVMGMT.h:109
WiMOD_SAP_DevMgmt::GetAesKey
virtual TWiMODLRResultCodes GetAesKey(UINT8 *key, UINT8 *statusRsp)
GetAesKey Cmd - Get the 128bit AES that that is used for encryption.
Definition: WiMOD_SAP_DEVMGMT.cpp:609
WiMOD_SAP_SensorApp::RegisterSensorAckIndClient
virtual void RegisterSensorAckIndClient(TSensorAppAckIndicationCallback cb)
Register a callback function for the event "SensorApp Ack Data Indication".
Definition: WiMOD_SAP_SensorApp.cpp:289
WiMOD_SAP_LoRaWAN_ProLink::GetRadioStackConfig
virtual TWiMODLRResultCodes GetRadioStackConfig(TWiMODProLinkLORAWAN_RadioStackConfig *data, UINT8 *statusRsp)
Gets the current radio config parameter set of the WiMOD.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:340
WiMODLRBASE_PLUS::RegisterAckTxCallback
void RegisterAckTxCallback(TRadioLinkAckTxIndicationCallback cb)
Register a callback function for the TX Ack Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1794
TWiMODLRHCI
Internal helper class for processing SLIP frames.
Definition: WiMODLRHCI.h:235
WiMOD_SAP_LoRaWAN::ReactivateDevice
virtual TWiMODLRResultCodes ReactivateDevice(UINT32 *devAdr, UINT8 *statusRsp)
Re-Activates the device via the ABP procedure.
Definition: WiMOD_SAP_LORAWAN.cpp:167
FreqCalc_calcRegisterToFreq
uint32_t FreqCalc_calcRegisterToFreq(uint8_t msb, uint8_t mid, uint8_t lsb)
Translates given register values to a carrier frequency.
Definition: FreqCalc_SX127x.c:68
TRadioLinkUDataRxIndicationCallback
void(* TRadioLinkUDataRxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:115
FreqCalcSX1280_calcFreqToRegister
void FreqCalcSX1280_calcFreqToRegister(uint32_t freq, uint8_t *msb, uint8_t *mid, uint8_t *lsb)
Translates a given frequency to the according register values of the TRX.
Definition: FreqCalc_SX1280.c:45
TWiMODLORAWAN_McastData
Structure containing a MultiCast Data.
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:139
TWiMODLR_HCIMessage::SapID
UINT8 SapID
Definition: WiMODLRHCI.h:126
TWiMODLR_DevMgmt_RadioConfig::RxWindowTime
UINT16 RxWindowTime
Definition: WiMOD_SAP_DEVMGMT_IDs.h:429
WiMODLRBASE_PLUS::GetLastResponseStatus
UINT8 GetLastResponseStatus(void)
Gets the value of the last status response value of the WiMOD.
Definition: WiMODLR_BASE_PLUS.cpp:1919
WiMODProLink::GetNwkStatus
bool GetNwkStatus(TWiMODLORAWAN_NwkStatus_Data *nwkStatus, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current status of the network "connection".
Definition: WiMODProLink.cpp:2523
WiMOD_SAP_RadioLink::SetAckData
virtual TWiMODLRResultCodes SetAckData(const TWiMODLR_RadioLink_Msg *txMsg, UINT8 *statusRsp)
Sets additional user payload for the next ack frame to send.
Definition: WiMOD_SAP_RadioLink.cpp:481
WiMODLRBASE::SetRtcAlarm
bool SetRtcAlarm(const TWiMODLR_DevMgmt_RtcAlarm *rtcAlarm, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets and enables the RTC alarm feature of the WiMOD.
Definition: WiMODLR_BASE.cpp:796
WiMODLRBASE_PLUS::SetAckData
bool SetAckData(const TWiMODLR_RadioLink_Msg *txMsg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets additional user payload for the next ack frame to send.
Definition: WiMODLR_BASE_PLUS.cpp:1447
WiMODLoRaWAN::GetSupportedBands
bool GetSupportedBands(TWiMODLORAWAN_SupportedBands *supportedBands, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the supported bands of this firmware.
Definition: WiMODLoRaWAN.cpp:2386
WiMODLRBASE::RegisterUDataTxClient
void RegisterUDataTxClient(TRadioLinkUDataTxIndicationCallback cb)
Register a callback function for the TX U-Data Indication - optional -.
Definition: WiMODLR_BASE.cpp:1460
WiMODLRBASE::WiMODLRBASE
WiMODLRBASE(Stream &s)
Constructor.
Definition: WiMODLR_BASE.cpp:69
WiMODLRBASE_PLUS::GetRtc
bool GetRtc(UINT32 *rtcTime, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current RTC data info from WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:387
WiMODProLink::GetDeviceConfig
bool GetDeviceConfig(TProLinkDeviceConfig *config, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the common Device config of the WiMOD (only ProLink firmware)
Definition: WiMODProLink.cpp:1095
WiMODLRBASE::RegisterCDataTxClient
void RegisterCDataTxClient(TRadioLinkCDataTxIndicationCallback cb)
Register a callback function for the TX C-Data Indication - optional -.
Definition: WiMODLR_BASE.cpp:1575
WiMODLRBASE_PLUS::RegisterSensorAppDataIndClient
void RegisterSensorAppDataIndClient(TSensorAppSensorDataIndicationCallback cb)
Register a callback function for the SensorAppData Indication.
Definition: WiMODLR_BASE_PLUS.cpp:2479
WiMODProLink::SetTxPowerLimitConfig
bool SetTxPowerLimitConfig(TWiMODLORAWAN_TxPwrLimitConfig &txPwrLimitCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Set a single TX limit for a single sub-band.
Definition: WiMODProLink.cpp:2683
WiMOD_SAP_RLT::convert
virtual bool convert(TWiMODLR_HCIMessage &RxMsg, TWiMODLR_RLT_Status *statusData)
Convert a received low level HCI-Msg to a high-level SensorAckData structure.
Definition: WiMOD_SAP_RLT.cpp:191
WiMODLRBASE::SapDevMgmt
WiMOD_SAP_DevMgmt SapDevMgmt
Definition: WiMODLR_BASE.h:210
WiMODProLink::SetDeviceEUI
bool SetDeviceEUI(const UINT8 *deviceEUI, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets a new DeviceEUI (aka. IEEE-Address) to the WiMOD.
Definition: WiMODProLink.cpp:2438
WiMODLRBASE::SetRtc
bool SetRtc(const UINT32 rtcTime, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the current RTC values to WiMOD module.
Definition: WiMODLR_BASE.cpp:425
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
WiMODLRBASE::RegisterUDataRxClient
void RegisterUDataRxClient(TRadioLinkUDataRxIndicationCallback cb)
Register a callback function for the RX U-Data Indication - optional -.
Definition: WiMODLR_BASE.cpp:1418
TRadioCfg_RxControl
TRadioCfg_RxControl
RX Operation modes (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:347
WiMODLoRaWAN::SetRtcAlarm
bool SetRtcAlarm(const TWiMODLR_DevMgmt_RtcAlarm *rtcAlarm, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets and enables the RTC alarm feature of the WiMOD.
Definition: WiMODLoRaWAN.cpp:813
WiMODProLink::Reset
bool Reset(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset Cmd - Reboots the WiMOD module.
Definition: WiMODProLink.cpp:467
TWiMODLR_RadioLink_Msg
Structure containing a general RadioLink HCI message.
Definition: WiMOD_SAP_RadioLink_IDs.h:160
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
WiMOD_SAP_LoRaWAN::SetRadioStackConfig
virtual TWiMODLRResultCodes SetRadioStackConfig(TWiMODLORAWAN_RadioStackConfig *data, UINT8 *statusRsp)
Sets a new radio config parameter set of the WiMOD.
Definition: WiMOD_SAP_LORAWAN.cpp:886
WiMODLR_RESULT_TRANMIT_ERROR
@ WiMODLR_RESULT_TRANMIT_ERROR
Definition: WiMODLRHCI.h:154
TWiMODLORAWAN_NwkStatus_Data::NetworkStatus
UINT8 NetworkStatus
Definition: WiMOD_SAP_LORAWAN_IDs.h:621
WiMODLoRaWAN::ActivateDevice
bool ActivateDevice(TWiMODLORAWAN_ActivateDeviceData &activationData, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Activates the device via the ABP procedure.
Definition: WiMODLoRaWAN.cpp:1112
ProLink_LoRaWAN_FreqBand_AU_915
@ ProLink_LoRaWAN_FreqBand_AU_915
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:71
WiMODLRBASE_PLUS::GetDeviceInfo
bool GetDeviceInfo(TWiMODLR_DevMgmt_DevInfo *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the basic DeviceInfo from WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:262
WiMODLRBASE_PLUS::ExecuteGenericCmd
bool ExecuteGenericCmd(TWiMODLR_Generic_CmdInfo *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Generic Execution Function for HCI commands that are currently not implemented.
Definition: WiMODLR_BASE_PLUS.cpp:1979
TWiMODLORAWAN_NwkStatus_Data
Structure containing all data about LoRaWAN network status.
Definition: WiMOD_SAP_LORAWAN_IDs.h:619
WiMOD_SAP_LoRaWAN::RegisterRxAckIndicationClient
void RegisterRxAckIndicationClient(TRxAckIndicationCallback cb)
Register a callback function for the event "RX ACK (data) Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:868
WiMODLRBASE::GetDeviceInfo
bool GetDeviceInfo(TWiMODLR_DevMgmt_DevInfo *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the basic DeviceInfo from WiMOD module.
Definition: WiMODLR_BASE.cpp:259
WiMOD_SAP_LoRaWAN_ProLink::SendNwkTimeRequest
TWiMODLRResultCodes SendNwkTimeRequest(TWiMODLORAWAN_DevTimeReqInfo *devTimeInfo, UINT8 *statusRsp)
SendNwkTimeRequest Cmd - Sends a network device time request to WiMOD.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:485
WiMODLoRaWAN::RegisterTxCDataIndicationClient
void RegisterTxCDataIndicationClient(TTxCDataIndicationCallback cb)
Register a callback function for the event "TX C-Data Indication".
Definition: WiMODLoRaWAN.cpp:1738
TWiMODLR_DevMgmt_FwInfo
Basic information about the current firmware of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:220
WiMODProLink::RegisterRxUDataIndicationClient
void RegisterRxUDataIndicationClient(TRxUDataIndicationCallback cb)
Register a callback function for the event "RX U-Data Indication".
Definition: WiMODProLink.cpp:2049
WiMODLoRaWAN::GetSystemStatus
bool GetSystemStatus(TWiMODLR_DevMgmt_SystemStatusLorawan *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
GetSystemStatus Cmd - Gets the basic information about the system status of the WiMOD.
Definition: WiMODLoRaWAN.cpp:587
TRadioLinkAckRxIndicationCallback
void(* TRadioLinkAckRxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:130
WiMOD_SAP_LoRaWAN::SendUData
virtual TWiMODLRResultCodes SendUData(const TWiMODLORAWAN_TX_Data *data, UINT8 *statusRsp)
Tries to send transmit U-Data to network server via RF link.
Definition: WiMOD_SAP_LORAWAN.cpp:278
WiMOD_SAP_RadioLink_ProLink::SetRadioConfig
virtual TWiMODLRResultCodes SetRadioConfig(const TWiMODLR_ProLinkRadioLink_RadioConfig *radioCfg, UINT8 *statusRsp)
SetRadioConfig Cmd - Set the radio settings of the of the proprietary LR-BASE mode.
Definition: WiMOD_SAP_RadioLink_ProLink.cpp:197
TWiMODLR_DevMgmt_FwInfo::BuildCount
UINT16 BuildCount
Definition: WiMOD_SAP_DEVMGMT_IDs.h:225
WiMOD_SAP_LoRaWAN::RegisterJoinTxIndicationClient
virtual void RegisterJoinTxIndicationClient(TJoinTxIndicationCallback cb)
Register a callback function for the event "TX Join Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:406
WiMODProLink::SetJoinNonce
bool SetJoinNonce(const UINT16 joinNonce, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Set the Join Nonce for the next Join OTAA procedure.
Definition: WiMODProLink.cpp:2872
WiMODLRBASE_PLUS::WiMODLRBASE_PLUS
WiMODLRBASE_PLUS(Stream &s)
Constructor.
Definition: WiMODLR_BASE_PLUS.cpp:72
WiMODLoRaWAN::ConvertNwkSKeyStrToArray
void ConvertNwkSKeyStrToArray(char *nwkSKeyStr, uint8_t *nwkSKeyArray)
Converts a string containing an NwkSKey string into a given byte array.
Definition: WiMODLoRaWAN.cpp:355
WiMODLRBASE::RegisterRtcAlarmIndicationClient
void RegisterRtcAlarmIndicationClient(TDevMgmtRtcAlarmCallback cb)
Register a callback function for the RTC Alarm Indication - optional -.
Definition: WiMODLR_BASE.cpp:947
WiMODProLink::RegisterTxUDataIndicationClient
void RegisterTxUDataIndicationClient(TTxUDataIndicationCallback cb)
Register a callback function for the event "TX U Data Indication".
Definition: WiMODProLink.cpp:2028
TWiMODLR_AckTxInd_Msg
Structure containing information about an acknowledgment transmission.
Definition: WiMOD_SAP_RadioLink_IDs.h:243
WiMOD_SAP_DevMgmt::GetRadioConfig
virtual TWiMODLRResultCodes GetRadioConfig(TWiMODLR_DevMgmt_RadioConfig *radioCfg, UINT8 *statusRsp)
GetRadioConfig Cmd - Get the radio settings of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:351
WiMODLoRaWAN.h
TWiMODLR_DevMgmt_DevInfoLoRaWan
Structure containing basic information about the WiMOD device.
Definition: WiMOD_SAP_DEVMGMT_Lorawan_IDs.h:64
FreqCalcSX1280_calcRegisterToFreq
uint32_t FreqCalcSX1280_calcRegisterToFreq(uint8_t msb, uint8_t mid, uint8_t lsb)
Translates given register values to a carrier frequency.
Definition: FreqCalc_SX1280.c:68
TWiMODLR_HCIMessage
basic low level HCI message structure used for all serial messages to/from WiMOD
Definition: WiMODLRHCI.h:120
WiMODLRBASE::SetRadioMode
bool SetRadioMode(const TRadioCfg_RadioMode radioMode, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
SetRadioMode - Set the current radio mode of the WiMOD.
Definition: WiMODLR_BASE.cpp:583
WiMODLRBASE::GetOperationMode
bool GetOperationMode(TWiMOD_OperationMode *opMode, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current operation mode of the WiMOD module.
Definition: WiMODLR_BASE.cpp:625
TWiMODLORAWAN_JoinParams::AppKey
UINT8 AppKey[WiMODLORAWAN_APP_KEY_LEN]
Definition: WiMOD_SAP_LORAWAN_IDs.h:453
WiMODLRBASE::RegisterPowerUpIndicationClient
void RegisterPowerUpIndicationClient(TDevMgmtPowerUpCallback cb)
Register a callback function for the PowerUp Indication - optional -.
Definition: WiMODLR_BASE.cpp:910
WiMODLR_RESULT_OK
@ WiMODLR_RESULT_OK
Definition: WiMODLRHCI.h:151
TRadioCfg_PowerSavingMode
TRadioCfg_PowerSavingMode
Settings general PowerSaving mode (aka. Sleep mode)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:397
LoRaWAN_Region_US915
@ LoRaWAN_Region_US915
Definition: WiMOD_SAP_LORAWAN.h:82
WiMOD_SAP_LoRaWAN_ProLink::SendCData
TWiMODLRResultCodes SendCData(TWiMODProLinkLORAWAN_TX_Data *data, UINT8 *statusRsp)
Tries to send transmit C-Data to network server via RF link.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:445
WiMOD_SAP_DEVMGMT.h
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
TWiMODLORAWAN_SupportedBands
data structure for supported bands
Definition: WiMOD_SAP_LORAWAN_IDs.h:663
WiMODProLink::ConvertAppKeyStrToArray
void ConvertAppKeyStrToArray(char *appKeyStr, uint8_t *appKeyArray)
Converts a string containing an App Key string into a given byte array.
Definition: WiMODProLink.cpp:338
WiMODLoRaWAN::ConnectViaOTAA
void ConnectViaOTAA(const uint8_t *appEUI=NULL, const uint8_t *appKey=NULL)
do a jump start and use OTAA to connect to a Nwk server
Definition: WiMODLoRaWAN.cpp:260
WiMOD_SAP_DevMgmt::RegisterRtcAlarmIndicationClient
void RegisterRtcAlarmIndicationClient(TDevMgmtRtcAlarmCallback cb)
Register a callback function for processing a RTC Alarm Indication message.
Definition: WiMOD_SAP_DEVMGMT.cpp:833
TWiMODLR_DevMgmt_SystemStatus::SysTickCounter
UINT32 SysTickCounter
Definition: WiMOD_SAP_DEVMGMT_IDs.h:238
WiMODLoRaWAN::SendMacCmd
bool SendMacCmd(const TWiMODLORAWAN_MacCmd *cmd, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Send a MAC command to the server; expert level only.
Definition: WiMODLoRaWAN.cpp:2315
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
WiMODProLink::RegisterJoinTxIndicationClient
void RegisterJoinTxIndicationClient(TJoinTxIndicationCallback cb)
Register a callback function for the event "TX Join Indication".
Definition: WiMODProLink.cpp:1447
WiMODLRBASE_PLUS::SetAesKey
bool SetAesKey(const UINT8 *key, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the security 128bit AES key to use for RF communication.
Definition: WiMODLR_BASE_PLUS.cpp:711
WiMODLRBASE_PLUS::GetRadioConfig
bool GetRadioConfig(TWiMODLR_DevMgmt_RadioConfigPlus *radioCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current configuration of the radio of the WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:473
WiMOD_SAP_SensorApp::convert
virtual bool convert(TWiMODLR_HCIMessage &RxMsg, TWiMODLR_SensorApp_SensorData *sensorData)
Convert a received low level HCI-Msg to a high-level SensorData structure.
Definition: WiMOD_SAP_SensorApp.cpp:176
WiMOD_SAP_DevMgmt::GetRtc
virtual TWiMODLRResultCodes GetRtc(UINT32 *rtcTime, UINT8 *statusRsp)
GetRtc Cmd - Get the current RTC time/date from WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:285
WiMODProLink::Ping
bool Ping(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Ping Cmd - Checks the serial connection to the WiMOD module.
Definition: WiMODProLink.cpp:443
TWiMODLR_DevMgmt_RtcAlarm::Hour
UINT8 Hour
Definition: WiMOD_SAP_DEVMGMT_IDs.h:490
WiMOD_SAP_SensorApp::SetSensorAppConfig
virtual TWiMODLRResultCodes SetSensorAppConfig(const TWiMODLR_SensorApp_Config *config, UINT8 *statusRsp)
Sets a new SensorApp configuration to the WiMOD.
Definition: WiMOD_SAP_SensorApp.cpp:88
ProLink_LoRaWAN_FreqBand_AS_923_3
@ ProLink_LoRaWAN_FreqBand_AS_923_3
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:75
TWiMODLORAWAN_JoinParams
JOIN data structure for LoRa network activation.
Definition: WiMOD_SAP_LORAWAN_IDs.h:450
LoRaWAN_Region_IL915
@ LoRaWAN_Region_IL915
Definition: WiMOD_SAP_LORAWAN.h:85
WiMOD_SAP_DevMgmt::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.cpp:230
TWiMODLR_SensorApp_Config
Structure containing a general RadioLink HCI message.
Definition: WiMOD_SAP_SensorApp_IDs.h:121
WiMOD_SAP_DevMgmt::GetHCIConfig
virtual TWiMODLRResultCodes GetHCIConfig(TWiMODLR_DevMgmt_HciConfig *hciConfig, UINT8 *statusRsp)
SetHCIConfig Cmd - Gets the HCI config options for the LR-BASE_PLUS firmware.
Definition: WiMOD_SAP_DEVMGMT.cpp:786
WiMODLoRaWAN::convert
bool convert(TWiMODLR_HCIMessage &RxMsg, TWiMODLORAWAN_RX_Data *loraWanRxData)
Convert a received low level HCI-Msg to a high-level Rx Data structure.
Definition: WiMODLoRaWAN.cpp:1383
TWiMODLR_DevMgmt_RadioConfig::Modulation
TRadioCfg_Modulation Modulation
Definition: WiMOD_SAP_DEVMGMT_IDs.h:419
WiMODProLink::RegisterRadioLinkRxUDataIndicationClient
void RegisterRadioLinkRxUDataIndicationClient(TRadioLinkUDataRxIndicationCallback cb)
Register a callback function for the event "RX U-Data Indication".
Definition: WiMODProLink.cpp:3399
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
WiMODProLink::GetRtc
bool GetRtc(UINT32 *rtcTime, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current RTC data info from WiMOD module.
Definition: WiMODProLink.cpp:593
WiMOD_SAP_DevMgmt::WiMOD_SAP_DevMgmt
WiMOD_SAP_DevMgmt(TWiMODLRHCI *hci, UINT8 *buffer, UINT16 bufferSize)
Constructor.
Definition: WiMOD_SAP_DEVMGMT.cpp:64
WiMODProLink::RegisterMulticastDataIndicationClient
void RegisterMulticastDataIndicationClient(TMCastDataIndicationCallback cb)
Register a callback function for the event "MultiCast Data (Rx) Indication".
Definition: WiMODProLink.cpp:3099
TWiMODLR_DevMgmt_SystemStatusPlus
Basic information about system status of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:331
WiMODProLink::RegisterMulticastInvalidDataIndicationClient
void RegisterMulticastInvalidDataIndicationClient(TMCastInvalidDataIndicationCallback cb)
Register a callback function for the event "Invalid MultiCast Data (RX) Indication".
Definition: WiMODProLink.cpp:3120
WiMODLoRaWAN::GetDeviceInfo
bool GetDeviceInfo(TWiMODLR_DevMgmt_DevInfoLoRaWan *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
GetDeviceInfo Cmd - Gets the basic device information of the WiMOD.
Definition: WiMODLoRaWAN.cpp:502
ProLink_LoRaWAN_FreqBand_US_915
@ ProLink_LoRaWAN_FreqBand_US_915
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:69
WiMODProLink::end
void end(void)
Shut shut down function.
Definition: WiMODProLink.cpp:128
WiMODProLink::convert
bool convert(TWiMODLR_HCIMessage &RxMsg, TWiMODLORAWAN_RX_Data *loraWanRxData)
Convert a received low level HCI-Msg to a high-level Rx Data structure.
Definition: WiMODProLink.cpp:1500
WiMODLRBASE::convert
bool convert(TWiMODLR_HCIMessage &RxMsg, TWiMODLR_RadioLink_Msg *radioLinkMsg)
Convert a received low level HCI-Msg to a high-level RadioLink-Msg.
Definition: WiMODLR_BASE.cpp:1129
TWiMODLR_SensorApp_AckSensorData
Structure containing the data of an Ack of the SensorApp.
Definition: WiMOD_SAP_SensorApp_IDs.h:164
WiMODLRBASE_PLUS::SendUData
bool SendUData(const TWiMODLR_RadioLink_Msg *txMsg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to send transmit U-Data to peer module via RF link.
Definition: WiMODLR_BASE_PLUS.cpp:1091
WiMOD_SAP_LoRaWAN::SetJoinParameter
virtual TWiMODLRResultCodes SetJoinParameter(TWiMODLORAWAN_JoinParams &joinParams, UINT8 *statusRsp)
Sets the parameters used for the OTAA activation procedure.
Definition: WiMOD_SAP_LORAWAN.cpp:208
TWiMODLR_DevMgmt_DevInfo::GroupAdr
UINT8 GroupAdr
Definition: WiMOD_SAP_DEVMGMT_IDs.h:177
WiMODLRBASE_PLUS::RegisterRltStatusClient
void RegisterRltStatusClient(TRltStatusIndicationCallback cb)
Register a callback function for RLT updates.
Definition: WiMODLR_BASE_PLUS.cpp:2186
WiMOD_SAP_DevMgmt::SetRadioMode
virtual TWiMODLRResultCodes SetRadioMode(const TRadioCfg_RadioMode radioMode, UINT8 *statusRsp)
SetRadioMode - Set the current radio mode of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:553
TWiMODLR_DevMgmt_RadioConfig::LoRaSpreadingFactor
TRadioCfg_LoRaSpreadingFactor LoRaSpreadingFactor
Definition: WiMOD_SAP_DEVMGMT_IDs.h:424
WiMODLoRaWAN::RegisterRtcAlarmIndicationClient
void RegisterRtcAlarmIndicationClient(TDevMgmtRtcAlarmCallback cb)
Register a callback function for the RTC Alarm Indication - optional -.
Definition: WiMODLoRaWAN.cpp:961
TWiMODLR_DevMgmt_RadioConfig::RfFreq_MSB
UINT8 RfFreq_MSB
Definition: WiMOD_SAP_DEVMGMT_IDs.h:422
TWiMODLR_RLT_Status
Structure containing a general RadioLink HCI message.
Definition: WiMOD_SAP_RLT_IDs.h:114
TWiMODLR_SensorApp_SensorData
Structure containing SensorApp Data information.
Definition: WiMOD_SAP_SensorApp_IDs.h:137
WiMODLRBASE_PLUS::SapDevMgmt
WiMOD_SAP_DevMgmt_Plus SapDevMgmt
Definition: WiMODLR_BASE_PLUS.h:222
WiMODProLink::GetRadioStack
bool GetRadioStack(TRadioStack_Mode *stackMode, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the active Radio Stack Mode of the WiMOD (only ProLink firmware)
Definition: WiMODProLink.cpp:964
WiMODLoRaWAN::SetOperationMode
bool SetOperationMode(const TWiMOD_OperationMode opMode, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the current operation mode of the WiMOD module.
Definition: WiMODLoRaWAN.cpp:759
WiMOD_SAP_DevMgmt::GetFirmwareInfo
virtual TWiMODLRResultCodes GetFirmwareInfo(TWiMODLR_DevMgmt_FwInfo *info, UINT8 *statusRsp)
GetFirmwareInfo Cmd - Get basic info about the running firmware.
Definition: WiMOD_SAP_DEVMGMT.cpp:185
TWiMODLR_RLT_Parameter
Structure containing a general RadioLink HCI message.
Definition: WiMOD_SAP_RLT_IDs.h:102
WiMODProLink::SapLoRaWan
WiMOD_SAP_LoRaWAN_ProLink SapLoRaWan
Definition: WiMODProLink.h:291
WiMOD_SAP_LoRaWAN::RegisterJoinedNwkIndicationClient
void RegisterJoinedNwkIndicationClient(TJoinedNwkIndicationCallback cb)
Register a callback function for the event "Joined Nwk Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:853
TRadioLinkRawDataRxIndicationCallback
void(* TRadioLinkRawDataRxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:121
WiMODLRBASE_PLUS::SetHciConfig
bool SetHciConfig(TWiMODLR_DevMgmt_HciConfig &hciConfig, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets a new HCI configuration of the WiMOD.
Definition: WiMODLR_BASE_PLUS.cpp:1033
WiMOD_SAP_LoRaWAN::GetRadioStackConfig
virtual TWiMODLRResultCodes GetRadioStackConfig(TWiMODLORAWAN_RadioStackConfig *data, UINT8 *statusRsp)
Gets the current radio config parameter set of the WiMOD.
Definition: WiMOD_SAP_LORAWAN.cpp:946
TWiMODLORAWAN_RadioStackConfig
Radio stack configuration related to to LoRaWAN specific options.
Definition: WiMOD_SAP_LORAWAN_IDs.h:568
TWiMODLR_DevMgmt_SystemStatus::ExtraStatus
UINT16 ExtraStatus
Definition: WiMOD_SAP_DEVMGMT_IDs.h:242
TWiMODLR_DevMgmt_SystemStatusPlus::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:333
WiMODProLink::RegisterRxCDataIndicationClient
void RegisterRxCDataIndicationClient(TRxCDataIndicationCallback cb)
Register a callback function for the event "RX C-Data Indication".
Definition: WiMODProLink.cpp:2070
TWiMODLR_HCIMessage::Length
UINT16 Length
Definition: WiMODLRHCI.h:123
WiMODLRBASE::SapRadioLink
WiMOD_SAP_RadioLink SapRadioLink
Definition: WiMODLR_BASE.h:211
WiMOD_SAP_DevMgmt::Reset
virtual TWiMODLRResultCodes Reset(UINT8 *statusRsp)
Reset Cmd - Do a reset / reboot of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:118
TWiMODLR_HCIMessage::MsgID
UINT8 MsgID
Definition: WiMODLRHCI.h:129
WiMODProLink::RegisterJoinedNwkIndicationClient
void RegisterJoinedNwkIndicationClient(TJoinedNwkIndicationCallback cb)
Register a callback function for the event "Joined Nwk Indication".
Definition: WiMODProLink.cpp:2112
WiMOD_SAP_DevMgmt::ClearRtcAlarm
virtual TWiMODLRResultCodes ClearRtcAlarm(UINT8 *statusRsp)
ClearRtcAlarm Cmd - Clear a pending RTC alarm.
Definition: WiMOD_SAP_DEVMGMT.cpp:713
WiMOD_SAP_RemoteCtrl::RegisterBtnPressedClient
virtual void RegisterBtnPressedClient(TRemoteCtrlBtnPressedIndicationCallback cb)
Register a callback function for the event "Button Pressed Indication".
Definition: WiMOD_SAP_RemoteCtrl.cpp:123
WiMOD_SAP_LoRaWAN::RegisterTxCDataIndicationClient
void RegisterTxCDataIndicationClient(TTxCDataIndicationCallback cb)
Register a callback function for the event "TX C-Data Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:778
WiMOD_SAP_RadioLink::RegisterAckTxCallback
virtual void RegisterAckTxCallback(TRadioLinkAckTxIndicationCallback cb)
Register a callback function for the TX Ack Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:638
WiMODProLink::RemoveMulticastConfig
bool RemoveMulticastConfig(const UINT8 mcastIndex, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Remove a single Multicast configuration from module.
Definition: WiMODProLink.cpp:2827
WiMODProLink::SetRtcAlarm
bool SetRtcAlarm(const TWiMODLR_DevMgmt_RtcAlarm *rtcAlarm, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets and enables the RTC alarm feature of the WiMOD.
Definition: WiMODProLink.cpp:687
TRadioCfg_Modulation
TRadioCfg_Modulation
Modulation technique supported by the WiMOD (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:266
TTxUDataIndicationCallback
void(* TTxUDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:163
WiMOD_SAP_DevMgmt::RegisterPowerUpIndicationClient
void RegisterPowerUpIndicationClient(TDevMgmtPowerUpCallback cb)
Register a callback function for processing a PowerUp Indication message.
Definition: WiMOD_SAP_DEVMGMT.cpp:821
TWiMODLORAWAN_TxPwrLimitConfig
data structure for TX Power Limits
Definition: WiMOD_SAP_LORAWAN_IDs.h:674
WiMODLoRaWAN::RegisterRxCDataIndicationClient
void RegisterRxCDataIndicationClient(TRxCDataIndicationCallback cb)
Register a callback function for the event "RX C-Data Indication".
Definition: WiMODLoRaWAN.cpp:1828
WiMODLoRaWAN::ReactivateDevice
bool ReactivateDevice(UINT32 *devAdr, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Re-Activates the device via the ABP procedure.
Definition: WiMODLoRaWAN.cpp:1179
WiMODLoRaWAN::SetRtc
bool SetRtc(const UINT32 rtcTime, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the current RTC values to WiMOD module.
Definition: WiMODLoRaWAN.cpp:673
WiMODLRBASE::SendUData
bool SendUData(const TWiMODLR_RadioLink_Msg *txMsg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to send transmit U-Data to peer module via RF link.
Definition: WiMODLR_BASE.cpp:1002
TWiMODLORAWAN_JoinParams::JoinEUI
UINT8 JoinEUI[WiMODLORAWAN_JOIN_EUI_LEN]
Definition: WiMOD_SAP_LORAWAN_IDs.h:452
TRadioLinkCDataTxIndicationCallback
void(* TRadioLinkCDataTxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:127
WiMOD_SAP_LoRaWAN_ProLink::SendUData
TWiMODLRResultCodes SendUData(TWiMODProLinkLORAWAN_TX_Data *data, UINT8 *statusRsp)
Tries to send transmit U-Data to network server via RF link.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:396
WiMODLoRaWAN::GetHciConfig
bool GetHciConfig(TWiMODLR_DevMgmt_HciConfig *hciConfig, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current HCI configuration of the WiMOD.
Definition: WiMODLoRaWAN.cpp:1000
TRxAckIndicationCallback
void(* TRxAckIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:175
WiMODProLink::SetRadioStack
bool SetRadioStack(const TRadioStack_Mode &stackMode, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the active Radio Stack Mode of the WiMOD (only ProLink firmware)
Definition: WiMODProLink.cpp:1001
TWiMODLR_DevMgmt_SystemStatus::NvmStatus
UINT16 NvmStatus
Definition: WiMOD_SAP_DEVMGMT_IDs.h:240
WiMODLoRaWAN::JoinNetwork
bool JoinNetwork(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Start joining the network via the OTAA procedure. Asynchronous process.
Definition: WiMODLoRaWAN.cpp:1294
TRemoteCtrlBtnPressedIndicationCallback
void(* TRemoteCtrlBtnPressedIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RemoteCtrl.h:81
WiMOD_SAP_LoRaWAN::GetDeviceEUI
virtual TWiMODLRResultCodes GetDeviceEUI(UINT8 *deviceEUI, UINT8 *statusRsp)
Gets the DeviceEUI (aka. IEEE-Address) of the WiMOD.
Definition: WiMOD_SAP_LORAWAN.cpp:1094
TWiMODLORAWAN_RX_ACK_Data
Data structure for received Acknowledgment data.
Definition: WiMOD_SAP_LORAWAN_IDs.h:602
TWiMODLR_HCIMessage::Payload
UINT8 Payload[WIMODLR_HCI_MSG_PAYLOAD_SIZE]
Definition: WiMODLRHCI.h:132
WiMOD_SAP_LoRaWAN::GetCustomConfig
virtual TWiMODLRResultCodes GetCustomConfig(INT8 *rfGain, UINT8 *statusRsp)
Get the current offet for tx power level; expert level only.
Definition: WiMOD_SAP_LORAWAN.cpp:1302
WiMOD_SAP_LoRaWAN_ProLink::GetJoinNonce
TWiMODLRResultCodes GetJoinNonce(UINT16 *joinNonce, UINT8 *statusRsp)
Gets the current Join NONCE value of the WiMOD.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:239
TMCastDataIndicationCallback
void(* TMCastDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN_ProLink.h:124
WiMOD_SAP_DevMgmt_Lorawan::GetDeviceInfo
virtual TWiMODLRResultCodes GetDeviceInfo(TWiMODLR_DevMgmt_DevInfo *info, UINT8 *statusRsp)
Get Device Info - Basic Information about the WiMOD module.
Definition: WiMOD_SAP_DEVMGMT_Lorawan.cpp:82
WiMODProLink::GetJoinNonce
bool GetJoinNonce(UINT16 *joinNonce, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the Join Nonce that will be used for next Join OTAA procedure.
Definition: WiMODProLink.cpp:2895
WiMODLRBASE_PLUS::SapRemoteCtrl
WiMOD_SAP_RemoteCtrl SapRemoteCtrl
Definition: WiMODLR_BASE_PLUS.h:227
WiMODProLink::RegisterResetDevNonceIndicationClient
void RegisterResetDevNonceIndicationClient(TResetDevNonceIndicationCallback cb)
Register a callback function for the event "Reset DevNonce Indication".
Definition: WiMODProLink.cpp:2851
WiMODLRBASE::end
void end(void)
De-Setup internal things.
Definition: WiMODLR_BASE.cpp:122
WiMODProLink::GetMulticastConfig
bool GetMulticastConfig(TWiMODLORAWAN_McastConfig *mcastCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get a single Multicase configuration from module.
Definition: WiMODProLink.cpp:2803
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
WiMODLoRaWAN::SetHciConfig
bool SetHciConfig(TWiMODLR_DevMgmt_HciConfig &hciConfig, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets a new HCI configuration of the WiMOD.
Definition: WiMODLoRaWAN.cpp:1042
WiMODProLink::SetRtc
bool SetRtc(const UINT32 rtcTime, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the current RTC values to WiMOD module.
Definition: WiMODProLink.cpp:632
TWiMODLR_DevMgmt_DevInfo::ModuleType
UINT8 ModuleType
Definition: WiMOD_SAP_DEVMGMT_IDs.h:175
WiMODLRBASE::RegisterAckRxTimeoutClient
void RegisterAckRxTimeoutClient(TRadioLinkAckRxTimeoutIndicationCallback cb)
Register a callback function for the Ack Timeout Indication - optional -.
Definition: WiMODLR_BASE.cpp:1671
TWiMODLR_DevMgmt_RadioConfig::ErrorCoding
TRadioCfg_ErrorCoding ErrorCoding
Definition: WiMOD_SAP_DEVMGMT_IDs.h:425
WiMODLRBASE::GetRtc
bool GetRtc(UINT32 *rtcTime, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current RTC data info from WiMOD module.
Definition: WiMODLR_BASE.cpp:386
TProLinkLoRaWANregion
TProLinkLoRaWANregion
LoRaWAN Region support.
Definition: WiMOD_SAP_LORAWAN_ProLink.h:72
WiMOD_SAP_RadioLink::RegisterCDataRxClient
virtual void RegisterCDataRxClient(TRadioLinkCDataRxIndicationCallback cb)
Register a callback function for the RX C-Data Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:574
WiMOD_SAP_LoRaWAN::RegisterRxMacCmdIndicationClient
void RegisterRxMacCmdIndicationClient(TRxMacCmdIndicationCallback cb)
Register a callback function for the event "RX MAC Cmd Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:838
TRadioCfg_LoRaSpreadingFactor
TRadioCfg_LoRaSpreadingFactor
SpreadingFactors for LoRa modulation (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:285
TWiMODLRHCI::end
virtual void end(void)
shutdown function
Definition: WiMODLRHCI.cpp:107
ProLink_LoRaWAN_Region_EU868
@ ProLink_LoRaWAN_Region_EU868
Definition: WiMOD_SAP_LORAWAN_ProLink.h:74
WiMOD_SAP_LoRaWAN::GetNwkStatus
virtual TWiMODLRResultCodes GetNwkStatus(TWiMODLORAWAN_NwkStatus_Data *nwkStatus, UINT8 *statusRsp)
Gets the current status of the network "connection".
Definition: WiMOD_SAP_LORAWAN.cpp:1168
WiMODLRBASE::GetFirmwareInfo
bool GetFirmwareInfo(TWiMODLR_DevMgmt_FwInfo *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the basic FirmwareInfo from WiMOD module.
Definition: WiMODLR_BASE.cpp:298
WiMODLRBASE_PLUS::convert
bool convert(TWiMODLR_HCIMessage &RxMsg, TWiMODLR_RadioLink_Msg *radioLinkMsg)
Convert a received low level HCI-Msg to a high-level RadioLink-Msg.
Definition: WiMODLR_BASE_PLUS.cpp:1218
TWiMODLR_DevMgmt_RadioConfig::PowerSavingMode
TRadioCfg_PowerSavingMode PowerSavingMode
Definition: WiMOD_SAP_DEVMGMT_IDs.h:433
WiMODProLink::calcRegisterToFreq
uint32_t calcRegisterToFreq(uint8_t msb, uint8_t mid, uint8_t lsb)
Convert a frequency registers to frequency in Hz.
Definition: WiMODProLink.cpp:3378
WiMODLRBASE::SetAesKey
bool SetAesKey(const UINT8 *key, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the security 128bit AES key to use for RF communication.
Definition: WiMODLR_BASE.cpp:703
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
ProLink_LoRaWAN_FreqBand_IN_865_RX2_SF8
@ ProLink_LoRaWAN_FreqBand_IN_865_RX2_SF8
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:81
WiMOD_SAP_DEVMGMT_IDs.h
WiMODLRBASE_PLUS::RegisterSensorAppAckIndClient
void RegisterSensorAppAckIndClient(TSensorAppAckIndicationCallback cb)
Register a callback function for the SensorAppAckData Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:2435
WiMOD_SAP_LoRaWAN_ProLink::RegisterMulticastDataIndicationClient
void RegisterMulticastDataIndicationClient(TMCastDataIndicationCallback cb)
Register a callback function for the event "RX Multicast Data Indication".
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:809
TRxMacCmdIndicationCallback
void(* TRxMacCmdIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:172
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
WiMODProLink::SendNwkTimeRequest
bool SendNwkTimeRequest(TWiMODLORAWAN_DevTimeReqInfo *devTimeInfo, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Send a Network Time Request /DevTimeRequest via MAC Cmd to LNS.
Definition: WiMODProLink.cpp:2941
WiMODProLink::SetRadioStackConfig
bool SetRadioStackConfig(TWiMODProLinkLORAWAN_RadioStackConfig *data, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets a new radio config parameter set of the WiMOD.
Definition: WiMODProLink.cpp:2290
WiMODLRBASE_PLUS::ClearRtcAlarm
bool ClearRtcAlarm(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Clears pending RTC Alarms of the WiMOD.
Definition: WiMODLR_BASE_PLUS.cpp:876
WiMOD_SAP_RadioLink::RegisterAckRxClient
virtual void RegisterAckRxClient(TRadioLinkAckRxIndicationCallback cb)
Register a callback function for the RX Ack (+data) Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:608
WiMOD_SAP_LoRaWAN_ProLink::SetJoinNonce
TWiMODLRResultCodes SetJoinNonce(const UINT16 joinNonce, UINT8 *statusRsp)
SetJoinNonce Cmd - Sets the Join NONCE value of WiMOD.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:208
PROLINK_RADIOLINK_SAP_ID
#define PROLINK_RADIOLINK_SAP_ID
Definition: WiMOD_SAP_RadioLink_ProLink_IDs.h:61
WiMODProLink::RegisterNwkTimeAnsIndicationClient
void RegisterNwkTimeAnsIndicationClient(TNwkDeviceTimeAnsIndicationCallback cb)
Register a callback function for the event "DeviceTimeAnser Indication".
Definition: WiMODProLink.cpp:2966
TWiMODProLinkLORAWAN_RadioStackConfig
Radio stack configuration related to to LoRaWAN specific options.
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:191
WiMODProLink::RegisterNoDataIndicationClient
void RegisterNoDataIndicationClient(TNoDataIndicationCallback cb)
Register a callback function for the event "TX Join Indication".
Definition: WiMODProLink.cpp:1933
WiMOD_SAP_LoRaWAN::RegisterRxCDataIndicationClient
void RegisterRxCDataIndicationClient(TRxCDataIndicationCallback cb)
Register a callback function for the event "RX C-Data Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:823
TWiMODLR_DevMgmt_FwInfo::FirmwareName
UINT8 FirmwareName[WIMOD_DEVMGMT_MAX_FIRMWARE_NAME_LEN]
Definition: WiMOD_SAP_DEVMGMT_IDs.h:227
WiMOD_SAP_LoRaWAN_ProLink::RegisterResetDevNonceIndicationClient
void RegisterResetDevNonceIndicationClient(TResetDevNonceIndicationCallback cb)
Register a callback function for the event "Reset DeviceNonce Indication".
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:764
ProLink_LoRaWAN_Region_IN865
@ ProLink_LoRaWAN_Region_IN865
Definition: WiMOD_SAP_LORAWAN_ProLink.h:76
WiMODLRBASE_PLUS::SetSensorAppConfig
bool SetSensorAppConfig(const TWiMODLR_SensorApp_Config *config, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to configure the integrated Sensor App feature of the WiMOD.
Definition: WiMODLR_BASE_PLUS.cpp:2327
WiMOD_SAP_DevMgmt_Lorawan::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_Lorawan.cpp:120
WiMODProLink::JoinNetwork
bool JoinNetwork(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Start joining the network via the OTAA procedure. Asynchronous process.
Definition: WiMODProLink.cpp:1411
TWiMODLR_DevMgmt_RadioConfig::RfFreq_LSB
UINT8 RfFreq_LSB
Definition: WiMOD_SAP_DEVMGMT_IDs.h:420
TSensorAppAckIndicationCallback
void(* TSensorAppAckIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_SensorApp.h:84
TRadioCfg_LoRaBandwidth
TRadioCfg_LoRaBandwidth
Bandwidth settings for the LoRa modulation (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:275
WiMOD_SAP_RadioLink::RegisterUDataTxClient
virtual void RegisterUDataTxClient(TRadioLinkUDataTxIndicationCallback cb)
Register a callback function for the TX U-Data Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:540
WiMODLoRaWAN::SetCustomConfig
bool SetCustomConfig(const INT8 rfGain, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Setup a custom config for tx power settings; expert level only.
Definition: WiMODLoRaWAN.cpp:2338
WiMOD_SAP_DevMgmt::SetRtcAlarm
virtual TWiMODLRResultCodes SetRtcAlarm(const TWiMODLR_DevMgmt_RtcAlarm *rtcAlarm, UINT8 *statusRsp)
SetRtcAlarm Cmd - Set a new RTC alarm config.
Definition: WiMOD_SAP_DEVMGMT.cpp:639
WiMODLRBASE_PLUS::SetOperationMode
bool SetOperationMode(const TWiMOD_OperationMode opMode, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the current operation mode of the WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:645
TWiMODLR_DevMgmt_RtcAlarm::Minutes
UINT8 Minutes
Definition: WiMOD_SAP_DEVMGMT_IDs.h:491
WiMOD_SAP_RadioLink::SendUData
virtual TWiMODLRResultCodes SendUData(const TWiMODLR_RadioLink_Msg *txMsg, UINT8 *statusRsp)
Tries to send transmit U-Data to peer module via RF link.
Definition: WiMOD_SAP_RadioLink.cpp:107
WiMODProLink::ExecuteGenericCmd
bool ExecuteGenericCmd(TWiMODLR_Generic_CmdInfo *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Generic Execution Function for HCI commands that are currently not implemented.
Definition: WiMODProLink.cpp:3506
WiMODLRBASE::GetAesKey
bool GetAesKey(UINT8 *key, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the used security 128bit AES key.
Definition: WiMODLR_BASE.cpp:742
WiMODProLink::SapDevMgmt
WiMOD_SAP_DevMgmt_ProLink SapDevMgmt
Definition: WiMODProLink.h:290
WiMODProLink::GetDeviceInfo
bool GetDeviceInfo(TWiMODLR_DevMgmt_DevInfoLoRaWan *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
GetDeviceInfo Cmd - Gets the basic device information of the WiMOD.
Definition: WiMODProLink.cpp:504
WiMODLoRaWAN::end
void end(void)
Shut shut down function.
Definition: WiMODLoRaWAN.cpp:127
WiMODProLink::GetCustomConfig
bool GetCustomConfig(INT8 *rfGain, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the current offet for tx power level; expert level only.
Definition: WiMODProLink.cpp:2612
TNwkDeviceTimeAnsIndicationCallback
void(* TNwkDeviceTimeAnsIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:148
TWiMODLR_DevMgmt_SystemStatus::TxError
UINT32 TxError
Definition: WiMOD_SAP_DEVMGMT_IDs.h:247
TWiMODLR_DevMgmt_SystemStatusLorawan::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_Lorawan_IDs.h:79
WiMODLoRaWAN::GetOperationMode
bool GetOperationMode(TWiMOD_OperationMode *opMode, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current operation mode of the WiMOD module.
Definition: WiMODLoRaWAN.cpp:719
WiMODLoRaWAN::RegisterRxAckIndicationClient
void RegisterRxAckIndicationClient(TRxAckIndicationCallback cb)
Register a callback function for the event "RX ACK (data) Indication".
Definition: WiMODLoRaWAN.cpp:1891
TRadioLinkCDataRxIndicationCallback
void(* TRadioLinkCDataRxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:124
WiMODLoRaWAN::GetRadioStackConfig
bool GetRadioStackConfig(TWiMODLORAWAN_RadioStackConfig *data, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current radio config parameter set of the WiMOD.
Definition: WiMODLoRaWAN.cpp:2082
TTxCDataIndicationCallback
void(* TTxCDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:160
WiMOD_SAP_RadioLink::RegisterRawDataRxClient
virtual void RegisterRawDataRxClient(TRadioLinkRawDataRxIndicationCallback cb)
Register a callback function for the RX Raw-Data Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:557
TWiMODLR_DevMgmt_RadioConfig::TxDeviceAddress
UINT16 TxDeviceAddress
Definition: WiMOD_SAP_DEVMGMT_IDs.h:418
WiMODProLink::RegisterTxCDataIndicationClient
void RegisterTxCDataIndicationClient(TTxCDataIndicationCallback cb)
Register a callback function for the event "TX C-Data Indication".
Definition: WiMODProLink.cpp:1980
WiMODLoRaWAN::ExecuteGenericCmd
bool ExecuteGenericCmd(TWiMODLR_Generic_CmdInfo *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Generic Execution Function for HCI commands that are currently not implemented.
Definition: WiMODLoRaWAN.cpp:2569
TWiMODLR_DevMgmt_SystemStatus::BatteryStatus
UINT16 BatteryStatus
Definition: WiMOD_SAP_DEVMGMT_IDs.h:241
WiMODLoRaWAN::GetRtcAlarm
bool GetRtcAlarm(TWiMODLR_DevMgmt_RtcAlarm *rtcAlarm, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets information about the RTC alarm feature of the WiMOD.
Definition: WiMODLoRaWAN.cpp:856
WiMODProLink::GetDeviceEUI
bool GetDeviceEUI(UINT8 *deviceEUI, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the DeviceEUI (aka. IEEE-Address) of the WiMOD.
Definition: WiMODProLink.cpp:2475
TWiMODLR_DevMgmt_RadioConfig::GroupAddress
UINT8 GroupAddress
Definition: WiMOD_SAP_DEVMGMT_IDs.h:415
WIMOD_STACK_ERR_UNKNOWN_RX_SAP_ID
@ WIMOD_STACK_ERR_UNKNOWN_RX_SAP_ID
Definition: WiMODLRHCI.h:173
WiMODProLink::ResetRadioLinkRadioConfig
bool ResetRadioLinkRadioConfig(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset the RadioConfig for the proprietary LoRa communication feature to defaults.
Definition: WiMODProLink.cpp:3205
WiMODProLink::SetMulticastConfig
bool SetMulticastConfig(TWiMODLORAWAN_McastConfig &mcastCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Set a (new) Configuration for Multicast Mode.
Definition: WiMODProLink.cpp:2778
WiMODProLink::GetHciConfig
bool GetHciConfig(TWiMODLR_DevMgmt_HciConfig *hciConfig, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current HCI configuration of the WiMOD.
Definition: WiMODProLink.cpp:874
WiMODProLink::GetDeviceStatus
bool GetDeviceStatus(TProLinkDeviceStatus *devStatus, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
GetDeviceStatus Cmd - Gets the basic information about the device status of the WiMOD.
Definition: WiMODProLink.cpp:1161
WiMODLRBASE::GetSystemStatus
bool GetSystemStatus(TWiMODLR_DevMgmt_SystemStatus *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the bas SystemStatus info from WiMOD module.
Definition: WiMODLR_BASE.cpp:339
WiMOD_SAP_LoRaWAN::SetTxPowerLimitConfig
virtual TWiMODLRResultCodes SetTxPowerLimitConfig(TWiMODLORAWAN_TxPwrLimitConfig &txPwrLimitCfg, UINT8 *statusRsp)
Set a SINGLE TxPowerLimit entry.
Definition: WiMOD_SAP_LORAWAN.cpp:1431
WiMODProLink::RegisterRxAckIndicationClient
void RegisterRxAckIndicationClient(TRxAckIndicationCallback cb)
Register a callback function for the event "RX ACK (data) Indication".
Definition: WiMODProLink.cpp:2133
WiMODLRBASE_PLUS::end
void end(void)
De-Setup internal things.
Definition: WiMODLR_BASE_PLUS.cpp:126
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
WiMODLRBASE::calcRegisterToFreq
uint32_t calcRegisterToFreq(uint8_t msb, uint8_t mid, uint8_t lsb)
Convert a frequency registers to frequency in Hz.
Definition: WiMODLR_BASE.cpp:1747
WiMODLRBASE::RegisterCDataRxClient
void RegisterCDataRxClient(TRadioLinkCDataRxIndicationCallback cb)
Register a callback function for the RX C-Data Indication - optional -.
Definition: WiMODLR_BASE.cpp:1528
TWiMODLORAWAN_DevTimeReqInfo
info data structure for LoRa device time request MAC command
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:104
WiMODLRBASE_PLUS::GetLastHciResult
TWiMODLRResultCodes GetLastHciResult(void)
Gets the value of the last local HCI TX status.
Definition: WiMODLR_BASE_PLUS.cpp:1874
WiMOD_SAP_DevMgmt::ResetRadioConfig
virtual TWiMODLRResultCodes ResetRadioConfig(UINT8 *statusRsp)
ResetRadioConfig Cmd - Reset the radio config to factory defaults.
Definition: WiMOD_SAP_DEVMGMT.cpp:473
WiMODLoRaWAN::Ping
bool Ping(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Ping Cmd - Checks the serial connection to the WiMOD module.
Definition: WiMODLoRaWAN.cpp:442
WiMODLR_RESULT_PAYLOAD_PTR_ERROR
@ WiMODLR_RESULT_PAYLOAD_PTR_ERROR
Definition: WiMODLRHCI.h:153
WiMOD_SAP_RadioLink_ProLink::GetAesKey
virtual TWiMODLRResultCodes GetAesKey(UINT8 *key, UINT8 *statusRsp)
GetAesKey Cmd - Get the 128bit AES that that is used for encryption.
Definition: WiMOD_SAP_RadioLink_ProLink.cpp:316
WiMODProLink.h
TWiMODLORAWAN_MacCmd
LoRaWAN MAC command structure.
Definition: WiMOD_SAP_LORAWAN_IDs.h:590
WiMODLRBASE::RegisterAckRxClient
void RegisterAckRxClient(TRadioLinkAckRxIndicationCallback cb)
Register a callback function for the RX Ack (+data) Indication - optional -.
Definition: WiMODLR_BASE.cpp:1623
WiMODProLink::ClearRtcAlarm
bool ClearRtcAlarm(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Clears pending RTC Alarms of the WiMOD.
Definition: WiMODProLink.cpp:759
WiMODLRBASE::begin
void begin(void)
Setup internal things.
Definition: WiMODLR_BASE.cpp:111
WiMODProLink::SendMacCmd
bool SendMacCmd(const TWiMODLORAWAN_MacCmd *cmd, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Send a MAC command to the server; expert level only.
Definition: WiMODProLink.cpp:2564
WiMODLoRaWAN::SapGeneric
WiMOD_SAP_Generic SapGeneric
Definition: WiMODLoRaWAN.h:224
WiMODLRBASE::SetAckData
bool SetAckData(const TWiMODLR_RadioLink_Msg *txMsg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets additional user payload for the next ack frame to send.
Definition: WiMODLR_BASE.cpp:1368
WiMODLRBASE::SapGeneric
WiMOD_SAP_Generic SapGeneric
Definition: WiMODLR_BASE.h:212
TWiMODProLinkLORAWAN_TX_Data
Structure containing all data necessary to transmitting a data message.
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:91
ProLink_LoRaWAN_FreqBand_AS_923_2
@ ProLink_LoRaWAN_FreqBand_AS_923_2
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:74
WiMODProLink::SendCData
bool SendCData(TWiMODProLinkLORAWAN_TX_Data *data, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to send transmit C-Data to network server via RF link.
Definition: WiMODProLink.cpp:2243
WiMOD_SAP_RadioLink::RegisterCDataTxClient
virtual void RegisterCDataTxClient(TRadioLinkCDataTxIndicationCallback cb)
Register a callback function for the TX C-Data Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:591
WiMODLR_BASE_PLUS.h
TWiMODLR_DevMgmt_SystemStatus::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:236
ProLink_LoRaWAN_FreqBand_AS_923_1
@ ProLink_LoRaWAN_FreqBand_AS_923_1
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:73
TWiMODLR_DevMgmt_SystemStatus::TxMediaBusyEvents
UINT32 TxMediaBusyEvents
Definition: WiMOD_SAP_DEVMGMT_IDs.h:248
WiMODLRBASE_PLUS::RegisterCDataTxClient
void RegisterCDataTxClient(TRadioLinkCDataTxIndicationCallback cb)
Register a callback function for the TX C-Data Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1654
WiMODLoRaWAN::RegisterJoinTxIndicationClient
void RegisterJoinTxIndicationClient(TJoinTxIndicationCallback cb)
Register a callback function for the event "TX Join Indication".
Definition: WiMODLoRaWAN.cpp:1330
TWiMODLORAWAN_McastConfig
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:121
WiMODLoRaWAN::RegisterJoinedNwkIndicationClient
void RegisterJoinedNwkIndicationClient(TJoinedNwkIndicationCallback cb)
Register a callback function for the event "Joined Nwk Indication".
Definition: WiMODLoRaWAN.cpp:1870
TWiMODLR_DevMgmt_RadioConfig::DeviceAddress
UINT16 DeviceAddress
Definition: WiMOD_SAP_DEVMGMT_IDs.h:417
WiMODProLink::SetCustomConfig
bool SetCustomConfig(const INT8 rfGain, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Setup a custom config for tx power settings; expert level only.
Definition: WiMODProLink.cpp:2589
TJoinTxIndicationCallback
void(* TJoinTxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:151
WiMOD_SAP_DevMgmt::SetOperationMode
virtual TWiMODLRResultCodes SetOperationMode(const TWiMOD_OperationMode opMode, UINT8 *statusRsp)
SetOperationMode Cmd - Set the current operation mode of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:525
TNoDataIndicationCallback
void(* TNoDataIndicationCallback)(void)
Definition: WiMOD_SAP_LORAWAN.h:157
WiMODLoRaWAN::WiMODLoRaWAN
WiMODLoRaWAN(Stream &s)
Constructor.
Definition: WiMODLoRaWAN.cpp:69
TWiMODLR_DevMgmt_HciConfig::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:524
WiMOD_SAP_DevMgmt::GetDeviceInfo
virtual TWiMODLRResultCodes GetDeviceInfo(TWiMODLR_DevMgmt_DevInfo *info, UINT8 *statusRsp)
Get Device Info - Basic Information about the WiMOD module.
Definition: WiMOD_SAP_DEVMGMT.cpp:144
TSensorAppSensorDataIndicationCallback
void(* TSensorAppSensorDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_SensorApp.h:87
WiMODLRBASE_PLUS::GetAesKey
bool GetAesKey(UINT8 *key, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the used security 128bit AES key.
Definition: WiMODLR_BASE_PLUS.cpp:750
WiMOD_SAP_LoRaWAN::GetTxPowerLimitConfig
virtual TWiMODLRResultCodes GetTxPowerLimitConfig(TWiMODLORAWAN_TxPwrLimitConfig *txPwrLimitCfg, UINT8 *statusRsp)
Get the configured TxPowerLimit settings.
Definition: WiMOD_SAP_LORAWAN.cpp:1382
WiMOD_SAP_LoRaWAN::SetBatteryLevelStatus
virtual TWiMODLRResultCodes SetBatteryLevelStatus(UINT8 battStatus, UINT8 *statusRsp)
Set Battery Level Status.
Definition: WiMOD_SAP_LORAWAN.cpp:1569
TRadioCfg_ErrorCoding
TRadioCfg_ErrorCoding
ErrorCoding settings (for LoRa modulation) (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:305
WiMOD_SAP_RadioLink_ProLink::SetAesKey
virtual TWiMODLRResultCodes SetAesKey(const UINT8 *key, UINT8 *statusRsp)
SetAesKey Cmd - Set the 128bit AES that is to be used for encryption.
Definition: WiMOD_SAP_RadioLink_ProLink.cpp:286
WiMODProLink::DeactivateDevice
bool DeactivateDevice(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Deactivate the device (logical disconnect from lora network)
Definition: WiMODProLink.cpp:2361
TWiMODLR_DevMgmt_RadioConfig::Status
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:409
WiMODLRBASE_PLUS::SapGeneric
WiMOD_SAP_Generic SapGeneric
Definition: WiMODLR_BASE_PLUS.h:224
WiMOD_SAP_DevMgmt::~WiMOD_SAP_DevMgmt
virtual ~WiMOD_SAP_DevMgmt(void)
Destructor.
Definition: WiMOD_SAP_DEVMGMT.cpp:77
WiMODProLink::FactoryReset
bool FactoryReset(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset all internal settings to default values (incl. DevEUI !!!)
Definition: WiMODProLink.cpp:2394
WiMODLRBASE_PLUS::~WiMODLRBASE_PLUS
~WiMODLRBASE_PLUS(void)
Destructor.
Definition: WiMODLR_BASE_PLUS.cpp:94
WiMODLRBASE::ClearRtcAlarm
bool ClearRtcAlarm(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Clears pending RTC Alarms of the WiMOD.
Definition: WiMODLR_BASE.cpp:868
WiMOD_SAP_LoRaWAN::SetCustomConfig
virtual TWiMODLRResultCodes SetCustomConfig(const INT8 rfGain, UINT8 *statusRsp)
Setup a custom config for tx power settings; expert level only.
Definition: WiMOD_SAP_LORAWAN.cpp:1268
TRadioCfg_PowerLevel
enum TRadioCfg_TxPowerLevel TRadioCfg_PowerLevel
TxPowerLevel settings (only for LR-BASE)
TRxCDataIndicationCallback
void(* TRxCDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:169
WiMODLRBASE_PLUS::StartRadioLinkTest
bool StartRadioLinkTest(const TWiMODLR_RLT_Parameter *params, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to start the integrated Radio Link Test feature of the WiMOD.
Definition: WiMODLR_BASE_PLUS.cpp:2066
WiMODProLink::RegisterRadioLinkTxUDataIndicationClient
void RegisterRadioLinkTxUDataIndicationClient(TRadioLinkUDataTxIndicationCallback cb)
Register a callback function for the TX U-Data Indication - optional -.
Definition: WiMODProLink.cpp:3443
TRadioLinkAckRxTimeoutIndicationCallback
void(* TRadioLinkAckRxTimeoutIndicationCallback)(void)
Definition: WiMOD_SAP_RadioLink.h:133
WiMODProLink::SetBatteryLevelStatus
bool SetBatteryLevelStatus(UINT8 battStatus, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Set the Battery Level Status.
Definition: WiMODProLink.cpp:2709
WiMODLRBASE::calcFreqToRegister
void calcFreqToRegister(uint32_t freq, uint8_t *msb, uint8_t *mid, uint8_t *lsb)
Convert a frequency in Hz to the corresponding low level register values.
Definition: WiMODLR_BASE.cpp:1731
TResetDevNonceIndicationCallback
void(* TResetDevNonceIndicationCallback)(void)
Definition: WiMOD_SAP_LORAWAN.h:142
WiMODLRBASE::SendCData
bool SendCData(const TWiMODLR_RadioLink_Msg *txMsg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to send transmit C-Data to peer module via RF link.
Definition: WiMODLR_BASE.cpp:1064
WiMOD_SAP_LoRaWAN_ProLink::convert
bool convert(TWiMODLR_HCIMessage &RxMsg, TWiMODLORAWAN_DevTimeAnsInfo *info)
Convert a received low level HCI-Msg to a high-level DevicetimeAnswser structure.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:525
WiMOD_SAP_LoRaWAN_ProLink::GetDeviceNonce
TWiMODLRResultCodes GetDeviceNonce(UINT16 *devNonce, UINT8 *statusRsp)
Gets the current device NONCE value of the WiMOD.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:169
TWiMODLORAWAN_RX_MacCmdData
Structure containing a received MAC command.
Definition: WiMOD_SAP_LORAWAN_IDs.h:534
WiMODProLink::RegisterLinkDiconnectIndicationClient
void RegisterLinkDiconnectIndicationClient(TLinkDisconnectIndicationCallback cb)
Register a callback function for the event "Link Disconnect Indication".
Definition: WiMODProLink.cpp:2920
WiMODLRBASE::ExecuteGenericCmd
bool ExecuteGenericCmd(TWiMODLR_Generic_CmdInfo *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Generic Execution Function for HCI commands that are currently not implemented.
Definition: WiMODLR_BASE.cpp:1898
WiMODProLink::GetDeviceNonce
bool GetDeviceNonce(UINT16 *devNonce, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the Device Nonce / DevNonce that will be used for next Join OTAA procedure.
Definition: WiMODProLink.cpp:2755
WiMODProLink::SetDeviceNonce
bool SetDeviceNonce(const UINT16 devNonce, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Set the Device Nonce / DevNonce for the next Join OTAA procedure.
Definition: WiMODProLink.cpp:2732
TWiMODLRResultCodes
TWiMODLRResultCodes
Result codes for the local serial communication itself.
Definition: WiMODLRHCI.h:149
WiMOD_SAP_SensorApp::GetSensorAppConfig
virtual TWiMODLRResultCodes GetSensorAppConfig(TWiMODLR_SensorApp_Config *config, UINT8 *statusRsp)
Gets the current SensorApp configuration from the WiMOD.
Definition: WiMOD_SAP_SensorApp.cpp:128
LoRaWAN_Region_EU868
@ LoRaWAN_Region_EU868
Definition: WiMOD_SAP_LORAWAN.h:81
SENSORAPP_SAP_ID
#define SENSORAPP_SAP_ID
Definition: WiMOD_SAP_SensorApp_IDs.h:52
WiMODLRBASE::SetOperationMode
bool SetOperationMode(const TWiMOD_OperationMode opMode, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the current operation mode of the WiMOD module.
Definition: WiMODLR_BASE.cpp:666
WiMODLRBASE::ResetRadioConfig
bool ResetRadioConfig(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Resets the current configuration to defaults.
Definition: WiMODLR_BASE.cpp:556
TWiMODLR_DevMgmt_RadioConfig::FskDatarate
TRadioCfg_FskDatarate FskDatarate
Definition: WiMOD_SAP_DEVMGMT_IDs.h:432
TRadioStack_Mode
TRadioStack_Mode
Radio Stack Mode(only for ProLink)
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:71
LoRaWAN_Region_IN865
@ LoRaWAN_Region_IN865
Definition: WiMOD_SAP_LORAWAN.h:83
TWiMODLR_DevMgmt_DevInfo::DevID
UINT32 DevID
Definition: WiMOD_SAP_DEVMGMT_IDs.h:178
WiMOD_SAP_LoRaWAN::setRegion
virtual void setRegion(TLoRaWANregion regionalSetting)
Setup regional settings for the LoRaWAN Firmware of the WiMOD module.
Definition: WiMOD_SAP_LORAWAN.cpp:108
WiMODLRBASE_PLUS::Reset
bool Reset(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset Cmd - Do a local reboot of the WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:223
TWiMODLR_DevMgmt_RadioConfig::LoRaBandWidth
TRadioCfg_LoRaBandwidth LoRaBandWidth
Definition: WiMOD_SAP_DEVMGMT_IDs.h:423
WiMOD_SAP_RadioLink_ProLink::convert
virtual bool convert(TWiMODLR_HCIMessage &RxMsg, TWiMODLR_RadioLink_CdataInd *cDataTxInfo)
Convert a received low level HCI-Msg to a high-level CDataTx Info.
Definition: WiMOD_SAP_RadioLink_ProLink.cpp:98
ProLink_LoRaWAN_FreqBand_EU_868
@ ProLink_LoRaWAN_FreqBand_EU_868
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:65
TWiMODLR_DevMgmt_RadioConfig::RfFreq_MID
UINT8 RfFreq_MID
Definition: WiMOD_SAP_DEVMGMT_IDs.h:421
WiMOD_SAP_RadioLink_ProLink::ResetRadioConfig
virtual TWiMODLRResultCodes ResetRadioConfig(UINT8 *statusRsp)
ResetRadioConfig Cmd - Reset the radio config of the proprietary LR-BASE mode to factory defaults.
Definition: WiMOD_SAP_RadioLink_ProLink.cpp:259
WiMOD_SAP_LoRaWAN_ProLink::RegisterMulticastInvalidDataIndicationClient
void RegisterMulticastInvalidDataIndicationClient(TMCastInvalidDataIndicationCallback cb)
Register a callback function for the event "RX Invalid Multicast Data".
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:825
WiMOD_SAP_RLT::StopRadioLinkTest
virtual TWiMODLRResultCodes StopRadioLinkTest(UINT8 *statusRsp)
Stops the integrated Radio Link Test mode/feature.
Definition: WiMOD_SAP_RLT.cpp:143
WiMODProLink::SetHciConfig
bool SetHciConfig(TWiMODLR_DevMgmt_HciConfig &hciConfig, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets a new HCI configuration of the WiMOD.
Definition: WiMODProLink.cpp:916
TWiMODLR_DevMgmt_FwInfo::FirmwareMayorVersion
UINT8 FirmwareMayorVersion
Definition: WiMOD_SAP_DEVMGMT_IDs.h:224
WiMOD_SAP_RadioLink_ProLink::GetRadioConfig
virtual TWiMODLRResultCodes GetRadioConfig(TWiMODLR_ProLinkRadioLink_RadioConfig *radioCfg, UINT8 *statusRsp)
GetRadioConfig Cmd - Get the radio settings of the proprietary LR-BASE mode.
Definition: WiMOD_SAP_RadioLink_ProLink.cpp:133
ProLink_LoRaWAN_FreqBand_EU_868_RX2_SF9
@ ProLink_LoRaWAN_FreqBand_EU_868_RX2_SF9
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:80
TWiMODLR_DevMgmt_SystemStatus::RxCRCError
UINT32 RxCRCError
Definition: WiMOD_SAP_DEVMGMT_IDs.h:245
WiMODProLink::SetRadioLinkAesKey
bool SetRadioLinkAesKey(const UINT8 *key, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets an AES encryption key for the proprietary LoRa communication feature.
Definition: WiMODProLink.cpp:3259
WiMOD_SAP_RadioLink::convert
virtual bool convert(TWiMODLR_HCIMessage &RxMsg, TWiMODLR_RadioLink_Msg *radioLinkMsg)
Convert a received low level HCI-Msg to a high-level RadioLink-Msg.
Definition: WiMOD_SAP_RadioLink.cpp:153
WiMODLRBASE_PLUS::calcRegisterToFreq
uint32_t calcRegisterToFreq(uint8_t msb, uint8_t mid, uint8_t lsb)
Convert a frequency registers to frequency in Hz.
Definition: WiMODLR_BASE_PLUS.cpp:1825
WiMOD_SAP_LoRaWAN::SendCData
virtual TWiMODLRResultCodes SendCData(const TWiMODLORAWAN_TX_Data *data, UINT8 *statusRsp)
Tries to send transmit C-Data to network server via RF link.
Definition: WiMOD_SAP_LORAWAN.cpp:325
WiMODProLink::ReactivateDevice
bool ReactivateDevice(UINT32 *devAdr, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Re-Activates the device via the ABP procedure.
Definition: WiMODProLink.cpp:1296
TWiMODLORAWAN_ActivateDeviceData
Activation data structure for LoRa network activation.
Definition: WiMOD_SAP_LORAWAN_IDs.h:439
WiMODProLink::WiMODProLink
WiMODProLink(Stream &s)
Constructor.
Definition: WiMODProLink.cpp:69
TWiMODLR_DevMgmt_RadioConfig::StoreNwmFlag
UINT8 StoreNwmFlag
Definition: WiMOD_SAP_DEVMGMT_IDs.h:412
TProLinkDeviceConfig
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:82
WiMODProLink::GetLastHciResult
TWiMODLRResultCodes GetLastHciResult(void)
Gets the last HCI result code from the last executed command.
Definition: WiMODProLink.cpp:3559
WiMODLoRaWAN::SetTxPowerLimitConfig
bool SetTxPowerLimitConfig(TWiMODLORAWAN_TxPwrLimitConfig &txPwrLimitCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Set a single TX limit for a single sub-band.
Definition: WiMODLoRaWAN.cpp:2432
TWiMODLR_RemoteCtrl_BtnPressed
Structure containing a general RadioLink HCI message.
Definition: WiMOD_SAP_RemoteCtrl_IDs.h:86
WiMOD_SAP_LoRaWAN::DeactivateDevice
virtual TWiMODLRResultCodes DeactivateDevice(UINT8 *statusRsp)
Deactivate the device (logical disconnect from lora network)
Definition: WiMOD_SAP_LORAWAN.cpp:996
WiMOD_SAP_RLT::RegisterStatusIndClient
virtual void RegisterStatusIndClient(TRltStatusIndicationCallback cb)
Register a callback function for the event "RLT Status Indication".
Definition: WiMOD_SAP_RLT.cpp:172
ProLink_LoRaWAN_FreqBand_RU_868
@ ProLink_LoRaWAN_FreqBand_RU_868
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:77
WiMODLoRaWAN::SendCData
bool SendCData(const TWiMODLORAWAN_TX_Data *data, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to send transmit C-Data to network server via RF link.
Definition: WiMODLoRaWAN.cpp:1996
TWiMODLR_DevMgmt_RadioConfig::RadioMode
TRadioCfg_RadioMode RadioMode
Definition: WiMOD_SAP_DEVMGMT_IDs.h:414
TWiMODLR_DevMgmt_HciConfig
HCI Configuration Parameters.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:519
WiMOD_SAP_RadioLink::SendCData
virtual TWiMODLRResultCodes SendCData(const TWiMODLR_RadioLink_Msg *txMsg, UINT8 *statusRsp)
Tries to send transmit C-Data to peer module via RF link.
Definition: WiMOD_SAP_RadioLink.cpp:329
WiMOD_SAP_LoRaWAN_ProLink::RegisterDeviceTimeAnsIndicationClient
void RegisterDeviceTimeAnsIndicationClient(TNwkDeviceTimeAnsIndicationCallback cb)
Register a callback function for the event "Nwk DeviceTime Answer Indication".
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:795
WiMOD_SAP_DevMgmt::Ping
virtual TWiMODLRResultCodes Ping(UINT8 *statusRsp)
Ping Cmd - Checks if the serial connection of to the WiMOD module is OK.
Definition: WiMOD_SAP_DEVMGMT.cpp:91
WiMODProLink::GetRtcAlarm
bool GetRtcAlarm(TWiMODLR_DevMgmt_RtcAlarm *rtcAlarm, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets information about the RTC alarm feature of the WiMOD.
Definition: WiMODProLink.cpp:730
WiMODLRBASE_PLUS::RegisterUDataTxClient
void RegisterUDataTxClient(TRadioLinkUDataTxIndicationCallback cb)
Register a callback function for the TX U-Data Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1539
TWiMODLRHCI::begin
virtual void begin(void)
Init function of the generic HCI message handler.
Definition: WiMODLRHCI.cpp:92
WiMODProLink::RegisterRxMacCmdIndicationClient
void RegisterRxMacCmdIndicationClient(TRxMacCmdIndicationCallback cb)
Register a callback function for the event "RX MAC Cmd Indication".
Definition: WiMODProLink.cpp:2091
TWiMODLR_DevMgmt_HciConfig::NumWakeUpChars
UINT16 NumWakeUpChars
Definition: WiMOD_SAP_DEVMGMT_IDs.h:526
TDevMgmtRtcAlarmCallback
void(* TDevMgmtRtcAlarmCallback)(void)
Definition: WiMOD_SAP_DEVMGMT.h:96
WiMOD_SAP_LoRaWAN::GetSupportedBands
virtual TWiMODLRResultCodes GetSupportedBands(TWiMODLORAWAN_SupportedBands *supportedBands, UINT8 *statusRsp)
Get the supported bands of this firmware.
Definition: WiMOD_SAP_LORAWAN.cpp:1338
WiMOD_SAP_RemoteCtrl::convert
virtual bool convert(TWiMODLR_HCIMessage &RxMsg, TWiMODLR_RemoteCtrl_BtnPressed *btnInfo)
Convert a received low level HCI-Msg to a high-level Rx Data structure.
Definition: WiMOD_SAP_RemoteCtrl.cpp:90
WiMOD_SAP_LoRaWAN::ActivateDevice
virtual TWiMODLRResultCodes ActivateDevice(TWiMODLORAWAN_ActivateDeviceData &activationData, UINT8 *statusRsp)
Activates the device via the ABP procedure.
Definition: WiMOD_SAP_LORAWAN.cpp:126
WiMOD_SAP_LoRaWAN::RegisterTxUDataIndicationClient
void RegisterTxUDataIndicationClient(TTxUDataIndicationCallback cb)
Register a callback function for the event "TX U Data Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:793
TDevMgmtPowerUpCallback
void(* TDevMgmtPowerUpCallback)(void)
Definition: WiMOD_SAP_DEVMGMT.h:93
WiMOD_SAP_LoRaWAN::convert
bool convert(TWiMODLR_HCIMessage &RxMsg, TWiMODLORAWAN_RX_Data *loraWanRxData)
Convert a received low level HCI-Msg to a high-level Rx Data structure.
Definition: WiMOD_SAP_LORAWAN.cpp:489
TWiMODLR_DevMgmt_SystemStatusLorawan
Basic information about system status of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_Lorawan_IDs.h:77
TWiMODLR_RadioLink_UdataInd
Structure containing information about a U-Data indication (TX only)
Definition: WiMOD_SAP_RadioLink_IDs.h:232
TWiMODLR_DevMgmt_RadioConfig
Structure containing the radio (stack) config parameters of the WiMOD (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:406
WiMODProLink::SapRadioLink
WiMOD_SAP_RadioLink_ProLink SapRadioLink
Definition: WiMODProLink.h:292
WiMOD_SAP_DevMgmt::GetOperationMode
virtual TWiMODLRResultCodes GetOperationMode(TWiMOD_OperationMode *opMode, UINT8 *statusRsp)
GetOperationMode Cmd - Get the current operation mode of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:499
WiMODProLink::calcFreqToRegister
void calcFreqToRegister(uint32_t freq, uint8_t *msb, uint8_t *mid, uint8_t *lsb)
Convert a frequency in Hz to the corresponding low level register values.
Definition: WiMODProLink.cpp:3362
WiMODLRBASE_PLUS::SetRadioMode
bool SetRadioMode(const TRadioCfg_RadioMode radioMode, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
SetRadioMode - Set the current radio mode of the WiMOD.
Definition: WiMODLR_BASE_PLUS.cpp:673
WiMODLoRaWAN::SetBatteryLevelStatus
bool SetBatteryLevelStatus(UINT8 battStatus, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Set the Battery Level Status.
Definition: WiMODLoRaWAN.cpp:2505
LoRaWAN_Region_RU868
@ LoRaWAN_Region_RU868
Definition: WiMOD_SAP_LORAWAN.h:86
WiMODLoRaWAN::SapDevMgmt
WiMOD_SAP_DevMgmt_Lorawan SapDevMgmt
Definition: WiMODLoRaWAN.h:222
WiMODLRBASE_PLUS::ResetRadioConfig
bool ResetRadioConfig(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Resets the current configuration to defaults.
Definition: WiMODLR_BASE_PLUS.cpp:563
TWiMODLR_DevMgmt_HciConfig::StoreNwmFlag
UINT8 StoreNwmFlag
Definition: WiMOD_SAP_DEVMGMT_IDs.h:522
WiMODProLink::ActivateDevice
bool ActivateDevice(TWiMODLORAWAN_ActivateDeviceData &activationData, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Activates the device via the ABP procedure.
Definition: WiMODProLink.cpp:1229
WiMODLRBASE_PLUS::SendCData
bool SendCData(const TWiMODLR_RadioLink_Msg *txMsg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to send transmit C-Data to peer module via RF link.
Definition: WiMODLR_BASE_PLUS.cpp:1153
WiMODLR_BASE.h
WiMODLRBASE::GetRtcAlarm
bool GetRtcAlarm(TWiMODLR_DevMgmt_RtcAlarm *rtcAlarm, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets information about the RTC alarm feature of the WiMOD.
Definition: WiMODLR_BASE.cpp:839
WiMODLRBASE_PLUS::SapSensor
WiMOD_SAP_SensorApp SapSensor
Definition: WiMODLR_BASE_PLUS.h:226
WiMODLoRaWAN::GetRtc
bool GetRtc(UINT32 *rtcTime, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current RTC data info from WiMOD module.
Definition: WiMODLoRaWAN.cpp:634
WiMODLRBASE_PLUS::begin
void begin(void)
Setup internal things.
Definition: WiMODLR_BASE_PLUS.cpp:117
WiMODLRBASE_PLUS::RegisterRtcAlarmIndicationClient
void RegisterRtcAlarmIndicationClient(TDevMgmtRtcAlarmCallback cb)
Register a callback function for the RTC Alarm Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:952
TWiMODLORAWAN_TX_Data
Structure containing all data necessary to transmitting a data message.
Definition: WiMOD_SAP_LORAWAN_IDs.h:502
WiMOD_SAP_LoRaWAN::SendMacCmd
virtual TWiMODLRResultCodes SendMacCmd(const TWiMODLORAWAN_MacCmd *cmd, UINT8 *statusRsp)
Send a MAC command to the server; expert level only.
Definition: WiMOD_SAP_LORAWAN.cpp:1221
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
WiMODProLink::GetRadioLinkAesKey
bool GetRadioLinkAesKey(UINT8 *key, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current AES encryption of the proprietary LoRa communication feature.
Definition: WiMODProLink.cpp:3289
WiMOD_SAP_DevMgmt::SetAesKey
virtual TWiMODLRResultCodes SetAesKey(const UINT8 *key, UINT8 *statusRsp)
SetAesKey Cmd - Set the 128bit AES that is to be used for encryption.
Definition: WiMOD_SAP_DEVMGMT.cpp:580
TMCastInvalidDataIndicationCallback
void(* TMCastInvalidDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN_ProLink.h:127
WiMODLoRaWAN::GetLastResponseStatus
UINT8 GetLastResponseStatus(void)
Gets the last response code of the WiMOD of the last executed command.
Definition: WiMODLoRaWAN.cpp:2667
ProLink_LoRaWAN_FreqBand_IN_865
@ ProLink_LoRaWAN_FreqBand_IN_865
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:67
WiMODProLink::GetSupportedBands
bool GetSupportedBands(TWiMODLORAWAN_SupportedBands *supportedBands, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the supported bands of this firmware.
Definition: WiMODProLink.cpp:2637
TWiMODLR_DevMgmt_RadioConfig::MiscOptions
UINT8 MiscOptions
Definition: WiMOD_SAP_DEVMGMT_IDs.h:431
WiMODProLink::ConvertAppEuiStrToArray
void ConvertAppEuiStrToArray(char *appEuiStr, uint8_t *appEuiArray)
Converts a string containing an App EUI string into a given byte array.
Definition: WiMODProLink.cpp:319
WiMODLoRaWAN::SendUData
bool SendUData(const TWiMODLORAWAN_TX_Data *data, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to send transmit U-Data to network server via RF link.
Definition: WiMODLoRaWAN.cpp:1938
WiMODProLink::GetTxPowerLimitConfig
bool GetTxPowerLimitConfig(TWiMODLORAWAN_TxPwrLimitConfig *txPwrLimitCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the configured TX limits for all sub-bands.
Definition: WiMODProLink.cpp:2660
TWiMODLR_DevMgmt_SystemStatus
Basic information about system status of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:234
WiMODLoRaWAN::RegisterPowerUpIndicationClient
void RegisterPowerUpIndicationClient(TDevMgmtPowerUpCallback cb)
Register a callback function for the PowerUp Indication - optional -.
Definition: WiMODLoRaWAN.cpp:923
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
RLT_SAP_ID
#define RLT_SAP_ID
Definition: WiMOD_SAP_RLT_IDs.h:52
WiMODProLink::ResetDeviceConfig
bool ResetDeviceConfig(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Resets the settings about the common stack features of the WiMOD module (ProLink firmware)
Definition: WiMODProLink.cpp:1120
WiMODProLink::ConvertNwkSKeyStrToArray
void ConvertNwkSKeyStrToArray(char *nwkSKeyStr, uint8_t *nwkSKeyArray)
Converts a string containing an NwkSKey string into a given byte array.
Definition: WiMODProLink.cpp:357
TWiMODLR_DevMgmt_RadioConfig::RxControl
TRadioCfg_RxControl RxControl
Definition: WiMOD_SAP_DEVMGMT_IDs.h:428
WiMODLRBASE_PLUS::GetOperationMode
bool GetOperationMode(TWiMOD_OperationMode *opMode, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current operation mode of the WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:604
WiMOD_SAP_RadioLink::RegisterUDataRxClient
virtual void RegisterUDataRxClient(TRadioLinkUDataRxIndicationCallback cb)
Register a callback function for the RX U-Data Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:526
WiMODLRBASE_PLUS::RegisterAckRxClient
void RegisterAckRxClient(TRadioLinkAckRxIndicationCallback cb)
Register a callback function for the RX Ack (+data) Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1702
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
WiMODLRBASE_PLUS::GetRtcAlarm
bool GetRtcAlarm(TWiMODLR_DevMgmt_RtcAlarm *rtcAlarm, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets information about the RTC alarm feature of the WiMOD.
Definition: WiMODLR_BASE_PLUS.cpp:847
WiMODLRBASE::GetLastHciResult
TWiMODLRResultCodes GetLastHciResult(void)
Gets the value of the last local HCI TX status.
Definition: WiMODLR_BASE.cpp:1793
FreqCalc_calcFreqToRegister
void FreqCalc_calcFreqToRegister(uint32_t freq, uint8_t *msb, uint8_t *mid, uint8_t *lsb)
Translates a given frequency to the according register values of the TRX.
Definition: FreqCalc_SX127x.c:45
TWiMODLR_RadioLink_CdataInd
Structure containing information about a C-Data indication (TX only)
Definition: WiMOD_SAP_RadioLink_IDs.h:221
WiMODProLink::SetRadioLinkRadioConfig
bool SetRadioLinkRadioConfig(const TWiMODLR_ProLinkRadioLink_RadioConfig *radioCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Set a new RadioConfig to be used for the proprietary LoRa communication feature.
Definition: WiMODProLink.cpp:3180
WiMOD_SAP_SensorApp::RegisterSensorDataIndClient
virtual void RegisterSensorDataIndClient(TSensorAppSensorDataIndicationCallback cb)
Register a callback function for the event "SensorApp Data Indication".
Definition: WiMOD_SAP_SensorApp.cpp:304
WiMODProLink::ConnectViaOTAA
void ConnectViaOTAA(const uint8_t *appEUI=NULL, const uint8_t *appKey=NULL)
do a jump start and use OTAA to connect to a Nwk server
Definition: WiMODProLink.cpp:262
WiMODProLink::RegisterRtcAlarmIndicationClient
void RegisterRtcAlarmIndicationClient(TDevMgmtRtcAlarmCallback cb)
Register a callback function for the RTC Alarm Indication - optional -.
Definition: WiMODProLink.cpp:835
TRadioLinkAckTxIndicationCallback
void(* TRadioLinkAckTxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:136
TLinkDisconnectIndicationCallback
void(* TLinkDisconnectIndicationCallback)(void)
Definition: WiMOD_SAP_LORAWAN.h:145
TWiMODLR_DevMgmt_SystemStatus::RxPackets
UINT32 RxPackets
Definition: WiMOD_SAP_DEVMGMT_IDs.h:243
WiMOD_SAP_LoRaWAN_ProLink::SetDeviceNonce
TWiMODLRResultCodes SetDeviceNonce(const UINT16 devNonce, UINT8 *statusRsp)
SetDeviceNonce Cmd - Sets the device NONCE of WiMOD.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:138
WiMODLRBASE_PLUS::SapRLT
WiMOD_SAP_RLT SapRLT
Definition: WiMODLR_BASE_PLUS.h:225
LoRaWAN_Region_AS923
@ LoRaWAN_Region_AS923
Definition: WiMOD_SAP_LORAWAN.h:84
TWiMODLR_ProLinkRadioLink_RadioConfig
Structure containing the radio (stack) config parameters of the proprietary LR-BASE stack (only for P...
Definition: WiMOD_SAP_RadioLink_ProLink_IDs.h:226
StrToIntConverter_convertHexStrToArray
void StrToIntConverter_convertHexStrToArray(char *inputString, uint8_t *targetArray, uint8_t numberOfEntries)
Convert a String containing hex numbers into an C array.
Definition: StrToIntConverter.cpp:68
WiMODLRBASE::RegisterAckTxCallback
void RegisterAckTxCallback(TRadioLinkAckTxIndicationCallback cb)
Register a callback function for the TX Ack Indication - optional -.
Definition: WiMODLR_BASE.cpp:1715
WiMODProLink::~WiMODProLink
~WiMODProLink(void)
Desctructor.
Definition: WiMODProLink.cpp:89
WiMODProLink::SetDeviceConfig
bool SetDeviceConfig(const TProLinkDeviceConfig &config, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the common Device config features of the WiMOD (only ProLink firmware)
Definition: WiMODProLink.cpp:1045
ProLink_LoRaWAN_Region_RU868
@ ProLink_LoRaWAN_Region_RU868
Definition: WiMOD_SAP_LORAWAN_ProLink.h:79
TWiMOD_RtcAlarmType
TWiMOD_RtcAlarmType
This enum describes the possible RTC alarm types.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:475
WiMOD_SAP_LoRaWAN_ProLink::SetRadioStackConfig
virtual TWiMODLRResultCodes SetRadioStackConfig(TWiMODProLinkLORAWAN_RadioStackConfig *data, UINT8 *statusRsp)
Sets a new radio config parameter set of the WiMOD.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:280
RADIOLINK_SAP_ID
#define RADIOLINK_SAP_ID
Definition: WiMOD_SAP_RadioLink_IDs.h:60
WiMOD_SAP_LoRaWAN_ProLink::setRegion
virtual void setRegion(TProLinkLoRaWANregion regionalSetting)
Setup regional settings for the LoRaWAN Firmware of the WiMOD module.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:123
TRltStatusIndicationCallback
void(* TRltStatusIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RLT.h:80
WiMODLoRaWAN::RegisterRxUDataIndicationClient
void RegisterRxUDataIndicationClient(TRxUDataIndicationCallback cb)
Register a callback function for the event "RX U-Data Indication".
Definition: WiMODLoRaWAN.cpp:1807
TRadioLinkUDataTxIndicationCallback
void(* TRadioLinkUDataTxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:118
WiMOD_SAP_DevMgmt::GetRtcAlarm
virtual TWiMODLRResultCodes GetRtcAlarm(TWiMODLR_DevMgmt_RtcAlarm *rtcAlarm, UINT8 *statusRsp)
GetRtcAlarm Cmd - Get information about RTC alarm feature.
Definition: WiMOD_SAP_DEVMGMT.cpp:675
WiMOD_SAP_DevMgmt::SetRadioConfig
virtual TWiMODLRResultCodes SetRadioConfig(const TWiMODLR_DevMgmt_RadioConfig *radioCfg, UINT8 *statusRsp)
SetRadioConfig Cmd - Set the radio settings of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:411
WiMODLoRaWAN::GetNwkStatus
bool GetNwkStatus(TWiMODLORAWAN_NwkStatus_Data *nwkStatus, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current status of the network "connection".
Definition: WiMODLoRaWAN.cpp:2274
TWiMODLR_DevMgmt_RtcAlarm::Options
TWiMOD_RtcAlarmType Options
Definition: WiMOD_SAP_DEVMGMT_IDs.h:489
TWiMODLR_DevMgmt_DevInfoLoRaWan::DevID
UINT32 DevID
Definition: WiMOD_SAP_DEVMGMT_Lorawan_IDs.h:69
WiMODLRBASE_PLUS::RegisterUDataRxClient
void RegisterUDataRxClient(TRadioLinkUDataRxIndicationCallback cb)
Register a callback function for the RX U-Data Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1496
WiMODProLink::SendUData
bool SendUData(TWiMODProLinkLORAWAN_TX_Data *data, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to send transmit U-Data to network server via RF link.
Definition: WiMODProLink.cpp:2185