Component: RF 2.4GHz (nRF24L01) (Wireless)

Author	Matrix Ltd.
Version	2.0
Category	Wireless

RF 2.4GHz component

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

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

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

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

	ReadRxFifo
Reads the Rx FIFO buffer into a local buffer. Use the ReadBuffer macro to collect the individual data bytes.
- BYTE	NumBytes
Number of bytes to try and read from the FIFO Range 1-32
- VOID	Return

	WriteTxFifo
Writes the contents of the local Tx buffer to the Transmit FIFO.
- BYTE	NumBytes
Number of bytes to write to the FIFO, Range 1 - 32
- VOID	Return

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

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

	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

	SetTxMode
Sets the module up ready to transmit data.
- 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

	SetRxMode
Sets the module up ready to receive data.
- 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
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

	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

Property reference

	Properties
	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.
	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.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	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
	Simulations
	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