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

Revision as of 12:02, 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_temp/MULTIUART.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/MULTIUART.fcfx

Detailed description

No detailed description exists yet for this component

Examples

Simple test program

Macro reference

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

Initialise

	Initialise
Activates the SPI peripheral and claims control over the I/O pins.
- VOID	Return

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

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

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

TransmitString

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

- 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 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_MULTIUART.fcfx FC_Comp_Source_MULTIUART.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/MULTIUART.fcfx FC_Comp_Source_temp/MULTIUART.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_MULTIUART.fcfx FC_Comp_Source_MULTIUART.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/MULTIUART.fcfx FC_Comp_Source_temp/MULTIUART.fcfx]
 ==Detailed description==
@@ Line 74: / Line 74: @@
 {{Fcfile|MULTIUART Test.fcfx|Simple test program}}
@@ Line 83: / Line 85: @@
 ==Macro reference==
-===ReceiveByte===
+===CheckRx===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckRx'''
 |-
-| colspan="2" | Returns the first received byte held in queue for the selected channel. Recommended to use the CheckRx macro first to collect number of bytes.&nbsp;
+| colspan="2" | Returns the number of received bytes held in queue for the selected channel.&nbsp;
 |-
 |-
@@ Line 102: / Line 104: @@
-===TransmitString===
+===CheckTx===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TransmitString'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckTx'''
 |-
-| colspan="2" | Adds a byte to the transmit queue for the selected channel.&nbsp;
+| colspan="2" | Returns the number of bytes held in the transmit queue for the selected channel.&nbsp;
 |-
 |-
@@ Line 116: / Line 118: @@
 | colspan="2" | UART Index Range: 0-3&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Data
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===Initialise===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+|-
+| colspan="2" | Activates the SPI peripheral and claims control over the I/O pins.&nbsp;
 |-
-| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 126: / Line 137: @@
-===SetBaud===
+===ReceiveByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetBaud'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveByte'''
 |-
-| colspan="2" | Adds a byte to the transmit queue for the selected channel.&nbsp;
+| colspan="2" | Returns the first received byte held in queue for the selected channel. Recommended to use the CheckRx macro first to collect number of bytes.&nbsp;
 |-
 |-
@@ Line 140: / Line 151: @@
 | colspan="2" | UART Index Range: 0-3&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Baud
-|-
-| colspan="2" | 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===TransmitByte===
+===ReceiveString===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TransmitByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
 |-
-| colspan="2" | Adds a byte to the transmit queue for the selected channel.&nbsp;
+| colspan="2" | 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.&nbsp;
 |-
 |-
@@ Line 165: / Line 171: @@
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Data
+| width="90%" | NumBytes
 |-
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===CheckRx===
+===SetBaud===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckRx'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetBaud'''
 |-
-| colspan="2" | Returns the number of received bytes held in queue for the selected channel.&nbsp;
+| colspan="2" | Adds a byte to the transmit queue for the selected channel.&nbsp;
 |-
 |-
@@ Line 188: / Line 194: @@
 | colspan="2" | UART Index Range: 0-3&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Baud
+|-
+| colspan="2" | 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===CheckTx===
+===TransmitByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckTx'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TransmitByte'''
 |-
-| colspan="2" | Returns the number of bytes held in the transmit queue for the selected channel.&nbsp;
+| colspan="2" | Adds a byte to the transmit queue for the selected channel.&nbsp;
 |-
 |-
@@ Line 207: / Line 218: @@
 | colspan="2" | UART Index Range: 0-3&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Data
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===ReceiveString===
+===TransmitString===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TransmitString'''
 |-
-| colspan="2" | 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.&nbsp;
+| colspan="2" | Adds a byte to the transmit queue for the selected channel.&nbsp;
 |-
 |-
@@ Line 226: / Line 242: @@
 | colspan="2" | UART Index Range: 0-3&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | NumBytes
+| width="90%" | Data
 |-
 | colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-===Initialise===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
-|-
-| colspan="2" | Activates the SPI peripheral and claims control over the I/O pins.&nbsp;
-|-
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID