Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. More...

#include <Module.h>

Public Member Functions
	Module (RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial *serial=nullptr, RADIOLIB_PIN_TYPE rst=RADIOLIB_NC)
	UART-based module constructor. More...

	Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst)
	SPI-based module constructor. Will use the default SPI interface automatically initialize it. More...

	Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio)
	Extended SPI-based module constructor. Will use the default SPI interface automatically initialize it. More...

	Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, SPIClass &spi, SPISettings spiSettings)
	SPI-based module constructor. More...

	Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE gpio, SPIClass &spi, SPISettings spiSettings)
	Extended SPI-based module constructor. More...

	Module (RADIOLIB_PIN_TYPE cs, RADIOLIB_PIN_TYPE irq, RADIOLIB_PIN_TYPE rst, RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, SPIClass &spi=RADIOLIB_DEFAULT_SPI, SPISettings spiSettings=SPISettings(2000000, MSBFIRST, SPI_MODE0), HardwareSerial *serial=nullptr)
	Generic module constructor. More...

	Module (const Module &mod)
	Copy constructor. More...

Module &	operator= (const Module &mod)
	Overload for assignment operator. More...

void	init (uint8_t interface)
	Initialize low-level module control. More...

void	term (uint8_t interface)
	Terminate low-level module control. More...

void	ATemptyBuffer ()
	Empty internal AT buffer.

bool	ATgetResponse ()
	Get response after sending AT command. More...

bool	ATsendCommand (const char *cmd)
	Send AT command. Will also call ATgetResponse. More...

bool	ATsendData (uint8_t *data, uint32_t len)
	Send raw AT data. Will also call ATgetResponse. More...

int16_t	SPIgetRegValue (uint8_t reg, uint8_t msb=7, uint8_t lsb=0)
	SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism. More...

int16_t	SPIsetRegValue (uint8_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2)
	Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism. More...

void	SPIreadRegisterBurst (uint8_t reg, uint8_t numBytes, uint8_t *inBytes)
	SPI burst read method. More...

uint8_t	SPIreadRegister (uint8_t reg)
	SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be used instead. More...

void	SPIwriteRegisterBurst (uint8_t reg, uint8_t *data, uint8_t numBytes)
	SPI burst write method. More...

void	SPIwriteRegister (uint8_t reg, uint8_t data)
	SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be used instead. More...

void	SPItransfer (uint8_t cmd, uint8_t reg, uint8_t dataOut, uint8_t dataIn, uint8_t numBytes)
	SPI single transfer method. More...

RADIOLIB_PIN_TYPE	getCs () const
	Access method to get the pin number of SPI chip select. More...

RADIOLIB_PIN_TYPE	getIrq () const
	Access method to get the pin number of interrupt/GPIO. More...

RADIOLIB_PIN_TYPE	getRst () const
	Access method to get the pin number of hardware reset pin. More...

RADIOLIB_PIN_TYPE	getGpio () const
	Access method to get the pin number of second interrupt/GPIO. More...

RADIOLIB_PIN_TYPE	getRx () const
	Access method to get the pin number of UART Rx. More...

RADIOLIB_PIN_TYPE	getTx () const
	Access method to get the pin number of UART Rx. More...

SPIClass *	getSpi () const
	Access method to get the SPI interface. More...

SPISettings	getSpiSettings () const
	Access method to get the SPI interface settings. 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...

void	setRfSwitchState (RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState)
	Set RF switch state. More...

Static Public Member Functions
static void	pinMode (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_MODE mode)
	Arduino core pinMode override that checks RADIOLIB_NC as alias for unused pin. More...

static void	digitalWrite (RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)
	Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin. More...

static RADIOLIB_PIN_STATUS	digitalRead (RADIOLIB_PIN_TYPE pin)
	Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin. More...

static void	tone (RADIOLIB_PIN_TYPE pin, uint16_t value)
	Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPORTED to make sure the platform does support tone. More...

static void	noTone (RADIOLIB_PIN_TYPE pin)
	Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPORTED to make sure the platform does support tone. More...

static void	attachInterrupt (RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)
	Arduino core attachInterrupt override. More...

static void	detachInterrupt (RADIOLIB_PIN_TYPE interruptNum)
	Arduino core detachInterrupt override. More...

static void	yield ()
	Arduino core yield override.

static void	delay (uint32_t ms)
	Arduino core delay override. More...

static void	delayMicroseconds (uint32_t us)
	Arduino core delayMicroseconds override. More...

static uint32_t	millis ()
	Arduino core millis override.

static uint32_t	micros ()
	Arduino core micros override.

Public Attributes
SoftwareSerial *	ModuleSerial
	Internal SoftwareSerial instance.

uint32_t	baudrate = 9600
	Baud rate of SoftwareSerial UART communication. Defaults to 9600 baud.

char	AtLineFeed [3] = {'\r', '\n'}
	Line feed to be used when sending AT commands. Defaults to CR+LF.

uint8_t	SPIreadCommand = 0b00000000
	Basic SPI read command. Defaults to 0x00.

uint8_t	SPIwriteCommand = 0b10000000
	Basic SPI write command. Defaults to 0x80.

Detailed Description

Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class.

Constructor & Destructor Documentation

◆ Module() [1/7]

Module::Module	(	RADIOLIB_PIN_TYPE	rx,
		RADIOLIB_PIN_TYPE	tx,
		HardwareSerial *	serial = `nullptr`,
		RADIOLIB_PIN_TYPE	rst = `RADIOLIB_NC`
	)

UART-based module constructor.

Parameters

rx	Arduino pin to be used as Rx pin for SoftwareSerial communication.
tx	Arduino pin to be used as Tx pin for SoftwareSerial communication.
serial	HardwareSerial to be used on platforms that do not support SoftwareSerial. Defaults to Serial1.
rst	Arduino pin to be used as hardware reset for the module. Defaults to NC (unused).

◆ Module() [2/7]

Module::Module	(	RADIOLIB_PIN_TYPE	cs,
		RADIOLIB_PIN_TYPE	irq,
		RADIOLIB_PIN_TYPE	rst
	)

SPI-based module constructor. Will use the default SPI interface automatically initialize it.

Parameters

cs	Arduino pin to be used as chip select.
irq	Arduino pin to be used as interrupt/GPIO.
rst	Arduino pin to be used as hardware reset for the module.

◆ Module() [3/7]

Module::Module	(	RADIOLIB_PIN_TYPE	cs,
		RADIOLIB_PIN_TYPE	irq,
		RADIOLIB_PIN_TYPE	rst,
		RADIOLIB_PIN_TYPE	gpio
	)

Extended SPI-based module constructor. Will use the default SPI interface automatically initialize it.

Parameters

cs	Arduino pin to be used as chip select.
irq	Arduino pin to be used as interrupt/GPIO.
rst	Arduino pin to be used as hardware reset for the module.
gpio	Arduino pin to be used as additional interrupt/GPIO.

◆ Module() [4/7]

Module::Module	(	RADIOLIB_PIN_TYPE	cs,
		RADIOLIB_PIN_TYPE	irq,
		RADIOLIB_PIN_TYPE	rst,
		SPIClass &	spi,
		SPISettings	spiSettings
	)

SPI-based module constructor.

Parameters

cs	Arduino pin to be used as chip select.
irq	Arduino pin to be used as interrupt/GPIO.
rst	Arduino pin to be used as hardware reset for the module.
spi	SPI interface to be used, can also use software SPI implementations.
spiSettings	SPI interface settings.

◆ Module() [5/7]

Module::Module	(	RADIOLIB_PIN_TYPE	cs,
		RADIOLIB_PIN_TYPE	irq,
		RADIOLIB_PIN_TYPE	rst,
		RADIOLIB_PIN_TYPE	gpio,
		SPIClass &	spi,
		SPISettings	spiSettings
	)

Extended SPI-based module constructor.

Parameters

cs	Arduino pin to be used as chip select.
irq	Arduino pin to be used as interrupt/GPIO.
rst	Arduino pin to be used as hardware reset for the module.
gpio	Arduino pin to be used as additional interrupt/GPIO.
spi	SPI interface to be used, can also use software SPI implementations.
spiSettings	SPI interface settings.

◆ Module() [6/7]

Module::Module	(	RADIOLIB_PIN_TYPE	cs,
		RADIOLIB_PIN_TYPE	irq,
		RADIOLIB_PIN_TYPE	rst,
		RADIOLIB_PIN_TYPE	rx,
		RADIOLIB_PIN_TYPE	tx,
		SPIClass &	spi = `RADIOLIB_DEFAULT_SPI`,
		SPISettings	spiSettings = `SPISettings(2000000, MSBFIRST, SPI_MODE0)`,
		HardwareSerial *	serial = `nullptr`
	)

Generic module constructor.

Parameters

cs	Arduino pin to be used as chip select.
irq	Arduino pin to be used as interrupt/GPIO.
rst	Arduino pin to be used as hardware reset for the module.
tx	Arduino pin to be used as Tx pin for SoftwareSerial communication.
rx	Arduino pin to be used as Rx pin for SoftwareSerial communication.
spi	SPI interface to be used. Defaults to Arduino hardware SPI interface, can also use software SPI implementations.
spiSettings	SPI interface settings. Defaults to 2 MHz clock, MSB first, mode 0.
serial	HardwareSerial to be used on ESP32 and SAMD. Defaults to 1

◆ Module() [7/7]

Module::Module ( const Module & mod )

Copy constructor.

Parameters

mod	Module instance to copy.

Member Function Documentation

◆ ATgetResponse()

bool Module::ATgetResponse ( )

Get response after sending AT command.

Returns: True if AT response contains the string "OK", false otherwise.

◆ ATsendCommand()

bool Module::ATsendCommand ( const char * cmd )

Send AT command. Will also call ATgetResponse.

Parameters

cmd	AT command to be sent. Line feed characters are added automatically.

Returns: True if AT response contains the string "OK", false otherwise.

◆ ATsendData()

bool Module::ATsendData	(	uint8_t *	data,
		uint32_t	len
	)

Send raw AT data. Will also call ATgetResponse.

Parameters

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

Returns: True if AT response contains the string "OK", false otherwise.

◆ attachInterrupt()

void Module::attachInterrupt	(	RADIOLIB_PIN_TYPE	interruptNum,
		void(*)(void)	userFunc,
		RADIOLIB_INTERRUPT_STATUS	mode
	)

static

Arduino core attachInterrupt override.

Parameters

interruptNum	Interrupt number.
userFunc	Interrupt service routine.
mode	Pin hcange direction.

◆ delay()

void Module::delay ( uint32_t ms )

static

Arduino core delay override.

Parameters

ms	Delay length in milliseconds.

◆ delayMicroseconds()

void Module::delayMicroseconds ( uint32_t us )

static

Arduino core delayMicroseconds override.

Parameters

us	Delay length in microseconds.

◆ detachInterrupt()

void Module::detachInterrupt ( RADIOLIB_PIN_TYPE interruptNum )

static

Arduino core detachInterrupt override.

Parameters

interruptNum Interrupt number.

◆ digitalRead()

RADIOLIB_PIN_STATUS Module::digitalRead ( RADIOLIB_PIN_TYPE pin )

static

Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.

Parameters

pin	Pin to read from.

Returns: Pin value.

◆ digitalWrite()

void Module::digitalWrite	(	RADIOLIB_PIN_TYPE	pin,
		RADIOLIB_PIN_STATUS	value
	)

static

Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin.

Parameters

pin	Pin to write to.
value	Whether to set the pin high or low.

◆ getCs()

RADIOLIB_PIN_TYPE Module::getCs ( ) const

inline

Access method to get the pin number of SPI chip select.

Returns: Pin number of SPI chip select configured in the constructor.

◆ getGpio()

RADIOLIB_PIN_TYPE Module::getGpio ( ) const

inline

Access method to get the pin number of second interrupt/GPIO.

Returns: Pin number of second interrupt/GPIO configured in the constructor.

◆ getIrq()

RADIOLIB_PIN_TYPE Module::getIrq ( ) const

inline

Access method to get the pin number of interrupt/GPIO.

Returns: Pin number of interrupt/GPIO configured in the constructor.

◆ getRst()

RADIOLIB_PIN_TYPE Module::getRst ( ) const

inline

Access method to get the pin number of hardware reset pin.

Returns: Pin number of hardware reset pin configured in the constructor.

◆ getRx()

RADIOLIB_PIN_TYPE Module::getRx ( ) const

inline

Access method to get the pin number of UART Rx.

Returns: Pin number of UART Rx configured in the constructor.

◆ getSpi()

SPIClass* Module::getSpi ( ) const

inline

Access method to get the SPI interface.

Returns: SPI interface configured in the constructor.

◆ getSpiSettings()

SPISettings Module::getSpiSettings ( ) const

inline

Access method to get the SPI interface settings.

Returns: SPI interface settings configured in the constructor.

◆ getTx()

RADIOLIB_PIN_TYPE Module::getTx ( ) const

inline

Access method to get the pin number of UART Rx.

Returns: Pin number of UART Rx configured in the constructor.

◆ init()

void Module::init ( uint8_t interface )

Initialize low-level module control.

Parameters

interface Interface to be used on the module. See Shield Configuration for details.

◆ noTone()

void Module::noTone ( RADIOLIB_PIN_TYPE pin )

static

Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPORTED to make sure the platform does support tone.

Parameters

pin	Pin to write to.

◆ operator=()

Module & Module::operator= ( const Module & mod )

Overload for assignment operator.

Parameters

frame rvalue Module.

◆ pinMode()

void Module::pinMode	(	RADIOLIB_PIN_TYPE	pin,
		RADIOLIB_PIN_MODE	mode
	)

static

Arduino core pinMode override that checks RADIOLIB_NC as alias for unused pin.

Parameters

pin	Pin to change the mode of.
mode	Which mode to set.

◆ setRfSwitchPins()

void Module::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.

◆ setRfSwitchState()

void Module::setRfSwitchState	(	RADIOLIB_PIN_STATUS	rxPinState,
		RADIOLIB_PIN_STATUS	txPinState
	)

Set RF switch state.

Parameters

rxPinState	Pin state to set on Tx enable pin (usually high to transmit).
txPinState	Pin state to set on Rx enable pin (usually high to receive).

◆ SPIgetRegValue()

int16_t Module::SPIgetRegValue	(	uint8_t	reg,
		uint8_t	msb = `7`,
		uint8_t	lsb = `0`
	)

SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism.

Parameters

reg	Address of SPI register to read.
msb	Most significant bit of the register variable. Bits above this one will be masked out.
lsb	Least significant bit of the register variable. Bits below this one will be masked out.

Returns: Masked register value or status code.

◆ SPIreadRegister()

uint8_t Module::SPIreadRegister ( uint8_t reg )

SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be used instead.

Parameters

reg	Address of SPI register to read.

Returns: Value that was read from register.

◆ SPIreadRegisterBurst()

void Module::SPIreadRegisterBurst	(	uint8_t	reg,
		uint8_t	numBytes,
		uint8_t *	inBytes
	)

SPI burst read method.

Parameters

reg	Address of SPI register to read.
numBytes	Number of bytes that will be read.
inBytes	Pointer to array that will hold the read data.

◆ SPIsetRegValue()

int16_t Module::SPIsetRegValue	(	uint8_t	reg,
		uint8_t	value,
		uint8_t	msb = `7`,
		uint8_t	lsb = `0`,
		uint8_t	checkInterval = `2`
	)

Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism.

Parameters

reg	Address of SPI register to write.
value	Single byte value that will be written to the SPI register.
msb	Most significant bit of the register variable. Bits above this one will not be affected by the write operation.
lsb	Least significant bit of the register variable. Bits below this one will not be affected by the write operation.
checkInterval	Number of milliseconds between register writing and verification reading. Some registers need up to 10ms to process the change.

Returns: Status Codes

◆ SPItransfer()

void Module::SPItransfer	(	uint8_t	cmd,
		uint8_t	reg,
		uint8_t *	dataOut,
		uint8_t *	dataIn,
		uint8_t	numBytes
	)

SPI single transfer method.

Parameters

cmd	SPI access command (read/write/burst/...).
reg	Address of SPI register to transfer to/from.
dataOut	Data that will be transfered from master to slave.
dataIn	Data that was transfered from slave to master.
numBytes	Number of bytes to transfer.

◆ SPIwriteRegister()

void Module::SPIwriteRegister	(	uint8_t	reg,
		uint8_t	data
	)

SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be used instead.

Parameters

reg	Address of SPI register to write.
data	Value that will be written to the register.

◆ SPIwriteRegisterBurst()

void Module::SPIwriteRegisterBurst	(	uint8_t	reg,
		uint8_t *	data,
		uint8_t	numBytes
	)

SPI burst write method.

Parameters

reg	Address of SPI register to write.
data	Pointer to array that holds the data that will be written.
numBytes	Number of bytes that will be written.

◆ term()

void Module::term ( uint8_t interface )

Terminate low-level module control.

Parameters

interface Interface to be terminated. See Shield Configuration for details.

◆ tone()

void Module::tone	(	RADIOLIB_PIN_TYPE	pin,
		uint16_t	value
	)

static

Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPORTED to make sure the platform does support tone.

Parameters

pin	Pin to write to.
value	Frequency to output.

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

src/Module.h
src/Module.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Module() [1/7]

◆ Module() [2/7]

◆ Module() [3/7]

◆ Module() [4/7]

◆ Module() [5/7]

◆ Module() [6/7]

◆ Module() [7/7]

Member Function Documentation

◆ ATgetResponse()

◆ ATsendCommand()

◆ ATsendData()

◆ attachInterrupt()

◆ delay()

◆ delayMicroseconds()

◆ detachInterrupt()

◆ digitalRead()

◆ digitalWrite()

◆ getCs()

◆ getGpio()

◆ getIrq()

◆ getRst()

◆ getRx()

◆ getSpi()

◆ getSpiSettings()

◆ getTx()

◆ init()

◆ noTone()

◆ operator=()

◆ pinMode()

◆ setRfSwitchPins()

◆ setRfSwitchState()

◆ SPIgetRegValue()

◆ SPIreadRegister()

◆ SPIreadRegisterBurst()

◆ SPIsetRegValue()

◆ SPItransfer()

◆ SPIwriteRegister()

◆ SPIwriteRegisterBurst()

◆ term()

◆ tone()