Difference between revisions of "Component: MULTIUART (SPI2UART) (Comms: Interface)"

Revision as of 11:51, 3 February 2023

Author	Matrix TSL
Version	2.0
Category	Comms: Interface

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 download the component source project: FC_Comp_Source_MULTIUART.fcfx

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

Simple test program

Macro reference

ReceiveByte

	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

	TransmitString
Adds a byte to the transmit queue for the selected channel.
- BYTE	UART
UART Index Range: 0-3
- STRING	Data

- VOID	Return

SetBaud

	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

	TransmitByte
Adds a byte to the transmit queue for the selected channel.
- BYTE	UART
UART Index Range: 0-3
- BYTE	Data

- VOID	Return

CheckRx

	CheckRx
Returns the number of received bytes held in queue for the selected channel.
- BYTE	UART
UART Index Range: 0-3
- BYTE	Return

CheckTx

	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

	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

	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

@@ Line 74: / Line 74: @@
 {{Fcfile|MULTIUART Test.fcfx|Simple test program}}
@@ Line 81: / Line 83: @@
 ==Macro reference==
+===ReceiveByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 99: / Line 102: @@
+===TransmitString===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 122: / Line 126: @@
+===SetBaud===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 145: / Line 150: @@
+===TransmitByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 168: / Line 174: @@
+===CheckRx===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 186: / Line 193: @@
+===CheckTx===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 204: / Line 212: @@
+===ReceiveString===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 227: / Line 236: @@
+===Initialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-