Stable version of the xDot library for mbed 5. This version of the library is suitable for deployment scenarios.

Dependents:   Dot-Examples XDOT-Devicewise Dot-Examples-delujoc Dot-Examples_receive ... more

Fork of libxDot-dev-mbed5-deprecated by MultiTech

Embed: (wiki syntax)

« Back to documentation index

SxRadioEvents Class Reference

SxRadioEvents Class Reference

Radio driver callback functions. More...

#include <SxRadioEvents.h>

Public Member Functions

virtual void TxStart (void)
 Tx Start callback prototype.
virtual void TxDone (void)
 Tx Done callback prototype.
virtual void TxTimeout (void)
 Tx Timeout callback prototype.
virtual void RxDone (uint8_t *payload, uint16_t size, int16_t rssi, int16_t snr)
 Rx Done callback prototype.
virtual void OnBeaconless (uint32_t beaconTime, bool no_rx=false)
 Called if Beacon Window cannot be opened or is missed.
virtual void RxTimeout (void)
 Rx Timeout callback prototype.
virtual void RxError (void)
 Rx Error callback prototype.
virtual void FhssChangeChannel (uint8_t currentChannel)
 FHSS Change Channel callback prototype.
virtual void CadDone (bool channelActivityDetected)
 CAD Done callback prototype.
virtual void MacEvent (void)
 Mac Event callback prototype.

Detailed Description

Radio driver callback functions.

Definition at line 21 of file SxRadioEvents.h.


Member Function Documentation

virtual void CadDone ( bool  channelActivityDetected ) [virtual]

CAD Done callback prototype.

Parameters:
[IN]channelActivityDetected Channel Activity detected during the CAD

Definition at line 78 of file SxRadioEvents.h.

virtual void FhssChangeChannel ( uint8_t  currentChannel ) [virtual]

FHSS Change Channel callback prototype.

Parameters:
[IN]currentChannel Index number of the current channel

Definition at line 72 of file SxRadioEvents.h.

virtual void MacEvent ( void   ) [virtual]

Mac Event callback prototype.

Definition at line 82 of file SxRadioEvents.h.

virtual void OnBeaconless ( uint32_t  beaconTime,
bool  no_rx = false 
) [virtual]

Called if Beacon Window cannot be opened or is missed.

Parameters:
[IN]beaconTime Updated time of beacon for the period
[IN]no_rx True if called from rx done

Definition at line 55 of file SxRadioEvents.h.

virtual void RxDone ( uint8_t *  payload,
uint16_t  size,
int16_t  rssi,
int16_t  snr 
) [virtual]

Rx Done callback prototype.

Parameters:
[IN]payload Received buffer pointer
[IN]size Received buffer size
[IN]rssi RSSI value computed while receiving the frame [dBm]
[IN]snr Raw SNR value given by the radio hardware FSK : N/A ( set to 0 ) LoRa: SNR value is two's complement in 1/4 dB

Definition at line 47 of file SxRadioEvents.h.

virtual void RxError ( void   ) [virtual]

Rx Error callback prototype.

Definition at line 66 of file SxRadioEvents.h.

virtual void RxTimeout ( void   ) [virtual]

Rx Timeout callback prototype.

Definition at line 62 of file SxRadioEvents.h.

virtual void TxDone ( void   ) [virtual]

Tx Done callback prototype.

Definition at line 31 of file SxRadioEvents.h.

virtual void TxStart ( void   ) [virtual]

Tx Start callback prototype.

Definition at line 27 of file SxRadioEvents.h.

virtual void TxTimeout ( void   ) [virtual]

Tx Timeout callback prototype.

Definition at line 35 of file SxRadioEvents.h.