Difference between revisions of "Component: SCADA (Dummy) (SCADA Slaves)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_OLD_API_Slave_Dummy.fcfx FC_Comp_Source_OLD_API_Slave_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_Dummy.fcfx FC_Comp_Source_OLD_API_Slave_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_Dummy.fcfx FC_Comp_Source_OLD_API_Slave_Dummy.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 34: | Line 36: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 46: | Line 50: | ||
==Macro reference== | ==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;" | '''I2CInitialise''' | ||
| + | |- | ||
| + | | colspan="2" | Initialsie the I2C module ready for communications | ||
| + | |- | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Pin | ||
| + | |- | ||
| + | | colspan="2" | Range: 0-13 | ||
| + | |- | ||
| + | | 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;" | '''I2CRestart''' | ||
| + | |- | ||
| + | | colspan="2" | Put the I2C Module into Restart mode | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''I2CStart''' | ||
| + | |- | ||
| + | | colspan="2" | Put the I2C Module into Start mode | ||
| + | |- | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | DataOut | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''I2CReceive''' | ||
| + | |- | ||
| + | | colspan="2" | Receive a byte using the I2C bus | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | Last | ||
| + | |- | ||
| + | | colspan="2" | Last byte to receive: Range 0-1 | ||
| + | |- | ||
| + | | 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;" | '''I2CStop''' | ||
| + | |- | ||
| + | | colspan="2" | Put the I2C Module into Stop mode | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''SPIPrescaler''' | ||
| + | |- | ||
| + | | colspan="2" | Modify the speed of the SPI bus | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Prescaler | ||
| + | |- | ||
| + | | colspan="2" | Range: 0-2 | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Pin | ||
| + | |- | ||
| + | | colspan="2" | Range: 0-13 | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | State | ||
| + | |- | ||
| + | | colspan="2" | Range: 0-1 | ||
| + | |- | ||
| + | | 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;" | '''SPIInitialise''' | ||
| + | |- | ||
| + | | colspan="2" | Initialsie the SPI module ready for communications | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''I2CSend''' | ||
| + | |- | ||
| + | | colspan="2" | Transmit a byte using the I2C bus | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | DataOut | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''Initialise''' | ||
| + | |- | ||
| + | | colspan="2" | Initialise the comms to the Arduino board ready for commands to be sent. | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 09:59, 27 January 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | SCADA Slaves |
Contents
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 |
| Initialsie the I2C module ready for communications | |
 - VOID
|
Return |
|
|
IOGetInputPin |
| Sets the selected digital pin to an input and reads the input state. | |
 - BYTE
|
Pin |
| Range: 0-13 | |
 - BOOL
|
Return |
|
|
I2CRestart |
| Put the I2C Module into Restart mode | |
| - VOID
|
Return |
|
|
I2CStart |
| Put the I2C Module into Start mode | |
| - VOID
|
Return |
|
|
SPITransfer |
| Transfer a byte using the SPI bus | |
| - BYTE
|
DataOut |
| - BYTE
|
Return |
|
|
I2CReceive |
| Receive a byte using the I2C bus | |
| - BOOL
|
Last |
| Last byte to receive: Range 0-1 | |
| - BYTE
|
Return |
|
|
I2CStop |
| Put the I2C Module into Stop mode | |
| - VOID
|
Return |
|
|
SPIPrescaler |
| Modify the speed of the SPI bus | |
| - BYTE
|
Prescaler |
| Range: 0-2 | |
| - VOID
|
Return |
|
|
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 |
|
|
SPIInitialise |
| Initialsie the SPI module ready for communications | |
| - VOID
|
Return |
|
|
I2CSend |
| Transmit a byte using the I2C bus | |
| - BYTE
|
DataOut |
| - BOOL
|
Return |
|
|
Initialise |
| Initialise the comms to the Arduino board ready for commands to be sent. | |
| - VOID
|
Return |
Property reference
|
Properties |
==Macro reference==
|
|
I2CInitialise |
| Initialsie the I2C module ready for communications | |
| - VOID
|
Return |
|
|
IOGetInputPin |
| Sets the selected digital pin to an input and reads the input state. | |
| - BYTE
|
Pin |
| Range: 0-13 | |
| - BOOL
|
Return |
|
|
I2CRestart |
| Put the I2C Module into Restart mode | |
| - VOID
|
Return |
|
|
I2CStart |
| Put the I2C Module into Start mode | |
| - VOID
|
Return |
|
|
SPITransfer |
| Transfer a byte using the SPI bus | |
| - BYTE
|
DataOut |
| - BYTE
|
Return |
|
|
I2CReceive |
| Receive a byte using the I2C bus | |
| - BOOL
|
Last |
| Last byte to receive: Range 0-1 | |
| - BYTE
|
Return |
|
|
I2CStop |
| Put the I2C Module into Stop mode | |
| - VOID
|
Return |
|
|
SPIPrescaler |
| Modify the speed of the SPI bus | |
| - BYTE
|
Prescaler |
| Range: 0-2 | |
| - VOID
|
Return |
|
|
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 |
|
|
SPIInitialise |
| Initialsie the SPI module ready for communications | |
| - VOID
|
Return |
|
|
I2CSend |
| Transmit a byte using the I2C bus | |
| - BYTE
|
DataOut |
| - BOOL
|
Return |
|
|
Initialise |
| Initialise the comms to the Arduino board ready for commands to be sent. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
==Macro reference==
|
|
I2CInitialise |
| Initialsie the I2C module ready for communications | |
| - VOID
|
Return |
|
|
IOGetInputPin |
| Sets the selected digital pin to an input and reads the input state. | |
| - BYTE
|
Pin |
| Range: 0-13 | |
| - BOOL
|
Return |
|
|
I2CRestart |
| Put the I2C Module into Restart mode | |
| - VOID
|
Return |
|
|
I2CStart |
| Put the I2C Module into Start mode | |
| - VOID
|
Return |
|
|
SPITransfer |
| Transfer a byte using the SPI bus | |
| - BYTE
|
DataOut |
| - BYTE
|
Return |
|
|
I2CReceive |
| Receive a byte using the I2C bus | |
| - BOOL
|
Last |
| Last byte to receive: Range 0-1 | |
| - BYTE
|
Return |
|
|
I2CStop |
| Put the I2C Module into Stop mode | |
| - VOID
|
Return |
|
|
SPIPrescaler |
| Modify the speed of the SPI bus | |
| - BYTE
|
Prescaler |
| Range: 0-2 | |
| - VOID
|
Return |
|
|
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 |
|
|
SPIInitialise |
| Initialsie the SPI module ready for communications | |
| - VOID
|
Return |
|
|
I2CSend |
| Transmit a byte using the I2C bus | |
| - BYTE
|
DataOut |
| - BOOL
|
Return |
|
|
Initialise |
| Initialise the comms to the Arduino board ready for commands to be sent. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
==Macro reference==
|
|
I2CInitialise |
| Initialsie the I2C module ready for communications | |
| - VOID
|
Return |
|
|
IOGetInputPin |
| Sets the selected digital pin to an input and reads the input state. | |
| - BYTE
|
Pin |
| Range: 0-13 | |
| - BOOL
|
Return |
|
|
I2CRestart |
| Put the I2C Module into Restart mode | |
| - VOID
|
Return |
|
|
I2CStart |
| Put the I2C Module into Start mode | |
| - VOID
|
Return |
|
|
SPITransfer |
| Transfer a byte using the SPI bus | |
| - BYTE
|
DataOut |
| - BYTE
|
Return |
|
|
I2CReceive |
| Receive a byte using the I2C bus | |
| - BOOL
|
Last |
| Last byte to receive: Range 0-1 | |
| - BYTE
|
Return |
|
|
I2CStop |
| Put the I2C Module into Stop mode | |
| - VOID
|
Return |
|
|
SPIPrescaler |
| Modify the speed of the SPI bus | |
| - BYTE
|
Prescaler |
| Range: 0-2 | |
| - VOID
|
Return |
|
|
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 |
|
|
SPIInitialise |
| Initialsie the SPI module ready for communications | |
| - VOID
|
Return |
|
|
I2CSend |
| Transmit a byte using the I2C bus | |
| - BYTE
|
DataOut |
| - BOOL
|
Return |
|
|
Initialise |
| Initialise the comms to the Arduino board ready for commands to be sent. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
