Skip to content

Commit 55b068d

Browse files
QQDQQQDQ
authored
Merge pull request #489 from eeff/v2.10
v2.10: add HollySys doc
2 parents d1d0518 + c2147a1 commit 55b068d

File tree

5 files changed

+409
-0
lines changed

5 files changed

+409
-0
lines changed

‎directory.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,10 @@
9999
}
100100
]
101101
},
102+
{
103+
"title": "HollySys Modbus RTU",
104+
"path": "configuration/south-devices/modbus-hollysys-rtu/modbus-hollysys-rtu"
105+
},
102106
{
103107
"title": "XINJE Modbus RTU",
104108
"path": "configuration/south-devices/modbus-xinje-rtu/modbus-xinje-rtu"
@@ -117,6 +121,10 @@
117121
}
118122
]
119123
},
124+
{
125+
"title": "HollySys Modbus TCP",
126+
"path": "configuration/south-devices/modbus-hollysys-tcp/modbus-hollysys-tcp"
127+
},
120128
{
121129
"title": "Inovance Modbus TCP",
122130
"path": "configuration/south-devices/modbus-hc-tcp/modbus-hc-tcp",
@@ -769,6 +777,10 @@
769777
}
770778
]
771779
},
780+
{
781+
"title": "HollySys Modbus RTU",
782+
"path": "configuration/south-devices/modbus-hollysys-rtu/modbus-hollysys-rtu"
783+
},
772784
{
773785
"title": "XINJE Modbus RTU",
774786
"path": "configuration/south-devices/modbus-xinje-rtu/modbus-xinje-rtu"
@@ -787,6 +799,10 @@
787799
}
788800
]
789801
},
802+
{
803+
"title": "HollySys Modbus TCP",
804+
"path": "configuration/south-devices/modbus-hollysys-tcp/modbus-hollysys-tcp"
805+
},
790806
{
791807
"title": "Inovance Modbus TCP",
792808
"path": "configuration/south-devices/modbus-hc-tcp/modbus-hc-tcp",

‎en_US/configuration/south-devices/modbus-hollysys-rtu/modbus-hollysys-rtu.md‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# HollySys Modbus RTU
2+
3+
The Neuron HollySys Modbus RTU plugin is for collecting HollySys PLC tags using the Modbus RTU protocol,
4+
5+
6+
## Add Device
7+
8+
Go to **Configuration -> South Devices**, then click **Add Device** to add the driver. Configure the following settings in the popup dialog box.
9+
10+
- Name: The name of this device node.
11+
- Plugin: Select the **HollySys Modbus RTU** plugin.
12+
13+
## Device Configuration
14+
15+
16+
After clicking **Create**, you will be redirected to the **Device Configuration** page, where we will set up the parameters required for Neuron to establish a connection with the device. You can also click the device configuration icon on the southbound device card to enter the **Device Configuration** interface.
17+
18+
| Parameter | Description |
19+
| -------------------------- | -------------------------------------------------------------------------------------- |
20+
| **Physical Link** | Selects the communication medium, either serial or Ethernet. |
21+
| **Connection Timeout** | The time the system waits for a device to respond to a command. |
22+
| **Maximum Retry Times** | The maximum number of retries after a failed attempt to send a read command. |
23+
| **Retry Interval** | Resend reading instruction interval(ms) after a failed attempt to send a read command. |
24+
| **Send Interval** | The waiting time between sending each read/write command. Some serial devices may discard certain commands if they receive consecutive commands in a short period of time. |
25+
| **Serial Device** | Only needed in **Serial** mode, the path to the serial device when using a serial connection, e.g., /dev/ttyS0 in Linux systems. |
26+
| **Stop Bits** | Only for the **Serial** mode, the serial connection parameter. |
27+
| **Parity** | Only for the **Serial** mode, the serial connection parameter. |
28+
| **Baud Rate** | Only for the **Serial** mode, the serial connection parameter. |
29+
| **Data Bits** | Only for the **Serial** mode, the serial connection parameter. |
30+
| **Connection Mode** | Only for the **Ethernet** mode, you can choose Neuron as the TCP client or server. |
31+
| **IP Address** | Only for the **Ethernet** mode, the IP address of the device when using TCP connection with Neuron as the client, or the IP address of Neuron when using TCP connection with Neuron as the server. The default value is 0.0.0.0. |
32+
| **Port** | Only for the **Ethernet** mode, the port number of the device when using TCP connection with Neuron as the client, or the port number of Neuron when using TCP connection with Neuron as the server. |
33+
| **Maximum Retry Times** | The maximum number of retries after a failed attempt to send a read command. |
34+
| **Retry Interval** | Resend reading instruction interval(ms) after a failed attempt to send a read command. |
35+
36+
The HollySys Modbus RTU plugin configuration is similar to that of the [Modbus RTU driver module](../modbus-rtu/modbus-rtu.md).
37+
38+
## Configure Data Groups and Tags
39+
40+
After the plugin is added and configured, the next step is to establish communication between your device and Neuron by adding groups and tags to the Southbound driver.
41+
42+
Once device configuration is completed, navigate to the **South Devices** page. Click on the device card or device row to access the **Group List** page. Here, you can create a new group by clicking on **Create**, then specifying the group name and data collection interval.
43+
44+
Upon successfully creating a group, click on its name to proceed to the **Tag List** page. This page allows you to add device tags for data collection. You'll need to provide information such as the tag address, attributes, and data type.
45+
46+
For information on general configuration items, see [Connect to Southbound Devices](../south-devices.md). The subsequent section will concentrate on configurations specific to the driver.
47+
48+
### Data types
49+
50+
* BIT
51+
* BOOL
52+
* INT16
53+
* UINT16
54+
* WORD
55+
56+
### Address format
57+
58+
> SLAVE!ADDRESS[#ENDIAN]
59+
60+
The address format is nearly the same to that of the [Modbus RTU driver module](../modbus-rtu/modbus-rtu.md), the only difference is in the **ADDRESS** part.
61+
62+
#### **SLAVE**
63+
64+
Required, Slave is the slave address or site number.
65+
66+
#### **ADDRESS**
67+
68+
HollySys PLC maps data units onto the Modbus address space for access through the Modbus RTU protocol.
69+
The Neuron HollySys Modbus RTU plugin frees users from details of the address mapping, and designates the PLC data unit name as the **ADDRESS**.
70+
71+
72+
| Area | Data unit example | Attribute | Register Size | Data Type |
73+
| ------------------------------- | ------------------------------------------- | ---------- | ------------- | -------------- |
74+
| IX (Input) | IX0.0 ... IX0.7, IX1.0 ... IX1.7 ... | Read | 1Bit | BOOL/BIT |
75+
| IW (Input Registers) | IW0, IW1, ... | Read | 16Bit,2Byte | INT16/UINT16 |
76+
| QX (Coils) | QX0.0 ... QX0.7, QX1.0 ... QX1.7 ... | Read/Write | 1Bit | BOOL/BIT |
77+
| QW (Hold Registers) | QW0, QW1, ... | Read/Write | 16Bit,2Byte | INT16/UINT16 |
78+
| MX (Coils) | MX0.0 ... MX0.7, MX1.0 ... MX1.7 ... | Read/Write | 1Bit | BOOL/BIT |
79+
| MW (Hold Registers) | MW0, MW1, ... | Read/Write | 16Bit,2Byte | INT16/UINT16 |
80+
81+
82+
#### **#ENDIAN**
83+
84+
Optional, byte order, applicable to data types int16/uint16, see the table below for details.
85+
| Symbol | Byte Order | Supported Data Types | Note |
86+
| ------ | ---------- | -------------------- | ----------------------------------- |
87+
| #B | 2,1 | int16/uint16 | |
88+
| #L | 1,2 | int16/uint16 | Default byte order if not specified |
89+
90+
::: tip
91+
The byte order can be illustrated using the notation ABCD, which corresponds directly to the sequence 1234. As an example, the ABCD designation represents the standard or default Endianness 1234. (#LL).
92+
:::
93+
94+
95+
### Example Addresses
96+
97+
| Address | Data Type | Description |
98+
| -------------- | --------- | -------------------------------------------------- |
99+
| 1!IX1.0 | bit | Data unit IX1.0 on slave 1, read only. |
100+
| 1!QW0 | int16 | Data unit QW0 on slave 1, support read/write. |
101+
| 2!MW1 | int16 | Data unit MW1 on slave 1, support read/write. |
102+
103+
104+
## Data Monitoring
105+
106+
After completing the point configuration, you can click **Monitoring** -> **Data Monitoring** to view device information and control devices. For details, refer to [Data Monitoring](../../../admin/monitoring.md).

‎en_US/configuration/south-devices/modbus-hollysys-tcp/modbus-hollysys-tcp.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# HollySys Modbus TCP
2+
3+
The Neuron HollySys Modbus TCP plugin is for collecting HollySys PLC tags using the Modbus TCP protocol,
4+
5+
Modbus TCP is a version of the Modbus protocol based on Ethernet, which uses TCP/IP for communication. Unlike the traditional Modbus RTU protocol, Modbus TCP allows devices to be interconnected directly through Ethernet without any special hardware or communication interface. Therefore, Modbus TCP has higher communication speed and wider application range.
6+
7+
8+
## Add Device
9+
10+
Go to **Configuration -> South Devices**, then click **Add Device** to add the driver. Configure the following settings in the popup dialog box.
11+
12+
- Name: The name of this device node.
13+
- Plugin: Select the **HollySys Modbus TCP** plugin.
14+
15+
16+
## Device Configuration
17+
18+
After clicking **Create**, you will be redirected to the **Device Configuration** page, where we will set up the parameters required for Neuron to establish a connection with the device. You can also click the device configuration icon on the southbound device card to enter the **Device Configuration** interface.
19+
20+
| Parameter | Description |
21+
| -------------------- | ------------------------------------------------------- |
22+
| **Maximum Retry Times** | The maximum number of retries after a failed attempt to send a read command. |
23+
| **Retry Interval** | Resend reading instruction interval(ms) after a failed attempt to send a read command. |
24+
| **Endianness** | Byte order of tags with 32 bits, ABCD corresponds to 1234. |
25+
| **Send Interval** | The waiting time between sending each read/write command. Some serial devices may discard certain commands if they receive consecutive commands in a short period of time. |
26+
| **IP Address** | The IP address of the device when using TCP connection with Neuron as the client. |
27+
| **Port** | The port number of the device when using TCP connection with Neuron as the client. |
28+
| **Connection Timeout** | The time the system waits for a device to respond to a command. |
29+
30+
## Configure Data Groups and Tags
31+
32+
After the plugin is added and configured, the next step is to establish communication between your device and Neuron by adding groups and tags to the Southbound driver.
33+
34+
Once device configuration is completed, navigate to the **South Devices** page. Click on the device card or device row to access the **Group List** page. Here, you can create a new group by clicking on **Create**, then specifying the group name and data collection interval.
35+
36+
Upon successfully creating a group, click on its name to proceed to the **Tag List** page. This page allows you to add device tags for data collection. You'll need to provide information such as the tag address, attributes, and data type.
37+
38+
For information on general configuration items, see [Connect to Southbound Devices](../south-devices.md). The subsequent section will concentrate on configurations specific to the driver.
39+
40+
### Data types
41+
42+
* BIT
43+
* BOOL
44+
* INT16
45+
* UINT16
46+
* WORD
47+
48+
### Address format
49+
50+
> SLAVE!ADDRESS[#ENDIAN]
51+
52+
#### **SLAVE**
53+
54+
Required, Slave is the slave address or site number.
55+
56+
#### **ADDRESS**
57+
58+
HollySys PLC maps data units onto the Modbus address space for access through the Modbus TCP protocol.
59+
The Neuron HollySys Modbus TCP plugin frees users from details of the address mapping, and designates the PLC data unit name as the **ADDRESS**.
60+
61+
62+
| Area | Data unit example | Attribute | Register Size | Data Type |
63+
| ------------------------------- | ------------------------------------------- | ---------- | ------------- | -------------- |
64+
| IX (Input) | IX0.0 ... IX0.7, IX1.0 ... IX1.7 ... | Read | 1Bit | BOOL/BIT |
65+
| IW (Input Registers) | IW0, IW1, ... | Read | 16Bit,2Byte | INT16/UINT16 |
66+
| QX (Coils) | QX0.0 ... QX0.7, QX1.0 ... QX1.7 ... | Read/Write | 1Bit | BOOL/BIT |
67+
| QW (Hold Registers) | QW0, QW1, ... | Read/Write | 16Bit,2Byte | INT16/UINT16 |
68+
| MX (Coils) | MX0.0 ... MX0.7, MX1.0 ... MX1.7 ... | Read/Write | 1Bit | BOOL/BIT |
69+
| MW (Hold Registers) | MW0, MW1, ... | Read/Write | 16Bit,2Byte | INT16/UINT16 |
70+
71+
72+
#### **#ENDIAN**
73+
74+
Optional, byte order, applicable to data types int16/uint16, see the table below for details.
75+
76+
| Symbol | Byte Order | Supported Data Types | Note |
77+
| ------ | ---------- | -------------------- | ----------------------------------- |
78+
| #B | 2,1 | int16/uint16 | |
79+
| #L | 1,2 | int16/uint16 | Default byte order if not specified |
80+
81+
::: tip
82+
The byte order of a tag has a higher priority than the byte order configuration of a node. That is to say, once the byte order is configured for a tag, it follows the configuration of that tag and ignores the node configuration.
83+
The byte order can be illustrated using the notation ABCD, which corresponds directly to the sequence 1234. As an example, the ABCD designation represents the standard or default Endianness 1234. (#LL).
84+
:::
85+
86+
87+
### Example Addresses
88+
89+
| Address | Data Type | Description |
90+
| -------------- | --------- | -------------------------------------------------- |
91+
| 1!IX1.0 | bit | Data unit IX1.0 on slave 1, read only. |
92+
| 1!QW0 | int16 | Data unit QW0 on slave 1, support read/write. |
93+
| 2!MW1 | int16 | Data unit MW1 on slave 1, support read/write. |
94+
95+
96+
## Data Monitoring
97+
98+
After completing the point configuration, you can click **Monitoring** -> **Data Monitoring** to view device information and control devices. For details, refer to [Data Monitoring](../../../admin/monitoring.md).

0 commit comments

Comments
 (0)