Control class for SX1231 module. Overrides some methods from RF69 due to different register values. More...

#include <SX1231.h>

Inheritance diagram for SX1231:

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

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

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

Module *	getMod ()

int16_t	begin (float freq=RADIOLIB_RF69_DEFAULT_FREQ, float br=RADIOLIB_RF69_DEFAULT_BR, float freqDev=RADIOLIB_RF69_DEFAULT_FREQDEV, float rxBw=RADIOLIB_RF69_DEFAULT_RXBW, int8_t power=RADIOLIB_RF69_DEFAULT_POWER, uint8_t preambleLen=RADIOLIB_RF69_DEFAULT_PREAMBLELEN)
	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	standby (uint8_t mode) override
	Sets the module to standby. 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.

void	setFifoEmptyAction (void(*func)(void))
	Set interrupt service routine function to call when FIFO is empty. More...

void	clearFifoEmptyAction ()
	Clears interrupt service routine to call when FIFO is empty.

void	setFifoFullAction (void(*func)(void))
	Set interrupt service routine function to call when FIFO is full. More...

void	clearFifoFullAction ()
	Clears interrupt service routine to call when FIFO is full.

bool	fifoAdd (uint8_t data, int totalLen, int remLen)
	Set interrupt service routine function to call when FIFO is empty. More...

bool	fifoGet (volatile uint8_t data, int totalLen, volatile int rcvLen)
	Set interrupt service routine function to call when FIFO is sufficently full to read. More...

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	finishTransmit () override
	Clean up after transmission is done. 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	getFrequency (float *freq)
	Gets carrier frequency. More...

int16_t	setBitRate (float br)
	Sets bit rate. Allowed values range from 0.5 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	getFrequencyDeviation (float *freqDev)
	Gets 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	setOOK (bool enableOOK)
	Enables/disables OOK modulation instead of FSK. Note: This function calls setRxBandwidth again, since register values differ based on OOK mode being enabled/disabled. More...

int16_t	setOokThresholdType (uint8_t type)
	Selects the type of threshold in the OOK data slicer. More...

int16_t	setOokFixedThreshold (uint8_t value)
	Fixed threshold for the Data Slicer in OOK mode or floor threshold for the Data Slicer in OOK when Peak mode is used. More...

int16_t	setOokPeakThresholdDecrement (uint8_t value)
	Period of decrement of the RSSI threshold in the OOK demodulator. More...

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

int16_t	variablePacketLengthMode (uint8_t maxLen=RADIOLIB_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	enableContinuousModeBitSync ()
	Enable Bit synchronization in continuous mode. More...

int16_t	disableContinuousModeBitSync ()
	Disable Bit synchronization in continuous mode. 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...

int16_t	setLnaTestBoost (bool value)
	Enable/disable LNA Boost mode (disabled by default). More...

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

int16_t	setRSSIThreshold (float dbm)
	Sets the RSSI value above which the RSSI interrupt is signaled. More...

void	setRfSwitchPins (RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)
	Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes: When idle both pins will be LOW, during TX the `txEn` pin will be HIGH, during RX the `rxPin` will be HIGH. More...

void	setRfSwitchTable (const RADIOLIB_PIN_TYPE(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
	Some modules contain external RF switch controlled by pins. This function gives RadioLib control over those pins to automatically switch between various modes. More...

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

int16_t	getChipVersion ()
	Read version SPI register. Should return RF69_CHIP_VERSION (0x24) if SX127x is connected and working. More...

void	setDirectAction (void(*func)(void))
	Set interrupt service routine function to call when data bit is receveid in direct mode. More...

void	readBit (RADIOLIB_PIN_TYPE pin)
	Function to read and process data bit in direct reception mode. More...

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...

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)
	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)
	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)
	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)
	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...

void	dropSync ()
	Forcefully drop synchronization.

uint8_t	read (bool drop=true)
	Get data from direct mode buffer. More...

Detailed Description

Control class for SX1231 module. Overrides some methods from RF69 due to different register values.

Constructor & Destructor Documentation

◆ SX1231()

SX1231::SX1231 ( Module * mod )

Default constructor.

Parameters

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

Member Function Documentation

◆ begin()

int16_t SX1231::begin	(	float	freq = `434.0`,
		float	br = `4.8`,
		float	freqDev = `5.0`,
		float	rxBw = `125.0`,
		int8_t	power = `10`,
		uint8_t	preambleLen = `16`
	)

Initialization method.