Control class for CC1101 module. More...

#include <CC1101.h>

Inheritance diagram for CC1101:

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

int16_t	begin (float freq=434.0, float br=48.0, float freqDev=48.0, float rxBw=135.0, int8_t power=10, uint8_t preambleLength=16)
	Initialization method. 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	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	setGdo0Action (void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=FALLING)
	Sets interrupt service routine to call when GDO0 activates. More...

void	clearGdo0Action ()
	Clears interrupt service routine to call when GDO0 activates.

void	setGdo2Action (void(*func)(void), RADIOLIB_INTERRUPT_STATUS dir=FALLING)
	Sets interrupt service routine to call when GDO2 activates. More...

void	clearGdo2Action ()
	Clears interrupt service routine to call when GDO0 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 300.0 to 348.0 MHz, 387.0 to 464.0 MHz and 779.0 to 928.0 MHz. More...

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

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

int16_t	setFrequencyDeviation (float freqDev) override
	Sets frequency deviation. Allowed values range from 1.587 to 380.8 kHz. More...

int16_t	setOutputPower (int8_t power)
	Sets output power. Allowed values are -30, -20, -15, -10, 0, 5, 7 or 10 dBm. More...

int16_t	setSyncWord (uint8_t syncH, uint8_t syncL, uint8_t maxErrBits=0, bool requireCarrierSense=false)
	Sets 16-bit sync word as a two byte value. More...

int16_t	setSyncWord (uint8_t *syncWord, uint8_t len, uint8_t maxErrBits=0, bool requireCarrierSense=false)
	Sets 1 or 2 bytes of sync word. More...

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

int16_t	setNodeAddress (uint8_t nodeAddr, uint8_t numBroadcastAddrs=0)
	Sets node and broadcast addresses. Calling this method will also enable address filtering. More...

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

int16_t	setOOK (bool enableOOK)
	Enables/disables OOK modulation instead of FSK. More...

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

uint8_t	getLQI () const
	Gets LQI (Link Quality Indicator) of the last received packet. More...

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

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

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

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

int16_t	disableSyncWordFiltering (bool requireCarrierSense=false)
	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 value is RADIOLIB_SHAPING_0_5. 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 and RADIOLIB_ENCODING_WHITENING. 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 CC1101 module.

Constructor & Destructor Documentation

◆ CC1101()

CC1101::CC1101 ( Module * module )

Default constructor.

Parameters

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

Member Function Documentation

◆ begin()

int16_t CC1101::begin	(	float	freq = `434.0`,
		float	br = `48.0`,
		float	freqDev = `48.0`,
		float	rxBw = `135.0`,
		int8_t	power = `10`,
		uint8_t	preambleLength = `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 48.0 kHz.
rxBw	Receiver bandwidth in kHz. Defaults to 135.0 kHz.
power	Output power in dBm. Defaults to 10 dBm.
preambleLength	Preamble Length in bits. Defaults to 16 bits.

Returns: Status Codes

◆ disableAddressFiltering()

int16_t CC1101::disableAddressFiltering ( )

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

Returns: Status Codes

◆ disableSyncWordFiltering()

int16_t CC1101::disableSyncWordFiltering ( bool requireCarrierSense = false )

Disable preamble and sync word filtering and generation.

Parameters

requireCarrierSense Require carrier sense above threshold.

Returns: Status Codes

◆ enableSyncWordFiltering()

int16_t CC1101::enableSyncWordFiltering	(	uint8_t	maxErrBits = `0`,
		bool	requireCarrierSense = `false`
	)

Enable sync word filtering and generation.

Parameters

numBits	Sync word length in bits.
requireCarrierSense	Require carrier sense above threshold in addition to sync word.

Returns: Status Codes

◆ fixedPacketLengthMode()

int16_t CC1101::fixedPacketLengthMode ( uint8_t len = CC1101_MAX_PACKET_LENGTH )

Set modem in fixed packet length mode.

Parameters

len	Packet length.

Returns: Status Codes

◆ getLQI()

uint8_t CC1101::getLQI ( ) const

Gets LQI (Link Quality Indicator) of the last received packet.

Returns: Last packet LQI (lower is better).

◆ getPacketLength()

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

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

Returns: Last packet RSSI in dBm.

◆ random()

uint8_t CC1101::random ( )

virtual

Get one truly random byte from RSSI noise.

Returns: TRNG byte.

Implements PhysicalLayer.

◆ readData()

int16_t CC1101::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 CC1101::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 CC1101::receiveDirect ( )

overridevirtual

Starts direct mode reception.

Returns: Status Codes

Implements PhysicalLayer.

◆ setBitRate()

int16_t CC1101::setBitRate ( float br )

Sets bit rate. Allowed values range from 0.025 to 600.0 kbps.

Parameters

br	Bit rate to be set in kbps.

Returns: Status Codes

◆ setCrcFiltering()

int16_t CC1101::setCrcFiltering ( bool crcOn = true )

Enable CRC filtering and generation.

Parameters

crcOn Set or unset promiscuous mode.

Returns: Status Codes

◆ setDataShaping()

int16_t CC1101::setDataShaping ( uint8_t sh )

overridevirtual

Sets Gaussian filter bandwidth-time product that will be used for data shaping. Allowed value is RADIOLIB_SHAPING_0_5. 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.

◆ setEncoding()

int16_t CC1101::setEncoding ( uint8_t encoding )

overridevirtual

Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ and RADIOLIB_ENCODING_WHITENING.

Parameters

encoding Encoding to be used.

Returns: Status Codes

Implements PhysicalLayer.

◆ setFrequency()

int16_t CC1101::setFrequency ( float freq )

Sets carrier frequency. Allowed values are in bands 300.0 to 348.0 MHz, 387.0 to 464.0 MHz and 779.0 to 928.0 MHz.

Parameters

freq	Carrier frequency to be set in MHz.

Returns: Status Codes

◆ setFrequencyDeviation()

int16_t CC1101::setFrequencyDeviation ( float freqDev )

overridevirtual

Sets frequency deviation. Allowed values range from 1.587 to 380.8 kHz.

Parameters

freqDev Frequency deviation to be set in kHz.

Returns: Status Codes

Implements PhysicalLayer.

◆ setGdo0Action()

void CC1101::setGdo0Action	(	void(*)(void)	func,
		RADIOLIB_INTERRUPT_STATUS	dir = `FALLING`
	)

Sets interrupt service routine to call when GDO0 activates.

Parameters

func	ISR to call.
dir	Signal change direction. Defaults to FALLING.

◆ setGdo2Action()

void CC1101::setGdo2Action	(	void(*)(void)	func,
		RADIOLIB_INTERRUPT_STATUS	dir = `FALLING`
	)

Sets interrupt service routine to call when GDO2 activates.

Parameters

func	ISR to call.
dir	Signal change direction. Defaults to FALLING.

◆ setNodeAddress()

int16_t CC1101::setNodeAddress	(	uint8_t	nodeAddr,
		uint8_t	numBroadcastAddrs = `0`
	)

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

Parameters

nodeAddr	Node address to be set.
numBroadcastAddrs	Number of broadcast addresses to be used. Can be set to 0 (no broadcast), 1 (broadcast at 0x00) or 2 (broadcast at 0x00 and 0xFF).

Returns: Status Codes

◆ setOOK()

int16_t CC1101::setOOK ( bool enableOOK )

Enables/disables OOK modulation instead of FSK.

Parameters

enableOOK Enable (true) or disable (false) OOK.

Returns: Status Codes

◆ setOutputPower()

int16_t CC1101::setOutputPower ( int8_t power )

Sets output power. Allowed values are -30, -20, -15, -10, 0, 5, 7 or 10 dBm.

Parameters

power Output power to be set in dBm.

Returns: Status Codes

◆ setPreambleLength()

int16_t CC1101::setPreambleLength ( uint8_t preambleLength )

Sets preamble length.

Parameters

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

Returns: Status Codes

◆ setPromiscuousMode()

int16_t CC1101::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 CC1101::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 CC1101::setRxBandwidth ( float rxBw )

Sets receiver bandwidth. Allowed values range from 58.0 to 812.0 kHz.

Parameters

rxBw	Receiver bandwidth to be set in kHz.

Returns: Status Codes

◆ setSyncWord() [1/2]

int16_t CC1101::setSyncWord	(	uint8_t	syncH,
		uint8_t	syncL,
		uint8_t	maxErrBits = `0`,
		bool	requireCarrierSense = `false`
	)

Sets 16-bit sync word as a two byte value.

Parameters

syncH	MSB of the sync word.
syncL	LSB of the sync word.
maxErrBits	Maximum allowed number of bit errors in received sync word. Defaults to 0.
requireCarrierSense	Require carrier sense above threshold in addition to sync word.

Returns: Status Codes

◆ setSyncWord() [2/2]

int16_t CC1101::setSyncWord	(	uint8_t *	syncWord,
		uint8_t	len,
		uint8_t	maxErrBits = `0`,
		bool	requireCarrierSense = `false`
	)

Sets 1 or 2 bytes of 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.
requireCarrierSense	Require carrier sense above threshold in addition to sync word.

Returns: Status Codes

◆ standby()

int16_t CC1101::standby ( )

overridevirtual

Sets the module to standby mode.

Returns: Status Codes

Implements PhysicalLayer.

◆ startReceive()

int16_t CC1101::startReceive ( )

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

Returns: Status Codes

◆ startTransmit()

int16_t CC1101::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 CC1101::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 CC1101::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 CC1101::variablePacketLengthMode ( uint8_t maxLen = CC1101_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/CC1101/CC1101.h
src/modules/CC1101/CC1101.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CC1101()

Member Function Documentation

◆ begin()

◆ disableAddressFiltering()

◆ disableSyncWordFiltering()

◆ enableSyncWordFiltering()

◆ fixedPacketLengthMode()

◆ getLQI()

◆ getPacketLength()

◆ getRSSI()

◆ random()

◆ readData()

◆ receive()

◆ receiveDirect()

◆ setBitRate()

◆ setCrcFiltering()

◆ setDataShaping()

◆ setEncoding()

◆ setFrequency()

◆ setFrequencyDeviation()

◆ setGdo0Action()

◆ setGdo2Action()

◆ setNodeAddress()

◆ setOOK()

◆ setOutputPower()

◆ setPreambleLength()

◆ setPromiscuousMode()

◆ setRfSwitchPins()

◆ setRxBandwidth()

◆ setSyncWord() [1/2]

◆ setSyncWord() [2/2]

◆ standby()

◆ startReceive()

◆ startTransmit()

◆ transmit()

◆ transmitDirect()

◆ variablePacketLengthMode()