LoRaMacClassB.h

Go to the documentation of this file.

 
#ifndef __LORAMACCLASSB_H__
#define __LORAMACCLASSB_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include "systime.h"
#include "LoRaMacTypes.h"
 
typedef enum eBeaconState
{
    BEACON_STATE_ACQUISITION,
    BEACON_STATE_ACQUISITION_BY_TIME,
    BEACON_STATE_TIMEOUT,
    BEACON_STATE_BEACON_MISSED,
    BEACON_STATE_REACQUISITION,
    BEACON_STATE_LOCKED,
    BEACON_STATE_HALT,
    BEACON_STATE_IDLE,
    BEACON_STATE_GUARD,
    BEACON_STATE_RX,
    BEACON_STATE_LOST,
}BeaconState_t;
 
typedef enum ePingSlotState
{
    PINGSLOT_STATE_CALC_PING_OFFSET,
    PINGSLOT_STATE_SET_TIMER,
    PINGSLOT_STATE_IDLE,
    PINGSLOT_STATE_RX,
}PingSlotState_t;
 
typedef struct sPingSlotContext
{
 
    uint32_t PingSlotWindow;
    uint16_t PingOffset;
    uint16_t SymbolTimeout;
    MulticastCtx_t *NextMulticastChannel;
}PingSlotContext_t;
 
 
typedef struct sBeaconContext
{
    struct sBeaconCtrl
    {
        uint8_t BeaconMode          : 1;
        uint8_t BeaconAcquired      : 1;
        uint8_t BeaconDelaySet      : 1;
        uint8_t BeaconChannelSet    : 1;
        uint8_t AcquisitionPending  : 1;
        uint8_t ResumeBeaconing      : 1;
    }Ctrl;
 
    float Temperature;
    SysTime_t BeaconTime;
    SysTime_t LastBeaconRx;
    SysTime_t NextBeaconRx;
    TimerTime_t NextBeaconRxAdjusted;
    uint16_t SymbolTimeout;
    TimerTime_t BeaconWindowMovement;
    uint8_t BeaconTimingChannel;
    TimerTime_t BeaconTimingDelay;
    TimerTime_t TimeStamp;
}BeaconContext_t;
 
typedef struct sLoRaMacClassBCallback
{
    float ( *GetTemperatureLevel )( void );
    void ( *MacProcessNotify )( void );
}LoRaMacClassBCallback_t;
 
typedef struct sLoRaMacClassBParams
{
    MlmeIndication_t *MlmeIndication;
    McpsIndication_t *McpsIndication;
    MlmeConfirm_t *MlmeConfirm;
    LoRaMacFlags_t *LoRaMacFlags;
    uint32_t *LoRaMacDevAddr;
    LoRaMacRegion_t *LoRaMacRegion;
    LoRaMacParams_t *LoRaMacParams;
    MulticastCtx_t *MulticastChannels;
}LoRaMacClassBParams_t;
 
typedef void ( *LoRaMacClassBNvmEvent )( void );
 
void LoRaMacClassBInit( LoRaMacClassBParams_t *classBParams, LoRaMacClassBCallback_t *callbacks, LoRaMacClassBNvmEvent classBNvmCtxChanged );
 
bool LoRaMacClassBRestoreNvmCtx( void* classBNvmCtx );
 
void* LoRaMacClassBGetNvmCtx( size_t* classBNvmCtxSize );
 
void LoRaMacClassBSetBeaconState( BeaconState_t beaconState );
 
void LoRaMacClassBSetPingSlotState( PingSlotState_t pingSlotState );
 
void LoRaMacClassBSetMulticastSlotState( PingSlotState_t multicastSlotState );
 
bool LoRaMacClassBIsAcquisitionInProgress( void );
 
void LoRaMacClassBBeaconTimerEvent( void* context );
 
void LoRaMacClassBPingSlotTimerEvent( void* context );
 
void LoRaMacClassBMulticastSlotTimerEvent( void* context );
 
bool LoRaMacClassBRxBeacon( uint8_t *payload, uint16_t size );
 
bool LoRaMacClassBIsBeaconExpected( void );
 
bool LoRaMacClassBIsPingExpected( void );
 
bool LoRaMacClassBIsMulticastExpected( void );
 
bool LoRaMacClassBIsAcquisitionPending( void );
 
bool LoRaMacClassBIsBeaconModeActive( void );
 
void LoRaMacClassBHaltBeaconing( void );
 
void LoRaMacClassBResumeBeaconing( void );
 
void LoRaMacClassBSetPingSlotInfo( uint8_t periodicity );
 
LoRaMacStatus_t LoRaMacClassBSwitchClass( DeviceClass_t nextClass );
 
LoRaMacStatus_t LoRaMacClassBMibGetRequestConfirm( MibRequestConfirm_t *mibGet );
 
LoRaMacStatus_t LoRaMacMibClassBSetRequestConfirm( MibRequestConfirm_t *mibSet );
 
void LoRaMacClassBPingSlotInfoAns( void );
 
uint8_t LoRaMacClassBPingSlotChannelReq( uint8_t datarate, uint32_t frequency );
 
void LoRaMacClassBBeaconTimingAns( uint16_t beaconTimingDelay, uint8_t beaconTimingChannel, TimerTime_t lastRxDone );
 
void LoRaMacClassBDeviceTimeAns( void );
 
bool LoRaMacClassBBeaconFreqReq( uint32_t frequency );
 
TimerTime_t LoRaMacClassBIsUplinkCollision( TimerTime_t txTimeOnAir );
 
void LoRaMacClassBStopRxSlots( void );
 
void LoRaMacClassBStartRxSlots( void );
 
void LoRaMacClassBSetMulticastPeriodicity( MulticastCtx_t* multicastChannel );
 
void LoRaMacClassBProcess( void );
 
#ifdef __cplusplus
}
#endif
 
#endif // __LORAMACCLASSB_H__