Derived class for Si4430 modules. More...

#include <Si4430.h>

Inheritance diagram for Si4430:

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

int16_t	begin (float freq=434.0, float br=48.0, float freqDev=50.0, float rxBw=181.1, int8_t power=10, uint8_t preambleLen=16)
	Initialization method. Must be called at least once from Arduino sketch to initialize the module. More...

int16_t	setFrequency (float freq)
	Sets carrier frequency. Allowed values range from 900.0 MHz to 960.0 MHz. More...

int16_t	setOutputPower (int8_t power)
	Sets output power. Allowed values range from -8 to 13 dBm in 3 dBm steps. More...

Public Member Functions inherited from Si4432
	Si4432 (Module *mod)
	Default constructor. More...

int16_t	begin (float freq=434.0, float br=48.0, float freqDev=50.0, float rxBw=181.1, int8_t power=10, uint8_t preambleLen=16)
	Initialization method. Must be called at least once from Arduino sketch to initialize the module. More...

int16_t	setFrequency (float freq)
	Sets carrier frequency. Allowed values range from 240.0 MHz to 930.0 MHz. More...

int16_t	setOutputPower (int8_t power)
	Sets output power. Allowed values range from -1 to 20 dBm in 3 dBm steps. More...

Public Member Functions inherited from Si443x
	Si443x (Module *mod)
	Default constructor. More...

int16_t	begin (float br, float freqDev, float rxBw, uint8_t preambleLen)
	Initialization method. More...

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

int16_t	transmit (uint8_t *data, size_t len, uint8_t addr=0) override
	Binary transmit method. Will transmit arbitrary binary data up to 64 bytes long. For overloads to transmit Arduino String or C-string, see PhysicalLayer::transmit. More...

int16_t	receive (uint8_t *data, size_t len) override
	Binary receive method. Will attempt to receive arbitrary binary data up to 64 bytes long. For overloads to receive Arduino String, see PhysicalLayer::receive. More...

int16_t	sleep ()
	Sets the module to sleep to save power. Module will not be able to transmit or receive any data while in sleep mode. Module will wake up automatically when methods like transmit or receive are called. More...

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

int16_t	transmitDirect (uint32_t frf=0) override
	Enables direct transmission mode. While in direct mode, the module will not be able to transmit or receive packets. More...

int16_t	receiveDirect () override
	Enables direct reception mode. While in direct mode, the module will not be able to transmit or receive packets. More...

int16_t	packetMode ()
	Disables direct mode and enables packet mode, allowing the module to receive packets. More...

void	setIrqAction (void(*func)(void))
	Sets interrupt service routine to call when IRQ activates. More...

void	clearIrqAction ()
	Clears interrupt service routine to call when IRQ activates.

int16_t	startTransmit (uint8_t *data, size_t len, uint8_t addr=0) override
	Interrupt-driven binary transmit method. Will start transmitting arbitrary binary data up to 64 bytes long. More...

int16_t	startReceive ()
	Interrupt-driven receive method. IRQ will be activated when full valid packet is received. More...

int16_t	readData (uint8_t *data, size_t len) override
	Reads data that was received after calling startReceive method. This method reads len characters. More...

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

int16_t	setFrequencyDeviation (float freqDev) override
	Sets FSK frequency deviation from carrier frequency. Allowed values range from 0.625 to 320.0 kHz. More...

int16_t	setRxBandwidth (float rxBw)
	Sets receiver bandwidth. Allowed values range from 2.6 to 620.7 kHz. More...

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

int16_t	setPreambleLength (uint8_t preambleLen)
	Sets preamble length. More...

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

int16_t	setEncoding (uint8_t encoding) override
	Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER and RADIOLIB_ENCODING_WHITENING. More...

int16_t	setDataShaping (uint8_t sh) override
	Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK mode with FSK modulation. 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...

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

int16_t	getChipVersion ()
	Read version SPI register. Should return SI443X_DEVICE_VERSION (0x06) if Si443x 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	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...

Detailed Description

Derived class for Si4430 modules.

Constructor & Destructor Documentation

◆ Si4430()

Si4430::Si4430 ( Module * mod )

Default constructor.

Parameters

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

Member Function Documentation

◆ begin()

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

Initialization method. Must be called at least once from Arduino sketch to initialize the module.

Parameters

freq	Carrier frequency in MHz. Allowed values range from 900.0 MHz to 960.0 MHz.
br	Bit rate of the FSK transmission in kbps (kilobits per second). Allowed values range from 0.123 to 256.0 kbps.
freqDev	Frequency deviation of the FSK transmission in kHz. Allowed values range from 0.625 to 320.0 kbps.
rxBw	Receiver bandwidth in kHz. Allowed values range from 2.6 to 620.7 kHz.
power	Transmission output power in dBm. Allowed values range from -8 to 13 dBm in 3 dBm steps.
preambleLen	Preamble Length in bits. Defaults to 16 bits.

Returns: Status Codes

◆ setFrequency()

int16_t Si4430::setFrequency ( float freq )

Sets carrier frequency. Allowed values range from 900.0 MHz to 960.0 MHz.

Parameters

freq	Carrier frequency to be set in MHz.

Returns: Status Codes

◆ setOutputPower()

int16_t Si4430::setOutputPower ( int8_t power )

Sets output power. Allowed values range from -8 to 13 dBm in 3 dBm steps.

Parameters

power Output power to be set in dBm.

Returns: Status Codes

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

src/modules/Si443x/Si4430.h
src/modules/Si443x/Si4430.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Si4430()

Member Function Documentation

◆ begin()

◆ setFrequency()

◆ setOutputPower()