1 System Overview

1.1  Functional Overview

The main functions of the system include:

l Flexible transport configuration (link, storage, device, factor, upload service)

l Data collection and upload

l Real-time monitoring (device, upload)

l Alarm configuration and monitoring

l Data storage and query (tables, charts, Web API)

l Configuration and visualization

l User and permission management

l Interface multi-language support

1.2 Operating Environment

1.3 Supported devices

1.3.1  Support communication links

Some of the communication links supported by the system include:

1.3.2 Supported communication protocols

Some of the communication protocols supported by the system include:

1.4 Glossary

1.4.1 equipment

The system collects data from a device that has a communication interface and uses a specific communication protocol to communicate. The device can be a detection instrument, a small meter, a sensor, or even a separate PLC.

1.4.2 factor

Factors are attributes of a device, including its measured value, state, control unit, etc. For example, for a measuring instrument, the following attributes can be called a factor:

l Latest measured value (measured value)

l Current device status: measuring, standby, fault, etc. (status)

l Start measurement, stop measurement (control unit)

1.4.3 link

The physical connection method between the system and the device and the basic communication protocol, that is, the part below the link layer in the communication process. For example, it can be using a serial communication line and a UART communication protocol; or using a network cable and a TCP/IP communication protocol. It supports multiple devices sharing one link.

1.4.4 drive

A functional module that implements functions such as collection, upload, and storage. According to the functional division, it includes collection driver (implementing collection communication protocol parsing), upload driver (implementing upload communication protocol parsing), link driver (implementing the connection and data transmission and reception of specific links), and storage driver (implementing the storage and operation of specific databases).

1.4.5 Upload Service

The system uploads data to the platform or other devices using specific links and communication protocols.

1.4.6 Upload Factor

The factor to be uploaded to the platform or other device.

2 Service Concept

Our company solemnly promises:

You buy not only the product, but also the meticulous and thoughtful technical support service ! ! ! ( =^_^= )

For most of our wireless products, ordinary workers are needed to connect the power and install them on site! No debugging is required!

We provide free remote guidance, remote configuration and debugging services, and send data to the user's designated cloud platform. (Hardware)

Free IoT solution consulting services!

3  Software Installation and Authentication

3.1 Installation on 64-bit Windows

3.1.1 Environment Preparation

Before installing the system, please make sure that .NET6 has been successfully installed. You can download and install .NET6 from the Microsoft official website .

If you are using an older Windows system, you may need to install the following prerequisite packages first (if you are prompted during the installation process that the service cannot be started, this generally means that you need to install the prerequisite packages):

Essential Package 1:

Essential Pack 2:

3.1.2 Software Installation

After downloading the installation package, run the installation program, as shown below:

Select the installation directory and click the Start Installation button to complete the system installation.

3.2 Open the management page

After the system is installed, you can use a modern browser (Edge or Chrome is recommended) and enter http://localhost:16801/scada.html in the address bar to access the management page. Since the system requires login, you will first enter the login page:

The default system accounts are:

After logging in, you can enter the system homepage, as shown below:

If necessary, the system can switch the interface language freely. The following figure is the English interface:

3.3 System Certification

The system has a 14-day trial period. After the trial period, the system needs to be authenticated before it can be used normally (otherwise the system cannot collect data). The authentication operation is completed on the system configuration page (Settings->System Configuration):

The certification process is:

1. Copy the machine code and provide it to the supplier.

2. Obtain certification documents from suppliers.

3. Upload the authentication document.

It should be noted that one authentication file can only authenticate one computer.

4 Transfer and storage configuration

4.1 Transport Architecture

for collection, uploading and storage is shown below:

Generally speaking, the core function of the system is to collect data from the device, store the data, and upload it to the platform. Each transmission requires the use of a communication link and a certain communication protocol. Then, the entire transmission and storage process will have the following modules:

l Communication Link

l Collection Protocol

l Upload Agreement

l Storage Solutions

For each module, the system adopts a driver + configuration model to meet the needs. Taking the storage solution as an example, the storage driver contains the code to store data in a certain database (such as MySQL), while the storage configuration includes the connection string and when to store these contents.

4.2 Driver Management

The driver is a code library that implements specific functions and can be imported into the system as needed. The following is the management page of the acquisition driver:

Generally, you can obtain the driver from the supplier, upload it to the system, and use it after configuration. For specific application scenarios, you can also develop the driver yourself according to the development documentation.

4.3Data collection configuration

Data collection requires configuration of storage solutions, communication links, and communication protocols.

4.3.1 Storage Solutions

Each device can select a different storage solution (or all devices can select the same storage solution). The storage solution management page (Storage Management->Storage Solution) is shown below:

In the storage plan, you can select the type of database to be stored, the storage time, whether to store the status, the data format, etc.

4.3.1.1 Supported databases

The system supports databases such as SQLite, SQL Server, and MySQL.

4.3.1.2 Connection String

For SQLite database, fill in the file path in the connection string, such as:

The typical connection string format for SQL Server is:

The typical connection string format for MySQL is:

4.3.1.3 Storage time

There are two types of storage timing: interval time and specified time.

The interval time needs to be filled in with a time in milliseconds . The data will be stored once every time this interval is reached . For example, if you fill in 60000, it will be stored once a minute.

The format for specifying time is: ` HH:mm HH:mm HH:mm `, only hours and minutes are supported. Data will be stored once at the specified time of each day. For example, if you enter `08:00 12:00 16:00 `, data will be stored once at 8:00, 12:00, and 16:00.

4.3.1.4 Data Format

Data formats include strings and numbers. If all data collected by the system are numbers, it is recommended to use the number format, which can save space and improve performance. If the data includes non-numeric strings, you can only choose the string format.

4.3.1.5 Storage Status

checking the storage status, the database will store the current status of the device while storing the data. When the device is offline, the collected data will still be the value collected last time. For specific values of the device status, see Appendix 1.

4.3.1.6 Database maintenance

When the transmission configuration is modified, the database structure will be modified accordingly. In order to clean up redundant structures and data, the system provides three maintenance operations:

Clean the table structure: clear unused columns and unused tables.

Clear data: Clear all data.

Rebuild table structure: Clear the old structure and data and recreate the table structure.

4.3.2 Link Configuration

The link configuration page (Transmission Configuration->Link Configuration) is shown below:

The currently supported link types and the contents that need to be configured are shown in the following table:

4.3.3 Device Configuration

4.3.3.1 Device Configuration

Device configuration is mainly about the configuration of communication protocol. The device configuration page (Transmission Configuration->Device Configuration) is shown in the figure below:

Devices using different drivers will have different configuration information. However, all devices need to configure certain information, as shown in the following table:

4.3.3.2 Factor configuration

The device contains factors (devices without added factors generally do not collect data). The factor configuration page (from the device configuration page, click the button on the far right of a device to enter) is shown in the figure below:

Devices using different drivers require different information to be configured. Several common properties are described below:

4.4 Data upload configuration

Data upload requires configuration of communication link and communication protocol. The configuration of communication link is the same as that of data collection.

upload service configuration page (Transfer Configuration -> Upload Configuration) is shown in the figure below:

the upload service, you need to configure the upload factor. You can configure it on the upload factor configuration page (from the upload configuration page, click the button on the far right of an upload service to enter), as shown in the following figure:

The configuration content varies according to the protocol. The following are the common properties of each upload factor:

coding

For most upload protocols, if you fill in the field, the data will be uploaded with the code. If you do not fill in the field, the data will be uploaded with the original name of the factor. For example, for the MQTT upload protocol, if the factor is device1.factor1, if you do not fill in the field, the topic of the upload is data/device1.factor1; if you fill in the field code1, the topic of the upload is data/code1.

4.5 Configuration import and export

4.5.1 Configuration Export

Export the configuration in the Configuration Export page (Transfer Configuration -> Configuration Export), as shown in the following figure:

During the export process, you need to select the device to be exported and the upload service. When exporting, the related link configuration and storage solution will be exported at the same time.

4.5.2 Configuration Import

Import the configuration in the Configuration Import page (Transfer Configuration -> Configuration Import), as shown below:

When importing configuration, you can choose from the following options based on actual conditions:

Clear configuration: Clear all configured contents.

Direct overwrite: Clear all original configurations first, and then add the imported configuration.

Supplemental configuration: Add imported configuration incrementally. If the original configuration and the imported configuration have the same ID or name, the imported configuration will not be used.

5 Real-time monitoring

5.1 System start and stop

In the system title bar, you can start or stop the system, as shown in the following figure:

The start and stop here refers to the start and stop of the entire system (including collection and upload). If you want to suspend a device or an upload service, you can operate (disable or enable) on the device monitoring and upload monitoring pages.

5.2 Equipment Monitoring

If you need to view the current collection status, you can open the device monitoring page (Data Monitoring->Device Monitoring), as shown below:

From this page, you can:

l Check the real-time status of the device. For the description of the device status, please refer to Appendix 1.

l View the real-time value of each factor, as well as the current data time.

l Enable or disable a device.

l Reverse control of the device to modify the factor value. This operation will send a change value and write command to the device , not a virtual change value.

5.3 Upload monitoring

On the upload monitoring page (Data Monitoring -> Upload Monitoring), you can view the current upload status, as shown below:

You can also pause uploading on this page.

 6 Historical data query

6.1 Data Query

You can use tables or charts to query historical data. If you find that there is no data when querying data, the possible reasons are:

l When configuring the factor, whether to store is not checked.

l Database configuration, storage time is not to store.

l Collection was not started.

l No legitimate data has yet appeared.

6.2 Table method

The data queried using the table method is detailed data. The data query page (Statistical Analysis->Data Query) is shown in the figure below:

Select the factor you want to query on the left side of the page, select the start time and end time, and you can query the results.

When a sign like [Ex] appears in front of the data (or the data starts with @), it means that the data is abnormal. The data at this time is only a historical retention value and cannot be used in practice. For example, when the link is disconnected or the device is disabled, if the query result still has a value, the result at this time is meaningless. The brackets represent the device status, please refer to Appendix 1.

6.3 Chart Mode

The data queried using the chart method is only brief data (when the amount of data is large, not all data will be displayed in the chart). The data chart page (Statistical Analysis->Data Chart) is shown in the figure below:

7 Alarm configuration and monitoring

7.1 Alarm Configuration

Configure the alarm on the alarm configuration page (Transmission Configuration -> Alarm Configuration), as shown below:

For each alarm, the configurable information includes the alarm title, alarm level, and the conditions that trigger the alarm. The expression used in the trigger condition is a logical expression, and the factors are enclosed in curly brackets. For details, please refer to Appendix 2.

7.2 Alarm storage

By default, alarm information is not stored. If storage is required, a storage plan needs to be set. Set the storage plan in the alarm storage plan setting page (Storage Management -> Alarm Storage Plan), as shown in the following figure:

In general, you only need to fill in the connection string.

Finally, return to the alarm configuration page (Transmission Configuration -> Alarm Configuration), click the second button in the upper right corner, and select the alarm storage solution:

7.3 Alarm monitoring

The alarm information generated by the system in real time can be viewed in the alarm monitoring page (Data Monitoring -> Alarm Monitoring):

7.4 Alarm query

All alarm information generated by the system can be queried in the alarm query interface (Statistical Analysis->Alarm Query), as shown in the following figure:

8 User and permissions management

8.1 Default User

By default, there are two users in the system, as shown in the following table:

After officially using the system, if permission control is required, the initial password should be modified.

8.2 User roles

The system-defined roles and their permissions are shown in the following table:

9 Configuration visualization

9.1 Functional Overview

This system provides configuration and visualization functions, with powerful low-code visualization building and orchestration capabilities, simple configuration, rich controls, and high degree of customization. Combined with data acquisition and control systems, it can realize the display of real-time and historical data, as well as real-time control of equipment.

The system supports the following functions:

l User-defined images can be added (supporting JPG, PNG, GIF, SVG and other formats).

l User-defined components can be added.

l Supports data display components such as tables and charts.

l Both real-time data and historical data can be displayed.

l Can send control commands to the device .

l Provides a large number of auxiliary design functions (auxiliary lines, rulers, magnets, alignment, etc.).

9.2 Application Examples

The following is a page designed using the visualization function:

9.3 Interface Introduction

9.3.1 Visual home page

The system home page is shown below:

You can add multiple views to this page. For each view, click the screen to enter the running page, and click the design button in the lower right corner to design the screen.

9.3.2 Visual design page

The system design page is shown below:

9.3.2.1 Page General Administration

At the top of the design page is the title bar. Click the view name to modify it, and click the preview button to enter the run page.

On the left side of the main part is the resource library, including the component library and image library, and you can drag resources to the main canvas.

On the right side of the main part is the property configuration panel. Selecting different elements will display the element's unique property configuration.

The center of the main part is the main canvas, where you can drag and adjust the position of resources. Below the main canvas are thumbnails and a display scale, where you can move and scale the main canvas.

9.3.2.2 General Design Steps

The general steps for designing a page are:

1. Drag assets from the asset library to the canvas.

2. Adjust the size and location of resources.

3. Modify the resource's style, data source, and trigger events.

9.3.2.3 Resource Library

The system's resource library includes two types: component library and image library.

The elements in the picture library are just simple pictures. Users can upload custom pictures. Supported formats include png , jpg, gif , svg , etc.

The elements in the component library contain code functions and can provide richer interactive functions, such as charts, progress bars, input boxes, etc. Users can also develop components according to the development documents and then upload them to the system for use.

9.3.2.4 Resource attributes

Different types of resources have different properties, such as rectangles have corner radius properties, pipes have flow shape properties. However, the properties of all resources can be divided into three parts: style, database, and event.

The style part includes information such as size, position, color, font, etc.

The data source part defines how the resource changes dynamically, and completes the function by filling in expressions. For example, after filling in an expression like {D1.F1}==1 in the display condition, the resource will be displayed when D1.F1 is 1, and hidden in other cases. For another example, for text, after filling in an expression like current value: {D1.F1}, the resource will display the following text when D1.F1 is 1: Current value: 1.

The event part defines what happens after some operations are performed on the resource on the running page. For example, if you fill in {D1.F1}=2 in the click event, then after the user clicks the resource, the system will send a command to the device to change the value to 2. For another example, if you fill in <var1>=value in the input box change value event , when the user enters 12.5 in the input box, the value of the variable var1 will change to 12.5.

9.3.3 Visual operation page

The running page only contains the designed content and no additional page elements, as shown in the following figure:

On the Run page, available functions include:

l Displays the device values collected in real time.

l Displays data history.

l Display dynamically changing system processes.

l Send instructions and values to the device by operating page elements .

l Switch to a different view page.

9.4 Data Source

9.4.1 Data Citation

To reference a factor in a data source, enclose the factor name in parentheses. The expression is:

To reference a temporary variable in a data source, add angle brackets around the variable name. The expression is:

9.4.2 Text data source

Text data sources can be written normally, and where data needs to be referenced, just insert a reference expression. For example:

9.4.3 Conditional Data Sources

The conditional data source requires the written content to be a logical expression, such as:

9.4.4 Chart Data

The format for reading factor data is:

The first factor is a fixed string.

factors is a list of factor names separated by commas, such as D1.F1,D1.F2.

Minutes is the number of minutes of data to be retrieved .

Interval is the interval in minutes between each piece of data.

format is the time display format. The year, month, day, hour and minute are represented by yyyy , MM, dd, HH and mm respectively.

Here is an example. Take the data of D1.F1 and D3.F1, take one piece of data every 5 minutes within one hour, and the time display format is HH:mm , then the content to be filled in is:

9.5 event

9.5.1 Event Overview

Each event can contain multiple instructions, separated by semicolons, such as:

Instruction types include modifying factors, modifying variables, switching pages, etc.

9.5.2 Modify Factor Event

The format of a modifier event is:

Other, the value can be a fixed number or a variable, such as:

9.5.3 Value Change Event

Some controls (such as input boxes) have value modification events. When the event occurs, use value to refer to the newly modified value. The format is:

Here is an example to implement such a function: add an input box and a button to the view, and when the button is clicked, the value of the input box is sent to the factor D1.F1. To complete such a function, enter the following in the input value change event:

Then in the button's click event enter:

9.5.4 Page switching events

The format of the page switching event is:

If you want to replace the current page, the command is:

If you want to open a new page, add "new" after the command, as shown below:

Appendix 1 Equipment Status Codes

The device status codes and their meanings are shown in the following table:

Appendix 2 Data Sources and Expressions

A2.1 Variable reference

In device configuration, hardware is read and written by configuring a factor. Where expressions are used, this factor refers to the corresponding hardware. Use device name.factor name to represent factors.

For example, a device D1 using the Modbus protocol is added, and a factor F1 is added to read and write the value of register address 40001. Then, D1.F1 represents register 40001.

In expressions, variables need to be written in curly braces:

To reference itself, you can use this:

A2.2 Expression Types

There are four expressions used in the system, namely:

Numeric expression: The result of the calculation is a numeric value, for example: {a}*2.5+3

Logical expression: The result of the calculation is a logical value, for example: {a}>10

Text expression: can only calculate the content in the braces, there is no fixed format, for example: the value of a is {a}mg/L

Command expression: There is an equal sign in the middle, the variable is on the left, and the value is on the right, for example: {a}=10

A2.3 Factor configuration expression

In the factor configuration, you can enter an expression. This is generally used when there is a functional relationship between the collected value and the actual displayed value. For example, the collected value is in kg, but the storage requirement is in g. Then, after this value is collected, an expression needs to be used for conversion.

The factor configuration expression is a numerical expression. Taking the above example, assuming the factor is D1.F1, the actual factor needs to be multiplied by 1000. The expression can be written as:

Since the factor filled in the expression is the current factor, you can also use this instead, as follows:

When the expression is simply multiplied by a factor, or a bias value is added (can only be multiplied or added), it can be abbreviated directly to:

or

Appendix 3 MODBUS Configuration Instructions

A3.1 Driver and Link Selection

There are three types of Modbus protocols, namely Modbus-RTU, Modbus-TCP and Modbus-ASCII. You need to select the appropriate acquisition driver according to the actual situation. All three communication protocols can communicate under TCP client or serial port link.

A3.2 Collection interval selection

For Modbus communication protocol, the acquisition interval and cycle wait can be set to 0, and the receiving wait time needs to be more than 100ms. If you find that the data is chaotic when receiving data, it is generally caused by insufficient receiving wait time. If this problem occurs, you can increase the receiving wait time appropriately. If you want to know the more accurate time, you can send a Modbus command to the device and observe the time of data reply.

A3.3 Storage Mode

The Modbus protocol defines a variety of data storage spaces, including registers, coils, input registers, and input coils. The storage mode to be used is selected according to the document description.

A3.4 Channel Type

For registers, the channel types are various, including FLOAT, INT, BIT, etc.; while for coils, the channel type is only BIT.

For multi-byte data, the storage order of bytes in different devices may be different, so you need to choose according to the actual situation. The following are commonly used byte orders:

A3.5 Bitwise Value

Select register for storage mode and BIT for channel type, then you can get the value by bit. The starting address is the address of the register, and the bit address indicates which bit of data to get. The bit address is from right to left, that is, the rightmost bit is bit 0.

A3.6 Continuous Addresses

If there are several factor channels of the same type and with consecutive addresses, they can be configured once. Just fill in a value greater than 1 in the channel number, and the automatically created factor address will be automatically adjusted according to the channel type. The following is an example after the channel number is filled in with 5: