Difference between revisions of "Component: RF 2.4GHz (Wireless)"
From Flowcode Help
Jump to navigationJump to search (XML import BR) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {| width= | + | |
| + | |||
| + | {| width="50%" | ||
|- | |- | ||
| − | | width= | + | | width="20%" style="color: gray;" | Author |
| Matrix Ltd. | | Matrix Ltd. | ||
|- | |- | ||
| − | | width= | + | | width="20%" style="color: gray;" | Version |
| 1.1 (Release) | | 1.1 (Release) | ||
|- | |- | ||
| − | | width= | + | | width="20%" style="color: gray;" | Category |
| Wireless | | Wireless | ||
|} | |} | ||
| Line 17: | Line 19: | ||
==Examples== | ==Examples== | ||
| − | + | Transmit - Reads a EB014 keypad, when a key is pressed and released the chosen key is transmitted as an ASCII value to the receiver. | |
| − | + | {{Fcfile|NRF24L01_TX_Example1.fcfx|Transmit Example}} | |
| + | Receive - Sets up the receiver ready to receive messages, when a message is received the byte value is printed to the LCD. | ||
| + | {{Fcfile|NRF24L01_RX_Example1.fcfx|Receive Example}} | ||
==Downloadable macro reference== | ==Downloadable macro reference== | ||
| − | === | + | ===<span style="font-weight: normal;"><u><tt>ReadRxByte</tt></u></span>=== |
Reads a single byte back from the local Rx buffer. | Reads a single byte back from the local Rx buffer. | ||
| − | + | '''Parameters''' | |
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''Index'' |
::Byte to read, range 0 - 31 | ::Byte to read, range 0 - 31 | ||
| − | + | '''Return value''' | |
:[[Variable Types|BYTE]] | :[[Variable Types|BYTE]] | ||
| − | === | + | ===<span style="font-weight: normal;"><u><tt>WriteTxByte</tt></u></span>=== |
Reads a single byte to the local Tx buffer. | Reads a single byte to the local Tx buffer. | ||
| − | + | '''Parameters''' | |
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''Index'' |
::Byte to read, range 0 - 31 | ::Byte to read, range 0 - 31 | ||
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|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. | Tells the RF module to flush the contents of the receive buffer. | ||
Returns the status from sending the command. | Returns the status from sending the command. | ||
| − | + | '''Parameters''' | |
| − | : | + | :''This macro has no parameters'' |
| − | + | '''Return value''' | |
:[[Variable Types|BYTE]] | :[[Variable Types|BYTE]] | ||
| − | === | + | ===<span style="font-weight: normal;"><u><tt>ReadRxFifo</tt></u></span>=== |
Reads the Rx FIFO buffer into a local buffer. | Reads the Rx FIFO buffer into a local buffer. | ||
Use the ReadBuffer macro to collect the individual data bytes. | Use the ReadBuffer macro to collect the individual data bytes. | ||
| − | + | '''Parameters''' | |
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''NumBytes'' |
::Number of bytes to try and read from the FIFO Range 1-32 | ::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. | Writes the contents of the local Tx buffer to the Transmit FIFO. | ||
| − | + | '''Parameters''' | |
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''NumBytes'' |
::Number of bytes to write to the FIFO, Range 1 - 32 | ::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. | Tells the RF module to flush the contents of the transmit buffer. | ||
Returns the status from sending the command. | Returns the status from sending the command. | ||
| − | + | '''Parameters''' | |
| − | : | + | :''This macro has no parameters'' |
| − | + | '''Return value''' | |
:[[Variable Types|BYTE]] | :[[Variable Types|BYTE]] | ||
| − | === | + | ===<span style="font-weight: normal;"><u><tt>CheckRX</tt></u></span>=== |
Check the Rx FIFO status register for any new data. | Check the Rx FIFO status register for any new data. | ||
| Line 119: | Line 123: | ||
Returns 1 = New data available | Returns 1 = New data available | ||
| − | + | '''Parameters''' | |
| − | : | + | :''This macro has no parameters'' |
| − | + | '''Return value''' | |
:[[Variable Types|BYTE]] | :[[Variable Types|BYTE]] | ||
| − | === | + | ===<span style="font-weight: normal;"><u><tt>ReadRegister</tt></u></span>=== |
Reads a single bytes from the selected register. | Reads a single bytes from the selected register. | ||
Directly returns the value read back from the register. | Directly returns the value read back from the register. | ||
| − | + | '''Parameters''' | |
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''Reg'' |
::Register address to access | ::Register address to access | ||
| − | + | '''Return value''' | |
:[[Variable Types|BYTE]] | :[[Variable Types|BYTE]] | ||
| − | === | + | ===<span style="font-weight: normal;"><u><tt>SetTxMode</tt></u></span>=== |
Sets the module up ready to transmit data. | Sets the module up ready to transmit data. | ||
| − | + | '''Parameters''' | |
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''PA0'' |
::Pipe Address Bytes | ::Pipe Address Bytes | ||
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''PA1'' |
::Pipe Address Bytes | ::Pipe Address Bytes | ||
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''PA2'' |
::Pipe Address Bytes | ::Pipe Address Bytes | ||
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''PA3'' |
::Pipe Address Bytes | ::Pipe Address Bytes | ||
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''PA4'' |
::Pipe Address Bytes | ::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. | Sets the module up ready to receive data. | ||
| − | + | '''Parameters''' | |
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''PA0'' |
::Pipe Address Bytes | ::Pipe Address Bytes | ||
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''PA1'' |
::Pipe Address Bytes | ::Pipe Address Bytes | ||
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''PA2'' |
::Pipe Address Bytes | ::Pipe Address Bytes | ||
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''PA3'' |
::Pipe Address Bytes | ::Pipe Address Bytes | ||
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''PA4'' |
::Pipe Address Bytes | ::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. | Writes a single byte to the selected register. | ||
Returns the status of the write command. | Returns the status of the write command. | ||
| − | + | '''Parameters''' | |
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''Reg'' |
::Register address to access | ::Register address to access | ||
| − | :[[Variable Types|BYTE]] | + | :[[Variable Types|BYTE]] ''Value'' |
| − | + | '''Return value''' | |
:[[Variable Types|BYTE]] | :[[Variable Types|BYTE]] | ||
| − | === | + | ===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>=== |
Starts up and configures the RF module ready for use. | 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. | 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''' | |
:[[Variable Types|UINT]] | :[[Variable Types|UINT]] | ||
| Line 233: | Line 237: | ||
==Simulation macro reference== | ==Simulation macro reference== | ||
| − | + | ''This component does not contain any simulation macros'' | |
==Property reference== | ==Property reference== | ||
| − | + | <span style="font-weight: normal;"><u>RF Channel</u></span> | |
| − | This property is of type | + | 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 | Sets the RF channel from 0 - 127 = 2.4000GHz - 2.525GHz | ||
| Line 245: | Line 249: | ||
Both the transmitter and receiver should be on the same channel to receive data. | 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 | + | 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. | SPI peripheral used to talk to the RF module. | ||
| − | + | <span style="font-weight: normal;"><u>Prescaler</u></span> | |
| + | |||
| + | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PR_SCALE''. | ||
| + | |||
| + | ''<span style="color:red;">No additional information</span>'' | ||
| + | |||
| − | This property is of type | + | |
| + | <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 | SPI Data Out pin - Master Out Slave In | ||
| − | + | <span style="font-weight: normal;"><u>MISO Pin</u></span> | |
| − | This property is of type | + | 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 | SPI Data In pin - Master In Slave Out | ||
| − | + | <span style="font-weight: normal;"><u>SCK Pin</u></span> | |
| − | This property is of type | + | This property is of type ''Single digital pin'' and can be referenced with the variable name ''sck_pin''. |
Serial clock 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 enable, configures RX or TX mode | |
| − | + | <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''. | ||
| + | SPI chip select pin - enables the SPI interface when pulled low | ||
| − | + | <span style="font-weight: normal;"><u>Label</u></span> | |
| − | This property is of type | + | 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. | Label used to help identify the component on the panel. | ||
Latest revision as of 15:46, 16 February 2017
| 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
Transmit - Reads a EB014 keypad, when a key is pressed and released the chosen key is transmitted as an ASCII value to the receiver.
Transmit Example
Receive - Sets up the receiver ready to receive messages, when a message is received the byte value is printed to the LCD.
Receive Example
Downloadable macro reference
ReadRxByte
Reads a single byte back from the local Rx buffer.
Parameters
- BYTE Index
- Byte to read, range 0 - 31
Return value
WriteTxByte
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
FlushRx
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
ReadRxFifo
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
WriteTxFifo
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
FlushTx
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
CheckRX
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
ReadRegister
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
SetTxMode
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
SetRxMode
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
WriteRegister
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
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
RF Channel
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.
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.
Prescaler
This property is of type Fixed list of ints and can be referenced with the variable name PR_SCALE.
No additional information
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 enable, configures RX or TX mode
CSN Pin
This property is of type Single digital pin and can be referenced with the variable name csn_pin.
SPI chip select pin - enables the SPI interface when pulled low
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.
