Difference between revisions of "Component: API UART Dummy (API Slave Devices)"

Revision as of 09:54, 27 January 2023

Author	Matrix TSL
Version	2.0
Category	API Slave Devices

API UART Dummy component

Connects to an Arduino Mega running the API Firmware allowing the board to become a slave to the Flowcode Embedded simulation or Flowcode App Developer. Supports: Digital IO / ADC / I2C / SPI / UART / PWM See Flowcode Help Wiki for firmware.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_API_UART_Dummy.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_API_UART_Dummy.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

	UARTBaud
Control the communications rate of the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Rate
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200
- VOID	Return

	UARTCheckRX
Check to see if the UART module has received any data
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

	UARTInitialise
Initialise the UART module ready for communications
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- VOID	Return

	IOSetOutputPin
Sets the selected digital pin to an output and assigns the output state.
- BYTE	Pin
Range: 0-53
- BOOL	State
Range: 0-1
- VOID	Return

	IOGetInputPin
Sets the selected digital pin to an input and reads the input state.
- BYTE	Pin
Range: 0-19
- BOOL	Return

	UARTReceive
Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

	UARTSend
Send a byte via the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Data
Data Byte to send. Range: 0-255
- VOID	Return

	Initialise
Initialise the comms to the Arduino board ready for commands to be sent.
- VOID	Return

Property reference

	Properties

==Macro reference==

	UARTBaud
Control the communications rate of the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Rate
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200
- VOID	Return

	UARTCheckRX
Check to see if the UART module has received any data
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

	UARTInitialise
Initialise the UART module ready for communications
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- VOID	Return

	IOSetOutputPin
Sets the selected digital pin to an output and assigns the output state.
- BYTE	Pin
Range: 0-53
- BOOL	State
Range: 0-1
- VOID	Return

	IOGetInputPin
Sets the selected digital pin to an input and reads the input state.
- BYTE	Pin
Range: 0-19
- BOOL	Return

	UARTReceive
Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

	UARTSend
Send a byte via the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Data
Data Byte to send. Range: 0-255
- VOID	Return

	Initialise
Initialise the comms to the Arduino board ready for commands to be sent.
- VOID	Return

Property reference

	Properties

==Macro reference==

	UARTBaud
Control the communications rate of the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Rate
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200
- VOID	Return

	UARTCheckRX
Check to see if the UART module has received any data
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

	UARTInitialise
Initialise the UART module ready for communications
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- VOID	Return

	IOSetOutputPin
Sets the selected digital pin to an output and assigns the output state.
- BYTE	Pin
Range: 0-53
- BOOL	State
Range: 0-1
- VOID	Return

	IOGetInputPin
Sets the selected digital pin to an input and reads the input state.
- BYTE	Pin
Range: 0-19
- BOOL	Return

	UARTReceive
Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

	UARTSend
Send a byte via the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Data
Data Byte to send. Range: 0-255
- VOID	Return

	Initialise
Initialise the comms to the Arduino board ready for commands to be sent.
- VOID	Return

Property reference

	Properties

==Macro reference==

	UARTBaud
Control the communications rate of the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Rate
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200
- VOID	Return

	UARTCheckRX
Check to see if the UART module has received any data
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

	UARTInitialise
Initialise the UART module ready for communications
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- VOID	Return

	IOSetOutputPin
Sets the selected digital pin to an output and assigns the output state.
- BYTE	Pin
Range: 0-53
- BOOL	State
Range: 0-1
- VOID	Return

	IOGetInputPin
Sets the selected digital pin to an input and reads the input state.
- BYTE	Pin
Range: 0-19
- BOOL	Return

	UARTReceive
Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

	UARTSend
Send a byte via the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Data
Data Byte to send. Range: 0-255
- VOID	Return

	Initialise
Initialise the comms to the Arduino board ready for commands to be sent.
- VOID	Return

Property reference

	Properties

==Macro reference==

	UARTBaud
Control the communications rate of the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Rate
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200
- VOID	Return

	UARTCheckRX
Check to see if the UART module has received any data
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

	UARTInitialise
Initialise the UART module ready for communications
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- VOID	Return

	IOSetOutputPin
Sets the selected digital pin to an output and assigns the output state.
- BYTE	Pin
Range: 0-53
- BOOL	State
Range: 0-1
- VOID	Return

	IOGetInputPin
Sets the selected digital pin to an input and reads the input state.
- BYTE	Pin
Range: 0-19
- BOOL	Return

	UARTReceive
Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

	UARTSend
Send a byte via the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Data
Data Byte to send. Range: 0-255
- VOID	Return

	Initialise
Initialise the comms to the Arduino board ready for commands to be sent.
- VOID	Return

Property reference

	Properties

@@ Line 22: / Line 22: @@
 ==Detailed description==
@@ Line 36: / Line 38: @@
 ==Examples==
@@ Line 50: / Line 54: @@
 ==Macro reference==
+{| 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;" | '''UARTBaud'''
+|-
+| colspan="2" | Control the communications rate of the UART module&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Channel
+|-
+| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Rate
+|-
+| 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''
+|}
+{| 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;" | '''UARTCheckRX'''
+|-
+| colspan="2" | Check to see if the UART module has received any data&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Channel
+|-
+| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| 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;" | '''UARTInitialise'''
+|-
+| colspan="2" | Initialise the UART module ready for communications&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Channel
+|-
+| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&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''
+|}
+{| 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;" | '''IOSetOutputPin'''
+|-
+| colspan="2" | Sets the selected digital pin to an output and assigns the output state.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Pin
+|-
+| colspan="2" | Range: 0-53&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | State
+|-
+| colspan="2" | Range: 0-1&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''
+|}
+{| 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;" | '''IOGetInputPin'''
+|-
+| colspan="2" | Sets the selected digital pin to an input and reads the input state.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Pin
+|-
+| colspan="2" | Range: 0-19&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| 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;" | '''UARTReceive'''
+|-
+| colspan="2" | Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Channel
+|-
+| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+{| 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;" | '''UARTSend'''
+|-
+| colspan="2" | Send a byte via the UART module&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Channel
+|-
+| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Data
+|-
+| colspan="2" | Data Byte to send. Range: 0-255&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''
+|}
+{| 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" | Initialise the comms to the Arduino board ready for commands to be sent.&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''
+|}
+==Property reference==
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+|-
+|}==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Difference between revisions of "Component: API UART Dummy (API Slave Devices)"

Revision as of 09:54, 27 January 2023

Contents

API UART Dummy component

Component Source Code

Detailed description

Examples

Macro reference

Property reference

Property reference

Property reference

Property reference

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools