 |
Demo HCI Implementation for WiMOD-LR Devices
V2.0.3
|
Go to the documentation of this file.
34 #ifndef ARDUINO_WIMOD_SAP_DEVMGMT_H_
35 #define ARDUINO_WIMOD_SAP_DEVMGMT_H_
53 #include "../HCI/WiMODLRHCI.h"
59 #ifdef WIMOD_USE_CPP11
69 #define WiMOD_DEVMGMT_MSG_SIZE (100)
79 #ifdef WIMOD_USE_CPP11
163 UINT16 txyPayloadSize;
virtual TWiMODLRResultCodes SetDeviceEUI(const UINT8 *deviceEUI, UINT8 *statusRsp)
Sets a new DeviceEUI (aka. IEEE-Address) to the WiMOD.
Definition: WiMOD_SAP_LORAWAN.cpp:1057
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
void(* TJoinedNwkIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:154
WiMOD_SAP_Generic SapGeneric
Definition: WiMODProLink.h:293
UINT8 BuildDateStr[WIMOD_DEVMGMT_MAX_BUILDDATE_LEN]
Definition: WiMOD_SAP_DEVMGMT_IDs.h:226
bool Reset(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset Cmd - Do a local reboot of the WiMOD module.
Definition: WiMODLR_BASE.cpp:220
info data structure for LoRa device time request MAC command
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:114
@ LoRaWAN_NwkStatus_Inactive
Definition: WiMOD_SAP_LORAWAN_IDs.h:387
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:94
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
bool Reset(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset Cmd - Reboots the WiMOD module.
Definition: WiMODLoRaWAN.cpp:465
UINT8 GetLastResponseStatus(void)
Gets the last response code of the WiMOD of the last executed command.
Definition: WiMODProLink.cpp:3605
bool GetDeviceEUI(UINT8 *deviceEUI, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the DeviceEUI (aka. IEEE-Address) of the WiMOD.
Definition: WiMODLoRaWAN.cpp:2227
~WiMODLoRaWAN(void)
Desctructor.
Definition: WiMODLoRaWAN.cpp:88
bool Ping(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Ping Cmd - Checks serial connetion to WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:190
void ConvertAppSKeyStrToArray(char *appSKeyStr, uint8_t *appSKeyArray)
Converts a string containing an AppSKey string into a given byte array.
Definition: WiMODLoRaWAN.cpp:375
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
UINT32 RtcTime
Definition: WiMOD_SAP_DEVMGMT_IDs.h:239
void RegisterAckRxTimeoutClient(TRadioLinkAckRxTimeoutIndicationCallback cb)
Register a callback function for the Ack Timeout Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1750
void RegisterRxUDataIndicationClient(TRxUDataIndicationCallback cb)
Register a callback function for the event "RX U-Data Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:808
void RegisterCDataRxClient(TRadioLinkCDataRxIndicationCallback cb)
Register a callback function for the RX C-Data Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1607
virtual TWiMODLRResultCodes SetRtc(const UINT32 rtcTime, UINT8 *statusRsp)
SetRtc Cmd - Set the current RTC time/date of WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:322
UINT8 TxHoldTime
Definition: WiMOD_SAP_DEVMGMT_IDs.h:527
void RegisterTxUDataIndicationClient(TTxUDataIndicationCallback cb)
Register a callback function for the event "TX U Data Indication".
Definition: WiMODLoRaWAN.cpp:1786
void RegisterRxMacCmdIndicationClient(TRxMacCmdIndicationCallback cb)
Register a callback function for the event "RX MAC Cmd Indication".
Definition: WiMODLoRaWAN.cpp:1849
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
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
Settings for the FSK data rate (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:379
@ ProLink_LoRaWAN_Region_AU915
Definition: WiMOD_SAP_LORAWAN_ProLink.h:77
void RegisterNoDataIndicationClient(TNoDataIndicationCallback cb)
Register a callback function for the event "TX Join Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:763
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
TRadioCfg_PowerLevel PowerLevel
Definition: WiMOD_SAP_DEVMGMT_IDs.h:426
Structure containing data of the joined network indication.
Definition: WiMOD_SAP_LORAWAN_IDs.h:551
void(* TRxUDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:166
Structure containing RX (user) payload data.
Definition: WiMOD_SAP_LORAWAN_IDs.h:514
TLoRaWANregion
LoRaWAN Region support.
Definition: WiMOD_SAP_LORAWAN.h:79
void RegisterNoDataIndicationClient(TNoDataIndicationCallback cb)
Register a callback function for the event "TX Join Indication".
Definition: WiMODLoRaWAN.cpp:1691
UINT8 BandIndex[(WiMODLORAWAN_APP_PAYLOAD_LEN/2)]
Definition: WiMOD_SAP_LORAWAN_IDs.h:666
UINT8 NumOfEntries
Definition: WiMOD_SAP_LORAWAN_IDs.h:665
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
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
void RegisterPowerUpIndicationClient(TDevMgmtPowerUpCallback cb)
Register a callback function for the PowerUp Indication - optional -.
Definition: WiMODProLink.cpp:797
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:174
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
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
virtual TWiMODLRResultCodes FactoryReset(UINT8 *statusRsp)
Reset all internal settings to default values (incl. DevEUI)
Definition: WiMOD_SAP_LORAWAN.cpp:1024
#define DEVMGMT_SAP_ID
Definition: WiMOD_SAP_DEVMGMT_IDs.h:61
bool SetJoinParameter(TWiMODLORAWAN_JoinParams &joinParams, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the parameters used for the OTAA activation procedure.
Definition: WiMODProLink.cpp:1342
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
bool DeactivateDevice(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Deactivate the device (logical disconnect from lora network)
Definition: WiMODLoRaWAN.cpp:2114
UINT32 RxAddressMatch
Definition: WiMOD_SAP_DEVMGMT_IDs.h:244
TWiMODLRResultCodes GetLastHciResult(void)
Gets the last HCI result code from the last executed command.
Definition: WiMODLoRaWAN.cpp:2621
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
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
bool StopRadioLinkTest(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Tries to stop a running Radio Link Test.
Definition: WiMODLR_BASE_PLUS.cpp:2129
TWiMODLRResultCodes ExecuteGenericCmd(TWiMODLR_Generic_CmdInfo *info, UINT8 *statusRsp)
Reset Cmd - Do a reset / reboot of the WiMOD.
Definition: WiMOD_SAP_Generic.cpp:87
void ConvertAppSKeyStrToArray(char *appSKeyStr, uint8_t *appSKeyArray)
Converts a string containing an AppSKey string into a given byte array.
Definition: WiMODProLink.cpp:377
bool ClearRtcAlarm(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Clears pending RTC Alarms of the WiMOD.
Definition: WiMODLoRaWAN.cpp:885
UINT8 GetLastResponseStatus(void)
Gets the value of the last status response value of the WiMOD.
Definition: WiMODLR_BASE.cpp:1838
Structure containing a MultiCast Data.
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:176
Structure containing the radio (stack) config parameters of the WiMOD (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:292
virtual TWiMODLRResultCodes JoinNetwork(UINT8 *statusRsp)
Start joining the network via the OTAA procedure. Asynchronous process.
Definition: WiMOD_SAP_LORAWAN.cpp:246
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
Definition: WiMOD_SAP_LORAWAN_ProLink.h:78
WiMOD_SAP_RadioLink SapRadioLink
Definition: WiMODLR_BASE_PLUS.h:223
Structure containing infos of a NoData Indication message.
Definition: WiMOD_SAP_LORAWAN_IDs.h:648
virtual TWiMODLRResultCodes StartRadioLinkTest(const TWiMODLR_RLT_Parameter *params, UINT8 *statusRsp)
Starts the integrated Radio Link Test mode/feature.
Definition: WiMOD_SAP_RLT.cpp:98
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
virtual void RegisterAckRxTimeoutClient(TRadioLinkAckRxTimeoutIndicationCallback cb)
Register a callback function for the Ack Timeout Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:623
~WiMODLRBASE(void)
Destructor.
Definition: WiMODLR_BASE.cpp:88
UINT8 LedControl
Definition: WiMOD_SAP_DEVMGMT_IDs.h:430
@ ProLink_LoRaWAN_Region_US915
Definition: WiMOD_SAP_LORAWAN_ProLink.h:75
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
void RegisterPowerUpIndicationClient(TDevMgmtPowerUpCallback cb)
Register a callback function for the PowerUp Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:916
bool SetJoinParameter(TWiMODLORAWAN_JoinParams &joinParams, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the parameters used for the OTAA activation procedure.
Definition: WiMODLoRaWAN.cpp:1225
void RegisterBtnPressedClient(TRemoteCtrlBtnPressedIndicationCallback cb)
Register a callback function for the RemoteCtrl Btn Pressed Indication.
Definition: WiMODLR_BASE_PLUS.cpp:2638
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
TWiMOD_RtcAlarmStatus AlarmStatus
Definition: WiMOD_SAP_DEVMGMT_IDs.h:487
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
Activation data structure for LoRa network activation.
Definition: WiMOD_SAP_LORAWAN_IDs.h:472
bool FactoryReset(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset all internal settings to default values (incl. DevEUI !!!)
Definition: WiMODLoRaWAN.cpp:2147
void RegisterLinkDisconnectIndicationClient(TLinkDisconnectIndicationCallback cb)
Register a callback function for the event "Link Disconnect Indication".
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:780
void ConvertAppEuiStrToArray(char *appEuiStr, uint8_t *appEuiArray)
Converts a string containing an App EUI string into a given byte array.
Definition: WiMODLoRaWAN.cpp:317
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
WiMOD_SAP_LoRaWAN SapLoRaWan
Definition: WiMODLoRaWAN.h:223
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
bool Ping(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Ping Cmd - Checks serial connetion to WiMOD module.
Definition: WiMODLR_BASE.cpp:187
bool GetTxPowerLimitConfig(TWiMODLORAWAN_TxPwrLimitConfig *txPwrLimitCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the configured TX limits for all sub-bands.
Definition: WiMODLoRaWAN.cpp:2409
Implementation for the ServiceAccessPoint DeviceManagement.
Definition: WiMOD_SAP_DEVMGMT.h:109
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
virtual void RegisterSensorAckIndClient(TSensorAppAckIndicationCallback cb)
Register a callback function for the event "SensorApp Ack Data Indication".
Definition: WiMOD_SAP_SensorApp.cpp:289
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
void RegisterAckTxCallback(TRadioLinkAckTxIndicationCallback cb)
Register a callback function for the TX Ack Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1794
Internal helper class for processing SLIP frames.
Definition: WiMODLRHCI.h:235
virtual TWiMODLRResultCodes ReactivateDevice(UINT32 *devAdr, UINT8 *statusRsp)
Re-Activates the device via the ABP procedure.
Definition: WiMOD_SAP_LORAWAN.cpp:167
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
void(* TRadioLinkUDataRxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:115
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
Structure containing a MultiCast Data.
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:139
UINT8 SapID
Definition: WiMODLRHCI.h:126
UINT16 RxWindowTime
Definition: WiMOD_SAP_DEVMGMT_IDs.h:429
UINT8 GetLastResponseStatus(void)
Gets the value of the last status response value of the WiMOD.
Definition: WiMODLR_BASE_PLUS.cpp:1919
bool GetNwkStatus(TWiMODLORAWAN_NwkStatus_Data *nwkStatus, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current status of the network "connection".
Definition: WiMODProLink.cpp:2523
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
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
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
bool GetSupportedBands(TWiMODLORAWAN_SupportedBands *supportedBands, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the supported bands of this firmware.
Definition: WiMODLoRaWAN.cpp:2386
void RegisterUDataTxClient(TRadioLinkUDataTxIndicationCallback cb)
Register a callback function for the TX U-Data Indication - optional -.
Definition: WiMODLR_BASE.cpp:1460
WiMODLRBASE(Stream &s)
Constructor.
Definition: WiMODLR_BASE.cpp:69
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
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
void RegisterCDataTxClient(TRadioLinkCDataTxIndicationCallback cb)
Register a callback function for the TX C-Data Indication - optional -.
Definition: WiMODLR_BASE.cpp:1575
void RegisterSensorAppDataIndClient(TSensorAppSensorDataIndicationCallback cb)
Register a callback function for the SensorAppData Indication.
Definition: WiMODLR_BASE_PLUS.cpp:2479
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
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
WiMOD_SAP_DevMgmt SapDevMgmt
Definition: WiMODLR_BASE.h:210
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
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
This enum describes the possible RTC alarm status types.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:459
TWiMOD_HCI_Baudrate BaudrateID
Definition: WiMOD_SAP_DEVMGMT_IDs.h:525
void RegisterUDataRxClient(TRadioLinkUDataRxIndicationCallback cb)
Register a callback function for the RX U-Data Indication - optional -.
Definition: WiMODLR_BASE.cpp:1418
TRadioCfg_RxControl
RX Operation modes (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:347
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
bool Reset(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset Cmd - Reboots the WiMOD module.
Definition: WiMODProLink.cpp:467
Structure containing a general RadioLink HCI message.
Definition: WiMOD_SAP_RadioLink_IDs.h:160
TWiMOD_HCI_Baudrate
This enum describes the Baudrate Settings for the HCI configuration (LR-BASE PLUS & LoRaWAN)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:501
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
Definition: WiMODLRHCI.h:154
UINT8 NetworkStatus
Definition: WiMOD_SAP_LORAWAN_IDs.h:621
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
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:71
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
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
Structure containing all data about LoRaWAN network status.
Definition: WiMOD_SAP_LORAWAN_IDs.h:619
void RegisterRxAckIndicationClient(TRxAckIndicationCallback cb)
Register a callback function for the event "RX ACK (data) Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:868
bool GetDeviceInfo(TWiMODLR_DevMgmt_DevInfo *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the basic DeviceInfo from WiMOD module.
Definition: WiMODLR_BASE.cpp:259
TWiMODLRResultCodes SendNwkTimeRequest(TWiMODLORAWAN_DevTimeReqInfo *devTimeInfo, UINT8 *statusRsp)
SendNwkTimeRequest Cmd - Sends a network device time request to WiMOD.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:485
void RegisterTxCDataIndicationClient(TTxCDataIndicationCallback cb)
Register a callback function for the event "TX C-Data Indication".
Definition: WiMODLoRaWAN.cpp:1738
Basic information about the current firmware of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:220
void RegisterRxUDataIndicationClient(TRxUDataIndicationCallback cb)
Register a callback function for the event "RX U-Data Indication".
Definition: WiMODProLink.cpp:2049
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
void(* TRadioLinkAckRxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:130
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
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
UINT16 BuildCount
Definition: WiMOD_SAP_DEVMGMT_IDs.h:225
virtual void RegisterJoinTxIndicationClient(TJoinTxIndicationCallback cb)
Register a callback function for the event "TX Join Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:406
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(Stream &s)
Constructor.
Definition: WiMODLR_BASE_PLUS.cpp:72
void ConvertNwkSKeyStrToArray(char *nwkSKeyStr, uint8_t *nwkSKeyArray)
Converts a string containing an NwkSKey string into a given byte array.
Definition: WiMODLoRaWAN.cpp:355
void RegisterRtcAlarmIndicationClient(TDevMgmtRtcAlarmCallback cb)
Register a callback function for the RTC Alarm Indication - optional -.
Definition: WiMODLR_BASE.cpp:947
void RegisterTxUDataIndicationClient(TTxUDataIndicationCallback cb)
Register a callback function for the event "TX U Data Indication".
Definition: WiMODProLink.cpp:2028
Structure containing information about an acknowledgment transmission.
Definition: WiMOD_SAP_RadioLink_IDs.h:243
virtual TWiMODLRResultCodes GetRadioConfig(TWiMODLR_DevMgmt_RadioConfig *radioCfg, UINT8 *statusRsp)
GetRadioConfig Cmd - Get the radio settings of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:351
Structure containing basic information about the WiMOD device.
Definition: WiMOD_SAP_DEVMGMT_Lorawan_IDs.h:64
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
basic low level HCI message structure used for all serial messages to/from WiMOD
Definition: WiMODLRHCI.h:120
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
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
UINT8 AppKey[WiMODLORAWAN_APP_KEY_LEN]
Definition: WiMOD_SAP_LORAWAN_IDs.h:453
void RegisterPowerUpIndicationClient(TDevMgmtPowerUpCallback cb)
Register a callback function for the PowerUp Indication - optional -.
Definition: WiMODLR_BASE.cpp:910
@ WiMODLR_RESULT_OK
Definition: WiMODLRHCI.h:151
TRadioCfg_PowerSavingMode
Settings general PowerSaving mode (aka. Sleep mode)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:397
@ LoRaWAN_Region_US915
Definition: WiMOD_SAP_LORAWAN.h:82
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
UINT16 DevAdr
Definition: WiMOD_SAP_DEVMGMT_IDs.h:176
Structure containing the RTC Alarm config parameters of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:484
UINT8 TxGroupAddress
Definition: WiMOD_SAP_DEVMGMT_IDs.h:416
data structure for supported bands
Definition: WiMOD_SAP_LORAWAN_IDs.h:663
void ConvertAppKeyStrToArray(char *appKeyStr, uint8_t *appKeyArray)
Converts a string containing an App Key string into a given byte array.
Definition: WiMODProLink.cpp:338
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
void RegisterRtcAlarmIndicationClient(TDevMgmtRtcAlarmCallback cb)
Register a callback function for processing a RTC Alarm Indication message.
Definition: WiMOD_SAP_DEVMGMT.cpp:833
UINT32 SysTickCounter
Definition: WiMOD_SAP_DEVMGMT_IDs.h:238
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
This enum describes the possible operation modes of the WiMOD (only for LR-BASE).
Definition: WiMOD_SAP_DEVMGMT_IDs.h:440
void RegisterJoinTxIndicationClient(TJoinTxIndicationCallback cb)
Register a callback function for the event "TX Join Indication".
Definition: WiMODProLink.cpp:1447
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
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
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
virtual TWiMODLRResultCodes GetRtc(UINT32 *rtcTime, UINT8 *statusRsp)
GetRtc Cmd - Get the current RTC time/date from WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:285
bool Ping(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Ping Cmd - Checks the serial connection to the WiMOD module.
Definition: WiMODProLink.cpp:443
UINT8 Hour
Definition: WiMOD_SAP_DEVMGMT_IDs.h:490
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
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:75
JOIN data structure for LoRa network activation.
Definition: WiMOD_SAP_LORAWAN_IDs.h:450
@ LoRaWAN_Region_IL915
Definition: WiMOD_SAP_LORAWAN.h:85
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
Structure containing a general RadioLink HCI message.
Definition: WiMOD_SAP_SensorApp_IDs.h:121
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
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
TRadioCfg_Modulation Modulation
Definition: WiMOD_SAP_DEVMGMT_IDs.h:419
void RegisterRadioLinkRxUDataIndicationClient(TRadioLinkUDataRxIndicationCallback cb)
Register a callback function for the event "RX U-Data Indication".
Definition: WiMODProLink.cpp:3399
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
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(TWiMODLRHCI *hci, UINT8 *buffer, UINT16 bufferSize)
Constructor.
Definition: WiMOD_SAP_DEVMGMT.cpp:64
void RegisterMulticastDataIndicationClient(TMCastDataIndicationCallback cb)
Register a callback function for the event "MultiCast Data (Rx) Indication".
Definition: WiMODProLink.cpp:3099
Basic information about system status of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:331
void RegisterMulticastInvalidDataIndicationClient(TMCastInvalidDataIndicationCallback cb)
Register a callback function for the event "Invalid MultiCast Data (RX) Indication".
Definition: WiMODProLink.cpp:3120
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
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:69
void end(void)
Shut shut down function.
Definition: WiMODProLink.cpp:128
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
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
Structure containing the data of an Ack of the SensorApp.
Definition: WiMOD_SAP_SensorApp_IDs.h:164
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
virtual TWiMODLRResultCodes SetJoinParameter(TWiMODLORAWAN_JoinParams &joinParams, UINT8 *statusRsp)
Sets the parameters used for the OTAA activation procedure.
Definition: WiMOD_SAP_LORAWAN.cpp:208
UINT8 GroupAdr
Definition: WiMOD_SAP_DEVMGMT_IDs.h:177
void RegisterRltStatusClient(TRltStatusIndicationCallback cb)
Register a callback function for RLT updates.
Definition: WiMODLR_BASE_PLUS.cpp:2186
virtual TWiMODLRResultCodes SetRadioMode(const TRadioCfg_RadioMode radioMode, UINT8 *statusRsp)
SetRadioMode - Set the current radio mode of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:553
TRadioCfg_LoRaSpreadingFactor LoRaSpreadingFactor
Definition: WiMOD_SAP_DEVMGMT_IDs.h:424
void RegisterRtcAlarmIndicationClient(TDevMgmtRtcAlarmCallback cb)
Register a callback function for the RTC Alarm Indication - optional -.
Definition: WiMODLoRaWAN.cpp:961
UINT8 RfFreq_MSB
Definition: WiMOD_SAP_DEVMGMT_IDs.h:422
Structure containing a general RadioLink HCI message.
Definition: WiMOD_SAP_RLT_IDs.h:114
Structure containing SensorApp Data information.
Definition: WiMOD_SAP_SensorApp_IDs.h:137
WiMOD_SAP_DevMgmt_Plus SapDevMgmt
Definition: WiMODLR_BASE_PLUS.h:222
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
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
virtual TWiMODLRResultCodes GetFirmwareInfo(TWiMODLR_DevMgmt_FwInfo *info, UINT8 *statusRsp)
GetFirmwareInfo Cmd - Get basic info about the running firmware.
Definition: WiMOD_SAP_DEVMGMT.cpp:185
Structure containing a general RadioLink HCI message.
Definition: WiMOD_SAP_RLT_IDs.h:102
WiMOD_SAP_LoRaWAN_ProLink SapLoRaWan
Definition: WiMODProLink.h:291
void RegisterJoinedNwkIndicationClient(TJoinedNwkIndicationCallback cb)
Register a callback function for the event "Joined Nwk Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:853
void(* TRadioLinkRawDataRxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:121
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
virtual TWiMODLRResultCodes GetRadioStackConfig(TWiMODLORAWAN_RadioStackConfig *data, UINT8 *statusRsp)
Gets the current radio config parameter set of the WiMOD.
Definition: WiMOD_SAP_LORAWAN.cpp:946
Radio stack configuration related to to LoRaWAN specific options.
Definition: WiMOD_SAP_LORAWAN_IDs.h:568
UINT16 ExtraStatus
Definition: WiMOD_SAP_DEVMGMT_IDs.h:242
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_PLUS_IDs.h:333
void RegisterRxCDataIndicationClient(TRxCDataIndicationCallback cb)
Register a callback function for the event "RX C-Data Indication".
Definition: WiMODProLink.cpp:2070
UINT16 Length
Definition: WiMODLRHCI.h:123
WiMOD_SAP_RadioLink SapRadioLink
Definition: WiMODLR_BASE.h:211
virtual TWiMODLRResultCodes Reset(UINT8 *statusRsp)
Reset Cmd - Do a reset / reboot of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:118
UINT8 MsgID
Definition: WiMODLRHCI.h:129
void RegisterJoinedNwkIndicationClient(TJoinedNwkIndicationCallback cb)
Register a callback function for the event "Joined Nwk Indication".
Definition: WiMODProLink.cpp:2112
virtual TWiMODLRResultCodes ClearRtcAlarm(UINT8 *statusRsp)
ClearRtcAlarm Cmd - Clear a pending RTC alarm.
Definition: WiMOD_SAP_DEVMGMT.cpp:713
virtual void RegisterBtnPressedClient(TRemoteCtrlBtnPressedIndicationCallback cb)
Register a callback function for the event "Button Pressed Indication".
Definition: WiMOD_SAP_RemoteCtrl.cpp:123
void RegisterTxCDataIndicationClient(TTxCDataIndicationCallback cb)
Register a callback function for the event "TX C-Data Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:778
virtual void RegisterAckTxCallback(TRadioLinkAckTxIndicationCallback cb)
Register a callback function for the TX Ack Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:638
bool RemoveMulticastConfig(const UINT8 mcastIndex, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Remove a single Multicast configuration from module.
Definition: WiMODProLink.cpp:2827
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
Modulation technique supported by the WiMOD (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:266
void(* TTxUDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:163
void RegisterPowerUpIndicationClient(TDevMgmtPowerUpCallback cb)
Register a callback function for processing a PowerUp Indication message.
Definition: WiMOD_SAP_DEVMGMT.cpp:821
data structure for TX Power Limits
Definition: WiMOD_SAP_LORAWAN_IDs.h:674
void RegisterRxCDataIndicationClient(TRxCDataIndicationCallback cb)
Register a callback function for the event "RX C-Data Indication".
Definition: WiMODLoRaWAN.cpp:1828
bool ReactivateDevice(UINT32 *devAdr, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Re-Activates the device via the ABP procedure.
Definition: WiMODLoRaWAN.cpp:1179
bool SetRtc(const UINT32 rtcTime, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the current RTC values to WiMOD module.
Definition: WiMODLoRaWAN.cpp:673
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
UINT8 JoinEUI[WiMODLORAWAN_JOIN_EUI_LEN]
Definition: WiMOD_SAP_LORAWAN_IDs.h:452
void(* TRadioLinkCDataTxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:127
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
bool GetHciConfig(TWiMODLR_DevMgmt_HciConfig *hciConfig, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current HCI configuration of the WiMOD.
Definition: WiMODLoRaWAN.cpp:1000
void(* TRxAckIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:175
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
UINT16 NvmStatus
Definition: WiMOD_SAP_DEVMGMT_IDs.h:240
bool JoinNetwork(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Start joining the network via the OTAA procedure. Asynchronous process.
Definition: WiMODLoRaWAN.cpp:1294
void(* TRemoteCtrlBtnPressedIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RemoteCtrl.h:81
virtual TWiMODLRResultCodes GetDeviceEUI(UINT8 *deviceEUI, UINT8 *statusRsp)
Gets the DeviceEUI (aka. IEEE-Address) of the WiMOD.
Definition: WiMOD_SAP_LORAWAN.cpp:1094
Data structure for received Acknowledgment data.
Definition: WiMOD_SAP_LORAWAN_IDs.h:602
UINT8 Payload[WIMODLR_HCI_MSG_PAYLOAD_SIZE]
Definition: WiMODLRHCI.h:132
virtual TWiMODLRResultCodes GetCustomConfig(INT8 *rfGain, UINT8 *statusRsp)
Get the current offet for tx power level; expert level only.
Definition: WiMOD_SAP_LORAWAN.cpp:1302
TWiMODLRResultCodes GetJoinNonce(UINT16 *joinNonce, UINT8 *statusRsp)
Gets the current Join NONCE value of the WiMOD.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:239
void(* TMCastDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN_ProLink.h:124
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
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
WiMOD_SAP_RemoteCtrl SapRemoteCtrl
Definition: WiMODLR_BASE_PLUS.h:227
void RegisterResetDevNonceIndicationClient(TResetDevNonceIndicationCallback cb)
Register a callback function for the event "Reset DevNonce Indication".
Definition: WiMODProLink.cpp:2851
void end(void)
De-Setup internal things.
Definition: WiMODLR_BASE.cpp:122
bool GetMulticastConfig(TWiMODLORAWAN_McastConfig *mcastCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get a single Multicase configuration from module.
Definition: WiMODProLink.cpp:2803
TRadioCfg_RadioMode
general operation mode of the radio part (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:255
UINT8 FirmwareMinorVersion
Definition: WiMOD_SAP_DEVMGMT_IDs.h:223
bool SetHciConfig(TWiMODLR_DevMgmt_HciConfig &hciConfig, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets a new HCI configuration of the WiMOD.
Definition: WiMODLoRaWAN.cpp:1042
bool SetRtc(const UINT32 rtcTime, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets the current RTC values to WiMOD module.
Definition: WiMODProLink.cpp:632
UINT8 ModuleType
Definition: WiMOD_SAP_DEVMGMT_IDs.h:175
void RegisterAckRxTimeoutClient(TRadioLinkAckRxTimeoutIndicationCallback cb)
Register a callback function for the Ack Timeout Indication - optional -.
Definition: WiMODLR_BASE.cpp:1671
TRadioCfg_ErrorCoding ErrorCoding
Definition: WiMOD_SAP_DEVMGMT_IDs.h:425
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
LoRaWAN Region support.
Definition: WiMOD_SAP_LORAWAN_ProLink.h:72
virtual void RegisterCDataRxClient(TRadioLinkCDataRxIndicationCallback cb)
Register a callback function for the RX C-Data Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:574
void RegisterRxMacCmdIndicationClient(TRxMacCmdIndicationCallback cb)
Register a callback function for the event "RX MAC Cmd Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:838
TRadioCfg_LoRaSpreadingFactor
SpreadingFactors for LoRa modulation (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:285
virtual void end(void)
shutdown function
Definition: WiMODLRHCI.cpp:107
@ ProLink_LoRaWAN_Region_EU868
Definition: WiMOD_SAP_LORAWAN_ProLink.h:74
virtual TWiMODLRResultCodes GetNwkStatus(TWiMODLORAWAN_NwkStatus_Data *nwkStatus, UINT8 *statusRsp)
Gets the current status of the network "connection".
Definition: WiMOD_SAP_LORAWAN.cpp:1168
bool GetFirmwareInfo(TWiMODLR_DevMgmt_FwInfo *info, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the basic FirmwareInfo from WiMOD module.
Definition: WiMODLR_BASE.cpp:298
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
TRadioCfg_PowerSavingMode PowerSavingMode
Definition: WiMOD_SAP_DEVMGMT_IDs.h:433
uint32_t calcRegisterToFreq(uint8_t msb, uint8_t mid, uint8_t lsb)
Convert a frequency registers to frequency in Hz.
Definition: WiMODProLink.cpp:3378
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
UINT8 SysTickResolution
Definition: WiMOD_SAP_DEVMGMT_IDs.h:237
UINT8 Seconds
Definition: WiMOD_SAP_DEVMGMT_IDs.h:492
@ ProLink_LoRaWAN_FreqBand_IN_865_RX2_SF8
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:81
void RegisterSensorAppAckIndClient(TSensorAppAckIndicationCallback cb)
Register a callback function for the SensorAppAckData Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:2435
void RegisterMulticastDataIndicationClient(TMCastDataIndicationCallback cb)
Register a callback function for the event "RX Multicast Data Indication".
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:809
void(* TRxMacCmdIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:172
INT16 LbtThreshold
Definition: WiMOD_SAP_DEVMGMT_IDs.h:434
UINT32 TxPackets
Definition: WiMOD_SAP_DEVMGMT_IDs.h:246
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
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
bool ClearRtcAlarm(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Clears pending RTC Alarms of the WiMOD.
Definition: WiMODLR_BASE_PLUS.cpp:876
virtual void RegisterAckRxClient(TRadioLinkAckRxIndicationCallback cb)
Register a callback function for the RX Ack (+data) Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:608
TWiMODLRResultCodes SetJoinNonce(const UINT16 joinNonce, UINT8 *statusRsp)
SetJoinNonce Cmd - Sets the Join NONCE value of WiMOD.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:208
#define PROLINK_RADIOLINK_SAP_ID
Definition: WiMOD_SAP_RadioLink_ProLink_IDs.h:61
void RegisterNwkTimeAnsIndicationClient(TNwkDeviceTimeAnsIndicationCallback cb)
Register a callback function for the event "DeviceTimeAnser Indication".
Definition: WiMODProLink.cpp:2966
Radio stack configuration related to to LoRaWAN specific options.
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:191
void RegisterNoDataIndicationClient(TNoDataIndicationCallback cb)
Register a callback function for the event "TX Join Indication".
Definition: WiMODProLink.cpp:1933
void RegisterRxCDataIndicationClient(TRxCDataIndicationCallback cb)
Register a callback function for the event "RX C-Data Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:823
UINT8 FirmwareName[WIMOD_DEVMGMT_MAX_FIRMWARE_NAME_LEN]
Definition: WiMOD_SAP_DEVMGMT_IDs.h:227
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
Definition: WiMOD_SAP_LORAWAN_ProLink.h:76
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
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
bool JoinNetwork(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Start joining the network via the OTAA procedure. Asynchronous process.
Definition: WiMODProLink.cpp:1411
UINT8 RfFreq_LSB
Definition: WiMOD_SAP_DEVMGMT_IDs.h:420
void(* TSensorAppAckIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_SensorApp.h:84
TRadioCfg_LoRaBandwidth
Bandwidth settings for the LoRa modulation (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:275
virtual void RegisterUDataTxClient(TRadioLinkUDataTxIndicationCallback cb)
Register a callback function for the TX U-Data Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:540
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
virtual TWiMODLRResultCodes SetRtcAlarm(const TWiMODLR_DevMgmt_RtcAlarm *rtcAlarm, UINT8 *statusRsp)
SetRtcAlarm Cmd - Set a new RTC alarm config.
Definition: WiMOD_SAP_DEVMGMT.cpp:639
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
UINT8 Minutes
Definition: WiMOD_SAP_DEVMGMT_IDs.h:491
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
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
bool GetAesKey(UINT8 *key, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the used security 128bit AES key.
Definition: WiMODLR_BASE.cpp:742
WiMOD_SAP_DevMgmt_ProLink SapDevMgmt
Definition: WiMODProLink.h:290
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
void end(void)
Shut shut down function.
Definition: WiMODLoRaWAN.cpp:127
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
void(* TNwkDeviceTimeAnsIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:148
UINT32 TxError
Definition: WiMOD_SAP_DEVMGMT_IDs.h:247
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_Lorawan_IDs.h:79
bool GetOperationMode(TWiMOD_OperationMode *opMode, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current operation mode of the WiMOD module.
Definition: WiMODLoRaWAN.cpp:719
void RegisterRxAckIndicationClient(TRxAckIndicationCallback cb)
Register a callback function for the event "RX ACK (data) Indication".
Definition: WiMODLoRaWAN.cpp:1891
void(* TRadioLinkCDataRxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:124
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
void(* TTxCDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:160
virtual void RegisterRawDataRxClient(TRadioLinkRawDataRxIndicationCallback cb)
Register a callback function for the RX Raw-Data Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:557
UINT16 TxDeviceAddress
Definition: WiMOD_SAP_DEVMGMT_IDs.h:418
void RegisterTxCDataIndicationClient(TTxCDataIndicationCallback cb)
Register a callback function for the event "TX C-Data Indication".
Definition: WiMODProLink.cpp:1980
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
UINT16 BatteryStatus
Definition: WiMOD_SAP_DEVMGMT_IDs.h:241
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
bool GetDeviceEUI(UINT8 *deviceEUI, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the DeviceEUI (aka. IEEE-Address) of the WiMOD.
Definition: WiMODProLink.cpp:2475
UINT8 GroupAddress
Definition: WiMOD_SAP_DEVMGMT_IDs.h:415
@ WIMOD_STACK_ERR_UNKNOWN_RX_SAP_ID
Definition: WiMODLRHCI.h:173
bool ResetRadioLinkRadioConfig(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset the RadioConfig for the proprietary LoRa communication feature to defaults.
Definition: WiMODProLink.cpp:3205
bool SetMulticastConfig(TWiMODLORAWAN_McastConfig &mcastCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Set a (new) Configuration for Multicast Mode.
Definition: WiMODProLink.cpp:2778
bool GetHciConfig(TWiMODLR_DevMgmt_HciConfig *hciConfig, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current HCI configuration of the WiMOD.
Definition: WiMODProLink.cpp:874
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
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
virtual TWiMODLRResultCodes SetTxPowerLimitConfig(TWiMODLORAWAN_TxPwrLimitConfig &txPwrLimitCfg, UINT8 *statusRsp)
Set a SINGLE TxPowerLimit entry.
Definition: WiMOD_SAP_LORAWAN.cpp:1431
void RegisterRxAckIndicationClient(TRxAckIndicationCallback cb)
Register a callback function for the event "RX ACK (data) Indication".
Definition: WiMODProLink.cpp:2133
void end(void)
De-Setup internal things.
Definition: WiMODLR_BASE_PLUS.cpp:126
Structure containing basic information about the WiMOD device.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:172
UINT8 RxHoldTime
Definition: WiMOD_SAP_DEVMGMT_IDs.h:528
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
void RegisterCDataRxClient(TRadioLinkCDataRxIndicationCallback cb)
Register a callback function for the RX C-Data Indication - optional -.
Definition: WiMODLR_BASE.cpp:1528
info data structure for LoRa device time request MAC command
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:104
TWiMODLRResultCodes GetLastHciResult(void)
Gets the value of the last local HCI TX status.
Definition: WiMODLR_BASE_PLUS.cpp:1874
virtual TWiMODLRResultCodes ResetRadioConfig(UINT8 *statusRsp)
ResetRadioConfig Cmd - Reset the radio config to factory defaults.
Definition: WiMOD_SAP_DEVMGMT.cpp:473
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
Definition: WiMODLRHCI.h:153
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
LoRaWAN MAC command structure.
Definition: WiMOD_SAP_LORAWAN_IDs.h:590
void RegisterAckRxClient(TRadioLinkAckRxIndicationCallback cb)
Register a callback function for the RX Ack (+data) Indication - optional -.
Definition: WiMODLR_BASE.cpp:1623
bool ClearRtcAlarm(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Clears pending RTC Alarms of the WiMOD.
Definition: WiMODProLink.cpp:759
void begin(void)
Setup internal things.
Definition: WiMODLR_BASE.cpp:111
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
WiMOD_SAP_Generic SapGeneric
Definition: WiMODLoRaWAN.h:224
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
WiMOD_SAP_Generic SapGeneric
Definition: WiMODLR_BASE.h:212
Structure containing all data necessary to transmitting a data message.
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:91
@ ProLink_LoRaWAN_FreqBand_AS_923_2
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:74
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
virtual void RegisterCDataTxClient(TRadioLinkCDataTxIndicationCallback cb)
Register a callback function for the TX C-Data Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:591
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:236
@ ProLink_LoRaWAN_FreqBand_AS_923_1
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:73
UINT32 TxMediaBusyEvents
Definition: WiMOD_SAP_DEVMGMT_IDs.h:248
void RegisterCDataTxClient(TRadioLinkCDataTxIndicationCallback cb)
Register a callback function for the TX C-Data Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1654
void RegisterJoinTxIndicationClient(TJoinTxIndicationCallback cb)
Register a callback function for the event "TX Join Indication".
Definition: WiMODLoRaWAN.cpp:1330
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:121
void RegisterJoinedNwkIndicationClient(TJoinedNwkIndicationCallback cb)
Register a callback function for the event "Joined Nwk Indication".
Definition: WiMODLoRaWAN.cpp:1870
UINT16 DeviceAddress
Definition: WiMOD_SAP_DEVMGMT_IDs.h:417
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
void(* TJoinTxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:151
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
void(* TNoDataIndicationCallback)(void)
Definition: WiMOD_SAP_LORAWAN.h:157
WiMODLoRaWAN(Stream &s)
Constructor.
Definition: WiMODLoRaWAN.cpp:69
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:524
virtual TWiMODLRResultCodes GetDeviceInfo(TWiMODLR_DevMgmt_DevInfo *info, UINT8 *statusRsp)
Get Device Info - Basic Information about the WiMOD module.
Definition: WiMOD_SAP_DEVMGMT.cpp:144
void(* TSensorAppSensorDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_SensorApp.h:87
bool GetAesKey(UINT8 *key, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the used security 128bit AES key.
Definition: WiMODLR_BASE_PLUS.cpp:750
virtual TWiMODLRResultCodes GetTxPowerLimitConfig(TWiMODLORAWAN_TxPwrLimitConfig *txPwrLimitCfg, UINT8 *statusRsp)
Get the configured TxPowerLimit settings.
Definition: WiMOD_SAP_LORAWAN.cpp:1382
virtual TWiMODLRResultCodes SetBatteryLevelStatus(UINT8 battStatus, UINT8 *statusRsp)
Set Battery Level Status.
Definition: WiMOD_SAP_LORAWAN.cpp:1569
TRadioCfg_ErrorCoding
ErrorCoding settings (for LoRa modulation) (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:305
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
bool DeactivateDevice(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Deactivate the device (logical disconnect from lora network)
Definition: WiMODProLink.cpp:2361
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:409
WiMOD_SAP_Generic SapGeneric
Definition: WiMODLR_BASE_PLUS.h:224
virtual ~WiMOD_SAP_DevMgmt(void)
Destructor.
Definition: WiMOD_SAP_DEVMGMT.cpp:77
bool FactoryReset(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset all internal settings to default values (incl. DevEUI !!!)
Definition: WiMODProLink.cpp:2394
~WiMODLRBASE_PLUS(void)
Destructor.
Definition: WiMODLR_BASE_PLUS.cpp:94
bool ClearRtcAlarm(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Clears pending RTC Alarms of the WiMOD.
Definition: WiMODLR_BASE.cpp:868
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
enum TRadioCfg_TxPowerLevel TRadioCfg_PowerLevel
TxPowerLevel settings (only for LR-BASE)
void(* TRxCDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN.h:169
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
void RegisterRadioLinkTxUDataIndicationClient(TRadioLinkUDataTxIndicationCallback cb)
Register a callback function for the TX U-Data Indication - optional -.
Definition: WiMODProLink.cpp:3443
void(* TRadioLinkAckRxTimeoutIndicationCallback)(void)
Definition: WiMOD_SAP_RadioLink.h:133
bool SetBatteryLevelStatus(UINT8 battStatus, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Set the Battery Level Status.
Definition: WiMODProLink.cpp:2709
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
void(* TResetDevNonceIndicationCallback)(void)
Definition: WiMOD_SAP_LORAWAN.h:142
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
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
TWiMODLRResultCodes GetDeviceNonce(UINT16 *devNonce, UINT8 *statusRsp)
Gets the current device NONCE value of the WiMOD.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:169
Structure containing a received MAC command.
Definition: WiMOD_SAP_LORAWAN_IDs.h:534
void RegisterLinkDiconnectIndicationClient(TLinkDisconnectIndicationCallback cb)
Register a callback function for the event "Link Disconnect Indication".
Definition: WiMODProLink.cpp:2920
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
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
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
Result codes for the local serial communication itself.
Definition: WiMODLRHCI.h:149
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
Definition: WiMOD_SAP_LORAWAN.h:81
#define SENSORAPP_SAP_ID
Definition: WiMOD_SAP_SensorApp_IDs.h:52
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
bool ResetRadioConfig(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Resets the current configuration to defaults.
Definition: WiMODLR_BASE.cpp:556
TRadioCfg_FskDatarate FskDatarate
Definition: WiMOD_SAP_DEVMGMT_IDs.h:432
TRadioStack_Mode
Radio Stack Mode(only for ProLink)
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:71
@ LoRaWAN_Region_IN865
Definition: WiMOD_SAP_LORAWAN.h:83
UINT32 DevID
Definition: WiMOD_SAP_DEVMGMT_IDs.h:178
virtual void setRegion(TLoRaWANregion regionalSetting)
Setup regional settings for the LoRaWAN Firmware of the WiMOD module.
Definition: WiMOD_SAP_LORAWAN.cpp:108
bool Reset(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Reset Cmd - Do a local reboot of the WiMOD module.
Definition: WiMODLR_BASE_PLUS.cpp:223
TRadioCfg_LoRaBandwidth LoRaBandWidth
Definition: WiMOD_SAP_DEVMGMT_IDs.h:423
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
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:65
UINT8 RfFreq_MID
Definition: WiMOD_SAP_DEVMGMT_IDs.h:421
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
void RegisterMulticastInvalidDataIndicationClient(TMCastInvalidDataIndicationCallback cb)
Register a callback function for the event "RX Invalid Multicast Data".
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:825
virtual TWiMODLRResultCodes StopRadioLinkTest(UINT8 *statusRsp)
Stops the integrated Radio Link Test mode/feature.
Definition: WiMOD_SAP_RLT.cpp:143
bool SetHciConfig(TWiMODLR_DevMgmt_HciConfig &hciConfig, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Sets a new HCI configuration of the WiMOD.
Definition: WiMODProLink.cpp:916
UINT8 FirmwareMayorVersion
Definition: WiMOD_SAP_DEVMGMT_IDs.h:224
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
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:80
UINT32 RxCRCError
Definition: WiMOD_SAP_DEVMGMT_IDs.h:245
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
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
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
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
bool ReactivateDevice(UINT32 *devAdr, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Re-Activates the device via the ABP procedure.
Definition: WiMODProLink.cpp:1296
Activation data structure for LoRa network activation.
Definition: WiMOD_SAP_LORAWAN_IDs.h:439
WiMODProLink(Stream &s)
Constructor.
Definition: WiMODProLink.cpp:69
UINT8 StoreNwmFlag
Definition: WiMOD_SAP_DEVMGMT_IDs.h:412
Definition: WiMOD_SAP_DEVMGMT_ProLink_IDs.h:82
TWiMODLRResultCodes GetLastHciResult(void)
Gets the last HCI result code from the last executed command.
Definition: WiMODProLink.cpp:3559
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
Structure containing a general RadioLink HCI message.
Definition: WiMOD_SAP_RemoteCtrl_IDs.h:86
virtual TWiMODLRResultCodes DeactivateDevice(UINT8 *statusRsp)
Deactivate the device (logical disconnect from lora network)
Definition: WiMOD_SAP_LORAWAN.cpp:996
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
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:77
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
TRadioCfg_RadioMode RadioMode
Definition: WiMOD_SAP_DEVMGMT_IDs.h:414
HCI Configuration Parameters.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:519
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
void RegisterDeviceTimeAnsIndicationClient(TNwkDeviceTimeAnsIndicationCallback cb)
Register a callback function for the event "Nwk DeviceTime Answer Indication".
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:795
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
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
void RegisterUDataTxClient(TRadioLinkUDataTxIndicationCallback cb)
Register a callback function for the TX U-Data Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1539
virtual void begin(void)
Init function of the generic HCI message handler.
Definition: WiMODLRHCI.cpp:92
void RegisterRxMacCmdIndicationClient(TRxMacCmdIndicationCallback cb)
Register a callback function for the event "RX MAC Cmd Indication".
Definition: WiMODProLink.cpp:2091
UINT16 NumWakeUpChars
Definition: WiMOD_SAP_DEVMGMT_IDs.h:526
void(* TDevMgmtRtcAlarmCallback)(void)
Definition: WiMOD_SAP_DEVMGMT.h:96
virtual TWiMODLRResultCodes GetSupportedBands(TWiMODLORAWAN_SupportedBands *supportedBands, UINT8 *statusRsp)
Get the supported bands of this firmware.
Definition: WiMOD_SAP_LORAWAN.cpp:1338
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
virtual TWiMODLRResultCodes ActivateDevice(TWiMODLORAWAN_ActivateDeviceData &activationData, UINT8 *statusRsp)
Activates the device via the ABP procedure.
Definition: WiMOD_SAP_LORAWAN.cpp:126
void RegisterTxUDataIndicationClient(TTxUDataIndicationCallback cb)
Register a callback function for the event "TX U Data Indication".
Definition: WiMOD_SAP_LORAWAN.cpp:793
void(* TDevMgmtPowerUpCallback)(void)
Definition: WiMOD_SAP_DEVMGMT.h:93
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
Basic information about system status of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_Lorawan_IDs.h:77
Structure containing information about a U-Data indication (TX only)
Definition: WiMOD_SAP_RadioLink_IDs.h:232
Structure containing the radio (stack) config parameters of the WiMOD (only for LR-BASE)
Definition: WiMOD_SAP_DEVMGMT_IDs.h:406
WiMOD_SAP_RadioLink_ProLink SapRadioLink
Definition: WiMODProLink.h:292
virtual TWiMODLRResultCodes GetOperationMode(TWiMOD_OperationMode *opMode, UINT8 *statusRsp)
GetOperationMode Cmd - Get the current operation mode of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT.cpp:499
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
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
bool SetBatteryLevelStatus(UINT8 battStatus, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Set the Battery Level Status.
Definition: WiMODLoRaWAN.cpp:2505
@ LoRaWAN_Region_RU868
Definition: WiMOD_SAP_LORAWAN.h:86
WiMOD_SAP_DevMgmt_Lorawan SapDevMgmt
Definition: WiMODLoRaWAN.h:222
bool ResetRadioConfig(TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Resets the current configuration to defaults.
Definition: WiMODLR_BASE_PLUS.cpp:563
UINT8 StoreNwmFlag
Definition: WiMOD_SAP_DEVMGMT_IDs.h:522
bool ActivateDevice(TWiMODLORAWAN_ActivateDeviceData &activationData, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Activates the device via the ABP procedure.
Definition: WiMODProLink.cpp:1229
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
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
WiMOD_SAP_SensorApp SapSensor
Definition: WiMODLR_BASE_PLUS.h:226
bool GetRtc(UINT32 *rtcTime, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current RTC data info from WiMOD module.
Definition: WiMODLoRaWAN.cpp:634
void begin(void)
Setup internal things.
Definition: WiMODLR_BASE_PLUS.cpp:117
void RegisterRtcAlarmIndicationClient(TDevMgmtRtcAlarmCallback cb)
Register a callback function for the RTC Alarm Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:952
Structure containing all data necessary to transmitting a data message.
Definition: WiMOD_SAP_LORAWAN_IDs.h:502
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
UINT8 TxControl
Definition: WiMOD_SAP_DEVMGMT_IDs.h:427
UINT8 Status
Definition: WiMOD_SAP_DEVMGMT_IDs.h:222
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
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
void(* TMCastInvalidDataIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_LORAWAN_ProLink.h:127
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
Definition: WiMOD_SAP_LORAWAN_ProLink_IDs.h:67
bool GetSupportedBands(TWiMODLORAWAN_SupportedBands *supportedBands, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the supported bands of this firmware.
Definition: WiMODProLink.cpp:2637
UINT8 MiscOptions
Definition: WiMOD_SAP_DEVMGMT_IDs.h:431
void ConvertAppEuiStrToArray(char *appEuiStr, uint8_t *appEuiArray)
Converts a string containing an App EUI string into a given byte array.
Definition: WiMODProLink.cpp:319
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
bool GetTxPowerLimitConfig(TWiMODLORAWAN_TxPwrLimitConfig *txPwrLimitCfg, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Get the configured TX limits for all sub-bands.
Definition: WiMODProLink.cpp:2660
Basic information about system status of the WiMOD.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:234
void RegisterPowerUpIndicationClient(TDevMgmtPowerUpCallback cb)
Register a callback function for the PowerUp Indication - optional -.
Definition: WiMODLoRaWAN.cpp:923
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
#define RLT_SAP_ID
Definition: WiMOD_SAP_RLT_IDs.h:52
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
void ConvertNwkSKeyStrToArray(char *nwkSKeyStr, uint8_t *nwkSKeyArray)
Converts a string containing an NwkSKey string into a given byte array.
Definition: WiMODProLink.cpp:357
TRadioCfg_RxControl RxControl
Definition: WiMOD_SAP_DEVMGMT_IDs.h:428
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
virtual void RegisterUDataRxClient(TRadioLinkUDataRxIndicationCallback cb)
Register a callback function for the RX U-Data Indication - optional -.
Definition: WiMOD_SAP_RadioLink.cpp:526
void RegisterAckRxClient(TRadioLinkAckRxIndicationCallback cb)
Register a callback function for the RX Ack (+data) Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1702
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
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
TWiMODLRResultCodes GetLastHciResult(void)
Gets the value of the last local HCI TX status.
Definition: WiMODLR_BASE.cpp:1793
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
Structure containing information about a C-Data indication (TX only)
Definition: WiMOD_SAP_RadioLink_IDs.h:221
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
virtual void RegisterSensorDataIndClient(TSensorAppSensorDataIndicationCallback cb)
Register a callback function for the event "SensorApp Data Indication".
Definition: WiMOD_SAP_SensorApp.cpp:304
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
void RegisterRtcAlarmIndicationClient(TDevMgmtRtcAlarmCallback cb)
Register a callback function for the RTC Alarm Indication - optional -.
Definition: WiMODProLink.cpp:835
void(* TRadioLinkAckTxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:136
void(* TLinkDisconnectIndicationCallback)(void)
Definition: WiMOD_SAP_LORAWAN.h:145
UINT32 RxPackets
Definition: WiMOD_SAP_DEVMGMT_IDs.h:243
TWiMODLRResultCodes SetDeviceNonce(const UINT16 devNonce, UINT8 *statusRsp)
SetDeviceNonce Cmd - Sets the device NONCE of WiMOD.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:138
WiMOD_SAP_RLT SapRLT
Definition: WiMODLR_BASE_PLUS.h:225
@ LoRaWAN_Region_AS923
Definition: WiMOD_SAP_LORAWAN.h:84
Structure containing the radio (stack) config parameters of the proprietary LR-BASE stack (only for P...
Definition: WiMOD_SAP_RadioLink_ProLink_IDs.h:226
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
void RegisterAckTxCallback(TRadioLinkAckTxIndicationCallback cb)
Register a callback function for the TX Ack Indication - optional -.
Definition: WiMODLR_BASE.cpp:1715
~WiMODProLink(void)
Desctructor.
Definition: WiMODProLink.cpp:89
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
Definition: WiMOD_SAP_LORAWAN_ProLink.h:79
TWiMOD_RtcAlarmType
This enum describes the possible RTC alarm types.
Definition: WiMOD_SAP_DEVMGMT_IDs.h:475
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
#define RADIOLINK_SAP_ID
Definition: WiMOD_SAP_RadioLink_IDs.h:60
virtual void setRegion(TProLinkLoRaWANregion regionalSetting)
Setup regional settings for the LoRaWAN Firmware of the WiMOD module.
Definition: WiMOD_SAP_LORAWAN_ProLink.cpp:123
void(* TRltStatusIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RLT.h:80
void RegisterRxUDataIndicationClient(TRxUDataIndicationCallback cb)
Register a callback function for the event "RX U-Data Indication".
Definition: WiMODLoRaWAN.cpp:1807
void(* TRadioLinkUDataTxIndicationCallback)(TWiMODLR_HCIMessage &rxMsg)
Definition: WiMOD_SAP_RadioLink.h:118
virtual TWiMODLRResultCodes GetRtcAlarm(TWiMODLR_DevMgmt_RtcAlarm *rtcAlarm, UINT8 *statusRsp)
GetRtcAlarm Cmd - Get information about RTC alarm feature.
Definition: WiMOD_SAP_DEVMGMT.cpp:675
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
bool GetNwkStatus(TWiMODLORAWAN_NwkStatus_Data *nwkStatus, TWiMODLRResultCodes *hciResult=NULL, UINT8 *rspStatus=NULL)
Gets the current status of the network "connection".
Definition: WiMODLoRaWAN.cpp:2274
TWiMOD_RtcAlarmType Options
Definition: WiMOD_SAP_DEVMGMT_IDs.h:489
UINT32 DevID
Definition: WiMOD_SAP_DEVMGMT_Lorawan_IDs.h:69
void RegisterUDataRxClient(TRadioLinkUDataRxIndicationCallback cb)
Register a callback function for the RX U-Data Indication - optional -.
Definition: WiMODLR_BASE_PLUS.cpp:1496
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