Creating a TCP server - Industrial IoT 5.2.3.0 | BACnet | Modbus | OPC Client | SNMP Manager

Industrial IoT Plugin Guide 5.2.3.0

Product
Industrial IoT
Content type
Guides > Plugin and extension guides
Version
5.2
Release
5.2.3.0
ft:locale
en-US
Last updated
2024-07-11

Before you connect TCP client devices to Security Center, you must add a TCP server that can connect the devices to the plugin role.

Procedure

  1. From the Config Tool homepage, open the Plugins task.
  2. From the entity browser, select the Industrial IoT plugin role and click the Protocols tab.
  3. In the Protocols list, turn on the TCP Server switch.
  4. Under the TCP Servers list, click Add TCP server ().
  5. In the Name field, enter a name for the TCP Server.
  6. In the Transport section, enter the following:
    Port
    The TCP port associated to the TCP server. This port must be open on the Security Center main server.
    Messages delimitation method
    The method used to extract the messages from the data stream. Depending on the method used, multiple messages can be extracted from a single data stream. The methods are:
    String
    End of message delimiter
    The specified string is used as the end of message delimiter. What comes before the delimiter string is the message.
    Regex
    Regular expression
    A regular expression is used to extract the message from the data stream. The first capture group is the message.
    NOTE: To capture a value with a regular expression, a capture group (delimited by parentheses) must be present. The plugin role uses the value returned by the first capture group. If there is no capture group in the regular expression, no value is returned. For help with regular expression syntax, see the Regular Expression Cheat Sheet.
    None
    The entire data received in one transmission is the message.
    Send acknowledgment message
    When turned on, the configured acknowledgment message is sent to the TCP Client by the TCP server.
    Acknowledgment message
    The message that is sent to the TCP client when a message is received from the TCP Server. It can be either in text format or in valid hexadecimal values. This field is available when the Send acknowledgment message toggle is switched on.
  7. In the Data Format section, enter the following:
    Type
    The type of parsing that should be done on the segmented message. The only supported format is plain text.
    Encoding
    The encoding is used to convert the TCP stream bytes into strings. Choose between UTF-8 and ASCII.
    Create device automatically
    Select this option to have the TCP server automatically created as a device on the Devices page.
    Device ID regular expression
    If the device IDs are generated from the TCP server, you must provide a regular expression to capture the value of Device ID from the data message.
    NOTE: To capture a value with a regular expression, a capture group (delimited by parentheses) must be present. The plugin role uses the value returned by the first capture group. If there is no capture group in the regular expression, no value is returned. For help with regular expression syntax, see the Regular Expression Cheat Sheet.
    Config Tool displaying the TCP Server configuration in the Industrial IoT plugin role's Protocols page.
  8. Click Apply.

Results

The server is added to the list of TCP Servers. If you selected the Create device automatically option, a TCP Server device is also added to the entity browser under the Industrial IoT plugin role.

After you finish

Add the TCP devices.