MultiTech / libxDot-dev-mbed5-deprecated

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Dot-Examples Dot-AT-Firmware Dot-Examples TEST_FF1705 ... more

Embed: (wiki syntax)

« Back to documentation index

SxRadio Class Reference
Public Types | Public Member Functions | Protected Attributes

SxRadio Class Reference

Radio driver definition. More...

#include <SxRadio.h>

Public Types

enum  RadioModems_t
enum  RadioState_t

Public Member Functions

virtual void Init (SxRadioEvents *events)=0
 Initializes the radio.
virtual void Terminate (void)=0
 Prepares the radio for destruction.
virtual RadioState_t Status (void)
virtual void SetModem (RadioModems_t modem)=0
 Configures the radio with the given modem.
virtual void SetChannel (uint32_t freq)=0
 Sets the channel frequency.
virtual bool IsChannelFree (RadioModems_t modem, uint32_t freq, uint8_t datarate, int16_t rssiThresh, uint8_t bandwidth, uint32_t timeout=5000, int16_t *rssiVal=NULL)=0
 Sets the channels configuration.
virtual uint32_t Random (void)=0
 Generates a 32 bits random value based on the RSSI readings.
virtual void SetRxConfig (RadioModems_t modem, uint32_t bandwidth, uint32_t datarate, uint8_t coderate, uint32_t bandwidthAfc, uint16_t preambleLen, uint16_t symbTimeout, bool fixLen, uint8_t payloadLen, bool crcOn, bool FreqHopOn, uint8_t HopPeriod, bool iqInverted, bool rxContinuous)=0
 Sets the reception parameters.
virtual void SetTxConfig (RadioModems_t modem, int8_t power, uint32_t fdev, uint32_t bandwidth, uint32_t datarate, uint8_t coderate, uint16_t preambleLen, bool fixLen, bool crcOn, bool FreqHopOn, uint8_t HopPeriod, bool iqInverted, uint32_t timeout)=0
 Sets the transmission parameters.
virtual bool CheckRfFrequency (uint32_t frequency)
 Checks if the given RF frequency is supported by the hardware.
virtual double TimeOnAir (RadioModems_t modem, uint8_t pktLen)=0
 Computes the packet time on air for the given payload.
virtual void Send (const uint8_t *buffer, uint8_t size)=0
 Sends the buffer of size. Prepares the packet to be sent and sets the radio in transmission.
virtual void Sleep (void)=0
 Sets the radio in sleep mode.
virtual void Standby (void)=0
 Sets the radio in standby mode.
virtual void Rx (uint32_t timeout)=0
 Sets the radio in reception mode for the given time.
virtual void StartCad (void)=0
 Start a Channel Activity Detection.
virtual int16_t Rssi (RadioModems_t modem)=0
 Reads the current RSSI value.
virtual void Write (uint8_t addr, uint8_t data)=0
 Writes the radio register at the specified address.
virtual uint8_t Read (uint8_t addr)=0
 Reads the radio register at the specified address.
virtual void WriteBuffer (uint8_t addr, const uint8_t *buffer, uint8_t size)=0
 Writes multiple radio registers starting at address.
virtual void ReadBuffer (uint8_t addr, uint8_t *buffer, uint8_t size)=0
 Reads multiple radio registers starting at address.

Protected Attributes

Mutex mutex

Detailed Description

Radio driver definition.

Definition at line 25 of file SxRadio.h.

Member Enumeration Documentation

enum RadioModems_t

Radio driver supported modems

Definition at line 31 of file SxRadio.h.

enum RadioState_t

Radio driver internal state machine states definition

Definition at line 40 of file SxRadio.h.

Member Function Documentation

virtual bool CheckRfFrequency ( uint32_t  frequency ) [virtual]

Checks if the given RF frequency is supported by the hardware.

Parameters:
[IN]frequency RF frequency to be checked
Return values:
isSupported[true: supported, false: unsupported]

Definition at line 199 of file SxRadio.h.

virtual void Init ( SxRadioEvents *  events ) [pure virtual]

Initializes the radio.

Parameters:
[IN]events Structure containing the driver callback functions
virtual bool IsChannelFree ( RadioModems_t  modem,
uint32_t  freq,
uint8_t  datarate,
int16_t  rssiThresh,
uint8_t  bandwidth,
uint32_t  timeout = 5000,
int16_t *  rssiVal = NULL 
) [pure virtual]

Sets the channels configuration.

Parameters:
[IN]modem Radio modem to be used [0: FSK, 1: LoRa]
[IN]freq Channel RF frequency
[IN]rssiThresh RSSI threshold
[IN]rssiVal pointer to variable to hold RSSI value if desired - ignored if NULL
Return values:
isFree[true: Channel is free, false: Channel is not free]
virtual uint32_t Random ( void   ) [pure virtual]

Generates a 32 bits random value based on the RSSI readings.

Remarks:
This function sets the radio in LoRa modem mode and disables all interrupts. After calling this function either Radio.SetRxConfig or Radio.SetTxConfig functions must be called.
Return values:
randomValue32 bits random value
virtual uint8_t Read ( uint8_t  addr ) [pure virtual]

Reads the radio register at the specified address.

Parameters:
[IN],:addr Register address
Return values:
dataRegister value
virtual void ReadBuffer ( uint8_t  addr,
uint8_t *  buffer,
uint8_t  size 
) [pure virtual]

Reads multiple radio registers starting at address.

Parameters:
[IN]addr First Radio register address
[OUT]buffer Buffer where to copy the registers data
[IN]size Number of registers to be read
virtual int16_t Rssi ( RadioModems_t  modem ) [pure virtual]

Reads the current RSSI value.

Return values:
rssiValueCurrent RSSI value in [dBm]
virtual void Rx ( uint32_t  timeout ) [pure virtual]

Sets the radio in reception mode for the given time.

Parameters:
[IN]timeout Reception timeout [us] [0: continuous, others timeout]
virtual void Send ( const uint8_t *  buffer,
uint8_t  size 
) [pure virtual]

Sends the buffer of size. Prepares the packet to be sent and sets the radio in transmission.

Parameters:
[IN],:buffer Buffer pointer
[IN],:size Buffer size
virtual void SetChannel ( uint32_t  freq ) [pure virtual]

Sets the channel frequency.

Parameters:
[IN]freq Channel RF frequency
virtual void SetModem ( RadioModems_t  modem ) [pure virtual]

Configures the radio with the given modem.

Parameters:
[IN]modem Modem to be used [0: FSK, 1: LoRa]
virtual void SetRxConfig ( RadioModems_t  modem,
uint32_t  bandwidth,
uint32_t  datarate,
uint8_t  coderate,
uint32_t  bandwidthAfc,
uint16_t  preambleLen,
uint16_t  symbTimeout,
bool  fixLen,
uint8_t  payloadLen,
bool  crcOn,
bool  FreqHopOn,
uint8_t  HopPeriod,
bool  iqInverted,
bool  rxContinuous 
) [pure virtual]

Sets the reception parameters.

Parameters:
[IN]modem Radio modem to be used [0: FSK, 1: LoRa]
[IN]bandwidth Sets the bandwidth FSK : >= 2600 and <= 250000 Hz LoRa: [0: 125 kHz, 1: 250 kHz, 2: 500 kHz, 3: Reserved]
[IN]datarate Sets the Datarate FSK : 600..300000 bits/s LoRa: [6: 64, 7: 128, 8: 256, 9: 512, 10: 1024, 11: 2048, 12: 4096 chips]
[IN]coderate Sets the coding rate (LoRa only) FSK : N/A ( set to 0 ) LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
[IN]bandwidthAfc Sets the AFC Bandwidth (FSK only) FSK : >= 2600 and <= 250000 Hz LoRa: N/A ( set to 0 )
[IN]preambleLen Sets the Preamble length FSK : Number of bytes LoRa: Length in symbols (the hardware adds 4 more symbols)
[IN]symbTimeout Sets the RxSingle timeout value (LoRa only) FSK : N/A ( set to 0 ) LoRa: timeout in symbols
[IN]fixLen Fixed length packets [0: variable, 1: fixed]
[IN]payloadLen Sets payload length when fixed length is used
[IN]crcOn Enables/Disables the CRC [0: OFF, 1: ON]
[IN]FreqHopOn Enables disables the intra-packet frequency hopping FSK : N/A ( set to 0 ) LoRa: [0: OFF, 1: ON]
[IN]HopPeriod Number of symbols bewteen each hop FSK : N/A ( set to 0 ) LoRa: Number of symbols
[IN]iqInverted Inverts IQ signals (LoRa only) FSK : N/A ( set to 0 ) LoRa: [0: not inverted, 1: inverted]
[IN]rxContinuous Sets the reception in continuous mode [false: single mode, true: continuous mode]
virtual void SetTxConfig ( RadioModems_t  modem,
int8_t  power,
uint32_t  fdev,
uint32_t  bandwidth,
uint32_t  datarate,
uint8_t  coderate,
uint16_t  preambleLen,
bool  fixLen,
bool  crcOn,
bool  FreqHopOn,
uint8_t  HopPeriod,
bool  iqInverted,
uint32_t  timeout 
) [pure virtual]

Sets the transmission parameters.

Parameters:
[IN]modem Radio modem to be used [0: FSK, 1: LoRa]
[IN]power Sets the output power [dBm]
[IN]fdev Sets the frequency deviation (FSK only) FSK : [Hz] LoRa: 0
[IN]bandwidth Sets the bandwidth (LoRa only) FSK : 0 LoRa: [0: 125 kHz, 1: 250 kHz, 2: 500 kHz, 3: Reserved]
[IN]datarate Sets the Datarate FSK : 600..300000 bits/s LoRa: [6: 64, 7: 128, 8: 256, 9: 512, 10: 1024, 11: 2048, 12: 4096 chips]
[IN]coderate Sets the coding rate (LoRa only) FSK : N/A ( set to 0 ) LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
[IN]preambleLen Sets the preamble length FSK : Number of bytes LoRa: Length in symbols (the hardware adds 4 more symbols)
[IN]fixLen Fixed length packets [0: variable, 1: fixed]
[IN]crcOn Enables disables the CRC [0: OFF, 1: ON]
[IN]FreqHopOn Enables disables the intra-packet frequency hopping FSK : N/A ( set to 0 ) LoRa: [0: OFF, 1: ON]
[IN]HopPeriod Number of symbols bewteen each hop FSK : N/A ( set to 0 ) LoRa: Number of symbols
[IN]iqInverted Inverts IQ signals (LoRa only) FSK : N/A ( set to 0 ) LoRa: [0: not inverted, 1: inverted]
[IN]timeout Transmission timeout [us]
virtual void Sleep ( void   ) [pure virtual]

Sets the radio in sleep mode.

virtual void Standby ( void   ) [pure virtual]

Sets the radio in standby mode.

virtual void StartCad ( void   ) [pure virtual]

Start a Channel Activity Detection.

virtual RadioState_t Status ( void   ) [virtual]

Return current radio status

Parameters:
statusRadio status.[RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING]

Definition at line 66 of file SxRadio.h.

virtual void Terminate ( void   ) [pure virtual]

Prepares the radio for destruction.

virtual double TimeOnAir ( RadioModems_t  modem,
uint8_t  pktLen 
) [pure virtual]

Computes the packet time on air for the given payload.

Can only be called once SetRxConfig or SetTxConfig have been called

Parameters:
[IN]modem Radio modem to be used [0: FSK, 1: LoRa]
[IN]pktLen Packet payload length
Return values:
airTimeComputed airTime for the given packet payload length
virtual void Write ( uint8_t  addr,
uint8_t  data 
) [pure virtual]

Writes the radio register at the specified address.

Parameters:
[IN],:addr Register address
[IN],:data New register value
virtual void WriteBuffer ( uint8_t  addr,
const uint8_t *  buffer,
uint8_t  size 
) [pure virtual]

Writes multiple radio registers starting at address.

Parameters:
[IN]addr First Radio register address
[IN]buffer Buffer containing the new register's values
[IN]size Number of registers to be written

Field Documentation

Mutex mutex [protected]

Access protection

Definition at line 299 of file SxRadio.h.

Generated on Tue Jul 12 2022 18:19:47 by  doxygen 1.7.2