Control class for RF69 module. Also serves as base class for SX1231. More...

#include <RF69.h>

Inheritance diagram for RF69:

Public Member Functions
	RF69 (Module *module)
	Default constructor. More...

int16_t	begin (float freq=434.0, float br=48.0, float freqDev=50.0, float rxBw=125.0, int8_t power=10, uint8_t preambleLen=16)
	Initialization method. More...

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

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	sleep ()
	Sets the module to sleep mode. More...

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

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

int16_t	receiveDirect () override
	Starts direct mode reception. More...

int16_t	packetMode ()
	Stops direct mode. It is required to call this method to switch from direct transmissions to packet-based transmissions.

void	setAESKey (uint8_t *key)
	Sets AES key. More...

int16_t	enableAES ()
	Enables AES encryption. More...

int16_t	disableAES ()
	Disables AES encryption. More...

void	setDio0Action (void(*func)(void))
	Sets interrupt service routine to call when DIO0 activates. More...

void	clearDio0Action ()
	Clears interrupt service routine to call when DIO0 activates.

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 ()
	Interrupt-driven receive method. GDO0 will be activated when full packet is received. More...

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

int16_t	setFrequency (float freq)
	Sets carrier frequency. Allowed values are in bands 290.0 to 340.0 MHz, 431.0 to 510.0 MHz and 862.0 to 1020.0 MHz. More...

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

int16_t	setRxBandwidth (float rxBw)
	Sets receiver bandwidth. Allowed values are 2.6, 3.1, 3.9, 5.2, 6.3, 7.8, 10.4, 12.5, 15.6, 20.8, 25.0, 31.3, 41.7, 50.0, 62.5, 83.3, 100.0, 125.0, 166.7, 200.0, 250.0, 333.3, 400.0 and 500.0 kHz. More...

int16_t	setFrequencyDeviation (float freqDev) override
	Sets frequency deviation. More...

int16_t	setOutputPower (int8_t power, bool highPower=false)
	Sets output power. Allowed values range from -18 to 13 dBm for low power modules (RF69C/CW) or -2 to 20 dBm (RF69H/HC/HCW). More...

int16_t	setSyncWord (uint8_t *syncWord, size_t len, uint8_t maxErrBits=0)
	Sets sync word. Up to 8 bytes can be set as sync word. More...

int16_t	setPreambleLength (uint8_t preambleLen)
	Sets preamble length. 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...

void	setAmbientTemperature (int16_t tempAmbient)
	Sets ambient temperature. Required to correct values from on-board temperature sensor. More...

int16_t	getTemperature ()
	Measures temperature. More...

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

int16_t	fixedPacketLengthMode (uint8_t len=RF69_MAX_PACKET_LENGTH)
	Set modem in fixed packet length mode. More...

int16_t	variablePacketLengthMode (uint8_t maxLen=RF69_MAX_PACKET_LENGTH)
	Set modem in variable packet length mode. More...

int16_t	enableSyncWordFiltering (uint8_t maxErrBits=0)
	Enable sync word filtering and generation. More...

int16_t	disableSyncWordFiltering ()
	Disable preamble and sync word filtering and generation. More...

int16_t	setCrcFiltering (bool crcOn=true)
	Enable CRC filtering and generation. More...

int16_t	setPromiscuousMode (bool promiscuous=true)
	Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address, CRC). More...

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

int16_t	setEncoding (uint8_t encoding) override
	Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. More...

float	getRSSI ()
	Gets RSSI (Recorded Signal Strength Indicator) of the last received packet. 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...

uint8_t	random ()
	Get one truly random byte from RSSI noise. 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...

Detailed Description

Control class for RF69 module. Also serves as base class for SX1231.

Constructor & Destructor Documentation

◆ RF69()

RF69::RF69 ( Module * module )

Default constructor.

Parameters

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

Member Function Documentation

◆ begin()

int16_t RF69::begin	(	float	freq = `434.0`,
		float	br = `48.0`,
		float	freqDev = `50.0`,
		float	rxBw = `125.0`,
		int8_t	power = `10`,
		uint8_t	preambleLen = `16`
	)

Initialization method.

Parameters

freq	Carrier frequency in MHz. Defaults to 434.0 MHz.
br	Bit rate to be used in kbps. Defaults to 48.0 kbps.
freqDev	Frequency deviation from carrier frequency in kHz Defaults to 50.0 kHz.
rxBw	Receiver bandwidth in kHz. Defaults to 125.0 kHz.
power	Output power in dBm. Defaults to 10 dBm.
preambleLen	Preamble Length in bits. Defaults to 16 bits.

Returns: Status Codes

◆ disableAddressFiltering()

int16_t RF69::disableAddressFiltering ( )

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

Returns: Status Codes

◆ disableAES()

int16_t RF69::disableAES ( )

Disables AES encryption.

Returns: Status Codes

◆ disableSyncWordFiltering()

int16_t RF69::disableSyncWordFiltering ( )

Disable preamble and sync word filtering and generation.

Returns: Status Codes

◆ enableAES()

int16_t RF69::enableAES ( )

Enables AES encryption.

Returns: Status Codes

◆ enableSyncWordFiltering()

int16_t RF69::enableSyncWordFiltering ( uint8_t maxErrBits = 0 )

Enable sync word filtering and generation.

Parameters

numBits Sync word length in bits.

Returns: Status Codes

◆ fixedPacketLengthMode()

int16_t RF69::fixedPacketLengthMode ( uint8_t len = RF69_MAX_PACKET_LENGTH )

Set modem in fixed packet length mode.

Parameters

len	Packet length.

Returns: Status Codes

◆ getPacketLength()

size_t RF69::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 RF69::getRSSI ( )

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

Returns: Last packet RSSI in dBm.

◆ getTemperature()

int16_t RF69::getTemperature ( )

Measures temperature.

Returns: Measured temperature in degrees Celsius.

◆ random()

uint8_t RF69::random ( )

virtual

Get one truly random byte from RSSI noise.

Returns: TRNG byte.

Implements PhysicalLayer.

◆ readData()

int16_t RF69::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 received. Must be known in advance for binary transmissions.

Returns: Status Codes

Implements PhysicalLayer.

◆ receive()

int16_t RF69::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.

◆ receiveDirect()

int16_t RF69::receiveDirect ( )

overridevirtual

Starts direct mode reception.

Returns: Status Codes

Implements PhysicalLayer.

◆ setAESKey()

void RF69::setAESKey ( uint8_t * key )

Sets AES key.

Parameters

Key	to be used for AES encryption. Must be exactly 16 bytes long.

◆ setAmbientTemperature()

void RF69::setAmbientTemperature ( int16_t tempAmbient )

Sets ambient temperature. Required to correct values from on-board temperature sensor.

Parameters

tempAmbient Ambient temperature in degrees Celsius.

◆ setBitRate()

int16_t RF69::setBitRate ( float br )

Sets bit rate. Allowed values range from 1.2 to 300.0 kbps.

Parameters

br	Bit rate to be set in kbps.

Returns: Status Codes

◆ setBroadcastAddress()

int16_t RF69::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

◆ setCrcFiltering()

int16_t RF69::setCrcFiltering ( bool crcOn = true )

Enable CRC filtering and generation.

Parameters

crcOn Set or unset promiscuous mode.

Returns: Status Codes

◆ setDataShaping()

int16_t RF69::setDataShaping ( uint8_t sh )

overridevirtual

Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5 or RADIOLIB_SHAPING_1_0. Set to RADIOLIB_SHAPING_NONE to disable data shaping.

Parameters

sh	Gaussian shaping bandwidth-time product that will be used for data shaping

Returns: Status Codes

Implements PhysicalLayer.

◆ setDio0Action()

void RF69::setDio0Action ( void(*)(void) func )

Sets interrupt service routine to call when DIO0 activates.

Parameters

func	ISR to call.

◆ setDio1Action()

void RF69::setDio1Action ( void(*)(void) func )

Sets interrupt service routine to call when DIO1 activates.

Parameters

func	ISR to call.

◆ setEncoding()

int16_t RF69::setEncoding ( uint8_t encoding )

overridevirtual

Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING.

Parameters

encoding Encoding to be used.

Returns: Status Codes

Implements PhysicalLayer.

◆ setFrequency()

int16_t RF69::setFrequency ( float freq )

Sets carrier frequency. Allowed values are in bands 290.0 to 340.0 MHz, 431.0 to 510.0 MHz and 862.0 to 1020.0 MHz.

Parameters

freq	Carrier frequency to be set in MHz.

Returns: Status Codes

◆ setFrequencyDeviation()

int16_t RF69::setFrequencyDeviation ( float freqDev )

overridevirtual

Sets frequency deviation.

Parameters

freqDev Frequency deviation to be set in kHz.

Returns: Status Codes

Implements PhysicalLayer.

◆ setNodeAddress()

int16_t RF69::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

◆ setOutputPower()

int16_t RF69::setOutputPower	(	int8_t	power,
		bool	highPower = `false`
	)

Sets output power. Allowed values range from -18 to 13 dBm for low power modules (RF69C/CW) or -2 to 20 dBm (RF69H/HC/HCW).

Parameters

power	Output power to be set in dBm.
highPower	Set to true when using modules high power port (RF69H/HC/HCW). Defaults to false (models without high power port - RF69C/CW).

Returns: Status Codes

◆ setPreambleLength()

int16_t RF69::setPreambleLength ( uint8_t preambleLen )

Sets preamble length.

Parameters

preambleLen Preamble length to be set (in bits), allowed values: 16, 24, 32, 48, 64, 96, 128 and 192.

Returns: Status Codes

◆ setPromiscuousMode()

int16_t RF69::setPromiscuousMode ( bool promiscuous = true )

Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address, CRC).

Parameters

promiscuous Set or unset promiscuous mode.

Returns: Status Codes

◆ setRfSwitchPins()

void RF69::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 RF69::setRxBandwidth ( float rxBw )

Sets receiver bandwidth. Allowed values are 2.6, 3.1, 3.9, 5.2, 6.3, 7.8, 10.4, 12.5, 15.6, 20.8, 25.0, 31.3, 41.7, 50.0, 62.5, 83.3, 100.0, 125.0, 166.7, 200.0, 250.0, 333.3, 400.0 and 500.0 kHz.

Parameters

rxBw	Receiver bandwidth to be set in kHz.

Returns: Status Codes

◆ setSyncWord()

int16_t RF69::setSyncWord	(	uint8_t *	syncWord,
		size_t	len,
		uint8_t	maxErrBits = `0`
	)

Sets sync word. Up to 8 bytes can be set as sync word.

Parameters

syncWord	Pointer to the array of sync word bytes.
len	Sync word length in bytes.
maxErrBits	Maximum allowed number of bit errors in received sync word. Defaults to 0.

◆ sleep()

int16_t RF69::sleep ( )

Sets the module to sleep mode.

Returns: Status Codes

◆ standby()

int16_t RF69::standby ( )

overridevirtual

Sets the module to standby mode.

Returns: Status Codes

Implements PhysicalLayer.

◆ startReceive()

int16_t RF69::startReceive ( )

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

Returns: Status Codes

◆ startTransmit()

int16_t RF69::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.

◆ transmit()

int16_t RF69::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.

◆ transmitDirect()

int16_t RF69::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 RF69::variablePacketLengthMode ( uint8_t maxLen = RF69_MAX_PACKET_LENGTH )

Set modem in variable packet length mode.

Parameters

len	Maximum packet length.

Returns: Status Codes

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

src/modules/RF69/RF69.h
src/modules/RF69/RF69.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RF69()

Member Function Documentation

◆ begin()

◆ disableAddressFiltering()

◆ disableAES()

◆ disableSyncWordFiltering()

◆ enableAES()

◆ enableSyncWordFiltering()

◆ fixedPacketLengthMode()

◆ getPacketLength()

◆ getRSSI()

◆ getTemperature()

◆ random()

◆ readData()

◆ receive()

◆ receiveDirect()

◆ setAESKey()

◆ setAmbientTemperature()

◆ setBitRate()

◆ setBroadcastAddress()

◆ setCrcFiltering()

◆ setDataShaping()

◆ setDio0Action()

◆ setDio1Action()

◆ setEncoding()

◆ setFrequency()

◆ setFrequencyDeviation()

◆ setNodeAddress()

◆ setOutputPower()

◆ setPreambleLength()

◆ setPromiscuousMode()

◆ setRfSwitchPins()

◆ setRxBandwidth()

◆ setSyncWord()

◆ sleep()

◆ standby()

◆ startReceive()

◆ startTransmit()

◆ transmit()

◆ transmitDirect()

◆ variablePacketLengthMode()