Component: RF Transceiver (nRF24L01) (Wireless)

Author	Matrix Ltd.
Version	9.0
Category	Wireless

RF Transceiver (nRF24L01) component

A simple RF communications module based on the 2.4GHz nRF24L01 transceivermodules.

Version information

Library Version, Component Version, Date, Author, Info
9, 9.0, 08-11-24, MW, added missing icon

Detailed description

No detailed description exists yet for this component

Examples

Example program transmitting a count value, echoing the count and TX status to the UART for debugging.

RF Test TX

Example program receiving a value, echoing any received values to the UART for debugging.

RF Test RX

Macro reference

CheckRX

	CheckRX
Check the Rx FIFO status register for any new data. Returns 0 = No data Returns 1 = New data available
- BYTE	Return

FlushRx

	FlushRx
Tells the RF module to flush the contents of the receive buffer. Returns the status from sending the command.
- BYTE	Return

FlushTx

	FlushTx
Tells the RF module to flush the contents of the transmit buffer. Returns the status from sending the command.
- BYTE	Return

Initialise

	Initialise
Starts up and configures the RF module ready for use. The macro will return a value greater then 0 if the module has been started correctly, otherwise the macro will return a 0.
- UINT	Return

ReadRegister

	ReadRegister
Reads a single bytes from the selected register. Directly returns the value read back from the register.
- BYTE	Reg
Register address to access
- BYTE	Return

ReadRxArray

	ReadRxArray
Reads an array of bytes back from the local Rx buffer.
- BYTE	Data
Byte array to store the received data
- BYTE	NumBytes
Range: 1-32
- VOID	Return

ReadRxByte

	ReadRxByte
Reads a single byte back from the local Rx buffer.
- BYTE	Index
Byte to read, range 0 - 31
- BYTE	Return

ReadRxFifo

	ReadRxFifo
Reads the Rx FIFO buffer into a local buffer. Use the ReadBuffer/ReadArray macros to collect the individual data bytes.
- VOID	Return

SetRxMode

	SetRxMode
Sets up the module up ready to receive data. Assigns the 5-byte pipe listen address.
- BYTE	PA0
Pipe Address Bytes
- BYTE	PA1
Pipe Address Bytes
- BYTE	PA2
Pipe Address Bytes
- BYTE	PA3
Pipe Address Bytes
- BYTE	PA4
Pipe Address Bytes
- VOID	Return

SetTxMode

	SetTxMode
Sets the module up ready to transmit data. Assigns the 5-byte pipe transmit address.
- BYTE	PA0
Pipe Address Bytes
- BYTE	PA1
Pipe Address Bytes
- BYTE	PA2
Pipe Address Bytes
- BYTE	PA3
Pipe Address Bytes
- BYTE	PA4
Pipe Address Bytes
- VOID	Return

WriteRegister

	WriteRegister
Writes a single byte to the selected register. Returns the status of the write command.
- BYTE	Reg
Register address to access
- BYTE	Value
- BYTE	Return

WriteTxArray

	WriteTxArray
Writes an array of bytes to the local Tx buffer.
- BYTE	Data
Byte array to write.
- BYTE	NumBytes
Range: 1-32
- VOID	Return

WriteTxByte

	WriteTxByte
Writes a single byte to the local Tx buffer.
- BYTE	Index
Byte to read, range 0 - 31
- BYTE	Value
- VOID	Return

WriteTxFifo

	WriteTxFifo
Writes the contents of the local Tx buffer to the Transmit FIFO and transmits. Returns 1 if transmission was sucessful.
- BOOL	Return

Property reference

	Properties
	RF Settings
	RF Channel
Sets the RF channel from 0 - 127 = 2.4000GHz - 2.525GHz Both the transmitter and receiver should be on the same channel to receive data. Default 76 is a relatively free channel meaning there should be little interference here.
	TX Power
Amount of power used for the transmitter circuit.
	Data Rate
Sets the data throughput rate.
	Connections
	Channel
SPI Channel selector
	Prescale
Prescale option selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MOSI Remap Pin
Select which the target pin to assign the MOSI hardware pin functionality.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	MISO Remap Pin
Select which the target pin to assign the MISO hardware pin functionality.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	CLK Remap Pin
Select which the target pin to assign the CLK hardware pin functionality.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	CE Pin
Chip enable, configures RX or TX mode
	Simulation
	Label
Label used to help identify the component on the panel.
	Scope Traces
Selects if the scope traces are automatically generated or not
	Console Data
Selects if the console data is automatically generated or not
	API

Component Source Code

Please click here to download the component source project: FC_Comp_Source_nRF24L01.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_nRF24L01.fcfx