Component: RF 2.4GHz (Wireless)

Author	Matrix Ltd.
Version	1.1 (Release)
Category	Wireless

RF 2.4GHz component

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

Examples

''<span style="color:red;">No additional examples</span>''

Downloadable macro reference

<span style="font-weight: normal;"><u><tt>ReadRxByte</tt></u></span>

Reads a single byte back from the local Rx buffer.

'''Parameters'''

BYTE ''Index''

Byte to read, range 0 - 31

'''Return value'''

BYTE

<span style="font-weight: normal;"><u><tt>WriteTxByte</tt></u></span>

Reads a single byte to the local Tx buffer.

'''Parameters'''

BYTE ''Index''

Byte to read, range 0 - 31

BYTE ''Value''

'''Return value'''

''This call does not return a value''

<span style="font-weight: normal;"><u><tt>FlushRx</tt></u></span>

Tells the RF module to flush the contents of the receive buffer.

Returns the status from sending the command.

'''Parameters'''

''This macro has no parameters''

'''Return value'''

BYTE

<span style="font-weight: normal;"><u><tt>ReadRxFifo</tt></u></span>

Reads the Rx FIFO buffer into a local buffer.

Use the ReadBuffer macro to collect the individual data bytes.

'''Parameters'''

BYTE ''NumBytes''

Number of bytes to try and read from the FIFO Range 1-32

'''Return value'''

''This call does not return a value''

<span style="font-weight: normal;"><u><tt>WriteTxFifo</tt></u></span>

Writes the contents of the local Tx buffer to the Transmit FIFO.

'''Parameters'''

BYTE ''NumBytes''

Number of bytes to write to the FIFO, Range 1 - 32

'''Return value'''

''This call does not return a value''

<span style="font-weight: normal;"><u><tt>FlushTx</tt></u></span>

Tells the RF module to flush the contents of the transmit buffer.

Returns the status from sending the command.

'''Parameters'''

''This macro has no parameters''

'''Return value'''

BYTE

<span style="font-weight: normal;"><u><tt>CheckRX</tt></u></span>

Check the Rx FIFO status register for any new data.

Returns 0 = No data

Returns 1 = New data available

'''Parameters'''

''This macro has no parameters''

'''Return value'''

BYTE

<span style="font-weight: normal;"><u><tt>ReadRegister</tt></u></span>

Reads a single bytes from the selected register.

Directly returns the value read back from the register.

'''Parameters'''

BYTE ''Reg''

Register address to access

'''Return value'''

BYTE

<span style="font-weight: normal;"><u><tt>SetTxMode</tt></u></span>

Sets the module up ready to transmit data.

'''Parameters'''

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

'''Return value'''

''This call does not return a value''

<span style="font-weight: normal;"><u><tt>SetRxMode</tt></u></span>

Sets the module up ready to receive data.

'''Parameters'''

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

'''Return value'''

''This call does not return a value''

<span style="font-weight: normal;"><u><tt>WriteRegister</tt></u></span>

Writes a single byte to the selected register.

Returns the status of the write command.

'''Parameters'''

BYTE ''Reg''

Register address to access

BYTE ''Value''

'''Return value'''

BYTE

<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>

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.

'''Parameters'''

''This macro has no parameters''

'''Return value'''

UINT

Simulation macro reference

''This component does not contain any simulation macros''

Property reference

<span style="font-weight: normal;"><u>RF Channel</u></span>

This property is of type ''Unsigned integer'' and can be referenced with the variable name ''RFChannel''.

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.

<span style="font-weight: normal;"><u>SPI Channel</u></span>

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Channel''.

SPI peripheral used to talk to the RF module.

<span style="font-weight: normal;"><u>MOSI Pin</u></span>

This property is of type ''Single digital pin'' and can be referenced with the variable name ''mosi_pin''.

SPI Data Out pin - Master Out Slave In

<span style="font-weight: normal;"><u>MISO Pin</u></span>

This property is of type ''Single digital pin'' and can be referenced with the variable name ''miso_pin''.

SPI Data In pin - Master In Slave Out

<span style="font-weight: normal;"><u>SCK Pin</u></span>

This property is of type ''Single digital pin'' and can be referenced with the variable name ''sck_pin''.

Serial clock pin

<span style="font-weight: normal;"><u>CE Pin</u></span>

This property is of type ''Single digital pin'' and can be referenced with the variable name ''ce_pin''.

Chip select pin

<span style="font-weight: normal;"><u>CSN Pin</u></span>

This property is of type ''Single digital pin'' and can be referenced with the variable name ''csn_pin''.

''<span style="color:red;">No additional information</span>''

<span style="font-weight: normal;"><u>Label</u></span>

This property is of type ''Line of text'' and can be referenced with the variable name ''label''.

Label used to help identify the component on the panel.