Component: RF 2.4GHz (Wireless)
| Author | Matrix Ltd. |
| Version | 1.1 (Release) |
| Category | Wireless |
Contents
RF 2.4GHz component
A simple RF communications module based on the 2.4GHz nRF24L01 modules.
Examples
No additional examples
Downloadable macro reference
StartListening
Starts listening for incoming data
Parameters
- This macro has no parameters
Return value
- This call does not return a value
OpenReadingPipe
Opens a data pipe for receiving data at the pipe address specified
Parameters
- BYTE child
- Range 0-5
Return value
- This call does not return a value
Read
Attempts to read received data from the RF module.
Returns 0 to indicate that there is still data to follow.
Returns 1 to indicate this is the last of the incoming data.
Parameters
- BYTE buffer
- BYTE length
Return value
StopListening
Stops listening for incoming data
Parameters
- This macro has no parameters
Return value
- This call does not return a value
SetPipeAddress
Sets the pipe address based on a 5-byte array.
Parameters
- BYTE Pipe
- Selects the data pipe - range 0-5
- BYTE PipeAddress
Return value
- This call does not return a value
Write
Writes data to be transmitted by the RF module.
Returns 0 to indicate a timeout
Returns 1 to indicate a succesful transmission.
Parameters
- BYTE Data
- BYTE Length
Return value
Available
Checks for incoming data.
Returns 0 if no data available.
Returns 1 for data available.
Parameters
- This macro has no parameters
Return value
OpenWritingPipe
Opens a data pipe for transmitting data at the pipe address specified
Parameters
- This macro has no parameters
Return value
- This call does not return a value
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.
Parameters
- This macro has no parameters
Return value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Dynamic Payloads
This property is of type True or false and can be referenced with the variable name DynamicPayloads.
Configures how the data packets are assembled and transmitted.
No = Always send out packets of 32 bytes, pad the number of bytes with the value 0.
Yes = Allow variable sized data packets, only transmit valid data.
SPI Channel
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.
FSEL Pin
This property is of type Single digital pin and can be referenced with the variable name fsel_pin.
RF Mode selection pin
MOSI Pin
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
MISO Pin
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
SCK Pin
This property is of type Single digital pin and can be referenced with the variable name sck_pin.
Serial clock pin
CE Pin
This property is of type Single digital pin and can be referenced with the variable name ce_pin.
Chip select pin
CSN Pin
This property is of type Single digital pin and can be referenced with the variable name csn_pin.
No additional information
Label
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.
