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

Revision as of 11:48, 3 February 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

	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

	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

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

IOSetOutputPin

	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

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

UARTReceive

	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

	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
Initialise the comms to the Arduino board ready for commands to be sent.
- VOID	Return

Property reference

	Properties

@@ Line 56: / Line 56: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 61: / Line 63: @@
 ==Macro reference==
+===UARTBaud===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 84: / Line 87: @@
+===UARTCheckRX===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 102: / Line 106: @@
+===UARTInitialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 120: / Line 125: @@
+===IOSetOutputPin===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 143: / Line 149: @@
+===IOGetInputPin===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 161: / Line 168: @@
+===UARTReceive===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 179: / Line 187: @@
+===UARTSend===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 202: / Line 211: @@
+===Initialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-