Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes. More...

#include <SX126x.h>

Inheritance diagram for SX126x:

Public Member Functions
	SX126x (Module *mod)
	Default constructor. More...

Module *	getMod ()

int16_t	begin (uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
	Initialization method for LoRa modem. More...

int16_t	beginFSK (float br, float freqDev, float rxBw, uint16_t preambleLength, float tcxoVoltage, bool useRegulatorLDO=false)
	Initialization method for FSK modem. More...

int16_t	reset (bool verify=true)
	Reset method. Will reset the chip to the default state using RST pin. More...

int16_t	transmit (uint8_t *data, size_t len, uint8_t addr=0) override
	Blocking binary transmit method. Overloads for string-based transmissions are implemented in PhysicalLayer. More...

int16_t	receive (uint8_t *data, size_t len) override
	Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalLayer. More...

int16_t	transmitDirect (uint32_t frf=0) override
	Starts direct mode transmission. More...

int16_t	receiveDirect () override
	Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN. More...

int16_t	scanChannel ()
	Performs scan for LoRa transmission in the current channel. Detects both preamble and payload. More...

int16_t	sleep (bool retainConfig=true)
	Sets the module to sleep mode. More...

int16_t	standby () override
	Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator). More...

int16_t	standby (uint8_t mode)
	Sets the module to standby mode. More...

void	setDio1Action (void(*func)(void))
	Sets interrupt service routine to call when DIO1 activates. More...

void	clearDio1Action ()
	Clears interrupt service routine to call when DIO1 activates.

int16_t	startTransmit (uint8_t *data, size_t len, uint8_t addr=0) override
	Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in PhysicalLayer. More...

int16_t	startReceive (uint32_t timeout=RADIOLIB_SX126X_RX_TIMEOUT_INF)
	Interrupt-driven receive method. DIO1 will be activated when full packet is received. More...

int16_t	startReceiveDutyCycle (uint32_t rxPeriod, uint32_t sleepPeriod)
	Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen. Note that this function assumes the unit will take 500us + TCXO_delay to change state. See datasheet section 13.1.7, version 1.2. More...

int16_t	startReceiveDutyCycleAuto (uint16_t senderPreambleLength=0, uint16_t minSymbols=8)
	Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages. More...

uint16_t	getIrqStatus ()
	Reads the current IRQ status. More...

int16_t	readData (uint8_t *data, size_t len) override
	Reads data received after calling startReceive method. More...

int16_t	startChannelScan ()
	Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout. More...

int16_t	getChannelScanResult ()
	Read the channel scan result. More...

int16_t	setBandwidth (float bw)
	Sets LoRa bandwidth. Allowed values are 7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125.0, 250.0 and 500.0 kHz. More...

int16_t	setSpreadingFactor (uint8_t sf)
	Sets LoRa spreading factor. Allowed values range from 5 to 12. More...

int16_t	setCodingRate (uint8_t cr)
	Sets LoRa coding rate denominator. Allowed values range from 5 to 8. More...

int16_t	setSyncWord (uint8_t syncWord, uint8_t controlBits=0x44)
	Sets LoRa sync word. More...

int16_t	setCurrentLimit (float currentLimit)
	Sets current protection limit. Can be set in 0.25 mA steps. More...

float	getCurrentLimit ()
	Reads current protection limit. More...

int16_t	setPreambleLength (uint16_t preambleLength)
	Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535. More...

int16_t	setFrequencyDeviation (float freqDev) override
	Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz. More...

int16_t	setBitRate (float br)
	Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps. More...

int16_t	setRxBandwidth (float rxBw)
	Sets FSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19.5, 23.4, 29.3, 39.0, 46.9, 58.6, 78.2, 93.8, 117.3, 156.2, 187.2, 234.3, 312.0, 373.6 and 467.0 kHz. More...

int16_t	setDataShaping (uint8_t sh) override
	Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5, RADIOLIB_SHAPING_0_7 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping. More...

int16_t	setSyncWord (uint8_t *syncWord, uint8_t len)
	Sets FSK sync word in the form of array of up to 8 bytes. More...

int16_t	setSyncBits (uint8_t *syncWord, uint8_t bitsLen)
	Sets FSK sync word in the form of array of up to 8 bytes. More...

int16_t	setNodeAddress (uint8_t nodeAddr)
	Sets node address. Calling this method will also enable address filtering for node address only. More...

int16_t	setBroadcastAddress (uint8_t broadAddr)
	Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address. More...

int16_t	disableAddressFiltering ()
	Disables address filtering. Calling this method will also erase previously set addresses. More...

int16_t	setCRC (uint8_t len, uint16_t initial=0x1D0F, uint16_t polynomial=0x1021, bool inverted=true)
	Sets CRC configuration. More...

int16_t	setWhitening (bool enabled, uint16_t initial=0x0100)
	Sets FSK whitening parameters. More...

int16_t	setTCXO (float voltage, uint32_t delay=5000)
	Sets TCXO (Temperature Compensated Crystal Oscillator) configuration. More...

int16_t	setDio2AsRfSwitch (bool enable=true)
	Set DIO2 to function as RF switch (default in Semtech example designs). More...

float	getDataRate () const
	Gets effective data rate for the last transmitted packet. The value is calculated only for payload bytes. More...

float	getRSSI ()
	Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. More...

float	getSNR ()
	Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem. More...

size_t	getPacketLength (bool update=true) override
	Query modem for the packet length of received payload. More...

int16_t	fixedPacketLengthMode (uint8_t len=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
	Set modem in fixed packet length mode. Available in FSK mode only. More...

int16_t	variablePacketLengthMode (uint8_t maxLen=RADIOLIB_SX126X_MAX_PACKET_LENGTH)
	Set modem in variable packet length mode. Available in FSK mode only. More...

uint32_t	getTimeOnAir (size_t len)
	Get expected time-on-air for a given size of payload. More...

float	getRSSIInst ()
	Get instantaneous RSSI value during recption of the packet. Should switch to FSK receive mode for LBT implementation. More...

int16_t	implicitHeader (size_t len)
	Set implicit header mode for future reception/transmission. More...

int16_t	explicitHeader ()
	Set explicit header mode for future reception/transmission. More...

int16_t	setRegulatorLDO ()
	Set regulator mode to LDO. More...

int16_t	setRegulatorDCDC ()
	Set regulator mode to DC-DC. More...

int16_t	setEncoding (uint8_t encoding) override
	Sets transmission encoding. Available in FSK mode only. Serves only as alias for PhysicalLayer compatibility. More...

void	setRfSwitchPins (RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
	Some modules contain external RF switch controlled by two pins. This function gives RadioLib control over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch! More...

int16_t	forceLDRO (bool enable)
	Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method, LDRO will always be set to the provided value, regardless of symbol length. To re-enable automatic LDRO configuration, call SX126x::autoLDRO() More...

int16_t	autoLDRO ()
	Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method, LDRO will be enabled automatically when symbol length exceeds 16 ms. More...

uint8_t	randomByte ()
	Get one truly random byte from RSSI noise. More...

void	setDirectAction (void(*func)(void))
	Dummy method, to ensure PhysicalLayer compatibility. More...

void	readBit (RADIOLIB_PIN_TYPE pin)
	Dummy method, to ensure PhysicalLayer compatibility. More...

int16_t	transmit (__FlashStringHelper *fstr, uint8_t addr=0)
	Arduino Flash String transmit method. More...

int16_t	transmit (String &str, uint8_t addr=0)
	Arduino String transmit method. More...

int16_t	transmit (const char *str, uint8_t addr=0)
	C-string transmit method. More...

virtual int16_t	transmit (uint8_t *data, size_t len, uint8_t addr=0)=0
	Binary transmit method. Must be implemented in module class. More...

int16_t	receive (String &str, size_t len=0)
	Arduino String receive method. More...

virtual int16_t	receive (uint8_t *data, size_t len)=0
	Binary receive method. Must be implemented in module class. More...

int16_t	startTransmit (String &str, uint8_t addr=0)
	Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...

int16_t	startTransmit (const char *str, uint8_t addr=0)
	Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...

virtual int16_t	startTransmit (uint8_t *data, size_t len, uint8_t addr=0)=0
	Interrupt-driven binary transmit method. More...

int16_t	readData (String &str, size_t len=0)
	Reads data that was received after calling startReceive method. More...

virtual int16_t	readData (uint8_t *data, size_t len)=0
	Reads data that was received after calling startReceive method. More...

Public Member Functions inherited from PhysicalLayer
	PhysicalLayer (float freqStep, size_t maxPacketLength)
	Default constructor. More...

int16_t	transmit (__FlashStringHelper *fstr, uint8_t addr=0)
	Arduino Flash String transmit method. More...

int16_t	transmit (String &str, uint8_t addr=0)
	Arduino String transmit method. More...

int16_t	transmit (const char *str, uint8_t addr=0)
	C-string transmit method. More...

int16_t	receive (String &str, size_t len=0)
	Arduino String receive method. More...

int16_t	startTransmit (String &str, uint8_t addr=0)
	Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...

int16_t	startTransmit (const char *str, uint8_t addr=0)
	Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes. More...

int16_t	readData (String &str, size_t len=0)
	Reads data that was received after calling startReceive method. More...

float	getFreqStep () const
	Gets the module frequency step size that was set in constructor. More...

int32_t	random (int32_t max)
	Get truly random number in range 0 - max. More...

int32_t	random (int32_t min, int32_t max)
	Get truly random number in range min - max. More...

int16_t	startDirect ()
	Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX.25. Only available in FSK mode. More...

int16_t	setDirectSyncWord (uint32_t syncWord, uint8_t len)
	Set sync word to be used to determine start of packet in direct reception mode. More...

int16_t	available ()
	Get the number of direct mode bytes currently available in buffer. More...

uint8_t	read ()
	Get data from direct mode buffer. More...

virtual int16_t	setDIOMapping (RADIOLIB_PIN_TYPE pin, uint8_t value)
	Configure DIO pin mapping to get a given signal on a DIO pin (if available). More...

Detailed Description

Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes.

Constructor & Destructor Documentation

◆ SX126x()

SX126x::SX126x ( Module * mod )

Default constructor.

Parameters

mod	Instance of Module that will be used to communicate with the radio.

Member Function Documentation

◆ autoLDRO()

int16_t SX126x::autoLDRO ( )

Re-enables automatic LDRO configuration. Only available in LoRa mode. After calling this method, LDRO will be enabled automatically when symbol length exceeds 16 ms.

Returns: Status Codes

◆ begin()

int16_t SX126x::begin	(	uint8_t	cr,
		uint8_t	syncWord,
		uint16_t	preambleLength,
		float	tcxoVoltage,
		bool	useRegulatorLDO = `false`
	)

Initialization method for LoRa modem.

Parameters

cr	LoRa coding rate denominator. Allowed values range from 5 to 8.
syncWord	1-byte LoRa sync word.
preambleLength	LoRa preamble length in symbols. Allowed values range from 1 to 65535.
tcxoVoltage	TCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip.
useRegulatorLDO	use the LDO instead of DC-DC converter (default false). This is necessary for some modules such as the LAMBDA from RF solutions.

Returns: Status Codes

◆ beginFSK()

int16_t SX126x::beginFSK	(	float	br,
		float	freqDev,
		float	rxBw,
		uint16_t	preambleLength,
		float	tcxoVoltage,
		bool	useRegulatorLDO = `false`
	)

Initialization method for FSK modem.

Parameters

br	FSK bit rate in kbps. Allowed values range from 0.6 to 300.0 kbps.
freqDev	Frequency deviation from carrier frequency in kHz. Allowed values range from 0.0 to 200.0 kHz.
rxBw	Receiver bandwidth in kHz. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19.5, 23.4, 29.3, 39.0, 46.9, 58.6, 78.2, 93.8, 117.3, 156.2, 187.2, 234.3, 312.0, 373.6 and 467.0 kHz.
preambleLength	FSK preamble length in bits. Allowed values range from 0 to 65535.
tcxoVoltage	TCXO reference voltage to be set on DIO3. Defaults to 1.6 V, set to 0 to skip.
useRegulatorLDO	use the LDO instead of DC-DC converter (default false). This is necessary for some modules such as the LAMBDA from RF solutions.

Returns: Status Codes

◆ disableAddressFiltering()

int16_t SX126x::disableAddressFiltering ( )

Disables address filtering. Calling this method will also erase previously set addresses.

Returns: Status Codes

◆ explicitHeader()

int16_t SX126x::explicitHeader ( )

Set explicit header mode for future reception/transmission.

Returns: Status Codes

◆ fixedPacketLengthMode()

int16_t SX126x::fixedPacketLengthMode ( uint8_t len = RADIOLIB_SX126X_MAX_PACKET_LENGTH )

Set modem in fixed packet length mode. Available in FSK mode only.

Parameters

len	Packet length.

Returns: Status Codes

◆ forceLDRO()

int16_t SX126x::forceLDRO ( bool enable )

Forces LoRa low data rate optimization. Only available in LoRa mode. After calling this method, LDRO will always be set to the provided value, regardless of symbol length. To re-enable automatic LDRO configuration, call SX126x::autoLDRO()

Parameters

enable Force LDRO to be always enabled (true) or disabled (false).

Returns: Status Codes

◆ getChannelScanResult()

int16_t SX126x::getChannelScanResult ( )

Read the channel scan result.

Returns: Status Codes

◆ getCurrentLimit()

float SX126x::getCurrentLimit ( )

Reads current protection limit.

Returns: Currently configured overcurrent protection limit in mA.

◆ getDataRate()

float SX126x::getDataRate ( ) const

Gets effective data rate for the last transmitted packet. The value is calculated only for payload bytes.

Returns: Effective data rate in bps.

◆ getIrqStatus()

uint16_t SX126x::getIrqStatus ( )

Reads the current IRQ status.

Returns: IRQ status bits

◆ getPacketLength()

size_t SX126x::getPacketLength ( bool update = true )

overridevirtual

Query modem for the packet length of received payload.

Parameters

update Update received packet length. Will return cached value when set to false.

Returns: Length of last received packet in bytes.

Implements PhysicalLayer.

◆ getRSSI()

float SX126x::getRSSI ( )

Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.

Returns: RSSI of the last received packet in dBm.

◆ getRSSIInst()

float SX126x::getRSSIInst ( )

Get instantaneous RSSI value during recption of the packet. Should switch to FSK receive mode for LBT implementation.

Returns: Instantaneous RSSI value in dBm, in steps of 0.5dBm

◆ getSNR()

float SX126x::getSNR ( )

Gets SNR (Signal to Noise Ratio) of the last received packet. Only available for LoRa modem.

Returns: SNR of the last received packet in dB.

◆ getTimeOnAir()

uint32_t SX126x::getTimeOnAir ( size_t len )

Get expected time-on-air for a given size of payload.

Parameters

len	Payload length in bytes.

Returns: Expected time-on-air in microseconds.

◆ implicitHeader()

int16_t SX126x::implicitHeader ( size_t len )

Set implicit header mode for future reception/transmission.

Parameters

len	Payload length in bytes.

Returns: Status Codes

◆ randomByte()

uint8_t SX126x::randomByte ( )

virtual

Get one truly random byte from RSSI noise.

Returns: TRNG byte.

Implements PhysicalLayer.

◆ readBit()

void SX126x::readBit ( RADIOLIB_PIN_TYPE pin )

virtual

Dummy method, to ensure PhysicalLayer compatibility.

Parameters

pin Ignored.

Implements PhysicalLayer.

◆ readData() [1/3]

int16_t PhysicalLayer::readData

Reads data that was received after calling startReceive method.

Parameters

str	Address of Arduino String to save the received data.
len	Expected number of characters in the message. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.

Returns: Status Codes

◆ readData() [2/3]

int16_t SX126x::readData	(	uint8_t *	data,
		size_t	len
	)

overridevirtual

Reads data received after calling startReceive method.

Parameters

data	Pointer to array to save the received binary data.
len	Number of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.

Returns: Status Codes

Implements PhysicalLayer.

◆ readData() [3/3]

virtual int16_t PhysicalLayer::readData

Reads data that was received after calling startReceive method.

Parameters

data	Pointer to array to save the received binary data.
len	Number of bytes that will be read. When set to 0, the packet length will be retreived automatically. When more bytes than received are requested, only the number of bytes requested will be returned.

Returns: Status Codes

◆ receive() [1/3]

int16_t PhysicalLayer::receive

Arduino String receive method.

Parameters

str	Address of Arduino String to save the received data.
len	Expected number of characters in the message. Leave as 0 if expecting a unknown size packet

Returns: Status Codes

◆ receive() [2/3]

int16_t SX126x::receive	(	uint8_t *	data,
		size_t	len
	)

overridevirtual

Blocking binary receive method. Overloads for string-based transmissions are implemented in PhysicalLayer.

Parameters

data	Binary data to be sent.
len	Number of bytes to send.

Returns: Status Codes

Implements PhysicalLayer.

◆ receive() [3/3]

virtual int16_t PhysicalLayer::receive

Binary receive method. Must be implemented in module class.

Parameters

data	Pointer to array to save the received binary data.
len	Number of bytes that will be received. Must be known in advance for binary transmissions.

Returns: Status Codes

◆ receiveDirect()

int16_t SX126x::receiveDirect ( )

overridevirtual

Starts direct mode reception. Only implemented for PhysicalLayer compatibility, as SX126x series does not support direct mode reception. Will always return RADIOLIB_ERR_UNKNOWN.

Returns: Status Codes

Implements PhysicalLayer.

◆ reset()

int16_t SX126x::reset ( bool verify = true )

Reset method. Will reset the chip to the default state using RST pin.

Parameters

verify Whether correct module startup should be verified. When set to true, RadioLib will attempt to verify the module has started correctly by repeatedly issuing setStandby command. Enabled by default.

Returns: Status Codes

◆ scanChannel()

int16_t SX126x::scanChannel ( )

Performs scan for LoRa transmission in the current channel. Detects both preamble and payload.

Returns: Status Codes

◆ setBandwidth()

int16_t SX126x::setBandwidth ( float bw )

Sets LoRa bandwidth. Allowed values are 7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125.0, 250.0 and 500.0 kHz.

Parameters

bw	LoRa bandwidth to be set in kHz.

Returns: Status Codes

◆ setBitRate()

int16_t SX126x::setBitRate ( float br )

Sets FSK bit rate. Allowed values range from 0.6 to 300.0 kbps.

Parameters

br	FSK bit rate to be set in kbps.

Returns: Status Codes

◆ setBroadcastAddress()

int16_t SX126x::setBroadcastAddress ( uint8_t broadAddr )

Sets broadcast address. Calling this method will also enable address filtering for node and broadcast address.

Parameters

broadAddr Node address to be set.

Returns: Status Codes

◆ setCodingRate()

int16_t SX126x::setCodingRate ( uint8_t cr )

Sets LoRa coding rate denominator. Allowed values range from 5 to 8.

Parameters

cr	LoRa coding rate denominator to be set.

Returns: Status Codes

◆ setCRC()

int16_t SX126x::setCRC	(	uint8_t	len,
		uint16_t	initial = `0x1D0F`,
		uint16_t	polynomial = `0x1021`,
		bool	inverted = `true`
	)

Sets CRC configuration.

Parameters

len	CRC length in bytes, Allowed values are 1 or 2, set to 0 to disable CRC.
initial	Initial CRC value. FSK only. Defaults to 0x1D0F (CCIT CRC).
polynomial	Polynomial for CRC calculation. FSK only. Defaults to 0x1021 (CCIT CRC).
inverted	Invert CRC bytes. FSK only. Defaults to true (CCIT CRC).

Returns: Status Codes

◆ setCurrentLimit()

int16_t SX126x::setCurrentLimit ( float currentLimit )

Sets current protection limit. Can be set in 0.25 mA steps.

Parameters

currentLimit current protection limit to be set in mA.

Returns: Status Codes

◆ setDataShaping()

int16_t SX126x::setDataShaping ( uint8_t sh )

overridevirtual

Sets time-bandwidth product of Gaussian filter applied for shaping. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5, RADIOLIB_SHAPING_0_7 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping.

Parameters

sh	Time-bandwidth product of Gaussian filter to be set.

Returns: Status Codes

Implements PhysicalLayer.

◆ setDio1Action()

void SX126x::setDio1Action ( void(*)(void) func )

Sets interrupt service routine to call when DIO1 activates.

Parameters

func	ISR to call.

◆ setDio2AsRfSwitch()

int16_t SX126x::setDio2AsRfSwitch ( bool enable = true )

Set DIO2 to function as RF switch (default in Semtech example designs).

Returns: Status Codes

◆ setDirectAction()

void SX126x::setDirectAction ( void(*)(void) func )

virtual

Dummy method, to ensure PhysicalLayer compatibility.

Parameters

func Ignored.

Implements PhysicalLayer.

◆ setEncoding()

int16_t SX126x::setEncoding ( uint8_t encoding )

overridevirtual

Sets transmission encoding. Available in FSK mode only. Serves only as alias for PhysicalLayer compatibility.

Parameters

encoding Encoding to be used. Set to 0 for NRZ, and 2 for whitening.

Returns: Status Codes

Implements PhysicalLayer.

◆ setFrequencyDeviation()

int16_t SX126x::setFrequencyDeviation ( float freqDev )

overridevirtual

Sets FSK frequency deviation. Allowed values range from 0.0 to 200.0 kHz.

Parameters

freqDev FSK frequency deviation to be set in kHz.

Returns: Status Codes

Implements PhysicalLayer.

◆ setNodeAddress()

int16_t SX126x::setNodeAddress ( uint8_t nodeAddr )

Sets node address. Calling this method will also enable address filtering for node address only.

Parameters

nodeAddr Node address to be set.

Returns: Status Codes

◆ setPreambleLength()

int16_t SX126x::setPreambleLength ( uint16_t preambleLength )

Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.

Parameters

preambleLength Preamble length to be set in symbols (LoRa) or bits (FSK).

Returns: Status Codes

◆ setRegulatorDCDC()

int16_t SX126x::setRegulatorDCDC ( )

Set regulator mode to DC-DC.

Returns: Status Codes

◆ setRegulatorLDO()

int16_t SX126x::setRegulatorLDO ( )

Set regulator mode to LDO.

Returns: Status Codes

◆ setRfSwitchPins()

void SX126x::setRfSwitchPins	(	RADIOLIB_PIN_TYPE	rxEn,
		RADIOLIB_PIN_TYPE	txEn
	)

Some modules contain external RF switch controlled by two pins. This function gives RadioLib control over those two pins to automatically switch Rx and Tx state. When using automatic RF switch control, DO NOT change the pin mode of rxEn or txEn from Arduino sketch!

Parameters

rxEn	RX enable pin.
txEn	TX enable pin.

◆ setRxBandwidth()

int16_t SX126x::setRxBandwidth ( float rxBw )

Sets FSK receiver bandwidth. Allowed values are 4.8, 5.8, 7.3, 9.7, 11.7, 14.6, 19.5, 23.4, 29.3, 39.0, 46.9, 58.6, 78.2, 93.8, 117.3, 156.2, 187.2, 234.3, 312.0, 373.6 and 467.0 kHz.

Parameters

FSK	receiver bandwidth to be set in kHz.

Returns: Status Codes

◆ setSpreadingFactor()

int16_t SX126x::setSpreadingFactor ( uint8_t sf )

Sets LoRa spreading factor. Allowed values range from 5 to 12.

Parameters

sf	LoRa spreading factor to be set.

Returns: Status Codes

◆ setSyncBits()

int16_t SX126x::setSyncBits	(	uint8_t *	syncWord,
		uint8_t	bitsLen
	)

Sets FSK sync word in the form of array of up to 8 bytes.

Parameters

syncWord	FSK sync word to be set.
bitsLen	FSK sync word length in bits. If length is not divisible by 8, least significant bits of syncWord will be ignored.

Returns: Status Codes

◆ setSyncWord() [1/2]

int16_t SX126x::setSyncWord	(	uint8_t *	syncWord,
		uint8_t	len
	)

Sets FSK sync word in the form of array of up to 8 bytes.

Parameters

syncWord	FSK sync word to be set.
len	FSK sync word length in bytes.

Returns: Status Codes

◆ setSyncWord() [2/2]

int16_t SX126x::setSyncWord	(	uint8_t	syncWord,
		uint8_t	controlBits = `0x44`
	)

Sets LoRa sync word.

Parameters

syncWord	LoRa sync word to be set.
controlBits	Undocumented control bits, required for compatibility purposes.

Returns: Status Codes

◆ setTCXO()

int16_t SX126x::setTCXO	(	float	voltage,
		uint32_t	delay = `5000`
	)

Sets TCXO (Temperature Compensated Crystal Oscillator) configuration.

Parameters

TCXO	reference voltage in volts. Allowed values are 1.6, 1.7, 1.8, 2.2. 2.4, 2.7, 3.0 and 3.3 V. Set to 0 to disable TCXO. NOTE: After setting this parameter to 0, the module will be reset (since there's no other way to disable TCXO).
TCXO	timeout in us. Defaults to 5000 us.

Returns: Status Codes

◆ setWhitening()

int16_t SX126x::setWhitening	(	bool	enabled,
		uint16_t	initial = `0x0100`
	)

Sets FSK whitening parameters.

Parameters

enabled	True = Whitening enabled
initial	Initial value used for the whitening LFSR in FSK mode. Defaults to 0x0100, use 0x01FF for SX127x compatibility.

Returns: Status Codes

◆ sleep()

int16_t SX126x::sleep ( bool retainConfig = true )

Sets the module to sleep mode.

Parameters

retainConfig Set to true to retain configuration of the currently active modem ("warm start") or to false to discard current configuration ("cold start"). Defaults to true.

Returns: Status Codes

◆ standby() [1/2]

int16_t SX126x::standby ( )

overridevirtual

Sets the module to standby mode (overload for PhysicalLayer compatibility, uses 13 MHz RC oscillator).

Returns: Status Codes

Implements PhysicalLayer.

◆ standby() [2/2]

int16_t SX126x::standby ( uint8_t mode )

Sets the module to standby mode.

Parameters

mode	Oscillator to be used in standby mode. Can be set to RADIOLIB_SX126X_STANDBY_RC (13 MHz RC oscillator) or RADIOLIB_SX126X_STANDBY_XOSC (32 MHz external crystal oscillator).

Returns: Status Codes

◆ startChannelScan()

int16_t SX126x::startChannelScan ( )

Interrupt-driven channel activity detection method. DIO0 will be activated when LoRa preamble is detected, or upon timeout.

Returns: Status Codes

◆ startReceive()

int16_t SX126x::startReceive ( uint32_t timeout = RADIOLIB_SX126X_RX_TIMEOUT_INF )

Interrupt-driven receive method. DIO1 will be activated when full packet is received.

Parameters

timeout Raw timeout value, expressed as multiples of 15.625 us. Defaults to RADIOLIB_SX126X_RX_TIMEOUT_INF for infinite timeout (Rx continuous mode), set to RADIOLIB_SX126X_RX_TIMEOUT_NONE for no timeout (Rx single mode). If timeout other than infinite is set, signal will be generated on DIO1.

Returns: Status Codes

◆ startReceiveDutyCycle()

int16_t SX126x::startReceiveDutyCycle	(	uint32_t	rxPeriod,
		uint32_t	sleepPeriod
	)

Interrupt-driven receive method where the device mostly sleeps and periodically wakes to listen. Note that this function assumes the unit will take 500us + TCXO_delay to change state. See datasheet section 13.1.7, version 1.2.

Parameters

rxPeriod	The duration the receiver will be in Rx mode, in microseconds.
sleepPeriod	The duration the receiver will not be in Rx mode, in microseconds.

Returns: Status Codes

◆ startReceiveDutyCycleAuto()

int16_t SX126x::startReceiveDutyCycleAuto	(	uint16_t	senderPreambleLength = `0`,
		uint16_t	minSymbols = `8`
	)

Calls startReceiveDutyCycle with rxPeriod and sleepPeriod set so the unit shouldn't miss any messages.

Parameters

senderPreambleLength	Expected preamble length of the messages to receive. If set to zero, the currently configured preamble length will be used. Defaults to zero.
minSymbols	Parameters will be chosen to ensure that the unit will catch at least this many symbols of any preamble of the specified length. Defaults to 8. According to Semtech, receiver requires 8 symbols to reliably latch a preamble. This makes this method redundant when transmitter preamble length is less than 17 (2*minSymbols + 1).

Returns: Status Codes

◆ startTransmit() [1/4]

int16_t PhysicalLayer::startTransmit

Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes.

Parameters

str	C-string that will be transmitted.
addr	Node address to transmit the packet to. Only used in FSK mode.

Returns: Status Codes

◆ startTransmit() [2/4]

int16_t PhysicalLayer::startTransmit

Interrupt-driven Arduino String transmit method. Unlike the standard transmit method, this one is non-blocking. Interrupt pin will be activated when transmission finishes.

Parameters

str	Address of Arduino String that will be transmitted.
addr	Node address to transmit the packet to. Only used in FSK mode.

Returns: Status Codes

◆ startTransmit() [3/4]

int16_t SX126x::startTransmit	(	uint8_t *	data,
		size_t	len,
		uint8_t	addr = `0`
	)

overridevirtual

Interrupt-driven binary transmit method. Overloads for string-based transmissions are implemented in PhysicalLayer.

Parameters

data	Binary data to be sent.
len	Number of bytes to send.
addr	Address to send the data to. Will only be added if address filtering was enabled.

Returns: Status Codes

Implements PhysicalLayer.

◆ startTransmit() [4/4]

virtual int16_t PhysicalLayer::startTransmit

Interrupt-driven binary transmit method.

Parameters

data	Binary data that will be transmitted.
len	Length of binary data to transmit (in bytes).
addr	Node address to transmit the packet to. Only used in FSK mode.

Returns: Status Codes

◆ transmit() [1/5]

int16_t PhysicalLayer::transmit

Arduino Flash String transmit method.

Parameters

str	Pointer to Arduino Flash String that will be transmitted.
addr	Node address to transmit the packet to. Only used in FSK mode.

Returns: Status Codes

◆ transmit() [2/5]

int16_t PhysicalLayer::transmit

C-string transmit method.

Parameters

str	C-string that will be transmitted.
addr	Node address to transmit the packet to. Only used in FSK mode.

Returns: Status Codes

◆ transmit() [3/5]

int16_t PhysicalLayer::transmit

Arduino String transmit method.

Parameters

str	Address of Arduino string that will be transmitted.
addr	Node address to transmit the packet to. Only used in FSK mode.

Returns: Status Codes

◆ transmit() [4/5]

int16_t SX126x::transmit	(	uint8_t *	data,
		size_t	len,
		uint8_t	addr = `0`
	)

overridevirtual

Blocking binary transmit method. Overloads for string-based transmissions are implemented in PhysicalLayer.

Parameters

data	Binary data to be sent.
len	Number of bytes to send.
addr	Address to send the data to. Will only be added if address filtering was enabled.

Returns: Status Codes

Implements PhysicalLayer.

◆ transmit() [5/5]

virtual int16_t PhysicalLayer::transmit

Binary transmit method. Must be implemented in module class.

Parameters

data	Binary data that will be transmitted.
len	Length of binary data to transmit (in bytes).
addr	Node address to transmit the packet to. Only used in FSK mode.

Returns: Status Codes

◆ transmitDirect()

int16_t SX126x::transmitDirect ( uint32_t frf = 0 )

overridevirtual

Starts direct mode transmission.

Parameters

frf	Raw RF frequency value. Defaults to 0, required for quick frequency shifts in RTTY.

Returns: Status Codes

Implements PhysicalLayer.

◆ variablePacketLengthMode()

int16_t SX126x::variablePacketLengthMode ( uint8_t maxLen = RADIOLIB_SX126X_MAX_PACKET_LENGTH )

Set modem in variable packet length mode. Available in FSK mode only.

Parameters

len	Maximum packet length.

Returns: Status Codes

The documentation for this class was generated from the following files:

src/modules/SX126x/SX126x.h
src/modules/SX126x/SX126x.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SX126x()

Member Function Documentation

◆ autoLDRO()

◆ begin()

◆ beginFSK()

◆ disableAddressFiltering()

◆ explicitHeader()

◆ fixedPacketLengthMode()

◆ forceLDRO()

◆ getChannelScanResult()

◆ getCurrentLimit()

◆ getDataRate()

◆ getIrqStatus()

◆ getPacketLength()

◆ getRSSI()

◆ getRSSIInst()

◆ getSNR()

◆ getTimeOnAir()

◆ implicitHeader()

◆ randomByte()

◆ readBit()

◆ readData() [1/3]

◆ readData() [2/3]

◆ readData() [3/3]

◆ receive() [1/3]

◆ receive() [2/3]

◆ receive() [3/3]

◆ receiveDirect()

◆ reset()

◆ scanChannel()

◆ setBandwidth()

◆ setBitRate()

◆ setBroadcastAddress()

◆ setCodingRate()

◆ setCRC()

◆ setCurrentLimit()

◆ setDataShaping()

◆ setDio1Action()

◆ setDio2AsRfSwitch()

◆ setDirectAction()

◆ setEncoding()

◆ setFrequencyDeviation()

◆ setNodeAddress()

◆ setPreambleLength()

◆ setRegulatorDCDC()

◆ setRegulatorLDO()

◆ setRfSwitchPins()

◆ setRxBandwidth()

◆ setSpreadingFactor()

◆ setSyncBits()

◆ setSyncWord() [1/2]

◆ setSyncWord() [2/2]

◆ setTCXO()

◆ setWhitening()

◆ sleep()

◆ standby() [1/2]

◆ standby() [2/2]

◆ startChannelScan()

◆ startReceive()

◆ startReceiveDutyCycle()

◆ startReceiveDutyCycleAuto()

◆ startTransmit() [1/4]

◆ startTransmit() [2/4]

◆ startTransmit() [3/4]

◆ startTransmit() [4/4]

◆ transmit() [1/5]

◆ transmit() [2/5]

◆ transmit() [3/5]

◆ transmit() [4/5]

◆ transmit() [5/5]

◆ transmitDirect()

◆ variablePacketLengthMode()