This Library is to establish communication between a transmitter and receivers formed by the combination of SX1272MB2DAS shield and FRDM kl25z board that uses Cortex M0+ architecture.
Fork of SX1272Lib by
SX1272 Class Reference
#include <sx1272.h>
Inherits Radio.
Inherited by SX1272MB2xAS.
Public Member Functions | |
virtual void | Init (RadioEvents_t *events) |
Initializes the radio. | |
virtual RadioState | GetStatus (void) |
virtual void | SetModem (RadioModems_t modem) |
Configures the SX1272 with the given modem. | |
virtual void | SetChannel (uint32_t freq) |
Sets the channel frequency. | |
virtual bool | IsChannelFree (RadioModems_t modem, uint32_t freq, int16_t rssiThresh) |
Sets the channels configuration. | |
virtual uint32_t | Random (void) |
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) |
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) |
Sets the transmission parameters. | |
virtual bool | CheckRfFrequency (uint32_t frequency)=0 |
Checks if the given RF frequency is supported by the hardware. | |
virtual uint32_t | TimeOnAir (RadioModems_t modem, uint8_t pktLen) |
Computes the packet time on air for the given payload. | |
virtual void | Send (uint8_t *buffer, uint8_t size) |
Sends the buffer of size. Prepares the packet to be sent and sets the radio in transmission. | |
virtual void | Sleep (void) |
Sets the radio in sleep mode. | |
virtual void | Standby (void) |
Sets the radio in standby mode. | |
virtual void | StartCad (void) |
Sets the radio in CAD mode. | |
virtual void | Rx (uint32_t timeout) |
Sets the radio in reception mode for the given time. | |
virtual void | Tx (uint32_t timeout) |
Sets the radio in transmission mode for the given time. | |
virtual void | SetTxContinuousWave (uint32_t freq, int8_t power, uint16_t time) |
Sets the radio in continuous wave transmission mode. | |
virtual int16_t | GetRssi (RadioModems_t modem) |
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 | Write (uint8_t addr, uint8_t *buffer, uint8_t size)=0 |
Writes multiple radio registers starting at address. | |
virtual void | Read (uint8_t addr, uint8_t *buffer, uint8_t size)=0 |
Reads multiple radio registers starting at address. | |
virtual void | WriteFifo (uint8_t *buffer, uint8_t size)=0 |
Writes the buffer contents to the SX1272 FIFO. | |
virtual void | ReadFifo (uint8_t *buffer, uint8_t size)=0 |
Reads the contents of the SX1272 FIFO. | |
virtual void | Reset (void)=0 |
Resets the SX1272. | |
virtual void | SetMaxPayloadLength (RadioModems_t modem, uint8_t max) |
Sets the maximum payload length. | |
virtual void | SetPublicNetwork (bool enable) |
Sets the network to public or private. Updates the sync byte. | |
Protected Member Functions | |
void | RxChainCalibration (void) |
virtual void | IoInit (void)=0 |
Initializes the radio I/Os pins interface. | |
virtual void | RadioRegistersInit ()=0 |
Initializes the radio registers. | |
virtual void | SpiInit (void)=0 |
Initializes the radio SPI. | |
virtual void | IoIrqInit (DioIrqHandler *irqHandlers)=0 |
Initializes DIO IRQ handlers. | |
virtual void | IoDeInit (void)=0 |
De-initializes the radio I/Os pins interface. | |
virtual void | SetRfTxPower (int8_t power)=0 |
Sets the radio output power. | |
virtual uint8_t | GetPaSelect (uint32_t channel)=0 |
Gets the board PA selection configuration. | |
virtual void | SetAntSwLowPower (bool status)=0 |
Set the RF Switch I/Os pins in Low Power mode. | |
virtual void | AntSwInit (void)=0 |
Initializes the RF Switch I/Os pins interface. | |
virtual void | AntSwDeInit (void)=0 |
De-initializes the RF Switch I/Os pins interface. | |
virtual void | SetAntSw (uint8_t opMode)=0 |
Controls the antenna switch if necessary. | |
virtual void | SetOpMode (uint8_t opMode) |
Sets the SX1272 operating mode. | |
virtual void | OnDio0Irq (void) |
DIO 0 IRQ callback. | |
virtual void | OnDio1Irq (void) |
DIO 1 IRQ callback. | |
virtual void | OnDio2Irq (void) |
DIO 2 IRQ callback. | |
virtual void | OnDio3Irq (void) |
DIO 3 IRQ callback. | |
virtual void | OnDio4Irq (void) |
DIO 4 IRQ callback. | |
virtual void | OnDio5Irq (void) |
DIO 5 IRQ callback. | |
virtual void | OnTimeoutIrq (void) |
Tx & Rx timeout timer callback. | |
Static Protected Member Functions | |
static uint8_t | GetFskBandwidthRegValue (uint32_t bandwidth) |
Protected Attributes | |
SPI | spi |
DigitalInOut | reset |
InterruptIn | dio0 |
DioIrqHandler * | dioIrq |
Timeout | txTimeoutTimer |
Detailed Description
Actual implementation of a SX1272 radio, inherits Radio
Definition at line 55 of file sx1272.h.
Member Function Documentation
virtual void AntSwDeInit | ( | void | ) | [protected, pure virtual] |
De-initializes the RF Switch I/Os pins interface.
- Remarks:
- Needed to decrease the power consumption in MCU lowpower modes
Implemented in SX1272MB2xAS.
virtual void AntSwInit | ( | void | ) | [protected, pure virtual] |
Initializes the RF Switch I/Os pins interface.
Implemented in SX1272MB2xAS.
virtual bool CheckRfFrequency | ( | uint32_t | frequency ) | [pure 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]
Implements Radio.
Implemented in SX1272MB2xAS.
uint8_t GetFskBandwidthRegValue | ( | uint32_t | bandwidth ) | [static, protected] |
Returns the known FSK bandwidth registers value
- Parameters:
-
[IN] bandwidth Bandwidth value in Hz
- Return values:
-
regValue Bandwidth register value.
Definition at line 161 of file sx1272.cpp.
virtual uint8_t GetPaSelect | ( | uint32_t | channel ) | [protected, pure virtual] |
Gets the board PA selection configuration.
- Parameters:
-
[IN] channel Channel frequency in Hz
- Return values:
-
PaSelect RegPaConfig PaSelect value
Implemented in SX1272MB2xAS.
int16_t GetRssi | ( | RadioModems_t | modem ) | [virtual] |
Reads the current RSSI value.
- Return values:
-
rssiValue Current RSSI value in [dBm]
Implements Radio.
Definition at line 824 of file sx1272.cpp.
RadioState GetStatus | ( | void | ) | [virtual] |
Return current radio status
- Parameters:
-
status Radio status. [RF_IDLE, RX_RUNNING, TX_RUNNING]
Implements Radio.
Definition at line 82 of file sx1272.cpp.
void Init | ( | RadioEvents_t * | events ) | [virtual] |
Initializes the radio.
- Parameters:
-
[IN] events Structure containing the driver callback functions
Implements Radio.
Definition at line 77 of file sx1272.cpp.
virtual void IoDeInit | ( | void | ) | [protected, pure virtual] |
De-initializes the radio I/Os pins interface.
- Remarks:
- Useful when going in MCU lowpower modes
Implemented in SX1272MB2xAS.
virtual void IoInit | ( | void | ) | [protected, pure virtual] |
Initializes the radio I/Os pins interface.
Implemented in SX1272MB2xAS.
virtual void IoIrqInit | ( | DioIrqHandler * | irqHandlers ) | [protected, pure virtual] |
Initializes DIO IRQ handlers.
- Parameters:
-
[IN] irqHandlers Array containing the IRQ callback functions
Implemented in SX1272MB2xAS.
bool IsChannelFree | ( | RadioModems_t | modem, |
uint32_t | freq, | ||
int16_t | rssiThresh | ||
) | [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
- Return values:
-
isFree [true: Channel is free, false: Channel is not free]
Implements Radio.
Definition at line 96 of file sx1272.cpp.
void OnDio0Irq | ( | void | ) | [protected, virtual] |
DIO 0 IRQ callback.
Definition at line 998 of file sx1272.cpp.
void OnDio1Irq | ( | void | ) | [protected, virtual] |
DIO 1 IRQ callback.
Definition at line 1185 of file sx1272.cpp.
void OnDio2Irq | ( | void | ) | [protected, virtual] |
DIO 2 IRQ callback.
Definition at line 1262 of file sx1272.cpp.
void OnDio3Irq | ( | void | ) | [protected, virtual] |
DIO 3 IRQ callback.
Definition at line 1332 of file sx1272.cpp.
void OnDio4Irq | ( | void | ) | [protected, virtual] |
DIO 4 IRQ callback.
Definition at line 1363 of file sx1272.cpp.
void OnDio5Irq | ( | void | ) | [protected, virtual] |
DIO 5 IRQ callback.
Definition at line 1382 of file sx1272.cpp.
void OnTimeoutIrq | ( | void | ) | [protected, virtual] |
Tx & Rx timeout timer callback.
Definition at line 928 of file sx1272.cpp.
virtual void RadioRegistersInit | ( | ) | [protected, pure virtual] |
Initializes the radio registers.
Implemented in SX1272MB2xAS.
uint32_t Random | ( | void | ) | [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:
-
randomValue 32 bits random value
Implements Radio.
Definition at line 119 of file sx1272.cpp.
virtual uint8_t Read | ( | uint8_t | addr ) | [pure virtual] |
Reads the radio register at the specified address.
- Parameters:
-
[IN],: addr Register address
- Return values:
-
data Register value
Implements Radio.
Implemented in SX1272MB2xAS.
virtual void Read | ( | 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
Implements Radio.
Implemented in SX1272MB2xAS.
virtual void ReadFifo | ( | uint8_t * | buffer, |
uint8_t | size | ||
) | [pure virtual] |
Reads the contents of the SX1272 FIFO.
- Parameters:
-
[OUT] buffer Buffer where to copy the FIFO read data. [IN] size Number of bytes to be read from the FIFO
Implements Radio.
Implemented in SX1272MB2xAS.
virtual void Reset | ( | void | ) | [pure virtual] |
Resets the SX1272.
Implemented in SX1272MB2xAS.
void Rx | ( | uint32_t | timeout ) | [virtual] |
Sets the radio in reception mode for the given time.
- Parameters:
-
[IN] timeout Reception timeout [ms] [0: continuous, others timeout]
Implements Radio.
Definition at line 593 of file sx1272.cpp.
void RxChainCalibration | ( | void | ) | [protected] |
Performs the Rx chain calibration for LF and HF bands
- Remarks:
- Must be called just after the reset so all registers are at their default values
void Send | ( | uint8_t * | buffer, |
uint8_t | size | ||
) | [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
Implements Radio.
Definition at line 501 of file sx1272.cpp.
virtual void SetAntSw | ( | uint8_t | opMode ) | [protected, pure virtual] |
Controls the antenna switch if necessary.
- Remarks:
- see errata note
- Parameters:
-
[IN] opMode Current radio operating mode
Implemented in SX1272MB2xAS.
virtual void SetAntSwLowPower | ( | bool | status ) | [protected, pure virtual] |
Set the RF Switch I/Os pins in Low Power mode.
- Parameters:
-
[IN] status enable or disable
Implemented in SX1272MB2xAS.
void SetChannel | ( | uint32_t | freq ) | [virtual] |
Sets the channel frequency.
- Parameters:
-
[IN] freq Channel RF frequency
Implements Radio.
Definition at line 87 of file sx1272.cpp.
void SetMaxPayloadLength | ( | RadioModems_t | modem, |
uint8_t | max | ||
) | [virtual] |
Sets the maximum payload length.
- Parameters:
-
[IN] modem Radio modem to be used [0: FSK, 1: LoRa] [IN] max Maximum payload length in bytes
Implements Radio.
Definition at line 894 of file sx1272.cpp.
void SetModem | ( | RadioModems_t | modem ) | [virtual] |
Configures the SX1272 with the given modem.
- Parameters:
-
[IN] modem Modem to be used [0: FSK, 1: LoRa]
Implements Radio.
Definition at line 857 of file sx1272.cpp.
void SetOpMode | ( | uint8_t | opMode ) | [protected, virtual] |
Sets the SX1272 operating mode.
- Parameters:
-
[IN] opMode New operating mode
Definition at line 843 of file sx1272.cpp.
void SetPublicNetwork | ( | bool | enable ) | [virtual] |
Sets the network to public or private. Updates the sync byte.
- Remarks:
- Applies to LoRa modem only
- Parameters:
-
[IN] enable if true, it enables a public network
Implements Radio.
Definition at line 912 of file sx1272.cpp.
virtual void SetRfTxPower | ( | int8_t | power ) | [protected, pure virtual] |
Sets the radio output power.
- Parameters:
-
[IN] power Sets the RF output power
Implemented in SX1272MB2xAS.
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 | ||
) | [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 ( LoRa only ) FSK : N/A ( set to 0 ) LoRa: Length in symbols ( the hardware adds 4 more symbols ) [IN] symbTimeout Sets the RxSingle timeout value FSK : timeout number of bytes LoRa: timeout in symbols [IN] fixLen Fixed length packets [0: variable, 1: fixed] [IN] payloadLen Sets payload length when fixed lenght is used [IN] crcOn Enables/Disables the CRC [0: OFF, 1: ON] [IN] freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only) [IN] hopPeriod Number of symbols bewteen each hop (LoRa only) [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]
Implements Radio.
Definition at line 176 of file sx1272.cpp.
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 | ||
) | [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 [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 [0: OFF, 1: ON] (LoRa only) [IN] hopPeriod Number of symbols bewteen each hop (LoRa only) [IN] iqInverted Inverts IQ signals ( LoRa only ) FSK : N/A ( set to 0 ) LoRa: [0: not inverted, 1: inverted] [IN] timeout Transmission timeout [ms]
Implements Radio.
Definition at line 319 of file sx1272.cpp.
void SetTxContinuousWave | ( | uint32_t | freq, |
int8_t | power, | ||
uint16_t | time | ||
) | [virtual] |
Sets the radio in continuous wave transmission mode.
- Parameters:
-
[IN],: freq Channel RF frequency [IN],: power Sets the output power [dBm] [IN],: time Transmission mode timeout [s]
Implements Radio.
Definition at line 806 of file sx1272.cpp.
void Sleep | ( | void | ) | [virtual] |
virtual void SpiInit | ( | void | ) | [protected, pure virtual] |
Initializes the radio SPI.
Implemented in SX1272MB2xAS.
void Standby | ( | void | ) | [virtual] |
void StartCad | ( | void | ) | [virtual] |
uint32_t TimeOnAir | ( | RadioModems_t | modem, |
uint8_t | pktLen | ||
) | [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:
-
airTime Computed airTime for the given packet payload length
Implements Radio.
Definition at line 444 of file sx1272.cpp.
void Tx | ( | uint32_t | timeout ) | [virtual] |
Sets the radio in transmission mode for the given time.
- Parameters:
-
[IN] timeout Transmission timeout [ms] [0: continuous, others timeout]
Implements Radio.
Definition at line 711 of file sx1272.cpp.
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
Implements Radio.
Implemented in SX1272MB2xAS.
virtual void Write | ( | uint8_t | addr, |
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
Implements Radio.
Implemented in SX1272MB2xAS.
virtual void WriteFifo | ( | uint8_t * | buffer, |
uint8_t | size | ||
) | [pure virtual] |
Writes the buffer contents to the SX1272 FIFO.
- Parameters:
-
[IN] buffer Buffer containing data to be put on the FIFO. [IN] size Number of bytes to be written to the FIFO
Implements Radio.
Implemented in SX1272MB2xAS.
Field Documentation
DioIrqHandler* dioIrq [protected] |
Timeout txTimeoutTimer [protected] |
Generated on Wed Jul 13 2022 02:47:00 by 1.7.2