Difference between revisions of "Component: Modbus Slave (SCADA) (Comms: System)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
+
{| style="width:50%"
 
 
{| width="50%"
 
 
|-
 
|-
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Comms: System
 
| Comms: System
 
|}
 
|}
  
  
 
+
==Modbus Slave (SCADA) component==
==[[File:Component Icon a93b1f52_b96d_4a14_806e_63f73d2654b2.png|Image]] Modbus Slave (SCADA) component==
 
 
Modbus component for creating Modbus compatible slave hardware via RS232 or RS485.  
 
Modbus component for creating Modbus compatible slave hardware via RS232 or RS485.  
  
==Examples==
+
==Component Pack==
''<span style="color:red;">No additional examples</span>''
 
  
 +
SCADA
  
==Downloadable macro reference==
+
==Detailed description==
  
===<span style="font-weight: normal;"><u><tt>ReadHoldingRegister</tt></u></span>===
 
Reads the value of a single holding register.
 
  
'''Parameters'''
 
  
:[[Variable Types|UINT]] ''Address''
 
::Coil Address
 
  
  
'''Return value'''
 
  
:[[Variable Types|UINT]]
 
  
  
===<span style="font-weight: normal;"><u><tt>ReadCoilStates</tt></u></span>===
 
Reads the state of a single digital coil.
 
  
Can pack a max of 8-bits together in a single operation
 
  
'''Parameters'''
 
  
:[[Variable Types|UINT]] ''StartAddress''
+
''No detailed description exists yet for this component''
::Coil Address Range 0 to (NumCoils - 1)
 
  
:[[Variable Types|BYTE]] ''AddressCount''
+
==Examples==
::Range 1-8
 
  
  
'''Return value'''
 
  
:[[Variable Types|BYTE]]
 
  
  
===<span style="font-weight: normal;"><u><tt>ReadAnalogueInput</tt></u></span>===
 
Reads the value of a single analogue input.
 
  
'''Parameters'''
 
  
:[[Variable Types|UINT]] ''Address''
 
::Coil Address
 
  
  
'''Return value'''
 
  
:[[Variable Types|UINT]]
 
  
  
===<span style="font-weight: normal;"><u><tt>ReadInputStates</tt></u></span>===
+
''<span style="color:red;">No additional examples</span>''
Reads the state of a single digital input.
 
  
Can pack a max of 8-bits together in a single operation
 
  
'''Parameters'''
+
==Downloadable macro reference==
  
:[[Variable Types|UINT]] ''StartAddress''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
::Coil Address Range 0 to (NumCoils - 1)
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadHoldingRegister'''
 +
|-
 +
| colspan="2" | Reads the value of a single holding register.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Coil Address&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
:[[Variable Types|BYTE]] ''AddressCount''
 
::Range 1-8
 
  
 +
{| 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;" | '''SetCoil'''
 +
|-
 +
| colspan="2" | Sets the state of a single digital coil.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Coil Address&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | State
 +
|-
 +
| colspan="2" | 0=off, 1=on&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''
 +
|}
  
'''Return value'''
 
  
:[[Variable Types|BYTE]]
+
{| 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;" | '''SetDigitalInput'''
 +
|-
 +
| colspan="2" | Sets the state of a single digital input.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Coil Address&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | State
 +
|-
 +
| colspan="2" | 0=off, 1=on&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''
 +
|}
  
  
===<span style="font-weight: normal;"><u><tt>SetSlaveAddress</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Allows the slave address to be overridden from the default slave address specified
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetSlaveAddress'''
 +
|-
 +
| colspan="2" | Allows the slave address to be overridden from the default slave address specified in the component property. The number of bytes used for the address is fixed by the Slave ID Bytes property to save on RAM usage.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | SlaveAddress
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
in the component property. The number of bytes used for the address is fixed by the
 
  
Slave ID Bytes property to save on RAM usage.
+
{| 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;" | '''ChangeFrameType'''
 +
|-
 +
| colspan="2" | Default frame type is the type set in the component properties.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Type
 +
|-
 +
| colspan="2" | 0 = Modbus RTU / 1 = Modbus ASCII&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''
 +
|}
  
'''Parameters'''
 
  
:[[Variable Types|UINT]] ''SlaveAddress''
+
{| 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;" | '''ReadCoils'''
 +
|-
 +
| colspan="2" | Reads the state of up to eight digital coils. Can pack a max of 8-bits together in a single operation&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | StartAddress
 +
|-
 +
| colspan="2" | Coil Address Range 0 to (NumCoils - 1)&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | AddressCount
 +
|-
 +
| colspan="2" | Range 1-8&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''
 +
|}
  
  
'''Return value'''
+
{| 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;" | '''SetHoldingRegister'''
 +
|-
 +
| colspan="2" | Sets the state of a single holding register.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Coil Address&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | Analogue Value range 0 - 65535&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''
 +
|}
  
:''This call does not return a value''
 
  
 +
{| 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;" | '''ReadAnalogInput'''
 +
|-
 +
| colspan="2" | Reads the value of a single analogue input.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Coil Address&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
===<span style="font-weight: normal;"><u><tt>SetCoilState</tt></u></span>===
 
Sets the state of a single digital coil.
 
  
'''Parameters'''
+
{| 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;" | '''CheckForIncoming'''
 +
|-
 +
| colspan="2" | Checks for an incoming message and if the data address is within range then also automatically replies with the correct reply. Returns 0 if no comms received, 1 for a succesful transaction, 255 for an error.&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''
 +
|}
  
:[[Variable Types|UINT]] ''Address''
 
::Coil Address
 
  
:[[Variable Types|BYTE]] ''State''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
::0=off, 1=on
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadDigitalInputs'''
 +
|-
 +
| colspan="2" | Reads the state of up to eight digital inputs. Can pack a max of 8-bits together in a single operation&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | StartAddress
 +
|-
 +
| colspan="2" | Coil Address Range 0 to (NumCoils - 1)&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | AddressCount
 +
|-
 +
| colspan="2" | Range 1-8&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''
 +
|}
  
  
'''Return value'''
+
{| 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;" | '''GetLastIncoming'''
 +
|-
 +
| colspan="2" | Gets a value from the last incoming command. Index 0 = 0 Read / 1 Write Index 1 = 0 Coils / 1 DigInput / 2 AnInput / 3 Register Index 2 = Address  Index 3 = Number&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
:''This call does not return a value''
 
  
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===<span style="font-weight: normal;"><u><tt>ChangeFrameType</tt></u></span>===
+
|-
Default frame type is the type set in the component properties.
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAnalogInput'''
'''Parameters'''
+
|-
 
+
| colspan="2" | Sets the state of a single analogue input.&nbsp;
:[[Variable Types|BYTE]] ''Type''
+
|-
::0 = Modbus RTU / 1 = Modbus ASCII
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
+
| width="90%" | Address
'''Return value'''
+
|-
 
+
| colspan="2" | Coil Address&nbsp;
:''This call does not return a value''
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
+
| width="90%" | Value
===<span style="font-weight: normal;"><u><tt>SetInputState</tt></u></span>===
+
|-
Sets the state of a single digital input.
+
| colspan="2" | Analogue Value range 0 - 65535&nbsp;
 
+
|-
'''Parameters'''
+
| 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''
:[[Variable Types|UINT]] ''Address''
+
|}
::Coil Address
 
 
 
:[[Variable Types|BYTE]] ''State''
 
::0=off, 1=on
 
 
 
 
 
'''Return value'''
 
 
 
:''This call does not return a value''
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>SetHoldingRegister</tt></u></span>===
 
Sets the state of a single holding register.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|UINT]] ''Address''
 
::Coil Address
 
 
 
:[[Variable Types|UINT]] ''Value''
 
::Analogue Value range 0 - 65535
 
 
 
 
 
'''Return value'''
 
 
 
:''This call does not return a value''
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>CheckForIncoming</tt></u></span>===
 
Checks for an incoming message and if the data address is within range then also automatically replies with the correct reply.
 
 
 
Returns 0 if no comms received, 1 for a succesful transaction, 255 for an error.
 
 
 
'''Parameters'''
 
 
 
:''This macro has no parameters''
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|BYTE]]
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>GetLastIncoming</tt></u></span>===
 
Gets a value from the last incoming command.
 
 
 
Index 0 = 0 Read / 1 Write
 
 
 
Index 1 = 0 Coils / 1 DigInput / 2 AnInput / 3 Register
 
 
 
Index 2 = Address
 
 
 
Index 3 = Number
 
 
 
'''Parameters'''
 
 
 
:''This macro has no parameters''
 
 
 
 
 
'''Return value'''
 
 
 
:[[Variable Types|UINT]]
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>SetAnalogueInput</tt></u></span>===
 
Sets the state of a single analogue input.
 
 
 
'''Parameters'''
 
 
 
:[[Variable Types|UINT]] ''Address''
 
::Coil Address
 
 
 
:[[Variable Types|UINT]] ''Value''
 
::Analogue Value range 0 - 65535
 
 
 
 
 
'''Return value'''
 
 
 
:''This call does not return a value''
 
 
 
 
 
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
 
Starts up the UART to allow communications and initialises the states of the various
 
 
 
Modbus Coils, Inputs and Registers to 0.
 
 
 
'''Parameters'''
 
 
 
:''This macro has no parameters''
 
 
 
 
 
'''Return value'''
 
 
 
:''This call does not return a value''
 
  
  
 +
{| 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" | Starts up the UART to allow communications and initialises the states of the various  Modbus Coils, Inputs and Registers to 0.&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''
 +
|}
  
==Simulation macro reference==
 
  
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
<span style="font-weight: normal;"><u>Frame Type</u></span>
 
  
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''FrameType''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
Switches between RTU and ASCII forms of Modbus
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
<span style="font-weight: normal;"><u>Receive Buffer Size</u></span>
+
|-
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ReceiveBufferSize''.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Modbus Properties
Maximum number of bytes the receive buffer can hold
+
|-
 
+
|-
<span style="font-weight: normal;"><u>Receive Timeout</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
+
| width="90%" | Frame Type
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Timeout''.
+
|-
 
+
| colspan="2" | Switches between RTU and ASCII forms of Modbus&nbsp;
Length in milliseconds to wait for additional bytes to be received when checking for incoming messages.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
<span style="font-weight: normal;"><u>Slave ID Bytes</u></span>
+
| width="90%" | Receive Buffer Size
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''AddressBytes''.
+
| colspan="2" | Maximum number of bytes the receive buffer can hold&nbsp;
 
+
|-
Number of bytes used when passing a slave ID, usually 1 but sometimes 2
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | Receive Timeout
<span style="font-weight: normal;"><u>Slave Address</u></span>
+
|-
 
+
| colspan="2" | Length in milliseconds to wait for additional bytes to be received when checking for incoming messages.&nbsp;
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''SlaveAddress''.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
''<span style="color:red;">No additional information</span>''
+
| width="90%" | Slave ID Bytes
 
+
|-
 
+
| colspan="2" | Number of bytes used when passing a slave ID, usually 1 but sometimes 2&nbsp;
 
+
|-
<span style="font-weight: normal;"><u>Reply Delay</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | Slave Address
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''ReplyDelay''.
+
|-
 
+
| colspan="2" | &nbsp;
Delay in micro seconds to wait before transmitting a reply
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
<span style="font-weight: normal;"><u>Maintain Stats</u></span>
+
| width="90%" | Reply Delay
 
+
|-
This property is of type ''True or false'' and can be referenced with the variable name ''Stats''.
+
| colspan="2" | Delay in micro seconds to wait before transmitting a reply&nbsp;
 
+
|-
Controls if the last command from the master is logged allowing for easier value updates.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
+
| width="90%" | Maintain Stats
No - Do not log commands
+
|-
 
+
| colspan="2" | Controls if the last command from the master is logged allowing for easier value updates. No - Do not log commands Yes - Commands are logged and available via the GetLastIncoming macro&nbsp;
Yes - Commands are logged and available via the GetLastIncoming macro
+
|-
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
<span style="font-weight: normal;"><u>Label</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Runtime Properties
 
+
|-
This property is of type ''Line of text'' and can be referenced with the variable name ''label''.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
A text label to appear on the Modbus panel object.
+
| width="90%" | Label
 
+
|-
<span style="font-weight: normal;"><u>Console Data</u></span>
+
| colspan="2" | A text label to appear on the Modbus panel object.&nbsp;
 
+
|-
This property is of type ''True or false'' and can be referenced with the variable name ''scada_uart1::ConsoleData''.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
+
| width="90%" | Console Data
Selects if the console data is automatically generated or not
+
|-
 
+
| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
<span style="font-weight: normal;"><u>Console Columns</u></span>
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''scada_uart1::ConsoleColumns''.
+
| width="90%" | Console Columns
 
+
|-
Number of characters that can be displayed on a single line of the console.
+
| colspan="2" | Number of characters that can be displayed on a single line of the console.&nbsp;
 
+
|-
<span style="font-weight: normal;"><u>Data Source</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
+
| width="90%" | Data Source
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''scada_uart1::DataSource''.
+
|-
 
+
| colspan="2" | Simulation data source used to allow the component to connect to various remote devices    Nothing - Simulation data is ignored    COM port - Routes the communication data to and from a physical or virtual COM port     Injector - Routes the communication data via a data injector component on the Panel.&nbsp;
Simulation data source used to allow the component to connect to various remote devices
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
     Nothing - Simulation data is ignored
+
| width="90%" | COM Port
 
+
|-
     COM port - Routes the communication data to and from a physical or virtual COM port  
+
| colspan="2" | Lists all the current available COM port hardware on your PC.&nbsp;
 
+
|-
    Injector - Routes the communication data via a data injector component on the Panel.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
+
| width="90%" | Refresh Ports
<span style="font-weight: normal;"><u>COM Port</u></span>
+
|-
 
+
| colspan="2" | &nbsp;
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''scada_uart1::com_port''.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
Lists all the current available COM port hardware on your PC.
+
| width="90%" | Baud Rate
 
+
|-
<span style="font-weight: normal;"><u>Baud Rate</u></span>
+
| colspan="2" | COM port data rate in bits per second&nbsp;
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''scada_uart1::baud''.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Modbus Coils - Single bit values
COM port data rate in bits per second
+
|-
 
+
|-
<span style="font-weight: normal;"><u>Starting Address</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | Starting Address
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''StartAdrCoil''.
+
|-
 
+
| colspan="2" | Start address of the Modbus coils. Referenced from 0. For example Slave 1 might have 100 coils addressed 0-99 Start Address = 0 Slave 2 might have 100 coils addressed 100-199 Start Address = 100&nbsp;
Start address of the Modbus coils. Referenced from 0.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
For example  
+
| width="90%" | Number of Addresses
 
+
|-
Slave 1 might have 100 coils addressed 0-99 Start Address = 0
+
| colspan="2" | Specifies how many Coils are available on the slave. Each address consumes a single bit of RAM, 8 Addresses are packed together into a single RAM Byte.&nbsp;
 
+
|-
Slave 2 might have 100 coils addressed 100-199 Start Address = 100
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Digital Inputs - Single bit values
<span style="font-weight: normal;"><u>Number of Addresses</u></span>
+
|-
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''NumAdrCoil''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | Starting Address
Specifies how many Coils are available on the slave.
+
|-
 
+
| colspan="2" | Start address of the Modbus digital inputs. Referenced from 0. For example Slave 1 might have 100 inputs addressed 0-99 Start Address = 0 Slave 2 might have 100 inputs addressed 100-199 Start Address = 100&nbsp;
Each address consumes a single bit of RAM, 8 Addresses are packed together into a single RAM Byte.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
<span style="font-weight: normal;"><u>Starting Address</u></span>
+
| width="90%" | Number of Addresses
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''StartAdrDI''.
+
| colspan="2" | Specifies how many Digital Inputs are available on the slave. Each address consumes a single bit of RAM, 8 Addresses are packed together into a single RAM Byte.&nbsp;
 
+
|-
Start address of the Modbus digital inputs. Referenced from 0.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Analog Inputs - 16-bit values
For example  
+
|-
 
+
|-
Slave 1 might have 100 inputs addressed 0-99 Start Address = 0
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | Starting Address
Slave 2 might have 100 inputs addressed 100-199 Start Address = 100
+
|-
 
+
| colspan="2" | Start address of the Modbus analogue inputs. Referenced from 0. For example Slave 1 might have 100 inputs addressed 0-99 Start Address = 0 Slave 2 might have 100 inputs addressed 100-199 Start Address = 100&nbsp;
<span style="font-weight: normal;"><u>Number of Addresses</u></span>
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''NumAdrDI''.
+
| width="90%" | Number of Addresses
 
+
|-
Specifies how many Digital Inputs are available on the slave.
+
| colspan="2" | Specifies how many 16-bit analogue inputs are available on the slave. Each address consumes two RAM Bytes.&nbsp;
 
+
|-
Each address consumes a single bit of RAM, 8 Addresses are packed together into a single RAM Byte.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Holding Registers - 16-bit values
<span style="font-weight: normal;"><u>Starting Address</u></span>
+
|-
 
+
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''StartAdrAI''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
+
| width="90%" | Starting Address
Start address of the Modbus analogue inputs. Referenced from 0.
+
|-
 
+
| colspan="2" | Start address of the Modbus registers. Referenced from 0. For example Slave 1 might have 100 registers addressed 0-99 Start Address = 0 Slave 2 might have 100 registers addressed 100-199 Start Address = 100&nbsp;
For example  
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
Slave 1 might have 100 inputs addressed 0-99 Start Address = 0
+
| width="90%" | Number of Addresses
 
+
|-
Slave 2 might have 100 inputs addressed 100-199 Start Address = 100
+
| colspan="2" | Specifies how many 16-bit holding registers are available on the slave. Each address consumes two RAM Bytes.&nbsp;
 
+
|}
<span style="font-weight: normal;"><u>Number of Addresses</u></span>
 
 
 
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''NumAdrAI''.
 
 
 
Specifies how many 16-bit analogue inputs are available on the slave.
 
 
 
Each address consumes two RAM Bytes.
 
 
 
<span style="font-weight: normal;"><u>Starting Address</u></span>
 
 
 
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''StartAdrReg''.
 
 
 
Start address of the Modbus registers. Referenced from 0.
 
 
 
For example  
 
 
 
Slave 1 might have 100 registers addressed 0-99 Start Address = 0
 
 
 
Slave 2 might have 100 registers addressed 100-199 Start Address = 100
 
 
 
<span style="font-weight: normal;"><u>Number of Addresses</u></span>
 
 
 
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''NumAdrReg''.
 
 
 
Specifies how many 16-bit holding registers are available on the slave.
 
 
 
Each address consumes two RAM Bytes.
 

Latest revision as of 17:22, 9 November 2022

Author Matrix TSL
Version 1.0
Category Comms: System


Modbus Slave (SCADA) component

Modbus component for creating Modbus compatible slave hardware via RS232 or RS485.

Component Pack

SCADA

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png ReadHoldingRegister
Reads the value of a single holding register. 
Fc9-u16-icon.png - UINT Address
Coil Address 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png SetCoil
Sets the state of a single digital coil. 
Fc9-u16-icon.png - UINT Address
Coil Address 
Fc9-u8-icon.png - BYTE State
0=off, 1=on 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDigitalInput
Sets the state of a single digital input. 
Fc9-u16-icon.png - UINT Address
Coil Address 
Fc9-u8-icon.png - BYTE State
0=off, 1=on 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetSlaveAddress
Allows the slave address to be overridden from the default slave address specified in the component property. The number of bytes used for the address is fixed by the Slave ID Bytes property to save on RAM usage. 
Fc9-u16-icon.png - UINT SlaveAddress
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ChangeFrameType
Default frame type is the type set in the component properties. 
Fc9-u8-icon.png - BYTE Type
0 = Modbus RTU / 1 = Modbus ASCII 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadCoils
Reads the state of up to eight digital coils. Can pack a max of 8-bits together in a single operation 
Fc9-u16-icon.png - UINT StartAddress
Coil Address Range 0 to (NumCoils - 1) 
Fc9-u8-icon.png - BYTE AddressCount
Range 1-8 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SetHoldingRegister
Sets the state of a single holding register. 
Fc9-u16-icon.png - UINT Address
Coil Address 
Fc9-u16-icon.png - UINT Value
Analogue Value range 0 - 65535 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadAnalogInput
Reads the value of a single analogue input. 
Fc9-u16-icon.png - UINT Address
Coil Address 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png CheckForIncoming
Checks for an incoming message and if the data address is within range then also automatically replies with the correct reply. Returns 0 if no comms received, 1 for a succesful transaction, 255 for an error. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ReadDigitalInputs
Reads the state of up to eight digital inputs. Can pack a max of 8-bits together in a single operation 
Fc9-u16-icon.png - UINT StartAddress
Coil Address Range 0 to (NumCoils - 1) 
Fc9-u8-icon.png - BYTE AddressCount
Range 1-8 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetLastIncoming
Gets a value from the last incoming command. Index 0 = 0 Read / 1 Write Index 1 = 0 Coils / 1 DigInput / 2 AnInput / 3 Register Index 2 = Address Index 3 = Number 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png SetAnalogInput
Sets the state of a single analogue input. 
Fc9-u16-icon.png - UINT Address
Coil Address 
Fc9-u16-icon.png - UINT Value
Analogue Value range 0 - 65535 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Starts up the UART to allow communications and initialises the states of the various Modbus Coils, Inputs and Registers to 0. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Modbus Properties
Fc9-type-16-icon.png Frame Type
Switches between RTU and ASCII forms of Modbus 
Fc9-type-21-icon.png Receive Buffer Size
Maximum number of bytes the receive buffer can hold 
Fc9-type-21-icon.png Receive Timeout
Length in milliseconds to wait for additional bytes to be received when checking for incoming messages. 
Fc9-type-21-icon.png Slave ID Bytes
Number of bytes used when passing a slave ID, usually 1 but sometimes 2 
Fc9-type-21-icon.png Slave Address
 
Fc9-type-21-icon.png Reply Delay
Delay in micro seconds to wait before transmitting a reply 
Fc9-type-7-icon.png Maintain Stats
Controls if the last command from the master is logged allowing for easier value updates. No - Do not log commands Yes - Commands are logged and available via the GetLastIncoming macro 
Fc9-conn-icon.png Runtime Properties
Fc9-type-10-icon.png Label
A text label to appear on the Modbus panel object. 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-21-icon.png Console Columns
Number of characters that can be displayed on a single line of the console. 
Fc9-type-16-icon.png Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel. 
Fc9-type-16-icon.png COM Port
Lists all the current available COM port hardware on your PC. 
Fc9-type-7-icon.png Refresh Ports
 
Fc9-type-21-icon.png Baud Rate
COM port data rate in bits per second 
Fc9-conn-icon.png Modbus Coils - Single bit values
Fc9-type-21-icon.png Starting Address
Start address of the Modbus coils. Referenced from 0. For example Slave 1 might have 100 coils addressed 0-99 Start Address = 0 Slave 2 might have 100 coils addressed 100-199 Start Address = 100 
Fc9-type-21-icon.png Number of Addresses
Specifies how many Coils are available on the slave. Each address consumes a single bit of RAM, 8 Addresses are packed together into a single RAM Byte. 
Fc9-conn-icon.png Digital Inputs - Single bit values
Fc9-type-21-icon.png Starting Address
Start address of the Modbus digital inputs. Referenced from 0. For example Slave 1 might have 100 inputs addressed 0-99 Start Address = 0 Slave 2 might have 100 inputs addressed 100-199 Start Address = 100 
Fc9-type-21-icon.png Number of Addresses
Specifies how many Digital Inputs are available on the slave. Each address consumes a single bit of RAM, 8 Addresses are packed together into a single RAM Byte. 
Fc9-conn-icon.png Analog Inputs - 16-bit values
Fc9-type-21-icon.png Starting Address
Start address of the Modbus analogue inputs. Referenced from 0. For example Slave 1 might have 100 inputs addressed 0-99 Start Address = 0 Slave 2 might have 100 inputs addressed 100-199 Start Address = 100 
Fc9-type-21-icon.png Number of Addresses
Specifies how many 16-bit analogue inputs are available on the slave. Each address consumes two RAM Bytes. 
Fc9-conn-icon.png Holding Registers - 16-bit values
Fc9-type-21-icon.png Starting Address
Start address of the Modbus registers. Referenced from 0. For example Slave 1 might have 100 registers addressed 0-99 Start Address = 0 Slave 2 might have 100 registers addressed 100-199 Start Address = 100 
Fc9-type-21-icon.png Number of Addresses
Specifies how many 16-bit holding registers are available on the slave. Each address consumes two RAM Bytes.