sundp
/
STM32CubeWL
mirror of https://github.com/STMicroelectronics/STM32CubeWL.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
STM32CubeWL/Middlewares/Third_Party/LoRaWAN/LmHandler/LmHandler.h

829 lines
23 KiB
C
Raw Blame History

/*!
* \file LmHandler.h
*
* \brief Implements the LoRaMac layer handling.
* Provides the possibility to register applicative packages.
*
* \remark Inspired by the examples provided on the en.i-cube_lrwan fork.
* MCD Application Team ( STMicroelectronics International )
*
* \copyright Revised BSD License, see section \ref LICENSE.
*
* \code
* ______ _
* / _____) _ | |
* ( (____ _____ ____ _| |_ _____ ____| |__
* \____ \| ___ | (_ _) ___ |/ ___) _ \
* _____) ) ____| | | || |_| ____( (___| | | |
* (______/|_____)_|_|_| \__)_____)\____)_| |_|
* (C)2013-2018 Semtech
*
* \endcode
*
* \author Miguel Luis ( Semtech )
*/
/**
******************************************************************************
*
* Portions COPYRIGHT 2020 STMicroelectronics
*
* @file LmHandler.h
* @author MCD Application Team
* @brief Header for LoRaMAC Layer handling module
******************************************************************************
*/
#ifndef __LORAMAC_HANDLER_H__
#define __LORAMAC_HANDLER_H__
#ifdef __cplusplus
extern "C"
{
#endif
/* Includes ------------------------------------------------------------------*/
#include "LmHandlerTypes.h"
#include "LoRaMacVersion.h"
#include "RegionVersion.h"
/* Exported defines ----------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/* Exported types ------------------------------------------------------------*/
/*!
* \brief Join notification parameters
*/
typedef struct LmHandlerJoinParams_s
{
CommissioningParams_t *CommissioningParams;
int8_t Datarate;
int8_t TxPower;
LmHandlerErrorStatus_t Status;
ActivationType_t Mode;
bool forceRejoin;
} LmHandlerJoinParams_t;
/*!
* \brief Tx notification parameters
*/
typedef struct LmHandlerTxParams_s
{
uint8_t IsMcpsConfirm;
LoRaMacEventInfoStatus_t Status;
CommissioningParams_t *CommissioningParams;
LmHandlerMsgTypes_t MsgType;
uint8_t AckReceived;
int8_t Datarate;
uint32_t UplinkCounter;
LmHandlerAppData_t AppData;
int8_t TxPower;
uint8_t Channel;
} LmHandlerTxParams_t;
/*!
* \brief Rx notification parameters
*/
typedef struct LmHandlerRxParams_s
{
uint8_t IsMcpsIndication;
LoRaMacEventInfoStatus_t Status;
CommissioningParams_t *CommissioningParams;
int8_t Datarate;
int8_t Rssi;
int8_t Snr;
uint32_t DownlinkCounter;
uint8_t RxSlot;
bool LinkCheck;
uint8_t DemodMargin;
uint8_t NbGateways;
} LmHandlerRxParams_t;
/*!
* \brief Beacon notification parameters
*/
typedef struct LmHandlerBeaconParams_s
{
LoRaMacEventInfoStatus_t Status;
LmHandlerBeaconState_t State;
BeaconInfo_t Info;
} LmHandlerBeaconParams_t;
/*!
* \brief LoRaMac handler parameters
*/
typedef struct LmHandlerParams_s
{
/*!
* Active Region
*/
LoRaMacRegion_t ActiveRegion;
/*!
* Default Class
*/
DeviceClass_t DefaultClass;
/*!
* Holds the ADR state
*/
bool AdrEnable;
/*!
* Uplink frame type
*/
LmHandlerMsgTypes_t IsTxConfirmed;
/*!
* Uplink datarate, when \ref AdrEnable is OFF
*/
int8_t TxDatarate;
/*!
* Channels TX power
*/
int8_t TxPower;
/*!
* Enables/Disables a public network usage
*/
bool PublicNetworkEnable;
/*!
* LoRaWAN ETSI duty cycle control enable/disable
*
* \remark Please note that ETSI mandates duty cycled transmissions. Use only for test purposes
*/
bool DutyCycleEnabled;
/*!
* Application data buffer maximum size
*/
uint8_t DataBufferMaxSize;
/*!
* Application data buffer pointer
*/
uint8_t *DataBuffer;
/*!
* Class B ping-slot periodicity.
*/
uint8_t PingSlotPeriodicity;
/*!
* Default response timeout for class b and class c confirmed downlink frames in milli seconds.
*/
uint32_t RxBCTimeout;
} LmHandlerParams_t;
/*!
* \brief LoRaMac handler callbacks
*/
typedef struct LmHandlerCallbacks_s
{
/*!
* Get the current battery level
*
* \retval value Battery level ( 0: very low, 254: fully charged )
*/
uint8_t ( *GetBatteryLevel )( void );
/*!
* Get the current temperature
*
* \retval value Temperature in degree Celsius
*/
int16_t ( *GetTemperature )( void );
/*!
* Get the board 64 bits unique ID
*
* \param [out] id unique
*/
void ( *GetUniqueId )( uint8_t *id );
/*!
* Get the board 32 bits unique ID (LSB)
*
* \param [out] devAddr Device Address
*/
void ( *GetDevAddr )( uint32_t *devAddr );
/*!
* Restore the NVM Data context from the Flash
*
* \param [IN] nvm ptr on nvm structure
*
* \param [IN] nvm_size number of data bytes which were restored
*/
void ( *OnRestoreContextRequest )( void *nvm, uint32_t nvm_size );
/*!
* Store the NVM Data context to the Flash
*
* \param [IN] nvm ptr on nvm structure
*
* \param [IN] nvm_size number of data bytes which were stored
*/
void ( *OnStoreContextRequest )( void *nvm, uint32_t nvm_size );
/*!
*\brief Will be called each time a Radio IRQ is handled by the MAC
* layer.
*
*\warning Runs in a IRQ context. Should only change variables state.
*/
void ( *OnMacProcess )( void );
/*!
* Notifies the upper layer that the NVM context has changed
*
* \param [in] state Indicates if we are storing (true) or
* restoring (false) the NVM context
*/
void ( *OnNvmDataChange )( LmHandlerNvmContextStates_t state );
/*!
* Notifies the upper layer that a network parameters have been set
*
* \param [in] params notification parameters
*/
void ( *OnNetworkParametersChange )( CommissioningParams_t *params );
/*!
* Notifies the upper layer that a network has been joined
*
* \param [in] params notification parameters
*/
void ( *OnJoinRequest )( LmHandlerJoinParams_t *params );
/*!
* Notifies upper layer that a frame has been transmitted
*
* \param [in] params notification parameters
*/
void ( *OnTxData )( LmHandlerTxParams_t *params );
/*!
* Notifies the upper layer that an applicative frame has been received
*
* \param [in] appData Received applicative data
* \param [in] params notification parameters
*/
void ( *OnRxData )( LmHandlerAppData_t *appData, LmHandlerRxParams_t *params );
/*!
* Confirms the LoRaWAN device class change
*
* \param [in] deviceClass New end-device class
*/
void ( *OnClassChange )( DeviceClass_t deviceClass );
/*!
* Notifies the upper layer that the beacon status has changed
*
* \param [in] params notification parameters
*/
void ( *OnBeaconStatusChange )( LmHandlerBeaconParams_t *params );
/*!
* Notifies the upper layer that the system time has been updated.
*/
void ( *OnSysTimeUpdate )( void );
/*!
* Will be called to change applicative Tx frame period
*
* \param [in] periodicity index of Tx period in time array in sec [0, 5, 10, 20, 30, 40, 50, 60, 120, 240, 480]
* \note Compliance test protocol callbacks used when TS001-1.0.4 + TS009 1.0.0 are defined
*/
void ( *OnTxPeriodicityChanged )( uint32_t periodicity );
/*!
* Will be called to change applicative Tx frame control
*
* \param [in] isTxConfirmed set the Tx frame in confirmed/unconfirmed control
* \note Compliance test protocol callbacks used when TS001-1.0.4 + TS009 1.0.0 are defined
*/
void ( *OnTxFrameCtrlChanged )( LmHandlerMsgTypes_t isTxConfirmed );
/*!
* Will be called to change the ping period
*
* \param [in] pingSlotPeriodicity index of ping period as 2^X value
* \note Compliance test protocol callbacks used when TS001-1.0.4 + TS009 1.0.0 are defined
*/
void ( *OnPingSlotPeriodicityChanged )( uint8_t pingSlotPeriodicity );
/*!
* Will be called to reset the system
* \note Compliance test protocol callbacks used when TS001-1.0.4 + TS009 1.0.0 are defined
*/
void ( *OnSystemReset )( void );
} LmHandlerCallbacks_t;
/* External variables --------------------------------------------------------*/
/* Exported macros -----------------------------------------------------------*/
/* Exported functions ------------------------------------------------------- */
/*!
* LoRaMac handler initialisation
*
* \param [in] handlerCallbacks LoRaMac handler callbacks
* \param [in] fwVersion Current firmware version
*
* \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if package have been
* initialized else \ref LORAMAC_HANDLER_ERROR
*/
LmHandlerErrorStatus_t LmHandlerInit( LmHandlerCallbacks_t *handlerCallbacks, uint32_t fwVersion );
/*!
* LoRaMac handler deinit
*
* \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if package have been
* initialized else \ref LORAMAC_HANDLER_ERROR
*/
LmHandlerErrorStatus_t LmHandlerDeInit( void );
/*!
* \brief LoRaMac handler configuration
*
* \param [in] handlerParams LoRaMac handler parameters
*
* \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if configuration is
* done else \ref LORAMAC_HANDLER_ERROR
*/
LmHandlerErrorStatus_t LmHandlerConfigure( LmHandlerParams_t *handlerParams );
/*!
* Indicates if the LoRaMacHandler is busy
*
* \retval status [true] Busy, [false] free
*/
bool LmHandlerIsBusy( void );
/*!
* Processes the LoRaMac and Radio events.
* When no pending operation asks to go in low power mode.
*
* \remark This function must be called in the main loop.
*/
void LmHandlerProcess( void );
/*!
* Instructs the MAC layer to send a ClassA uplink
*
* \param [in] appData Data to be sent
* \param [in] isTxConfirmed Indicates if the uplink requires an acknowledgement
* \param [in] allowDelayedTx when set to true, the frame will be delayed
*
* \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if request has been
* processed else \ref LORAMAC_HANDLER_ERROR
*/
LmHandlerErrorStatus_t LmHandlerSend( LmHandlerAppData_t *appData, LmHandlerMsgTypes_t isTxConfirmed,
bool allowDelayedTx );
/*!
* Gets current duty-cycle wait time
*
* \retval time to wait in ms
*/
TimerTime_t LmHandlerGetDutyCycleWaitTime( void );
/*!
* Join a LoRa Network in classA
*
* \param [in] mode Activation mode (OTAA or ABP)
* \param [in] forceRejoin Flag to force the rejoin even if LoRaWAN context can be restored
*
* \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if request has been
* processed else if device not yet joined a network \ref LORAMAC_HANDLER_NO_NETWORK_JOINED
* else \ref LORAMAC_HANDLER_ERROR
*/
LmHandlerErrorStatus_t LmHandlerJoin( ActivationType_t mode, bool forceRejoin );
/*!
* Check whether the Device is joined to the network
*
* \retval status Returns \ref LORAMAC_HANDLER_SET if joined else \ref LORAMAC_HANDLER_RESET
*/
LmHandlerFlagStatus_t LmHandlerJoinStatus( void );
/*!
* Informs the server on the ping-slot periodicity to use
*
* \param [in] periodicity Is equal to 2^periodicity seconds.
* Example: 2^3 = 8 seconds. The end-device will open an Rx slot every 8 seconds.
*
* \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if request has been
* processed else \ref LORAMAC_HANDLER_ERROR
*/
LmHandlerErrorStatus_t LmHandlerPingSlotReq( uint8_t periodicity );
/*!
* \brief Request the MAC layer to change LoRaWAN class
*
* \note Callback \ref LmHandlerCallbacks_t.OnClassChange informs upper layer that the change has occurred
* \note Only switch from class A to class B/C OR from class B/C to class A is allowed
*
* \param [in] newClass New class to be requested
*
* \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if request has been
* processed else if device not yet joined a network \ref LORAMAC_HANDLER_NO_NETWORK_JOINED
* else \ref LORAMAC_HANDLER_ERROR
*/
LmHandlerErrorStatus_t LmHandlerRequestClass( DeviceClass_t newClass );
/*!
* \brief Gets the current LoRaWAN class
*
* \param [out] deviceClass current class
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetCurrentClass( DeviceClass_t *deviceClass );
/*!
* \brief Gets the current datarate
*
* \param [out] txDatarate Current TX datarate
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetTxDatarate( int8_t *txDatarate );
/*!
* \brief Gets the current active region
*
* \param [out] region Current active region
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetActiveRegion( LoRaMacRegion_t *region );
/*!
* Set system maximum tolerated rx error in milliseconds
*
* \param [in] maxErrorInMs Maximum tolerated error in milliseconds
*
* \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if request has been
* processed else \ref LORAMAC_HANDLER_ERROR
*/
LmHandlerErrorStatus_t LmHandlerSetSystemMaxRxError( uint32_t maxErrorInMs );
/*
*=============================================================================
* PACKAGES HANDLING
*=============================================================================
*/
/*!
* \brief LoRaMac handler package initialization
*
* \param [in] id package identifier
* \param [in] params package parameters
*
* \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if package initialization is
* completed else \ref LORAMAC_HANDLER_ERROR
*/
LmHandlerErrorStatus_t LmHandlerPackageRegister( uint8_t id, void *params );
/*!
* \brief Stop a LoRa Network connection
*
* \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if LoRaMAC has been stopped successfully
* else \ref LORAMAC_HANDLER_BUSY_ERROR
*/
LmHandlerErrorStatus_t LmHandlerStop( void );
/*!
* \brief Halt the LoRa stack with break of current process
*
* \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if LoRaMAC has been stopped successfully
* else \ref LORAMAC_HANDLER_BUSY_ERROR
*/
LmHandlerErrorStatus_t LmHandlerHalt( void );
/*!
* \brief Gets the LoRaWAN Device EUI (if OTAA)
*
* \param [out] devEUI LoRaWAN DevEUI
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetDevEUI( uint8_t *devEUI );
/*!
* \brief Sets the LoRaWAN Device EUI (if OTAA)
*
* \param [in] devEUI LoRaWAN DevEUI
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetDevEUI( uint8_t *devEUI );
/*!
* \brief Gets the LoRaWAN AppEUI (from the Commissioning)
*
* \param [out] appEUI LoRaWAN AppEUI
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetAppEUI( uint8_t *appEUI );
/*!
* \brief Sets the LoRaWAN App EUI (if OTAA)
*
* \param [in] appEUI LoRaWAN AppEUI
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetAppEUI( uint8_t *appEUI );
/*!
* \brief Gets the LoRaWAN Network ID (from the Commissioning if ABP or after the Join if OTAA)
*
* \param [out] networkId current network ID
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetNetworkID( uint32_t *networkId );
/*!
* \brief Sets the LoRaWAN Network ID
*
* \param [in] networkId new network ID
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetNetworkID( uint32_t networkId );
/*!
* \brief Gets the LoRaWAN Device Address (from the Commissioning if ABP or after the Join if OTAA)
*
* \param [out] devAddr current device address
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetDevAddr( uint32_t *devAddr );
/*!
* \brief Sets the LoRaWAN Device Address (if ABP)
*
* \param [in] devAddr device address
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetDevAddr( uint32_t devAddr );
/*!
* \brief Sets the current active region
*
* \param [in] region New active region requested
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetActiveRegion( LoRaMacRegion_t region );
/*!
* \brief Gets the Adaptive data rate (1 = the Network manages the DR, 0 = the device manages the DR)
*
* \param [out] adrEnable Adaptive data rate flag
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetAdrEnable( bool *adrEnable );
/*!
* \brief Sets the Adaptive data rate (1 = the Network manages the DR, 0 = the device manages the DR)
*
* \param [in] adrEnable Adaptive data rate flag
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetAdrEnable( bool adrEnable );
/*!
* \brief Sets the current datarate
*
* \param [in] txDatarate new TX datarate
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetTxDatarate( int8_t txDatarate );
/*!
* \brief Gets the duty cycle flag
*
* \param [out] dutyCycleEnable duty cycle flag
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetDutyCycleEnable( bool *dutyCycleEnable );
/*!
* \brief Sets the current datarate
*
* \param [in] dutyCycleEnable duty cycle flag
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetDutyCycleEnable( bool dutyCycleEnable );
/*!
* \brief Gets the current RX_2 datarate and frequency
*
* \param [out] rxParams rx2 parameters
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetRX2Params( RxChannelParams_t *rxParams );
/*!
* \brief Gets the current TX power
*
* \param [out] txPower TX power
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetTxPower( int8_t *txPower );
/*!
* \brief Gets the current RX1 delay (after the TX done)
*
* \param [out] rxDelay RX1 delay
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetRx1Delay( uint32_t *rxDelay );
/*!
* \brief Gets the current RX2 delay (after the TX done)
*
* \param [out] rxDelay RX2 delay
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetRx2Delay( uint32_t *rxDelay );
/*!
* \brief Gets the current RX1 Join delay (after the TX done)
*
* \param [out] rxDelay RX1 Join delay
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetJoinRx1Delay( uint32_t *rxDelay );
/*!
* \brief Gets the current RX2 Join delay (after the TX done)
*
* \param [out] rxDelay RX2 Join delay
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetJoinRx2Delay( uint32_t *rxDelay );
/*!
* \brief Sets the RX_2 datarate and frequency
*
* \param [in] rxParams rx2 parameters
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetRX2Params( RxChannelParams_t *rxParams );
/*!
* \brief Sets the TX power
*
* \param [in] txPower TX power
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetTxPower( int8_t txPower );
/*!
* \brief Sets the RX1 delay (after the TX done)
*
* \param [in] rxDelay RX1 delay
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetRx1Delay( uint32_t rxDelay );
/*!
* \brief Sets the RX2 delay (after the TX done)
*
* \param [in] rxDelay RX2 delay
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetRx2Delay( uint32_t rxDelay );
/*!
* \brief Sets the RX1 delay (after the TX done)
*
* \param [in] rxDelay RX1 Join delay
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetJoinRx1Delay( uint32_t rxDelay );
/*!
* \brief Sets the RX2 delay (after the TX done)
*
* \param [in] rxDelay RX2 Join delay
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetJoinRx2Delay( uint32_t rxDelay );
/*!
* \brief Gets the current ClassB Ping periodicity
*
* \param [out] pingPeriodicity ping periodicity
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetPingPeriodicity( uint8_t *pingPeriodicity );
/*!
* \brief Sets the ClassB Ping periodicity
*
* \param [in] pingPeriodicity ping periodicity
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetPingPeriodicity( uint8_t pingPeriodicity );
/*!
* \brief Gets the current ClassB Beacon status
*
* \param [out] beaconState current ClassB Beacon status
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetBeaconState( BeaconState_t *beaconState );
/*!
* \brief Gets the LoRaWAN Key
*
* \param [in] keyID - Key identifier
* \param [out] key - Key value (16 bytes)
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetKey( KeyIdentifier_t keyID, uint8_t *key );
/*!
* \brief Sets the LoRaWAN key
*
* \param [in] keyID - Key identifier
* \param [in] key - Key value (16 bytes)
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerSetKey( KeyIdentifier_t keyID, uint8_t *key );
/*!
* Requests network server time update
*
* \retval status Returns \ref LORAMAC_HANDLER_SUCCESS if request has been
* processed else \ref LORAMAC_HANDLER_ERROR
*/
LmHandlerErrorStatus_t LmHandlerDeviceTimeReq( void );
/*!
* Requests Link connectivity check
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerLinkCheckReq( void );
/*!
* \brief Returns current LoRaWAN specifications version
*
* \param [out] featureVersion Pointer to feature version
* \param [in] lmhType Type of the version
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerGetVersion( LmHandlerVersionType_t lmhType, uint32_t *featureVersion );
/*!
* Start the NVM Data store process
*
* \retval -1 LORAMAC_HANDLER_ERROR
* 0 LORAMAC_HANDLER_SUCCESS
*/
LmHandlerErrorStatus_t LmHandlerNvmDataStore( void );
#ifdef __cplusplus
}
#endif
#endif /* __LORAMAC_HANDLER_H__ */
Reference in New Issue View Git Blame Copy Permalink