Difference between revisions of "Component: MULTIUART (SPI2UART) (Comms: System)"
From Flowcode Help
Jump to navigationJump to search| Line 14: | Line 14: | ||
==MULTIUART component== | ==MULTIUART component== | ||
Uses a high speed SPI connection to enable up to four buffered external UARTs via the MULTIUART modules. | Uses a high speed SPI connection to enable up to four buffered external UARTs via the MULTIUART modules. | ||
| + | |||
| + | ==Component Pack== | ||
| + | |||
| + | FREE | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 26: | Line 32: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
Revision as of 16:21, 7 January 2022
| Author | Matrix TSL |
| Version | 2.0 |
| Category | Comms: System |
Contents
MULTIUART component
Uses a high speed SPI connection to enable up to four buffered external UARTs via the MULTIUART modules.
Component Pack
FREE
Detailed description
No detailed description exists yet for this component
Examples
Downloadable 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 |
|
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. | |
|
|
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. | |
|
|
Simulations |
|
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 |
