Getting Started

1.Introduction

The DeviceSupervisor Agent (hereinafter referred to as DSA) is a data acquisition and cloud software that runs on gateways, offering users convenient data collection, data processing, Data on the cloud, and protocol conversion functionalities. It supports a variety of industrial protocols such as Modbus, ISO on TCP, EtherNet/IP, as well as power protocols like DNP3, IEC 60870, and IEC 61850.

Version 1.2.X of DSA is referred to as DSA 1.0, version 2.X.X is referred to as DSA 2.0, and version 3.X.X is referred to as DSA 3.0. This manual takes collecting PLC data and uploading it to EMQX's online MQTT server as an example to explain how DSA 3.0 implements PLC data collection and data uploading to the cloud through DSA.

The overall process is shown in the figure below:

1.1 Preparation of hardware equipment and its data collection environment

1.1.1 Hardware Wiring

1.1.1.1 Serial/Ethernet Wiring

Power on the gateway and connect the IG gateway and PLC according to the topology using an Ethernet/serial cable. (The topology diagram of the EC series and the IG series is the same, taking IG502 as an example)

2.Install and manage DSA

2.1 Install and run DSA

2.1.1 EC series

2.1.1.1 Installation and Running of Python App

To install and run Python App (hereinafter referred to as App) in the EC series, please refer to the following process:

Click the "Add" button and select the App package file to be installed, and then click Confirm.

After a successful import, you can view the imported App as shown in the following diagram:

2.1.1.2 Update Python App Runtime Configuration

If the installed App supports modifying the runtime method by importing a configuration file, you can follow the process below to update the App's runtime configuration: 

2.1.1.3 Update the version of Python App

Usually, if you need to update the version of the Python App, you only need to import the new version of the App on the following page. 

After the update is completed, it will appear as shown below:

2.1.1.4 View/Download Logs

View/download the logs during the running of the App in the interface as shown: 

After selecting the log level in "Level", logs lower than this level will not be displayed and saved. Log level sorting: ERROR>WARN>INFO>DEBUG>All.

To download the log, click the "Download" button.

2.1.2 IG Series

2.1.2.1 Installation and Running of Python App

To install and run a Python App (hereinafter referred to as the App) on the IG series, please refer to the following process: 

Before installing the App, ensure that the Python SDK is installed and the Python edge computing engine is enabled, as shown in the diagram below:

Click the "Add" button and select the App package file you need to install, then click confirm.

After a successful import, you can view the imported App as shown in the diagram below:

Check the enable box to run the App.

Once enabled, the App will run on IG series products and automatically run every time the device is powered on.

2.1.2.2 Update Python App Runtime Configuration

If the installed App supports modifying the running method by importing a configuration file, click the "Import Configuration" button and select the configuration file you need to import, then click confirm.

After a successful import, restart the App, and once restarted, it will run according to the imported configuration file.

2.1.2.3 Update the version of Python App

To update the version of a Python App, you typically only need to import the new version of the App.

After the update is completed, the interface will appear as shown in the diagram below:

2.1.2.4 View/Download Logs

View/download the logs during the running of the App in the interface as shown:

After setting the log level, logs higher than this level will be displayed and saved. The log level is set in the Parameter Settings interface, and the log level is sorted: ERROR>WARN>INFO>DEBUG

3. Quick start

This tutorial takes the Modbus TCP protocol as an example to introduce a simple example of how DSA can quickly start collecting device data and upload the data to the EMQX MQTT public cloud service, as well as receive MQTT messages and write values.

3.1 Enable Modbus Simulator

The tutorial uses ModRSsim2 as the Modbus TCP Slave. Run the ModRSsim2.exe software and configure the port number as shown in the diagram:

3.2Configure Southbound Controller

After running device_supervisor, add a southbound controller. In the controller protocol, select the Modbus TCP protocol and configure the relevant parameters.

1. Name: Controller name, for example: Modbus TCP
   

1. Controller Protocol: Select Modbus TCP
   

1. IP Address: Fill in the IP address of the PC where the Modbus simulator is installed;
   

1. Port Number: Default port 502;
   

1. Slave Address: Default is sufficient.
   

3.3 Add Measuring Point

In the list of measuring points, add the device measuring points needed for collection and configure the measuring point's name, address, data type, etc., as shown in the diagram below: 

Once configured, click “Confirm” to add the measuring points. After creating the measuring points, wait a few seconds; if the controller connection status is still disconnected, perform the following actions to find the reason:

1. Check if the IP and port were entered correctly when creating the controller.
2. Check if the gateway can access the IP and port of the simulator.
   

3.4 Configure MQTT Cloud Service 

Enable the MQTT cloud service and configure the server address, MQTT client ID, port number, and other parameters as shown in the diagram:

1. Server Address: MQTT server address, for example, EMQX MQTT public cloud server address broker.emqx.io

1. Client ID: Custom client ID, which is the unique identifier for connecting to the server.

1. Port Number: MQTT server port number, for example, EMQX MQTT public cloud server port 1883

1. Check if the device can access the Internet;
2. Check if the server address and port and other configuration information are correct.
   

If the connection drops after a while, check if the MQTT client ID has been used, or consider changing the client ID.

3.5 Configure MQTT Publish/Subscribe Scripts

After the MQTT connection is successful, add a publishing script as shown below:

1. Name: Custom publishing script name
   

1. Trigger Source Type: For example, select "Measuring Point Group"
   

1. Group/Label: Select the group where the measuring point is located. The example uses the default group.
   

1. Topic: Publish topic, the example uses inhand_pub
   

1. Qos(MQTT): supports 0, 1, 2
   

1. QuickFunction: Just use the default

As shown in the figure below, add a subscription script:

1. Name: Custom publishing script name
   

1. Topic: Publish topic, the example uses inhand_pub
   

1. Qos(MQTT): supports 1
   

1. Payload type: Select Plaintext in the tutorial
   

1. QuickFunction:

3.6View data/write values on EMQX public cloud client

The tutorial uses the client tool provided by the EMQX official website to connect to the public EMQX broker to view the data uploaded by the gateway to the MQTT Broker.

On the EMQX official website (https://www.emqx.com/zh/mqtt/public-mqtt5-broker), choose to use the MQTT client tool online for testing

Click "New Connection" in the pop-up window that opens. After filling in the Name field in the pop-up interface, the rest of the configuration does not need to be modified. Finally, click "Connect".

In the MQTT client, write the value of the simulator collected by the gateway, as shown in the following figure, modify the value of the measurement point "WORD" collected by the gateway to 10, Paylaod:{"WORD": 10}

4. Concept

DSA Internal System Overview Block Diagram

1. Controller:The controller refers to the component on the gateway page that enables and manages various collection protocols.

1. (Southbound) Driver:The (southbound) driver refers to the software program in the gateway that communicates with PLC devices. It is usually developed specifically for certain manufacturers or device types and communicates using the device manufacturer's management protocols or APIs, such as Modbus, OPC, etc.

1. Measuring Point:A measuring point refers to a collection point for PLC devices configured on the gateway.

1. Grouping:Grouping refers to dividing measuring point data or alarm items into different groups within the gateway according to different needs and application scenarios for easier management.

1. Protocol Conversion:Protocol conversion refers to forwarding data collected from the southbound direction through other protocols.

1. Event Bus:The event bus refers to the message channel used for communication between various services within the gateway using MQTT messages.

1. Data Preprocessing: Divided into alarms and data transformation.

1. QuickFunction:QuickFunction refers to script functions configured within the gateway.

1. Historical Database:Cache of historical data collected at measuring points
   

Functional characteristics

1. Measuring point monitoring

1.1 Monitoring list

In the "Monitoring List" interface, you can add controllers and measuring points to collect PLC data, and view the status and configuration information of the controller as well as data collection information.

On the current page, the controller can be edited, copied, deleted, etc.; the measuring points can be added, imported, exported, deleted, etc.

The page display of the monitoring list is as shown in the figure:

1.1.1 Add/Edit Controller

Click the "Add"/"Edit" button, select the controller protocol, such as Modbus RTU, and configure the controller's slave address, communication method, polling cycle and other parameters on the add controller page. Note: Controller names cannot be repeated.

In the advanced settings, the controller's message processing can be configured. For example, in the advanced settings of the Modbus RTU controller, parameters such as byte order, timeout time, and communication time can be configured.

1.1.2 Copy Controller

In industrial settings, there are often many similar PLC configuration parameters and measuring point configurations. To achieve rapid configuration, we have introduced the "Copy Controller" function. This feature allows us to quickly add controllers and measurement point configurations with similar settings, avoiding repetitive configuration tasks. Click on the "..." in the top right corner of the controller card to display more controller actions, then click "Copy". After configuring one controller, you can quickly add a second one; the copy controller will duplicate all the measurement points under the controller.

After clicking the "Copy" button, you can modify the differing configurations as needed, such as the controller name, slave address, etc., and then submit.

Upon completion of the copy, as shown in the diagram, the system will automatically generate measurement points and controller information identical to the first controller:

1.1.3 Disable/Enable Controller

When collecting data from multiple PLC devices and the gateway controller status or collected data is abnormal, we enable only the problematic controller for easy log viewing and real-time communication packet inspection. Click on the "..." in the top right corner of the controller card to display more controller actions, and select "Disable". After that, the controller will no longer perform data collection and reporting.

After disabling, the controller card will turn gray, as shown in the diagram.

When you want to re-enable the controller, click on the "..." in the top right corner of the controller card and select "Enable". The controller will then resume data collection and reporting.

1.1.4 Real-Time Communication Messages

When the controller status displays as abnormal or there is abnormal data collection, viewing the real-time communication messages between the gateway controller and the PLC devices becomes crucial. DSA supports displaying channel real-time communication messages. Select a controller at will, click "..." in the upper right corner of the controller card, and click "Real-time Communication Messages" to display all communication message interactions of the current channel.For example, if two Modbus RTU protocol controllers are enabled and both use an RS485 communication port, the real-time communication messages will show the communication messages of both controllers.

The display effect of real-time communication messages is as follows (Note: If you need to download communication messages, you need to enable "Store Communication Messages" in the advanced settings of the controller configuration before the "Download" button will be displayed. Communication messages of all controllers The text is displayed and saved in HEX format):

1.1.5 Add Measuring Point

In the "Measuring Point List," you can add measuring points to collect data from PLC devices. Click the "Add" button, and in the pop-up box, configure the measuring point parameters, such as adding a measurement point under a Modbus RTU protocol controller and configuring the measurement point name, address, data type, etc. (Note: The measurement point name must be unique within its controller).

In the "Measuring Point List," the "Import" button allows you to import the measurement points from a CSV file into the current gateway; the "Export" button enables you to export the current gateway's measurement point configurations to a CSV file. For details on the specific measurement point CSV file, refer to the Measuring Point CSV File Parameter Description.

1.2 Group

Group allows you to manage measuring points in the monitoring list by dividing them into groups. After the measuring points are grouped, the storage of historical data and measuring point reporting intervals are managed according to the configured groups. If you need to configure different reporting intervals for the measuring points or need to report corresponding data of the measuring points according to different MQTT topics, you can add a new group to manage the measuring points with different requirements. (Note: The default group cannot be deleted)

The group interface is shown in the figure:

For specific group CSV files, please refer to the Grouping CSV File Parameter Description

Add a new group on the group page. The interface is as follows:

Add group parameters Introduction:

1. Name: Group name
   

1. Reporting Interval: the reporting interval of the measuring point in the group.
   

1. Periodically Upload Onchange Data :When enabled, Onchange data with unchanged values will also upload data according to the Onchange reporting cycle. The default is off.
   

1. Onchange Reporting Interval: A fixed reporting interval for Onchange data.
   

After adding a group, when adding a measuring point, you can choose to associate the measuring point with the group or select the measuring point in the list of measuring points to add to the specified group. The measuring points in the group will report data according to the reporting interval of the group.

Click "Export Historical Data" to export the group's historical data in CSV format

Click "Clear Historical Data" to clear the historical data stored in this group.

1.3 Historical Database

The historical database is used to store the historical data of the measuring points. After enabling the "Store Historical Data" function in the configuration of the measuring points, the data of the measuring points can be stored in the historical database. The historical data of measuring points is stored according to the groups they belong to. This arrangement makes it more convenient to locate and export historical data for specific measuring points.

2. Alarm

2.1 Real-time Alarms

After configuring alarm rules and when alarms are triggered, the real-time alarm page will display all triggered alarm items. 

In the real-time alarm table, some parameters from the alarm configuration, such as "Name," "Controller," "Alarm Level," etc., will be shown.

1. Status: The current trigger status of the alarm item, displayed as "Triggered"
   
2. Value: The value at the moment the alarm was triggered
   
3. Time: The time when the alarm was triggered
   
4. Action: An option to navigate to the "Historical Alarms" page for more details

Below is an example of a real-time alarm display interface.

2.2 Alarm Rules

Alarm rules can help us monitor the value of measuring points on the gateway side, and remind us in time when it exceeds the normal range. For example, in industrial scenarios, the range of voltage and current values and the start and stop status of some equipment need to be focused on. When we configure the alarm rules for collecting these data measuring points on the gateway side, if an alarm is triggered, the MQTT cloud service can be used to report the notification in time to avoid unnecessary losses.

On the alarm rules page, configure the alarm rules by clicking the "Add" button. In the pop-up box, set up the alarm rule parameters. The parameters include:

1. Name: Alarm name
2. Controller: The controller to which the alarm measuring point belongs
3. Measuring point name: The name of the measuring point that triggered the alarm
4. Alarm level: From low to high support "Remind", "Warning", "Secondary", "Important", "Serious"
5. Alert Condition:

1. Alarm content: the alarm content
2. Alarm label: The alarm label is used to classify the alarm and facilitate quick selection when the alarm is uploaded to the cloud
   

The following picture shows an alarm with alarm level of alert, which belongs to the default tag. This alarm is generated when the value of the measuring point is >30 and <50; When it is not in this range, no alarm will be generated or the alarm will be eliminated.

In the "Alarm Rules" page, "Import" and "Export" CSV files of alarm rules refer to the Alarm Rules CSV file parameter description

The "Add to Label" function can help us quickly switch multiple alarm items to the alarm label. The following picture is the batch addition of alarm items to the "group_test" alarm label.

2.3 History Alarms

The historical alarms page can help us view the history of all alarm items, including triggered and recovered alarms. This function can help us understand the reason and time when the gateway side triggers/recovers the alarm items.

In the current page, you will see information about all the historical alarms that have been triggered and recovered.

The current page displays parameters that include those configured on the "Alarm Rules" page, such as "Name," "Controller," "Alarm Level," and "Alarm Content." Other parameters in the table are as follows:

1. "Status" : There are two states, which are "triggered" and "Restored". "Triggered" means that the current alarm item is triggering an alarm; "Restored" means that the current alarm item has returned to normal.
2. "Value" : The value of the alarm item at the moment the current state has been triggered or has been restored.
3. "Time" : The time when the alarm was triggered or restored.
4. "Operation" : Click the "Details" button to see the detailed information when the current alarm item is triggered or restored, and the "Delete" button can delete the current alarm item in the history of alarms.

2.4 Alarm Label

The alarm label can help us manage the alarm items. When the alarm item triggers an alarm, the MQTT message needs to be reported. Directly selecting the alarm label can quickly include all the alarm items under the alarm label. And when we need to report MQTT messages with different topics, we can add an alarm label to group different alarm items, and then select the corresponding label in different MQTT topics.

Go to the alarm label page to view the content of the alarm label.

In the table on the current page, there will be an alarm label named "default" by default (Note: this label cannot be deleted, and the rest of the added alarm labels can be deleted).

After clicking the "Add" button, configure the name of the alarm label in the pop-up box. (Note: This name is unique throughout the alarm label and cannot be repeated).

In the "Alarm Label" page, "Import" and "Export" Alarm rule CSV files, please refer to the Alarm label CSV file parameter introduction

Note: When deleting a label, the alarm items belonging to the current label in the "Alarm Rule" will be deleted together

3. Cloud

In industrial scenarios, the collected data needs to be reported to the cloud platform to help enterprises achieve centralized management, intelligent analysis and remote management of data. In DSA, we can enable and configure corresponding cloud services in the cloud service interface to help customers quickly connect to use mainstream cloud services.

3.1 MQTT Cloud Services

In the current page, you can view the connection status and configuration information of the current MQTT cloud service, and you can edit, import, export and other operations on the MQTT cloud service. Click the "Add" button to add a new MQTT cloud platform. For example, when we need to report data to multiple cloud platforms at the same time, we can add a new MQTT platform to connect to the cloud platform to report data. (Note: the name of the MQTT platform cannot be repeated, and the name of the default MQTT cloud platform is "Default"). As shown in the figure, add an MQTT platform with the name "test" :

The interface after adding is as shown in the figure:

After checking Enable cloud services, MQTT cloud services can be selected in the "Cloud Types" of the configuration interface. "Cloud Types" : The currently supported cloud platforms are "MQTT", "MQTT SparkPlugB", "iSCADA Cloud", "White Eagle Energy Manager", "Alibaba Cloud", "AWS IoT", "Azure IoT".

1. "Clear Offline Cache" : This function can clear MQTT messages that failed to be published after the MQTT Cloud service went offline. For example, when we debug the MQTT function and the offline data generated do not want to be reported to the cloud platform, we can use this function to clear the offline data (Note: only messages with Qos greater than or equal to 1 are cached).
   

1. "Import" : Select the configuration file of the MQTT cloud service to import the MQTT configuration in the file and the script in the message management. This function can quickly configure and enable the cloud service. For example, when configuring the same cloud service on different gateways, the configuration file exported after configuring one gateway can be directly imported into other gateways for use.
   

1. "Export" : Click to export the configuration of the cloud and the script in the message management to a "cloud.json" file.
   

1. "Cloud Measuring Point Name" : The name of the measuring point reported to the cloud platform is reported with the name in the current configuration item
   

1. "Mute" : After muted, the measuring point will no longer be reported to the cloud platform
   

1. "Import" and "Export" can respectively import the configuration information of the upper cloud measuring point Settings to the current gateway, or export the upper cloud measuring point information of the current gateway (note: the CSV file in the upper cloud measuring point Settings only saves the change of the name of the upper cloud measuring point or the muted measuring point). For the specific introduction of CSV file parameters, please refer to the Description of CSV fileparameters for Settings of Upper cloud measuring points

1. "Message Management" : Here you can add publish script and subscribe script. Only when the script is added, can the message be published to the cloud platform and subscribe to the message of the cloud platform (Note: after enabling the MQTT SparkPlugB cloud service, the message is added by default and cannot be added but can only be modified)

4. Protocol

In industrial settings, data often exhibits diversity and complexity, and different application scenarios may require different communication protocols to meet their specific needs. DSA's protocol conversion functionality enables data to be uploaded in various application scenarios through different protocols. For example, using the Modbus TCP Slave protocol, data collected by controllers can be forwarded to SCADA servers.

The status page allows you to view the connection and running status of the current protocol (Note: not all protocols have status pages, such as BACnet Server protocol)

The configuration page can configure and view the connection parameters and add the mapping table function for the current protocol. For example, in the Modbus TCP Slave configuration interface, you can configure the Modbus TCP Slave port number, the maximum number of connections and other parameters. In the mapping table, you can perform add/edit, import/export and other operations.

For the specific mapping table CSV file, please refer to the Mapping table CSV file parameter introduction

For specific protocol configuration, please refer to the Appendix: Protocol conversion

5. Parameter Settings

In the parameter setting screen, you can configure the general Settings of the gateway. Such as setting gateway serial port parameters, storage configuration and custom parameters.

5.1Serial port Settings

In the serial port Settings page, you can configure the parameters of the serial port, such as the configuration of the serial port baud rate, data bits, etc.

The parameters of serial port Settings are shown in the figure:

The parameters are explained as follows (same for RS232 and RS485) :

1. Baud Rate: support 300, 1200, 2400, 4800, 9600, 19200, 39400, 57600, 115200, 230400. The default is 9600

1. Data Bits: 8 and 7 are supported. The default is 8

1. Parity: supports no check, odd check and even check. The default is no parity

1. Stop bit: 1 and 2 are supported. The default is 1
   

Click the "Submit" button to save your configuration after you've modified it.

5.2 Storage Configuration

In the storage configuration interface, you can configure the log storage of the gateway, the MQTT offline data storage and the communication packet storage of the controller.

The parameters of storage configuration are shown in the figure:

The parameters are explained as follows:

1. Log level: The log level of the log output, the log below this level will not be displayed in the log. The log level from lowest to highest supports DEBUG,INFO,WARNING,ERROR. The default is INFO
   

1. Historical alarm max: The maximum number of historical alarms in an alarm. Default 2000
   

1. Offline Data storage Method: Support USB,SD card, gateway storage. The default is gateway storage
   

1. Offline Data Max: The maximum number of offline data storage. Default 10000
   

1. Offline Data Upload Period: The frequency of offline data reporting after offline data and other MQTT connections. Default 200ms
   

1. Offline data retransmission policy: Support "retransmit all the time" and "retransmit a specified number of times and then discard". The default is "always retransmit". "Always retransmit" : The offline data will be retransmitted until the response from the server is received. "Retransmit the specified number of times and then discard" : After the specified number of retransmissions, if the response from the server is not received, the offline data will be discarded and the next one will be sent.
   

1. After selecting "retransmit and discard after a specified number of times", two options will appear:

1. Communication Message Storage Method: Support USB,SD card, gateway storage. The default is gateway storage
   

1. Max Stored Communication Messages:2000 by default

After modifying the configuration, click the "Submit" button to save the configuration. If you do not want to save the current changes, click the "Reset" button to restore the last saved configuration

5.3 Custom Parameter

Custom parameters are to define some global parameters, which can be used in cloud service configuration, fast function scripts. Set a global parameter to use, you can modify it more conveniently and quickly. For example, when a parameter needs to be used in multiple custom fast functions, if a custom parameter is used, then when the parameter value is changed, only the parameter value of the custom parameter interface is changed.

5.3.1Configure custom parameters

The parameters for custom parameters look like this:

By default, there are two parameters (note: these two parameters cannot be deleted or modified) :

1. SN: The SN code of the device

1. MAC: The MAC address of the device
   

If you want to add custom parameters, click the "Add" button, fill in the "Parameters" and "Parameters value" in the pop-up window, and click the "Confirm" button to add the modified value.

The "Import" and "Export" buttons can import the custom parameter configuration file to the current gateway and export the custom parameter of the current gateway into a configuration file respectively. For the specific CSV file, please refer to: Custom parameters CSV file parameter introduction

5.3.2Use custom parameters

You can add your own common parameters in custom parameters to be used as wildcards in cloud services and custom fast functions. The method is ${parameter name}, as shown in the following figure:

Custom parameters can also be used in scripts to get all custom parameters via the get_global_parameter() function.

An example script is as follows: (This script can output all the custom parameters in a log)

The output will be:

6. Custom QuickFunctions

In the custom quickfunctions screen, you can add Python scripts to implement private logic (new scripts are enabled in a threaded manner). Custom fast function scripts support three trigger modes: periodic trigger; Local Subscription Message Trigger; QuickFunction start trigger.

The custom quick function interface button is introduced as shown below:

6.1 Periodic Trigger

A period-triggered quickfunction will trigger the script to run after the period ends

Below is a custom quickfunction that adds a 10-second cycle trigger, using the default script. This script will log "Timer start" and "Timer end" every 10 seconds.

The instructions for each parameter are as follows:

1. Name: Any non-repeating name

1. Mode: Select periodic trigger

1. Periodic: The period that triggers this quickfunction. Units can be chosen: hours, minutes, seconds, the default is seconds.

1. Entry Function: Stay the same as the entry function name in the script

1. QuickFunction: Use Python code to customize the task logic of this periodic trigger script.
   

6.2Local Subscription Message Trigger

Local subscribe message trigger triggers the run script once when subscribed to the Topic that needs to be subscribed. The Topic on the gateway Event Bus can be looked from the  Event BUS

Below is the local subscribe message fast function that adds a subscribe controller write value message. This script will be triggered when a value is written to the controller. With the default script, the write value message will be printed to the log

The parameters are described as follows:

1. Name: Any non-repeating name
   

1. Mode: Select local subscribe message to trigger
   

1. Subscribe to Topic: Subscribe to the Topic of gateway internal messages
   

1. Entry Function: Keep the same name as the entry function in the script
   

1. Function code: Use Python code to customize the task logic of this periodic trigger script.

6.3QuickFunction start trigger

The QuickFunction start trigger, only when the fast function start is complete, triggers the run script once.

The diagram below shows how to add a quickfunction in the QuickFunction Start Trigger mode. Using the default script, "QuickFunction start" will be printed in the logs when the quickfunction is initiated.

The parameters are described as follows:

1. Name: Any non-repeating name
2. Mode: Select Quickfunction start trigger
   
3. Entry Function: Keep the same name as the entry function in the script
   
4. QuickFunction: Use Python code to customize the task logic of this periodic script.

Appendix: List of southbound drivers

AllenBrandly (Rockwell)

EtherNet/IP (CompactLogix)

EtherNet/IP is an industrial Ethernet protocol, which is used to realize communication and data exchange between devices in industrial control systems. It is based on the standard TCP/IP protocol stack, and added to it the application layer protocol used in the field of industrial automation, providing the support of real-time, reliability and security.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
2. Protocol: Select EtherNet/IP (CompactLogix)
3. IP Address: IP address
4. Port: Port information
5. Polling Interval: the time interval of data collection (seconds), for example, set to 10S, then all the measuring points under the controller are polled every 10S
6. Enable Multiple polling Interval: Once enabled, you can configure an additional polling interval and select certain measuring points under the controller to use the polling interval. This function can be used to distinguish the measuring points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.
7. Polling Interval 2: It is an additional polling interval (in seconds) that needs to be set after enabling multiple polling interval;
8. Description: You can add comment information to this controller
   

1. Timeout Settings:
   

1. Communication Message Settings:
   

Adding measuring points

1. Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
2. Address: the address of the measuring point
3. Data type: Measuring point data type, including:
1. BIT: 0 or 1
2. BYTE: An 8-bit unsigned number
3. SINT: 8-bit signed number
   
4. WORD: 16-bit unsigned integer
5. INT: 16-bit signed integer
6. DWORD: 32-bit unsigned integer
7. DINT: 32-bit signed integer
8. FLOAT: 32-bit floating point number
9. STRING: 8-bit string
10. BCD16:16-bit BCD code
4. Read Bit Data: When the data type is selected other than BIT,FLOAT,STRING, the value of any bit data in the integer can be read when enabled.
5. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
6. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
7. Decimal Places: The length of the data after the decimal point when the data type is FLOAT, the maximum is 6 digits
8. Read and write permissions:
1. Read: read-only, not writable
2. Read/Write: Readable and writable
3. Write: Only write, not read
9. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
10. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
11. Unit: Measuring point unit
12. Description: Description of the measuring point
13. Group: The group to which the measuring point belongs
14. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measuring point belongs, and the historical data will be stored according to the storage policy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
15. Data Calculation: When the data type of the measuring point is not BIT or STRING, and the bitwise value is not enabled, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
16. No: No computation is performed, the raw data value collected is used
17. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
18. Decimal Places: The number of decimal places that need to be retained after the operation
19. Data High Limit: The upper limit of the data of the measuring point
20. Data lower Limit: the lower limit of the data at the measuring point
21. High Limit Of Proportion: the upper limit of the data after the proportion operation
22. Lower Limit Of Proportion: The lower limit of the data after the scale operation
23. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
24. Decimal Places: The number of decimal places to be retained after the operation
25. Magnification: The multiplier that needs to be scaled up or down
26. Offset: The data value that needs to be increased or decreased after the multiplier operation
27. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
28. Start Bit: The bit offset at which the intercept of the original data begins
29. End Bit: The bit offset that ends the interception of the original data
30. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
31. Decimal Places: The number of decimal places that need to be retained after the operation
32. Magnification: The multiplier that needs to be scaled up or down
33. Offset: The data value that needs to be increased or decreased after the multiplier operation
34. PT: Additional PT multiplier
35. CT: Additional CT magnification
    
36. Value mapping: Configurable measuring points for specific values converted to other values.
    
37. Source Value: The raw value of the collected measuring point.
38. Target Value: The expected value of the converted measuring point.
39. Enable Package Reporting: This field is visible when the controller enables group packet reporting. When the measuring point is enabled, it will report data in accordance with the packet reporting logic set by the controller in addition to the group reporting data
40. Example description of measuring point address:

EtherNet/IP (Micro)

EtherNet/IP (Micro) is a variant of the EtherNet/IP protocol designed for smaller devices and resource-constrained environments. Compared with the standard EtherNet/IP protocol, EtherNet/IP (Micro) uses a more simplified message format and lightweight communication mechanism in the communication process to reduce resource consumption and communication overhead.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
   

1. Protocol: Select EtherNet/IP (MIcro)
   

1. IP Address: IP address
   

1. Port: Port information
   

1. Polling Interval: the time interval of data collection (seconds), for example, set to 10S, then all the measuring points under the controller are polled every 10S
   

1. Enable Multiple Polling Interval: Once enabled, you can configure an additional polling interval and select certain measuring points under the controller to use the polling interval. This function can be used to distinguish the measuring points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.
   

1. Polling Interval 2: It is an additional polling interval (in seconds) that needs to be set after enabling multiple polling interval;
   

1. Description: You can add comment information to this controller
   

1. Timeout Settings:
   

1. Slot:PLC slot
   

1. Communication Message Settings:
   

Adding measuring points

1. Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
   
2. Address: the address of the measuring point
   
3. Data type: Measuring point data type, including:
   
1. BIT: 0 or 1
   
2. BYTE: An 8-bit unsigned number
   
3. SINT: 8-bit signed number
   
4. WORD: 16-bit unsigned integer
5. INT: 16-bit signed integer
   
6. DWORD: 32-bit unsigned integer
   
7. DINT: 32-bit signed integer
   
8. BCD16:16-bit BCD code
   
9. FLOAT: 32-bit floating point number
   
10. STRING: 8-bit string
    
11. BCD16:16-bit BCD code
    
4. Read Bit Data: When the data type is selected other than BIT,FLOAT,STRING, the value of any bit data in the integer can be read when enabled.
   
5. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
   
6. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
   
7. Decimal Places: The length of the data after the decimal point when the data type is FLOAT, the maximum is 6 digits
   
8. Read and write permissions:
   
1. Read: read-only, not writable
   
2. Read/Write: Readable and writable
   
3. Write: Only write, not read
   
9. Mode:
   
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
   
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
   
3. Never: Only used locally, no need to upload data from the cloud
   
10. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
    
11. Unit: Measuring point unit
    
12. Description: Description of the measuring point
    
13. Group: The group to which the measuring point belongs
    
14. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measuring point belongs, and the historical data will be stored according to the storage policy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
    
15. Data Calculation: When the data type of the measuring point is not BIT or STRING, and the bitwise value is not enabled, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
    
16. No: No computation is performed, the raw data value collected is used
    
17. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
    
18. Decimal Places: The number of decimal places that need to be retained after the operation
    
19. Data High Limit: The upper limit of the data of the measuring point
    
20. Data lower Limit: the lower limit of the data at the measuring point
    
21. High Limit Of Proportion: the upper limit of the data after the proportion operation
    
22. Lower Limit Of Proportion: The lower limit of the data after the scale operation
    
23. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
    
24. Decimal Places: The number of decimal places to be retained after the operation
    
25. Magnification: The multiplier that needs to be scaled up or down
    
26. Offset: The data value that needs to be increased or decreased after the multiplier operation
    
27. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
28. Start Bit: The bit offset at which the intercept of the original data begins
    
29. End Bit: The bit offset that ends the interception of the original data
    
30. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
    
31. Decimal Places: The number of decimal places that need to be retained after the operation
    
32. Magnification: The multiplier that needs to be scaled up or down
    
33. Offset: The data value that needs to be increased or decreased after the multiplier operation
    
34. PT: Additional PT multiplier
    
35. CT: Additional CT magnification
    
36. Value mapping: Configurable measuring points for specific values converted to other values.
    
37. Source Value: The raw value of the collected measuring point.
    
38. Target Value: The expected value of the converted measuring point.
    
39. Enable Package Reporting: This field is visible when the controller enables group packet reporting. When the measuring point is enabled, it will report data in accordance with the packet reporting logic set by the controller in addition to the group reporting data
    
40. Example description of measuring point address:
    

EtherNet/IP (MicroLogix)

EtherNet/IP (MicroLogix) refers to the use of EtherNet/IP protocol for communication in the MicroLogix controller family

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
   

1. Protocol: Select EtherNet/IP (MIcroLogix)
   

1. IP Address: IP address
   

1. Port: Port information
   

1. Polling Interval: the time interval of data collection (seconds), for example, set to 10S, then all the measuring points under the controller are polled every 10S
   

1. Enable Multiple polling Interval: Once enabled, you can configure an additional polling interval and select certain measuring points under the controller to use the polling interval. This function can be used to distinguish the measuring points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.
   

1. Polling Interval 2: It is an additional polling interval (in seconds) that needs to be set after enabling multiple polling interval;
   

1. Description: You can add comment information to this controller
   

1. Timeout Settings:
   

1. Communication Message Settings:
   

Adding measuring points

1. Address: the address of the measuring point
2. Data type: Measuring point data type, including:
1. BIT: 0 or 1
2. BYTE: An 8-bit unsigned number
3. SINT: 8-bit signed number
4. WORD: 16-bit unsigned integer
5. INT: 16-bit signed integer
6. DWORD: 32-bit unsigned integer
7. DINT: 32-bit signed integer
8. FLOAT: 32-bit floating point number
9. STRING: 8-bit string
3. Read Bit Data: When the data type is selected other than BIT,FLOAT,STRING, the value of any bit data in the integer can be read when enabled.
4. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
5. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
6. Decimal Places: The length of the data after the decimal point when the data type is FLOAT, the maximum is 6 digits
7. Read and write permissions:
1. Read: read-only, not writable
2. Read/Write: Readable and writable
3. Write: Only write, not read
8. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
9. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
10. Unit: Measuring point unit
11. Description: Description of the measuring point
12. Group: The group to which the measuring point belongs
13. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measuring point belongs, and the historical data will be stored according to the storage policy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
14. Data Calculation: When the data type of the measuring point is not BIT or STRING, and the bitwise value is not enabled, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
15. No: No computation is performed, the raw data value collected is used
16. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
17. Decimal Places: The number of decimal places that need to be retained after the operation
18. Data High Limit: The upper limit of the data of the measuring point
19. Data lower Limit: the lower limit of the data at the measuring point
20. High Limit Of Proportion: the upper limit of the data after the proportion operation
21. Lower Limit Of Proportion: The lower limit of the data after the scale operation
22. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
23. Decimal Places: The number of decimal places to be retained after the operation
24. Magnification: The multiplier that needs to be scaled up or down
25. Offset: The data value that needs to be increased or decreased after the multiplier operation
26. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
27. Start Bit: The bit offset at which the intercept of the original data begins
28. End Bit: The bit offset that ends the interception of the original data
29. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
30. Decimal Places: The number of decimal places that need to be retained after the operation
31. Magnification: The multiplier that needs to be scaled up or down
32. Offset: The data value that needs to be increased or decreased after the multiplier operation
33. PT: Additional PT multiplier
34. CT: Additional CT magnification
35. Value mapping: Configurable measuring points for specific values converted to other values.
36. Source Value: The raw value of the collected measuring point.
37. Target Value: The expected value of the converted measuring point.
38. Enable Package Reporting: This field is visible when the controller enables group packet reporting. When the measuring point is enabled, it will report data in accordance with the packet reporting logic set by the controller in addition to the group reporting data
39. Example description of measuring point address:

EtherNet/IP (Unconnected)

EtherNet/IP (Unconnected) refers to a method of communication used in the EtherNet/IP protocol. Unconnected means that there is no need to establish a persistent connection when communicating, and each communication is independent and immediate. This method is similar to the connectionless communication method in the UDP protocol, which is more lightweight and flexible, and is suitable for some scenarios with less stringent real-time requirements.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
2. Protocol: Select EtherNet/IP (Unconnected)
3. IP Address: IP address
4. Port : Port information
5. Polling Interval: the time interval of data collection (seconds), for example, set to 10S, then all the measuring points under the controller are polled every 10S
6. Enable Multiple Polling Interval: Once enabled, you can configure an additional polling interval and select certain measuring points under the controller to use the polling interval. This function can be used to distinguish the measuring points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.
7. Polling Interval 2: It is an additional polling interval (in seconds) that needs to be set after enabling multiple polling interval;
8. Description: You can add comment information to this controller
   

1. Timeout Settings:
   

1.      Slot:PLC slot
2. Communication Message Settings:

Adding measuring points

1. Symbol: the address of the measuring point
2. Data type: Measuring point data type, including:
1. BIT: 0 or 1
2. BYTE: An 8-bit unsigned number
3. SINT: 8-bit signed number
4. WORD: 16-bit unsigned integer
5. INT: 16-bit signed integer
6. DWORD: 32-bit unsigned integer
7. DINT: 32-bit signed integer
8. FLOAT: 32-bit floating point number
9. STRING: 8-bit string
3. Read Bit Data: When the data type is selected other than BIT,FLOAT,STRING, the value of any bit data in the integer can be read when enabled.
   
4. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
5. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
6. Decimal Places: The length of the data after the decimal point when the data type is FLOAT, the maximum is 6 digits
7. Read and write permissions:
1. Read: read-only, not writable
2. Read/Write: Readable and writable
3. Write: Only write, not read
8. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
9. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
10. Unit: Measuring point unit
11. Description: Description of the measuring point
12. Group: The group to which the measuring point belongs
13. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measuring point belongs, and the historical data will be stored according to the storage policy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
14. Data Calculation: When the data type of the measuring point is not BIT or STRING, and the bitwise value is not enabled, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
15. No: No computation is performed, the raw data value collected is used
16. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Data High Limit: The upper limit of the data of the measuring point
3. Data lower Limit: the lower limit of the data at the measuring point
4. High Limit Of Proportion: the upper limit of the data after the proportion operation
5. Lower Limit Of Proportion: The lower limit of the data after the scale operation
17. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
1. Decimal Places: The number of decimal places to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
18. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
1. Start Bit: The bit offset at which the intercept of the original data begins
2. End Bit: The bit offset that ends the interception of the original data
19. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
4. PT: Additional PT multiplier
5. CT: Additional CT magnification
20. Value mapping: Configurable measuring points for specific values converted to other values.
1. Source Value: The raw value of the collected measuring point.
2. Target Value: The expected value of the converted measuring point.
21. Enable Package Reporting: This field is visible when the controller enables group packet reporting. When the measuring point is enabled, it will report data in accordance with the packet reporting logic set by the controller in addition to the group reporting data
22. Example description of measuring point address:

*SLC Net

SLC Net stands for "Symbian Limited Compatibility Network" and it is the network communication protocol for Symbian OS. Symbian OS is a kind of operating system that has been widely used in smart phones and mobile devices. It provides a wealth of functions and application support.

Adding controllers

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
2. Protocol: Select *SLC Net
3. IP Address: IP address
4. Port: Port information
5. Polling Interval: the time interval of data collection (seconds), for example, set to 10S, then all the measuring points under the controller are polled every 10S
6. Enable Multiple Polling Interval: Once enabled, you can configure an additional polling interval and select certain measuring points under the controller to use the polling interval. This function can be used to distinguish the measuring points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.
7. Polling Interval 2: It is an additional polling interval (in seconds) that needs to be set after enabling multiple polling interval;
8. Description: You can add comment information to this controller
   

1. Timeout Settings:
   

1. Communication Message Settings:

Adding measuring points

1. Address: the address of the measuring point
2. Data type: Measuring point data type, including:
1. BIT: 0 or 1
2. BYTE: An 8-bit unsigned number
3. SINT: 8-bit signed number
4. WORD: 16-bit unsigned integer
5. INT: 16-bit signed integer
6. DWORD: 32-bit unsigned integer
7. DINT: 32-bit signed integer
8. FLOAT: 32-bit floating point number
9. STRING: 8-bit string
10. BCD16:16-bit BCD code
3. Read Bit Data: When the data type is selected other than BIT,FLOAT,STRING, the value of any bit data in the integer can be read when enabled.
4. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
5. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
6. Decimal Places: The length of the data after the decimal point when the data type is FLOAT, the maximum is 6 digits
7. Read and write permissions:
1. Read: read-only, not writable
2. Read/Write: Readable and writable
3. Write: Only write, not read
8. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
9. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
10. Unit: Measuring point unit
11. Description: Description of the measuring point
12. Group: The group to which the measuring point belongs
13. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measuring point belongs, and the historical data will be stored according to the storage policy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
14. Data Calculation: When the data type of the measuring point is not BIT or STRING, and the bitwise value is not enabled, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
15. No: No computation is performed, the raw data value collected is used
16. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Data High Limit: The upper limit of the data of the measuring point
3. Data lower Limit: the lower limit of the data at the measuring point
4. High Limit Of Proportion: the upper limit of the data after the proportion operation
5. Lower Limit Of Proportion: The lower limit of the data after the scale operation
17. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
1. Decimal Places: The number of decimal places to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
18. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
1. Start Bit: The bit offset at which the intercept of the original data begins
2. End Bit: The bit offset that ends the interception of the original data
19. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
4. PT: Additional PT multiplier
5. CT: Additional CT magnification
20. Value mapping: Configurable measuring points for specific values converted to other values.
1. Source Value: The raw value of the collected measuring point.
2. Target Value: The expected value of the converted measuring point.
21. Enable Package Reporting: This field is visible when the controller enables group packet reporting. When the measuring point is enabled, it will report data in accordance with the packet reporting logic set by the controller in addition to the group reporting data
22. Example description of measuring point address:
    

DLT meter

DLT645-1997

    DLT645-1997 is a version of the Chinese national standard GB/T 645-1997 "Multi-function Meter Communication Protocol". This standard specifies the communication protocol and data format between the multi-function meter and the external equipment, which is used for data exchange and communication between the meter and the monitoring system.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
2. Protocol: Select DLT645-1997
3. Slave: Table Number
4. Endpoint: Support RS485 and RS232
5. Polling Interval: the time interval of data collection (seconds), for example, set to 10S, then all the measuring points under the controller are polled every 10S
6. Enable Multiple Polling Interval: Once enabled, you can configure an additional polling interval and select certain measuring points under the controller to use the polling interval. This function can be used to distinguish the measuring points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.
7. Polling Interval 2: It is an additional polling interval (in seconds) that needs to be set after enabling multiple polling interval;
8. Description: You can add comment information to this controller
   

1. Timeout Settings:
1. Timeout: The timeout time for the device to respond after the reading request is initiated to the device when the measuring point is collected. If the device does not respond to the reading request within the set collection timeout time, it is still the failure of this collection.

1. Communication time setting:
1. Communication Interval Time: The interval time between message exchanges, i.e., after receiving a response from the device, it will wait for a communication interval before sending the next request message.

1. Communication Message Settings:
1. Store of Communication Message: The controller with this function enabled will store communication messages. The storage path and number can be set in the "Default Parameters" of the "Parameter Settings" page. If you need to download the stored communication message, you can enter the " Realtime Communication Message " page of the specified controller in the "Measure Monitor" page, and click the "Download" button to download.

Adding measuring points

1. Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
2. Address: The address of the measuring point, the address format supports 0000 or 00-00.
3. Data type: Measuring point data type, including:
1. WORD: 16-bit unsigned integer
2. INT: 16-bit signed integer
3. DWORD: 32-bit unsigned integer
4. DINT: 32-bit signed integer
5. FLOAT: 32-bit floating point number
6. DOUBLE: A 64-bit floating point number
7. STRING: 8-bit string
4. Read Bit Data: When the data type is selected other than FLOAT,STRING, the value of any bit data in the integer can be read when enabled.
5. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
6. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
7. Decimal Places: The length of the data after the decimal point when the data type is FLOAT, the maximum is 6 digits
8. Read and write permissions:
1. Read: read-only, not writable
2. Read/Write: Readable and writable
9. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
10. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
11. Unit: Measuring point unit
12. Description: Description of the measuring point
13. Group: The group to which the measuring point belongs
14. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measuring point belongs, and the historical data will be stored according to the storage policy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
15. Data Calculation: When the data type of the measuring point is not BIT or STRING, and the bitwise value is not enabled, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
16. No: No computation is performed, the raw data value collected is used
17. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Data High Limit: The upper limit of the data of the measuring point
3. Data lower Limit: the lower limit of the data at the measuring point
4. High Limit Of Proportion: the upper limit of the data after the proportion operation
5. Lower Limit Of Proportion: The lower limit of the data after the scale operation
18. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
1. Decimal Places: The number of decimal places to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
19. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
1. Start Bit: The bit offset at which the intercept of the original data begins
2. End Bit: The bit offset that ends the interception of the original data
20. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
4. PT: Additional PT multiplier
5. CT: Additional CT magnification
21. Value mapping: Configurable measuring points for specific values converted to other values.
1. Source Value: The raw value of the collected measuring point.
2. Target Value: The expected value of the converted measuring point.
   

LT645-2007

DLT645-2007 is a version of the Chinese national standard GB/T 645-2007 "Multi-function Meter Communication Protocol". This standard is an important version of the DLT645 series of standards, which is used to specify the communication protocol and data format between the multifunctional electric energy meter and the external equipment.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
2. Protocol: Select DLT645-2007
3. Slave: Table Number
4. Endpoint: Support RS485 and RS232
5. Polling Interval: the time interval of data collection (seconds), for example, set to 10S, then all the measuring points under the controller are polled every 10S
6. Enable Multiple polling Interval: Once enabled, you can configure an additional polling interval and select certain measuring points under the controller to use the polling interval. This function can be used to distinguish the measuring points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.
7. Polling Interval 2: It is an additional polling interval (in seconds) that needs to be set after enabling multiple polling interval;
8. Description: You can add comment information to this controller
   

1. Timeout Settings:
1. Timeout: The timeout time for the device to respond after the reading request is initiated to the device when the measuring point is collected. If the device does not respond to the reading request within the set collection timeout time, it is still the failure of this collection.
2. Communication time setting:
1. Communication Interval Time: The interval time between message exchanges, i.e., after receiving a response from the device, it will wait for a communication interval before sending the next request message.
   
2. Initialization on Open: Whether to perform the operation of activation command when opening the serial port. After opening, add FE FE FE FE to the packet frame header.

1. Communication Message Settings:
1. Store Communication Message: The controller with this function enabled will store communication messages. The storage path and number can be set in the "Default Parameters" of the "Parameter Settings" page. If you need to download the stored communication message, you can enter the " Realtime Communication Message " page of the specified controller in the "Measure Monitor" page, and click the "Download" button to download.

Adding measuring points

1.      Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
   

1. Address: The address of the measuring point, the address format supports 0000 or 00-00.
   

1. Data type: Measuring point data type, including:
   

1. Read Bit Data: When the data type is selected other than FLOAT,STRING, the value of any bit data in the integer can be read when enabled.
   

1. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
   

1. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
   

1. Decimal Places: The length of the data after the decimal point when the data type is FLOAT, the maximum is 6 digits
   

1. Read and write permissions:
   

1. Mode:
   

1. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
   

1. Unit: Measuring point unit
   

1. Description: Description of the measuring point
   

1. Group: The group to which the measuring point belongs
   

1. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measuring point belongs, and the historical data will be stored according to the storage policy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
   

1. Data Calculation: When the data type of the measuring point is not BIT or STRING, and the bitwise value is not enabled, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
   

1. No: No computation is performed, the raw data value collected is used
   

1. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
   

1. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
   

1. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
   

1. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
   

1. Value mapping: Configurable measuring points for specific values converted to other values.
   

LT645-2007 over TCP

DLT645-2007 over TCP refers to the DLT645-2007 communication protocol applied to TCP/IP network communication mode. DLT645-2007 is a version of the multi-function meter communication protocol, and TCP is a common transmission control protocol used to achieve reliable data transmission in the network. The communication mode of DLT645-2007 over TCP can make full use of the reliability and stability of TCP protocol to ensure the safe transmission and reliable reception of data. This method is suitable for remote monitoring and management of electric energy data scenarios, such as power system monitoring, energy management systems, etc.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway

1. Protocol: Select DLT645-2007 over TCP

1. Station No: Table number

1. IP Address: The IP address of the meter

1. Port: The port information of the meter

1. Polling Interval: It is the time interval of collecting data (seconds), for example, it is set to 10S, then all the measuring points under the controller are polled every 10S

1. Enable Multiple Polling Interval: Once enabled, you can configure an additional polling cycle and select certain measurement points under the controller to use the polling cycle. This function can be used to distinguish the measurement points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.

1. Polling Interval 2: It is an additional polling cycle (in seconds) that needs to be set after enabling multiple polling cycles;

1. Description: You can add comment information to this controller

1. Timeout Settings:
   

Adding measuring points

1. Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
2. Address: Address of measuring point, address format only supports 00-00 format (" - "must be added).
3. Data type: Measuring point data type, including:
1. BIT: 0 or 1
2. BYTE: An 8-bit unsigned integer
3. SINT: 8-bit signed integer
4. WORD: 16-bit unsigned integer
5. INT: 16-bit signed integer
6. BCD16:16-bit BCD code
7. DWORD: 32-bit unsigned integer
8. DINT: 32-bit signed integer
9. FLOAT: 32-bit floating point number
10. DOUBLE: A 64-bit floating point number
11. STRING: 8-bit string
4. Read Bit Data: When the data type is selected other than FLOAT,STRING, the value of any bit data in the integer can be read when enabled.
5. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
6. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
7. Decimal Places: The length of the data after the decimal point when the data type is FLOAT, the maximum is 6 digits
8. Read and write permissions:
1. Read: read-only, not writable
2. Read/Write: Readable and writable
9. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
10. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
11. Unit: Measuring point unit
12. Description: Description of the measuring point
13. Group: The group to which the measuring point belongs
14. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measuring point belongs, and the historical data will be stored according to the storage policy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
15. Data Calculation: When the data type of the measuring point is not BIT or STRING, and the bitwise value is not enabled, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
16. No: No computation is performed, the raw data value collected is used
17. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Data High Limit: The upper limit of the data of the measuring point
3. Data lower Limit: the lower limit of the data at the measuring point
4. High Limit Of Proportion: the upper limit of the data after the proportion operation
5. Lower Limit Of Proportion: The lower limit of the data after the scale operation
18. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
1. Decimal Places: The number of decimal places to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
19. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
1. Start Bit: The bit offset at which the intercept of the original data begins
2. End Bit: The bit offset that ends the interception of the original data
20. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
4. PT: Additional PT multiplier
5. CT: Additional CT magnification
21. Value mapping: Configurable measuring points for specific values converted to other values.
1. Source Value: The raw value of the collected measuring point.
2. Target Value: The expected value of the converted measuring point.

*DLT698

DLT698 is an implementation of Chinese national standard GB/T 26880-2011 "Power information acquisition system communication protocol", it is based on the IEC 62056 series standard (DLT645) power information acquisition system communication protocol. DLT698 is mainly used for data acquisition, transmission and management in electric power information acquisition system. It is a general communication protocol in electric power industry.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
2. Protocol: Select *DLT698
3. Station No: Support RS485 and RS232
4. Polling Interval: the time interval of data collection (seconds), for example, set to 10S, then all the measuring points under the controller are polled every 10S
5. Enable Multiple Polling Interval: Once enabled, you can configure an additional polling interval and select certain measuring points under the controller to use the polling interval. This function can be used to distinguish the measuring points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.
6. Polling Interval 2: It is an additional polling interval (in seconds) that needs to be set after enabling multiple polling interval;
7. Description: You can add comment information to this controller
   

1. Timeout Settings:
1. Timeout: The timeout time for the device to respond after the reading request is initiated to the device when the measuring point is collected. If the device does not respond to the reading request within the set collection timeout time, it is still the failure of this collection.

1. Communication Timing Settings:
1. Communication Interval Time: The interval time between message exchanges, i.e., after receiving a response from the device, it will wait for a communication interval before sending the next request message.

1. Communication Message Settings:
1. Store Communication Message: The controller with this function enabled will store communication messages. The storage path and number can be set in the "Default Parameters" of the "Parameter Settings" page. If you need to download the stored communication message, you can enter the " Realtime Communication Message " page of the specified controller in the "Measure Monitor" page, and click the "Download" button to download.

Adding measuring points

1. Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
2. Address: Address of measuring point, address format only supports 00-00 format (" - "must be added).
3. Data type: Measuring point data type, including:
1. BIT: 0 or 1
2. BYTE: An 8-bit unsigned integer
3. SINT: 8-bit signed integer
4. WORD: 16-bit unsigned integer
5. INT: 16-bit signed integer
6. BCD16:16-bit BCD code
7. DWORD: 32-bit unsigned integer
8. DINT: 32-bit signed integer
9. FLOAT: 32-bit floating point number
10. DOUBLE: A 64-bit floating point number
11. STRING: 8-bit string
4. Read Bit Data: When the data type is selected other than FLOAT,STRING, the value of any bit data in the integer can be read when enabled.
5. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
6. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
7. Decimal Places: The length of the data after the decimal point when the data type is FLOAT, the maximum is 6 digits
8. Read and write permissions:
1. Read: read-only, not writable
2. Read/Write: Readable and writable
9. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
10. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
11. Unit: Measuring point unit
12. Description: Description of the measuring point
13. Group: The group to which the measuring point belongs
14. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measuring point belongs, and the historical data will be stored according to the storage policy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
15. Data Calculation: When the data type of the measuring point is not BIT or STRING, and the bitwise value is not enabled, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
16. No: No computation is performed, the raw data value collected is used
17. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Data High Limit: The upper limit of the data of the measuring point
3. Data lower Limit: the lower limit of the data at the measuring point
4. High Limit Of Proportion: the upper limit of the data after the proportion operation
5. Lower Limit Of Proportion: The lower limit of the data after the scale operation
18. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
1. Decimal Places: The number of decimal places to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
19. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
1. Start Bit: The bit offset at which the intercept of the original data begins
2. End Bit: The bit offset that ends the interception of the original data
20. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
4. PT: Additional PT multiplier
5. CT: Additional CT magnification
21. Value mapping: Configurable measuring points for specific values converted to other values.
1. Source Value: The raw value of the collected measuring point.
2. Target Value: The expected value of the converted measuring point.

IEC 60870

IEC 101

IEC 101 is a standard protocol developed by the International Electrotechnical Commission (IEC) for telecommunication. It is a communication protocol for monitoring and control of power systems, which is mainly used for applications such as remote monitoring, control, data acquisition and protection in power systems.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
   
2. Protocol: IEC 101 is selected
   
3. Communication Mode: support “Balanced Transmission” and “Unbalanced Transmission”, “Unbalanced Transmission” only supports one side of the communication at the same time to send data, belongs to half duplex, suitable for RS485 scenario, “Balanced Transmission” can support both sides of the communication to send data at the same time, belongs to full duplex, suitable for RS232 scenario
   
4. Link Address Size: support 1 and 2. The number of bits or bytes used to represent the address of a device in the link layer
   
5. Link Address: A unique identifier used in the link layer to identify a communicating device
   
6. ASDU Size: The byte length of the application service data unit, which is the length of the CA public address, the ASDU field is used to distinguish different sub-stations on this link. If more than one substation needs to be collected, more than one controller needs to be configured. 1 and 2 are supported, the default is 2, in bytes
   
7. ASDU Address: Application service data unit public address, also known as CA public address. An address or identifier used in a protocol to identify and distinguish between different ASdus
   
8. IOA Size: information object address byte length, the length of IOA determines the number and range of monitoring points, the default is 2, unit byte
   
9. COT Size: transmission cause byte length, determines the number of transmission causes that can be represented, the default is 2, unit byte
   
10. Originator Address: Used to identify the address of the device or system that sends the data packet, identifying the source of the data packet
    
11. Endpoint: support RS485 and RS232
    
12. General Interrogation Interval: the time interval during which the system regularly sends the total call command
    
13. Counter Interrogation Interval: The time interval at which the control system regularly sends the power total call command
    
14. Description: Note information can be added to this controller
    

1. Timeout: The timeout time of the device response after the reading request is initiated to the device when the measuring point is collected. If the device does not respond to the reading request within the set collection timeout time, it is still the failure of this collection.
   

1. Link confirmation timeout: the maximum time for the initiator to wait for a response from the receiver when a packet is interacting
   

1. Clock Sysc: When enabled, a clock synchronization command is periodically sent to the slave device to inform the device of the current system time or calibration value
   

1. Clock Sync Interval: The frequency at which clock synchronization commands are sent
   

1. Operate Mode: supports "Direct Operate" and "Select then Operate ". The "Direct Operate" command is sent directly by the master station to the remote device, and the device performs the corresponding operation immediately after receiving the command, without waiting for additional confirmation or response. In the " Select then Operate" mode, the master station first sends a selection command to the remote device, which indicates that the device is ready to perform a specific action, but does not execute it immediately for the time being. Upon receiving the selection command, the device will place the action in the pending state and send an acknowledgement response to the master indicating that the selection command has been accepted. The master then sends another action command that instructs the device to perform a specific action. After receiving the operation command, the device performs the corresponding operation and sends an acknowledgement response to the master station, indicating that the operation has been performed.
   

1. Communication message Settings:
   

Adding measuring points

1. Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
2. Register Type: Select the Type Identification (TI) of IEC101 from the dropdown menu.
3. IOA Size: Identifies the address of the information object, an integer from 1 to 16777215
4. Data type: Depending on the address type, the data types supported in the data type are also different. After you select an address type, select the actual supported data type from the drop-down list.
5. Read Bit Data: When the data type is selected other than FLOAT,STRING, the value of any bit data in the integer can be read when enabled.
6. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
7. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
8. Decimal Places: The length of the data after the decimal point when the data type is FLOAT, the maximum is 6 digits
9. Read and write permissions: Depending on the address type, the supported read and write permissions are different. After you select an address type, select the actual supported read and write permissions from the drop-down list.
10. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
11. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
12. Unit: Measuring point unit
13. Description: Description of the measuring point
14. Group: The group to which the measuring point belongs
15. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measuring point belongs, and the historical data will be stored according to the storage policy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
16. Data Calculation: When the data type of the measuring point is not BIT or STRING, and the bitwise value is not enabled, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
17. No: No computation is performed, the raw data value collected is used
18. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Data High Limit: The upper limit of the data of the measuring point
3. Data lower Limit: the lower limit of the data at the measuring point
4. High Limit Of Proportion: the upper limit of the data after the proportion operation
5. Lower Limit Of Proportion: The lower limit of the data after the scale operation
19. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
1. Decimal Places: The number of decimal places to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
20. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
1. Start Bit: The bit offset at which the intercept of the original data begins
2. End Bit: The bit offset that ends the interception of the original data
21. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
4. PT: Additional PT multiplier
5. CT: Additional CT magnification
22. Value mapping: Configurable measuring points for specific values converted to other values.
1. Source Value: The raw value of the collected measuring point.
2. Target Value: The expected value of the converted measuring point.

IEC 104

IEC 104 is an international standard protocol for remote communication in power systems. It was developed by the International Electrotechnical Commission (IEC) and is a communication protocol for monitoring, controlling, and protecting power systems. The IEC 104 protocol is built on top of the TCP/IP network protocol and usually uses TCP or UDP as the transport layer protocol to achieve reliable transmission of data in the network. It adopts a distributed and object-oriented communication model, and supports client-server and multicast communication modes.

IEC 104 protocol is mainly used for communication between remote terminal unit (RTU), remote control device, remote communication device and other equipment. It provides an efficient and reliable data transmission mechanism, which supports a variety of data types and function codes, such as telemetry data collection, remote communication information transmission, remote operation execution, etc.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway

1. Protocol: Select IEC 104
2. IP Address: Master IP address
3. ASDU address: The byte length of the application service data unit, that is, the length of the CA public address, the ASDU field is used to distinguish between different sub-stations on this link. If multiple substations need to be collected, multiple controllers need to be configured
   

1. Port: Master port information
2. COT Size: Transfer cause byte length, determines the number of transfer causes that can be represented, the default is 2
3. General Interrogation Interval: The time interval during which the system sends the total call command on a regular basis
4. Counter Interrogation Interval: The time interval at which the control system regularly sends the power total call command
   

1. K Value: The maximum number of I format (information) APDU (k) that has not been confirmed. Range 1-32, default 12.
2. W value: Receiver acknowledges after receiving w I format (information) APdus, range 1-32, default 8.
3. T0 Timeout (S) : T0 timeout is the timeout that the master waits for a response from the slave after sending the start frame. If no response frame is received from the slave within the T0 timeout period, the master will consider the communication failed and act accordingly. Range 1-3000, default is 30 in seconds.
4. T1 Timeout (S) : t1 stipulates that after the sender sends an I format packet or U format (control) packet, it must be accepted by the receiver within the time of t1, otherwise the sender considers that the TCP connection has a problem and should re-establish the connection. Range 1-3000, default is 15 in seconds.
5. T2 Timeout (S) : t2 stipulates that after receiving an I format packet, if the receiver does not receive a new I format packet after t2 time, it must send an S format (monitoring) frame to the sender to acknowledge the received I format packet. Range 1-3000, default is 10, in seconds. Note: T2 < T1
6. T3 Timeout (S) : t3 stipulates that the dispatcher or the sub-station RTU will retrigger the timer t3 every time it receives an I frame, S frame or U frame. If no packet is received within t3, it will send a test link frame to the other side. Range 1-3000, default is 20, the unit is seconds. Note: T3 > T1
7. Clock Sys: When enabled, a clock synchronization command will be sent to the slave device periodically to inform the device of the current system time or calibration value
8. Clock Sync Interval: The frequency at which clock synchronization commands are sent
9. Operate Mode: Support "direct operation" and "select operation". The "Direct operation" command is sent directly by the master station to the remote device, and the device performs the corresponding operation immediately after receiving the command, without waiting for additional confirmation or response. In the "Operation after Selection" mode, the master station first sends a selection command to the remote device, which indicates that the device is ready to perform a specific action, but does not execute it immediately for the time being. Upon receiving the selection command, the device will place the action in the pending state and send an acknowledgement response to the master indicating that the selection command has been accepted. The master then sends another action command that instructs the device to perform a specific action. After receiving the operation command, the device performs the corresponding operation and sends an acknowledgement response to the master station, indicating that the operation has been performed.
10. Communication Message Settings:

Adding measuring points

1.      Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
2. Register Type: Select the Type Identification (TI) of IEC104 from the dropdown menu.
3. IOA Size: Identifies the address of the information object, an integer from 1 to 16777215
4. Data type: Depending on the address type, the data types supported in the data type are also different. After you select an address type, select the actual supported data type from the drop-down list.
5. Read Bit Data: When the data type is selected other than FLOAT,STRING, the value of any bit data in the integer can be read when enabled.
6. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
7. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
8. Decimal Places: The length of the data after the decimal point when the data type is FLOAT, the maximum is 6 digits
9. Read and write permissions: Depending on the address type, the supported read and write permissions are different. After you select an address type, select the actual supported read and write permissions from the drop-down list.
10. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
11. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
12. Unit: Measuring point unit
13. Description: Description of the measuring point
14. Group: The group to which the measuring point belongs
15. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measuring point belongs, and the historical data will be stored according to the storage policy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
16. Data Calculation: When the data type of the measuring point is not BIT or STRING, and the bitwise value is not enabled, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
17. No: No computation is performed, the raw data value collected is used
18. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Data High Limit: The upper limit of the data of the measuring point
3. Data lower Limit: the lower limit of the data at the measuring point
4. High Limit Of Proportion: the upper limit of the data after the proportion operation
5. Lower Limit Of Proportion: The lower limit of the data after the scale operation
19. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
1. Decimal Places: The number of decimal places to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
20. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
1. Start Bit: The bit offset at which the intercept of the original data begins
2. End Bit: The bit offset that ends the interception of the original data
21. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
4. PT: Additional PT multiplier
5. CT: Additional CT magnification
22. Value mapping: Configurable measuring points for specific values converted to other values.
1. Source Value: The raw value of the collected measuring point.
2. Target Value: The expected value of the converted measuring point.

Modbus

Modbus ASCII

Modbus ASCII is a Modbus communication protocol based on ASCII character encoding for data exchange and device control in serial communication. It is a variant of the Modbus protocol and usually runs on serial communication media such as RS-232 or RS-485. The Modbus ASCII protocol is commonly used in industrial control systems for data exchange between devices and control operations. It supports a variety of function codes, including read/write registers, read/write coils, etc., which can be used to realize the monitoring and control of remote devices. The Modbus ASCII protocol is simple and easy to use, and is suitable for smaller scale systems and devices

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
2. Protocol: Select Modbus ASCII
3. Slave: The unique identification of the slave device
4. Endpoint: Support RS485 and RS232, default use RS485
5. Polling Interval: It is the time interval of data collection (seconds), for example, it is set to 10S, then all the measurement points under the controller are polled every 10S
6. Enable Multiple Polling Interval: Once enabled, you can configure an additional polling cycle and select certain measurement points under the controller to use the polling cycle. This function can be used to distinguish the measurement points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.
7. Polling Interval 2: An additional polling cycle (in seconds) that needs to be set when multiple polling cycles are enabled.
8. Description: You can add comment information to this controller

1. Byte order:

1. Enable Package Reporting: Measurement points under controllers with this feature enabled can be configured for individual polling cycles (in milliseconds). Measurement points that have " Enable Package Reporting " enabled collect data according to the set polling cycle and frequency, and publish the aggregated data to the local MQTT topic "ds2/eventbus/south/upload/msec/data/{controllerName}". A quick function with the mode "Local Subscription Message Trigger" can be added on the "Custom Quick Functions" page to subscribe to this topic, where the grouped data can be processed within the quick function.
2. Packet Data Polling Interval: The polling period for group packet data.
3. Millisecond Data uploading: How many times the group packet data is polled, it is reported uniformly.
4. Continuous Collection: Whether to carry out batch acquisition of the measurement points under the controller. For example, in the modbus protocol, after starting batch acquisition, all the measurement points with continuous addresses will be read in one read request, which can effectively improve the collection efficiency.

1. Timeout Settings:
   

1. Communication time setting:

1. Communication Message Settings:

Adding measuring points

807. Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
808. Address: the address of the measuring point. Support 0X (coil register), 1X (discrete register), 3X (input register), 4X (hold register)
809. Data type: Measuring point data type, including:
1. BIT: 0 or 1
2. WORD: 16-bit unsigned integer
3. INT: 16-bit signed integer
4. BCD16:16-bit BCD code
5. DWORD: 32-bit unsigned integer
6. DINT: 32-bit signed integer
7. BCD32:32-bit BCD code
8. FLOAT: 32-bit floating point number
9. DOUBLE: 64-bit floating point number
10. ULONG: 64-bit unsigned integer
11. LONG: 64-bit signed integer
12. STRING: 8-bit string
810. Decimal Places: The length of the data after the decimal point when the data type is FLOAT or DOUBLE ,the maximum is 6 digits
811. Size: The length of the STRING when the data type is String
812. Character Encoding Format: ASCII, UTF-8, UTF-16 little endian, UTF-16 big endian, GB2312 little endian, GB2312 big endian. Only data type selection STRING is valid.
813. Read Bit Data: The value of any bit data in the integer can be read when enabled.
814. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
815. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
816. Value mapping：When enabled, maps the 0 and 1 values of a BIT point to False and True
817. Read and write permissions:
1. Read: read-only, not writable
2. Read/Write: Readable and writable
3. Write: Only write, not read
818. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
819. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
820. Unit: Measuring point unit
821. Description: Description of the measuring point
822. Group: The group to which the measuring point belongs
823. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measurement point belongs, and the historical data will be stored according to the storage strategy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
824. Data Calculation: When the data type of the measurement point is not BIT or STRING, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
825. No: No computation is performed, the raw data value collected is used
826. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Data High Limit: The upper limit of the data of the measuring point
3. Data lower Limit: the lower limit of the data at the measuring point
4. High Limit Of Proportion: the upper limit of the data after the proportion operation
5. Lower Limit Of Proportion: The lower limit of the data after the scale operation
827. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
1. Decimal Places: The number of decimal places to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
828. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
1. Start Bit: The bit offset at which the intercept of the original data begins
2. End Bit: The bit offset that ends the interception of the original data
829. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
4. PT: Additional PT multiplier
5. CT: Additional CT magnification
830. Value mapping: Configurable measuring points for specific values converted to other values.
1. Source Value: The raw value of the collected measuring point.
2. Target Value: The expected value of the converted measuring point.
3. Enable Package Reporting: This field is visible when the controller enables group packet reporting. When the measuring point is enabled, it will report data in accordance with the packet reporting logic set by the controller in addition to the group reporting data

Modbus RTU

Modbus RTU (Remote Terminal Unit) is a commonly used serial communication protocol, which is used for data exchange and control operations between devices in industrial control systems. It is a variant of the Modbus protocol and usually runs on serial communication media (such as RS-232, RS-485). The Modbus RTU protocol supports a variety of function codes, including read/write hold registers, read/write coils, etc., which can be used to monitor and control remote devices. It has been widely used in the field of industrial control, because of its simple to use, low cost, reliable and stable characteristics, suitable for all sizes and types of industrial control systems.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
2. Protocol: Select Modbus RTU
3. Slave: The unique identification of the slave device
4. Endpoint: Support RS485 and RS232, default use RS485
5. Polling Interval: It is the time interval of data collection (seconds), for example, it is set to 10S, then all the measurement points under the controller are polled every 10S
6. Enable Multiple Polling Interval: Once enabled, you can configure an additional polling cycle and select certain measurement points under the controller to use the polling cycle. This function can be used to distinguish the measurement points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.
7. Polling Interval 2: An additional polling cycle (in seconds) that needs to be set when multiple polling cycles are enabled.
8. Description: You can add comment information to this controller

1. Byte order:

1. Enable Package Reporting: Measurement points under controllers with this feature enabled can be configured for individual polling cycles (in milliseconds). Measurement points that have " Enable Package Reporting " enabled collect data according to the set polling cycle and frequency, and publish the aggregated data to the local MQTT topic "ds2/eventbus/south/upload/msec/data/{controllerName}". A quick function with the mode "Local Subscription Message Trigger" can be added on the "Custom Quick Functions" page to subscribe to this topic, where the grouped data can be processed within the quick function.Packet Data Polling Interval: The polling period for group packet data.
2. Packet Data Polling Interval: The polling period for group packet data.
3. Millisecond Data uploading: How many times the group packet data is polled, it is reported uniformly.
4. Continuous Collection: Whether to carry out batch acquisition of the measurement points under the controller. For example, in the modbus protocol, after starting batch acquisition, all the measurement points with continuous addresses will be read in one read request, which can effectively improve the collection efficiency.

1. Timeout Settings:

1. Communication time setting:

1. Write function code settings:
   

1. Communication Message Settings:

Adding measuring points

1. Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
2. Address: the address of the measuring point. Support 0X (coil register), 1X (discrete register), 3X (input register), 4X (hold register)
3. Data type: Measuring point data type, including:
1. BIT: 0 or 1
2. WORD: 16-bit unsigned integer
3. INT: 16-bit signed integer
4. BCD16:16-bit BCD code
5. DWORD: 32-bit unsigned integer
6. DINT: 32-bit signed integer
7. BCD32:32-bit BCD code
8. FLOAT: 32-bit floating point number
9. DOUBLE: 64-bit floating point number
10. ULONG: 64-bit unsigned integer
11. LONG: 64-bit signed integer
12. STRING: 8-bit string
4. Decimal Places: The length of the data after the decimal point when the data type is FLOAT or DOUBLE ,the maximum is 6 digits
5. Size: The length of the STRING when the data type is String
6. Character Encoding Format: ASCII, UTF-8, UTF-16 little endian, UTF-16 big endian, GB2312 little endian, GB2312 big endian. Only data type selection STRING is valid.
7. Read Bit Data: The value of any bit data in the integer can be read when enabled.
8. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
9. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
10. Value mapping：When enabled, maps the 0 and 1 values of a BIT point to False and True
11. Read and write permissions:
1. Read: read-only, not writable
2. Read/Write: Readable and writable
3. Write: Only write, not read
12. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
13. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
14. Unit: Measuring point unit
15. Description: Description of the measuring point
16. Group: The group to which the measuring point belongs
17. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measurement point belongs, and the historical data will be stored according to the storage strategy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
18. Data Calculation: When the data type of the measurement point is not BIT or STRING, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
19. No: No computation is performed, the raw data value collected is used
20. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Data High Limit: The upper limit of the data of the measuring point
3. Data lower Limit: the lower limit of the data at the measuring point
4. High Limit Of Proportion: the upper limit of the data after the proportion operation
5. Lower Limit Of Proportion: The lower limit of the data after the scale operation
21. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
1. Decimal Places: The number of decimal places to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
22. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
1. Start Bit: The bit offset at which the intercept of the original data begins
2. End Bit: The bit offset that ends the interception of the original data
23. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
4. PT: Additional PT multiplier
5. CT: Additional CT magnification
24. Value mapping: Configurable measuring points for specific values converted to other values.
1. Source Value: The raw value of the collected measuring point.
2. Target Value: The expected value of the converted measuring point.
3. Enable Package Reporting: This field is visible when the controller enables group packet reporting. When the measuring point is enabled, it will report data in accordance with the packet reporting logic set by the controller in addition to the group reporting data

Modbus RTU over TCP

Modbus RTU over TCP refers to a way to wrap the Modbus RTU protocol in the TCP/IP network protocol for transmission. In this mode, Modbus RTU data frames are encapsulated in TCP packets and transmitted over the TCP/IP network. In Modbus RTU over TCP, Modbus RTU data frames are encapsulated in the data part of the TCP packet and transmitted over a TCP connection. After receiving the TCP packet, the receiver parses it out of the Modbus RTU data frame before processing and responding. This method retains the original characteristics of Modbus RTU protocol, while taking advantage of the reliability and flexibility provided by TCP/IP network, and is suitable for industrial control systems of all sizes and complexities.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
2. Protocol: Select Modbus RTU over TCP
3. IP Address: The IP address of the slave
4. Port :The port information of the slave
5. Slave: The unique identification of the slave device
6. Endpoint: Support RS485 and RS232, default use RS485
7. Polling Interval: It is the time interval of data collection (seconds), for example, it is set to 10S, then all the measurement points under the controller are polled every 10S
8. Enable Multiple Polling Interval: Once enabled, you can configure an additional polling cycle and select certain measurement points under the controller to use the polling cycle. This function can be used to distinguish the measurement points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.
9. Polling Interval 2: An additional polling cycle (in seconds) that needs to be set when multiple polling cycles are enabled.
10. Description: You can add comment information to this controller

1. Byte order:
   

1. Enable Package Reporting: Measurement points under controllers with this feature enabled can be configured for individual polling cycles (in milliseconds). Measurement points that have " Enable Package Reporting " enabled collect data according to the set polling cycle and frequency, and publish the aggregated data to the local MQTT topic "ds2/eventbus/south/upload/msec/data/{controllerName}". A quick function with the mode "Local Subscription Message Trigger" can be added on the "Custom Quick Functions" page to subscribe to this topic, where the grouped data can be processed within the quick function.Packet Data Polling Interval: The polling period for group packet data.
2. Packet Data Polling Interval: The polling period for group packet data.
3. Millisecond Data uploading: How many times the group packet data is polled, it is reported uniformly.
4. Continuous Collection: Whether to carry out batch acquisition of the measurement points under the controller. For example, in the modbus protocol, after starting batch acquisition, all the measurement points with continuous addresses will be read in one read request, which can effectively improve the collection efficiency.

1. Timeout Settings:
   

1. Communication time setting:
   

1. Write function code settings:
   

1. Communication Message Settings:

Adding measuring points

943. Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
944. Address: the address of the measuring point. Support 0X (coil register), 1X (discrete register), 3X (input register), 4X (hold register)
945. Data type: Measuring point data type, including:
1. BIT: 0 or 1
2. WORD: 16-bit unsigned integer
3. INT: 16-bit signed integer
4. BCD16:16-bit BCD code
5. DWORD: 32-bit unsigned integer
6. DINT: 32-bit signed integer
7. BCD32:32-bit BCD code
8. FLOAT: 32-bit floating point number
9. DOUBLE: 64-bit floating point number
10. ULONG: 64-bit unsigned integer
11. LONG: 64-bit signed integer
12. STRING: 8-bit string
946. Decimal Places: The length of the data after the decimal point when the data type is FLOAT or DOUBLE ,the maximum is 6 digits
947. Size: The length of the STRING when the data type is String
948. Character Encoding Format: ASCII, UTF-8, UTF-16 little endian, UTF-16 big endian, GB2312 little endian, GB2312 big endian. Only data type selection STRING is valid.
949. Read Bit Data: The value of any bit data in the integer can be read when enabled.
950. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
951. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
952. Value mapping：When enabled, maps the 0 and 1 values of a BIT point to False and True
953. Read and write permissions:
1. Read: read-only, not writable
2. Read/Write: Readable and writable
3. Write: Only write, not read
954. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
955. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
956. Unit: Measuring point unit
957. Description: Description of the measuring point
958. Group: The group to which the measuring point belongs
959. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measurement point belongs, and the historical data will be stored according to the storage strategy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
960. Data Calculation: When the data type of the measurement point is not BIT or STRING, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
961. No: No computation is performed, the raw data value collected is used
962. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Data High Limit: The upper limit of the data of the measuring point
3. Data lower Limit: the lower limit of the data at the measuring point
4. High Limit Of Proportion: the upper limit of the data after the proportion operation
5. Lower Limit Of Proportion: The lower limit of the data after the scale operation
963. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
1. Decimal Places: The number of decimal places to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
964. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
1. Start Bit: The bit offset at which the intercept of the original data begins
2. End Bit: The bit offset that ends the interception of the original data
965. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
4. PT: Additional PT multiplier
5. CT: Additional CT magnification
966. Value mapping: Configurable measuring points for specific values converted to other values.
1. Source Value: The raw value of the collected measuring point.
2. Target Value: The expected value of the converted measuring point.
3. Enable Package Reporting: This field is visible when the controller enables group packet reporting. When the measuring point is enabled, it will report data in accordance with the packet reporting logic set by the controller in addition to the group reporting data

Modbus TCP

Modbus TCP is an Ethernet-based version of the Modbus protocol that uses the TCP/IP protocol for communication. Unlike the traditional Modbus RTU protocol, Modbus TCP allows devices to communicate directly over Ethernet without any dedicated hardware or communication interfaces. Therefore, Modbus TCP has a higher communication rate and a wider range of applications.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway
2. Protocol: Select Modbus TCP
3. IP Address: The IP address of the slave
4. Port :The port information of the slave
5. Slave: The unique identification of the slave device
6. Endpoint: Support RS485 and RS232, default use RS485
7. Polling Interval: It is the time interval of data collection (seconds), for example, it is set to 10S, then all the measurement points under the controller are polled every 10S
8. Enable Multiple Polling Interval: Once enabled, you can configure an additional polling cycle and select certain measurement points under the controller to use the polling cycle. This function can be used to distinguish the measurement points that need high frequency and low frequency acquisition, and make efficient use of gateway and PLC performance.
9. Polling Interval 2: An additional polling cycle (in seconds) that needs to be set when multiple polling cycles are enabled.
10. Description: You can add comment information to this controller

1. Byte order:

1. Enable Package Reporting: Measurement points under controllers with this feature enabled can be configured for individual polling cycles (in milliseconds). Measurement points that have " Enable Package Reporting " enabled collect data according to the set polling cycle and frequency, and publish the aggregated data to the local MQTT topic "ds2/eventbus/south/upload/msec/data/{controllerName}". A quick function with the mode "Local Subscription Message Trigger" can be added on the "Custom Quick Functions" page to subscribe to this topic, where the grouped data can be processed within the quick function.Packet Data Polling Interval: The polling period for group packet data.
2. Packet Data Polling Interval: The polling period for group packet data.
3. Millisecond Data uploading: How many times the group packet data is polled, it is reported uniformly.
4. Continuous Collection: Whether to carry out batch acquisition of the measurement points under the controller. For example, in the modbus protocol, after starting batch acquisition, all the measurement points with continuous addresses will be read in one read request, which can effectively improve the collection efficiency.

1. Timeout Settings:

1. Communication time setting:
   

1. Write function code settings:

1. Communication Message Settings:

Adding measurement points

1. Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
2. Address: the address of the measuring point. Support 0X (coil register), 1X (discrete register), 3X (input register), 4X (hold register)
3. Data type: Measuring point data type, including:
1. BIT: 0 or 1
2. WORD: 16-bit unsigned integer
3. INT: 16-bit signed integer
4. BCD16:16-bit BCD code
5. DWORD: 32-bit unsigned integer
6. DINT: 32-bit signed integer
7. BCD32:32-bit BCD code
8. FLOAT: 32-bit floating point number
9. DOUBLE: 64-bit floating point number
10. ULONG: 64-bit unsigned integer
11. LONG: 64-bit signed integer
12. STRING: 8-bit string
4. Decimal Places: The length of the data after the decimal point when the data type is FLOAT or DOUBLE ,the maximum is 6 digits
5. Size: The length of the STRING when the data type is String
6. Character Encoding Format: ASCII, UTF-8, UTF-16 little endian, UTF-16 big endian, GB2312 little endian, GB2312 big endian. Only data type selection STRING is valid.
7. Read Bit Data: The value of any bit data in the integer can be read when enabled.
8. Register Bit: When the bitwise value is enabled, the bit offset of the measuring point when reading the bit data.
9. Negative Value: When the bitwise value is enabled or the data type is BIT, you can choose whether to negate the result of the read.
10. Value mapping：When enabled, maps the 0 and 1 values of a BIT point to False and True
11. Read and write permissions:
1. Read: read-only, not writable
2. Read/Write: Readable and writable
3. Write: Only write, not read
12. Mode:
1. Periodic: Periodically reports data according to the reporting period of the group it belongs to
2. Onchange: When the value of the measuring point changes, the data will be reported periodically according to the reporting period of the group
3. Never: Only used locally, no need to upload data from the cloud
13. Onchange Deadzone: When the upload mode is Onchange, you can set the value change within a certain range to be treated as no change. If the data has configuration data operation, the value after operation is used to detect whether the value change exceeds the dead zone.
14. Unit: Measuring point unit
15. Description: Description of the measuring point
16. Group: The group to which the measuring point belongs
17. Store Historical Data: When enabled, the historical data table will be generated with the name of the group to which the measurement point belongs, and the historical data will be stored according to the storage strategy set by the group. The stored historical data can be exported as CSV files or obtained by calling Python API.
18. Data Calculation: When the data type of the measurement point is not BIT or STRING, it supports simple operation processing through data operation, and the processed data value can be reported to the cloud platform. The value mapped to the protocol conversion (Modbus Slave or OPC UA Server, etc.) defaults to the original data value collected rather than the calculated data value
19. No: No computation is performed, the raw data value collected is used
20. Ratio Conversion: the collected data value is mapped to a data value in the range of the upper and lower limits of the ratio in equal proportion to the data value, such as mapping the data collected in the sensor to the actual temperature and humidity. The calculation formula is the calculated data value = (upper limit of proportion - lower limit of proportion)/(upper limit of data - lower limit of data) * (original data value - lower limit of data) + lower limit of proportion
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Data High Limit: The upper limit of the data of the measuring point
3. Data lower Limit: the lower limit of the data at the measuring point
4. High Limit Of Proportion: the upper limit of the data after the proportion operation
5. Lower Limit Of Proportion: The lower limit of the data after the scale operation
21. Offset and Zoom: calculate the original data value according to the multiplier and offset. The formula is the calculated data value = (original data value * multiplier) + offset
1. Decimal Places: The number of decimal places to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
22. Bit Trunction: Intercepts a segment of data in the original data as a data value. FLOAT type measuring points do not support this operation
1. Start Bit: The bit offset at which the intercept of the original data begins
2. End Bit: The bit offset that ends the interception of the original data
23. PT/CT: Calculate the original data value according to the magnification, offset, PT and CT, the formula is [(original value * magnification)+ offset]*PT*CT
1. Decimal Places: The number of decimal places that need to be retained after the operation
2. Magnification: The multiplier that needs to be scaled up or down
3. Offset: The data value that needs to be increased or decreased after the multiplier operation
4. PT: Additional PT multiplier
5. CT: Additional CT magnification
24. Value mapping: Configurable measuring points for specific values converted to other values.
1. Source Value: The raw value of the collected measuring point.
2. Target Value: The expected value of the converted measuring point.
3. Enable Package Reporting: This field is visible when the controller enables group packet reporting. When the measuring point is enabled, it will report data in accordance with the packet reporting logic set by the controller in addition to the group reporting data

Modbus RTU Slave

A Modbus RTU Slave is a party that exists as a passive device in the Modbus RTU communication protocol, which receives and responds to commands from the Master and provides data to the master.

In the controller of the gateway, the Modbus RTU Slave is used as a read-only collector, and the registers in the Slave are configured to passively wait for the data packets sent by the master.

Adding a controller

1. Name: The name of the controller, which is unique in the controller list for the entire gateway

1. Protocol: Modbus RTU Slave is selected

1. Slave: The unique identification of the slave device

1. Endpoint: Support RS485 and RS232, default use RS485

1. Status expiration time: When the controller or the measurement point does not receive a new message within the specified time, the state will be automatically updated to offline

1. Advanced Settings:

1. Byte order:

1. Communication Message Settings:

Adding measurement points

1. Measuring Point Name: The name of the measuring point (the name of the measuring point cannot be repeated under the same controller)
   

1. Address: the address of the measuring point. Support 0X (coil register), 4X (hold register)
   

1. Data type: Measuring point data type, including: