Difference between revisions of "Component: SCADA (UART Dummy) (SCADA Slaves)"

Latest revision as of 13:12, 7 February 2023

Author	Matrix TSL
Version	1.0
Category	SCADA Slaves

SCADA (UART Dummy) component

Dummy SCADA Slave component to enable injector referencing. Supports: Digital IO / UART See Flowcode Help Wiki for firmware.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

IOGetInputPin

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

IOSetOutputPin

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

Initialise

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

UARTBaud

	UARTBaud

- BYTE	Rate

- VOID	Return

UARTCheckRX

	UARTCheckRX

- BYTE	Return

UARTInitialise

	UARTInitialise
Initialise the UART module ready for communications
- VOID	Return

UARTReceive

	UARTReceive
Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.
- BYTE	Return

UARTSend

	UARTSend
Send a byte via the UART module
- BYTE	Data

- VOID	Return

Property reference

	Properties

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_OLD_API_Slave_UART_Dummy.fcfx FC_Comp_Source_OLD_API_Slave_UART_Dummy.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_OLD_API_Slave_UART_Dummy.fcfx FC_Comp_Source_OLD_API_Slave_UART_Dummy.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_OLD_API_Slave_UART_Dummy.fcfx FC_Comp_Source_OLD_API_Slave_UART_Dummy.fcfx]
 ==Detailed description==
 ''No detailed description exists yet for this component''
 ==Examples==
 ''<span style="color:red;">No additional examples</span>''
-==Downloadable macro reference==
+==Macro reference==
+===IOGetInputPin===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 47: / Line 84: @@
+===IOSetOutputPin===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IOSetOutputPin'''
 |-
-| colspan="2" | &nbsp;
+| 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%" | Rate
+| width="90%" | Pin
+|-
+| colspan="2" | Range: 0-13&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | State
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Range: 0-1&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 65: / Line 108: @@
+===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;" | '''UARTCheckRX'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | &nbsp;
+| 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-u8-icon.png]] - BYTE
+| 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''
 |}
+===UARTBaud===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTBaud'''
+|-
+| colspan="2" | &nbsp;
+|-
 |-
-| colspan="2" | Initialise the UART module ready for communications&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Rate
 |-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 91: / Line 141: @@
+===UARTCheckRX===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTCheckRX'''
 |-
-| colspan="2" | Sets the selected digital pin to an output and assigns the output state.&nbsp;
+| colspan="2" | &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%" | Pin
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===UARTInitialise===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| colspan="2" | Range: 0-13&nbsp;
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTInitialise'''
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| colspan="2" | Initialise the UART module ready for communications&nbsp;
-| 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
@@ Line 114: / Line 169: @@
+===UARTReceive===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 127: / Line 183: @@
+===UARTSend===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 143: / Line 200: @@
 | 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''
-|}