View source for Component: Modbus TCP Slave (Comms: System)

From Flowcode Help

← Component: Modbus TCP Slave (Comms: System)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd. |- | width="20%" style="color:gray;" | Version | 2.1 |- | width="20%" style="color:gray;" | Category | Comms: System |} ==Modbus TCP Slave component== Modbus component for creating Modbus compatible slave hardware via Ethernet or WIFI. Ensure TCP/IP or WIFI component is initialised and connected to a network before calling the ModbusSlaveTCP component macros. ==Component Pack== COMMSC ==Detailed description== ''No detailed description exists yet for this component'' ==Examples== ''<span style="color:red;">No additional examples</span>'' ==Downloadable 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;" | '''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'' |} {| 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'' |} {| 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'' |} {| 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;" | '''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'' |} {| 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 a single digital coil. 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'' |} {| 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'' |} {| 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'' |} {| 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'' |} {| 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;" | '''ReadDigitalInputs''' |- | colspan="2" | Reads the state of a single digital input. 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'' |} {| 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" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Index |- | colspan="2" | Range: 0-3&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'' |} {| 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;" | '''SetAnalogInput''' |- | colspan="2" | Sets the state 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" | [[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'' |} {| 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'' |} ==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''' |- |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Modbus TCP/IP Properties |- |- | width="10%" align="center" | [[File:Fc9-type-17-icon.png]] | width="90%" | Network Comms Component |- | colspan="2" | Redirects communications via the selected component allowing different TCP/IP modules with different macros to work.&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | width="90%" | Status |- | colspan="2" | Shows the state of the network comms component to verify everything is configured correctly.&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | TCP/IP Port |- | colspan="2" | Port used for network communications Range: 0-65535&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Receive Buffer Size |- | colspan="2" | Maximum number of bytes the receive buffer can hold&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Receive Timeout |- | colspan="2" | Maximum time to wait for reply, in mS&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Slave Address |- | colspan="2" | Address of the slave. Range: 0-255&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Maintain Stats |- | 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; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Open and Close Socket |- | colspan="2" | &nbsp; |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation Properties |- |- | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | width="90%" | Label |- | colspan="2" | A text label to appear on the Modbus panel object.&nbsp; |- | 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 |- |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Starting Address |- | 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; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Number of Addresses |- | 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; |- | 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 |- |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Starting Address |- | 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; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Number of Addresses |- | 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; |- | 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 |- |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Starting Address |- | 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; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Number of Addresses |- | colspan="2" | Specifies how many 16-bit analogue inputs are available on the slave. Each address consumes two RAM Bytes.&nbsp; |- | 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 |- |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Starting Address |- | 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; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Number of Addresses |- | colspan="2" | Specifies how many 16-bit holding registers are available on the slave. Each address consumes two RAM Bytes.&nbsp; |}

Return to Component: Modbus TCP Slave (Comms: System).