Component: MULTIUART (SPI2UART) (Comms: Interface)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix TSL |
| Version | 2.0 |
| Category | Comms: Interface |
Contents
MULTIUART component
Uses a high speed SPI connection to enable up to four buffered external UARTs via the MULTIUART modules.
Component Source Code
Please click here to view the component source code (Beta): FC_Comp_Source_MULTIUART.fcfx
Detailed description
No detailed description exists yet for this component
Examples
Macro reference
|
ReceiveByte |
| Returns the first received byte held in queue for the selected channel. Recommended to use the CheckRx macro first to collect number of bytes. | |
 - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - BYTE
|
Return |
|
|
TransmitString |
| Adds a byte to the transmit queue for the selected channel. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
 - STRING
|
Data |
 - VOID
|
Return |
|
|
SetBaud |
| Adds a byte to the transmit queue for the selected channel. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - BYTE
|
Baud |
| 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 | |
| - VOID
|
Return |
|
|
TransmitByte |
| Adds a byte to the transmit queue for the selected channel. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
CheckRx |
| Returns the number of received bytes held in queue for the selected channel. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - BYTE
|
Return |
|
|
CheckTx |
| Returns the number of bytes held in the transmit queue for the selected channel. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - BYTE
|
Return |
|
|
ReceiveString |
| Returns a string of received bytes held in queue for the selected channel. Recommended to use the CheckRx macro first to collect number of bytes. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - BYTE
|
NumBytes |
| - STRING
|
Return |
|
|
Initialise |
| Activates the SPI peripheral and claims control over the I/O pins. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Bus Settings |
|
Channel |
| SPI Channel selector | |
|
|
Prescale |
| Prescale option selector | |
|
|
Connections |
|
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. | |
|
|
Simulation |
|
Label |
| Label used to 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 |
==Macro reference==
|
|
ReceiveByte |
| Returns the first received byte held in queue for the selected channel. Recommended to use the CheckRx macro first to collect number of bytes. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - BYTE
|
Return |
|
|
TransmitString |
| Adds a byte to the transmit queue for the selected channel. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - STRING
|
Data |
| - VOID
|
Return |
|
|
SetBaud |
| Adds a byte to the transmit queue for the selected channel. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - BYTE
|
Baud |
| 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 | |
| - VOID
|
Return |
|
|
TransmitByte |
| Adds a byte to the transmit queue for the selected channel. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
CheckRx |
| Returns the number of received bytes held in queue for the selected channel. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - BYTE
|
Return |
|
|
CheckTx |
| Returns the number of bytes held in the transmit queue for the selected channel. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - BYTE
|
Return |
|
|
ReceiveString |
| Returns a string of received bytes held in queue for the selected channel. Recommended to use the CheckRx macro first to collect number of bytes. | |
| - BYTE
|
UART |
| UART Index Range: 0-3 | |
| - BYTE
|
NumBytes |
| - STRING
|
Return |
|
|
Initialise |
| Activates the SPI peripheral and claims control over the I/O pins. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Bus Settings |
|
|
Channel |
| SPI Channel selector | |
|
|
Prescale |
| Prescale option selector | |
|
|
Connections |
|
|
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. | |
|
|
Simulation |
|
|
Label |
| Label used to 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 |
