Getting Started

1.Introduction

1.1 Overview

DeviceSupervisor Agent (hereinafter referred to as DSA) is an industrial edge gateway software running on the gateway, providing convenient data acquisition, data processing, data to the cloud and protocol conversion. It is mainly deployed in industrial sites to achieve industrial equipment communication and industrial bus protocol acquisition, industrial system data integration, edge data filtering and analysis, as well as industrial IoT platform docking and integration, etc. It provides low-latency data access management and intelligent analysis services for industrial scenarios, helping users to quickly analyse business trends and improve operational efficiency and sustainability.

1.2 Product Advantages

1. Rich southbound acquisition protocols

Provides data acquisition services to meet various industrial scenarios, real-time data acquisition and unified access for PLC, CNC, robot, Scada and intelligent instrumentation, etc. These acquisition services are widely used in building automation, CNC machine tools, robotics, electric power, and various PLC communications.

1. Various protocol conversion functions

It supports to convert the data collected in the south direction to a specified industrial protocol, and then for the host computer or Scada software to collect, which is good to avoid the complexity of the collection problems caused by the diversity of industrial field protocols.

1. Platform integration

It supports connecting to mainstream industrial IoT cloud platforms and integrating data into local data centres, industrial internet platforms or cloud services by interfacing with standard MQTT, MQTT SparkPlugB, AliCloud IOT, AWS IOT, Azure IOT and so on.

1. Lightweight and flexible configuration

It has the characteristics of lightweight and low memory consumption; it can be installed or uninstalled in the form of APP (plug-in on EC products), which is easy to manage, and it can be used to meet various scenarios by modifying the DSA configuration.

1. Edge Measurement Intelligent Analytics

Within DSA, it supports the addition of fast function scripts to handle edge measurement data processing; "publish" scripts can report the data to the platform after filtering and format conversion, "subscribe" scripts can handle the platform's control of the site, and "custom fast function" scripts can handle edge measurement data management and intelligent analysis.

4. Quick start

4.1 Install 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:

4.2 Southbound Acquisition Configuration

4.2.1 Configuring the 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 1
   

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. The IP address, port number, and slave were correct when the controller was created;
   
2. Check if the gateway can access the IP and port of the simulator.
   

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.

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:
   

# Enter your python code.
import json
from common.Logger import logger
from quickfaas.measure import write_plc_values


def write_callback(message, userdata):
    logger.debug("write plc response: %s, userdata:%s" % (message, userdata))


def main(topic, payload, cloudName):
    logger.debug("subscribe topic: %s, payload: %s, cloudName: %s" % (topic, payload, cloudName))
    write_plc_values(message=json.loads(payload), callback=write_callback, userdata="")

4.5View 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/en/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.6 Northbound Protocol Conversion Configuration

4.6.1 Configuring the Modbus TCP Slave

Click Protocol Conversion, find the Modbus TCP Slave menu bar, select "Configuration", set the information and submit. As shown in the figure below:

4.6.2 Configuring the Modbus Mapping Table

Adopt the default slave address 1, click "Batch Add", set the starting mapping address, select the measurement point under the corresponding controller and click submit, as shown in the following figure:

When the addition is complete, it is shown in the following figure:

The Mapped Address column shows the register address information for the corresponding measurement point.

4.7 Collecting Gateway Data with Modbus Poll

Use Modbus Poll software as Master to collect the data from the gateway, set the connection information to the IP address and port number of the gateway, the slave address is set to 1, the start address of the register read is 40001, and the length of the register is 4, as shown in the following figure:

The data read after successful setup is the same as the data seen on the page of the Measure Monitor, as shown in the figure below:

4.8 Edge measurement data processing

4.8.1 Periodic trigger QuickFunctions

In the Custom QuickFunctions menu bar, click to add a "Periodic trigger" QuickFunctions, set to run in 10-second cycles, the function code for the recall of a southbound collection of data, as shown in the figure below:

# Enter your python code.
from common.Logger import logger
from quickfaas.measure import recall2

def recall2_callback(message, userdata):
    logger.info("recall2 response message: %s, userdata:%s" % (message, userdata))


def main():
    logger.info("Timer start")

    recall2(callback=recall2_callback, userdata="")

    logger.info("Timer end")

Once the setup is complete click submit and the script will run in 10 second cycles, each time it runs, recall2 is called to read the data collected from the southward direction.

4.8.2 Local Subscription Message Trigger QuickFunctions

In the Custom QuickFunctions menu bar, click to add a "Local Subscription Message Trigger" quickfunction, subscribe to the theme is: ds2/eventbus/south/read/+, the theme is the south to the driver to release the controller measurement point value of the message bus, used to get to the south of the cycle acquisition data, as follows shown in the figure:

After the settings are completed, submit. Each time a round of data is collected in the southward direction, this script will be triggered once and the collected data will be output to the log.

4.8.3 Power trigger QuickFunctions

In the Custom QuickFunctions menu, click to add a "Power trigger" quickfunction to indicate that the script will be triggered once when the DSA starts up, as shown in the following figure:

Once set up, the script is triggered to run once when the DSA starts.

5. Concept

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", "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:

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)

from common.Logger import logger
from quickfaas.global_dict import get_global_parameter

def main():
    logger.debug('get global dict: %s' % get_global_parameter()) 

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.

{
  "name": "rsa", //library name
  "version": "4.9", //library version number
  "desc": "", //library descriptive information
  "files": "rsa" //library file paths, more than one separated by spaces
}

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.
   

DLT645-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