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

Latest revision as of 13:12, 7 February 2023

Author	Matrix TSL
Version	1.0
Category	SCADA Slaves

SCADA (Dummy) component

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

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

I2CInitialise

	I2CInitialise
Initialsie the I2C module ready for communications
- VOID	Return

I2CReceive

	I2CReceive
Receive a byte using the I2C bus
- BOOL	Last
Last byte to receive: Range 0-1
- BYTE	Return

I2CRestart

	I2CRestart
Put the I2C Module into Restart mode
- VOID	Return

I2CSend

	I2CSend
Transmit a byte using the I2C bus
- BYTE	DataOut

- BOOL	Return

I2CStart

	I2CStart
Put the I2C Module into Start mode
- VOID	Return

I2CStop

	I2CStop
Put the I2C Module into Stop mode
- VOID	Return

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

SPIInitialise

	SPIInitialise
Initialsie the SPI module ready for communications
- VOID	Return

SPIPrescaler

	SPIPrescaler
Modify the speed of the SPI bus
- BYTE	Prescaler
Range: 0-2
- VOID	Return

SPITransfer

	SPITransfer
Transfer a byte using the SPI bus
- BYTE	DataOut

- BYTE	Return

Property reference

	Properties

@@ Line 52: / Line 52: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 57: / Line 65: @@
 ==Macro reference==
+===I2CInitialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 70: / Line 79: @@
+===I2CReceive===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CReceive'''
 |-
-| colspan="2" | Sets the selected digital pin to an input and reads the input state.&nbsp;
+| colspan="2" | Receive a byte using the I2C bus&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | Pin
+| width="90%" | Last
 |-
-| colspan="2" | Range: 0-13&nbsp;
+| colspan="2" | Last byte to receive: Range 0-1&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| 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''
 |}
+===I2CRestart===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 101: / Line 112: @@
+===I2CSend===
 {| 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;" | '''I2CStart'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CSend'''
 |-
-| colspan="2" | Put the I2C Module into Start mode&nbsp;
+| colspan="2" | Transmit a byte using the I2C bus&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;" | '''SPITransfer'''
-|-
-| colspan="2" | Transfer a byte using the SPI bus&nbsp;
 |-
 |-
@@ Line 127: / Line 126: @@
 | colspan="2" | &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-bool-icon.png]] - BOOL
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===I2CStart===
 {| 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;" | '''I2CReceive'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CStart'''
 |-
-| colspan="2" | Receive a byte using the I2C bus&nbsp;
+| colspan="2" | Put the I2C Module into Start mode&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Last
-|-
-| colspan="2" | Last byte to receive: Range 0-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''
 |}
+===I2CStop===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 163: / Line 159: @@
+===IOGetInputPin===
 {| 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;" | '''SPIPrescaler'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IOGetInputPin'''
 |-
-| colspan="2" | Modify the speed of the SPI bus&nbsp;
+| 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%" | Prescaler
+| width="90%" | Pin
 |-
-| colspan="2" | Range: 0-2&nbsp;
+| colspan="2" | Range: 0-13&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-bool-icon.png]] - BOOL
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===IOSetOutputPin===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 204: / Line 202: @@
+===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" | 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''
+|}
+===SPIInitialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 217: / Line 230: @@
+===SPIPrescaler===
 {| 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;" | '''I2CSend'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPIPrescaler'''
 |-
-| colspan="2" | Transmit a byte using the I2C bus&nbsp;
+| colspan="2" | Modify the speed of the SPI bus&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | DataOut
+| width="90%" | Prescaler
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Range: 0-2&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| 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''
 |}
+===SPITransfer===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPITransfer'''
+|-
+| colspan="2" | Transfer a byte using the SPI bus&nbsp;
+|-
 |-
-| colspan="2" | Initialise the comms to the Arduino board ready for commands to be sent.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | DataOut
 |-
+| 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-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}