Difference between revisions of "Template:Networking rutos manual dnp3"
(8 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
− | {{Template: | + | {{Template: Networking_rutos_manual_fw_disclosure |
− | + | | fw_version ={{Template: Networking_rutos_manual_latest_fw | |
− | |||
− | | fw_version ={{Template: | ||
| series = {{{series}}} | | series = {{{series}}} | ||
| name = {{{name}}} | | name = {{{name}}} | ||
Line 14: | Line 12: | ||
This manual page provides an overview of the DNP3 functionality in {{{name}}} devices. | This manual page provides an overview of the DNP3 functionality in {{{name}}} devices. | ||
− | <b>Note:</b> DNP3 is additional software that can be installed from the <b> | + | <b>Note:</b> DNP3 is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u> |
==DNP3 Parameters== | ==DNP3 Parameters== | ||
Line 64: | Line 62: | ||
|TRB142= | |TRB142= | ||
|TRB145= | |TRB145= | ||
− | | | + | | |
<tr> | <tr> | ||
<td>LAN MAC Address</td> | <td>LAN MAC Address</td> | ||
Line 319: | Line 317: | ||
<td>Octet String</td> | <td>Octet String</td> | ||
</tr> | </tr> | ||
− | + | }} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</table> | </table> | ||
Line 559: | Line 482: | ||
</tr> | </tr> | ||
</table> | </table> | ||
+ | |||
{{#switch:{{{name}}} | {{#switch:{{{name}}} | ||
|RUTX12= | |RUTX12= | ||
Line 573: | Line 497: | ||
A client in DNP3 is a component that communicates (requests data) with a single outstation via a communication channel. By default, the client list is empty. To add a new client, click the 'Add' button. | A client in DNP3 is a component that communicates (requests data) with a single outstation via a communication channel. By default, the client list is empty. To add a new client, click the 'Add' button. | ||
− | [[File: | + | [[File:Networking_rutos_manual_dnp3_tcp_master_add_button_v2.eps|border|class=tlt-border]] |
After clicking 'Add' you will be redirected to the newly added client's configuration page. | After clicking 'Add' you will be redirected to the newly added client's configuration page. | ||
Line 581: | Line 505: | ||
The <b>TCP Client Configuration</b> section is used to configure the parameters of a DNP3 Outstation that the Client (this {{{name}}} device) will be querying with requests. The figure below is an example of the TCP Client Configuration and the table below provides information on the fields contained in that section: | The <b>TCP Client Configuration</b> section is used to configure the parameters of a DNP3 Outstation that the Client (this {{{name}}} device) will be querying with requests. The figure below is an example of the TCP Client Configuration and the table below provides information on the fields contained in that section: | ||
− | [[File: | + | [[File:Networking_rutos_manual_dnp3_tcp_client_tcp_client_configuration.png|border|class=tlt-border]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 591: | Line 515: | ||
<tr> | <tr> | ||
<td>Enable</td> | <td>Enable</td> | ||
− | <td>off | + | <td>off | on; default: <b>off</b></td> |
<td>Turns communication with the outstation device on or off.</td> | <td>Turns communication with the outstation device on or off.</td> | ||
</tr> | </tr> | ||
Line 631: | Line 555: | ||
<tr> | <tr> | ||
<td>Save to flash</td> | <td>Save to flash</td> | ||
− | <td>off | + | <td>off | on; default: <b>off</b></td> |
<td>When enabled, stores request information in device flash.</td> | <td>When enabled, stores request information in device flash.</td> | ||
</tr> | </tr> | ||
Line 642: | Line 566: | ||
The Request Configuration list is empty by default. To add a new Request Configuration look to the Add New Instance section. Enter a custom name into the 'New Configuration Name' field and click the 'Add' button: | The Request Configuration list is empty by default. To add a new Request Configuration look to the Add New Instance section. Enter a custom name into the 'New Configuration Name' field and click the 'Add' button: | ||
− | [[File: | + | [[File:Networking_rutos_manual_dnp3_tcp_master_tcp_master_configuration_requests_configuration_add_new_instance_v2.png|border|class=tlt-border]] |
The new Request Configuration should become visible in the list: | The new Request Configuration should become visible in the list: | ||
− | [[File: | + | [[File:Networking_rutos_manual_dnp3_tcp_master_requests_configuration.png|border|class=tlt-border]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 671: | Line 595: | ||
<tr> | <tr> | ||
<td>Data Type</td> | <td>Data Type</td> | ||
− | <td>Binary | + | <td>Binary | Double Binary | Counter | Frozen Counter | Analog | Octet String | Analog Output Status | Binary Output Status; default: <b>Binary</b></td> |
<td>Data object group of the requested index(-es).</td> | <td>Data object group of the requested index(-es).</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>off/on slider</td> |
− | <td>off | + | <td>off | on; default: <b>off</b></td> |
<td>Turns the request on or off.</td> | <td>Turns the request on or off.</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
</table> | </table> | ||
Line 699: | Line 618: | ||
By default, the list is empty. To add a new client instance, enter the instance name, select serial interface and click the 'Add' button. | By default, the list is empty. To add a new client instance, enter the instance name, select serial interface and click the 'Add' button. | ||
− | [[File:Networking_rutos_manual_generic_serial_instance_add_button_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}v3. | + | [[File:Networking_rutos_manual_generic_serial_instance_add_button_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}v3.eps|border|class=tlt-border]] |
After clicking 'Add' you will be redirected to the newly added client instance configuration page. | After clicking 'Add' you will be redirected to the newly added client instance configuration page. | ||
Line 707: | Line 626: | ||
The <b>Serial Client Configuration</b> section is used to configure the parameters of a DNP3 Outstation that the Client (this {{{name}}} device) will be querying with requests. The figure below is an example of the Serial Client Configuration and the table below provides information on the fields contained in that section: | The <b>Serial Client Configuration</b> section is used to configure the parameters of a DNP3 Outstation that the Client (this {{{name}}} device) will be querying with requests. The figure below is an example of the Serial Client Configuration and the table below provides information on the fields contained in that section: | ||
− | [[File: | + | [[File:Networking_rutos_manual_dnp3_serial_client_configuration_rs232{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}.png|border|class=tlt-border]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 814: | Line 733: | ||
The new Request Configuration should become visible in the list: | The new Request Configuration should become visible in the list: | ||
− | [[File: | + | [[File:Networking_rutos_manual_dnp3_tcp_master_requests_configuration.png|border|class=tlt-border]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 843: | Line 762: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td>off/on slider</td> |
<td>off {{!}} on; default: <b>off</b></td> | <td>off {{!}} on; default: <b>off</b></td> | ||
<td>Turns the request on or off.</td> | <td>Turns the request on or off.</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
</table> | </table> | ||
Line 863: | Line 777: | ||
==DNP3 Outstation== | ==DNP3 Outstation== | ||
− | An outstation in DNP3 is a component that communicates with a single | + | An outstation in DNP3 is a component that communicates with a single master via a communication channel. It makes measurements of the physical world and then sends them to a master upon request (solicited) or on its own accord (unsolicited). Occasionally a master requests that it do something by sending it a control. This provides the user with the possibility to get system parameters. |
The figure below is an example of the DNP3 Outstation window section and the table below provides information on the fields contained in that window: | The figure below is an example of the DNP3 Outstation window section and the table below provides information on the fields contained in that window: | ||
− | [[File: | + | [[File:Networking_rutos_manual_dnp3_dnp3_outstation.png|border|class=tlt-border]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 877: | Line 791: | ||
<tr> | <tr> | ||
<td>Enable</td> | <td>Enable</td> | ||
− | <td>off | + | <td>off | on; default: <b>off</b></td> |
<td>Turns DNP3 Outstation on or off.</td> | <td>Turns DNP3 Outstation on or off.</td> | ||
</tr> | </tr> | ||
Line 888: | Line 802: | ||
<td>Remote Address</td> | <td>Remote Address</td> | ||
<td>integer [0..65535]; default: <b>none</b></td> | <td>integer [0..65535]; default: <b>none</b></td> | ||
− | <td> | + | <td>Master Link-Layer address.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Unsolicited enabled</td> | <td>Unsolicited enabled</td> | ||
− | <td>off | + | <td>off | on; default: <b>none</b></td> |
<td>Enables the transmission of unsolicited messages.</td> | <td>Enables the transmission of unsolicited messages.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Protocol</td> | <td>Protocol</td> | ||
− | <td>TCP | + | <td>TCP | <span style="color:red">UDP</span>; default: <b>TCP</b></td> |
<td>Protocol used for DNP3 communications.</td> | <td>Protocol used for DNP3 communications.</td> | ||
</tr> | </tr> | ||
Line 917: | Line 831: | ||
<tr> | <tr> | ||
<td>Allow Remote Access</td> | <td>Allow Remote Access</td> | ||
− | <td>off | + | <td>off | on; default: <b>off</b></td> |
<td>Allows remote DNP3 connections by adding an exception to the device's firewall on the port specified in the field above.</td> | <td>Allows remote DNP3 connections by adding an exception to the device's firewall on the port specified in the field above.</td> | ||
</tr> | </tr> | ||
Line 924: | Line 838: | ||
==DNP3 Serial Outstation== | ==DNP3 Serial Outstation== | ||
− | An outstation in DNP3 is a component that communicates with a single | + | An outstation in DNP3 is a component that communicates with a single master via a communication channel. It makes measurements of the physical world and then sends them to a master upon request (solicited) or on its own accord (unsolicited). Occasionally a master requests that it do something by sending it a control. This provides the user with the possibility to get system parameters. |
===DNP3 Serial Outstation Configuration=== | ===DNP3 Serial Outstation Configuration=== | ||
Line 934: | Line 848: | ||
[[File:Networking rutos manual generic serial outstation instance add button rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v1.png|border|class=tlt-border]] | [[File:Networking rutos manual generic serial outstation instance add button rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v1.png|border|class=tlt-border]] | ||
− | After clicking 'Add' you will be redirected to the newly added | + | After clicking 'Add' you will be redirected to the newly added master instance configuration page. |
===RS Device DNP3 Outstation Configuration=== | ===RS Device DNP3 Outstation Configuration=== | ||
---- | ---- | ||
− | The <b>RS Device DNP3 Outstation Configuration</b> section is used to configure the parameters of a Serial DNP3 Outstation that will be queried by other | + | The <b>RS Device DNP3 Outstation Configuration</b> section is used to configure the parameters of a Serial DNP3 Outstation that will be queried by other Master devices. The figure below is an example of the Serial Master Configuration and the table below provides information on the fields contained in that section: |
[[File:Networking_rutos_manual_dnp3_serial_outstation_configuration_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v1.png|border|class=tlt-border]] | [[File:Networking_rutos_manual_dnp3_serial_outstation_configuration_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}_v1.png|border|class=tlt-border]] | ||
Line 956: | Line 870: | ||
<td>Name</td> | <td>Name</td> | ||
<td>string; default: <b>none</b></td> | <td>string; default: <b>none</b></td> | ||
− | <td>Name of the Serial | + | <td>Name of the Serial master, used for easier management purposes.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 1,008: | Line 922: | ||
<td>Remote Address</td> | <td>Remote Address</td> | ||
<td>integer [0..65535]; default: <b>none</b></td> | <td>integer [0..65535]; default: <b>none</b></td> | ||
− | <td> | + | <td>Master Link-Layer address.</td> |
</tr> | </tr> | ||
<tr> | <tr> |
Revision as of 12:09, 25 September 2023
Template:Networking rutos manual fw disclosure
Summary
Distributed Network Protocol 3 (DNP3) is a set of communications protocols used between components in process automation systems. It is primarily used for communications between a client station and Remote Terminal Units (RTUs) or Intelligent Electronic Devices (IEDs).
This manual page provides an overview of the DNP3 functionality in {{{name}}} devices.
Note: DNP3 is additional software that can be installed from the Services → [[{{{name}}} Package Manager|Package Manager]] page.
DNP3 Parameters
DNP3 parameters are held within indexes. The index numbers and corresponding system values are described in the table below:
required value | index | group type |
---|---|---|
Uptime | 0 | Counter |
Hostname | 3 | Octet String |
Router Serial Number | 5 | Octet String |
LAN MAC Address | 6 | Octet String |
Router name | 7 | Octet String |
TCP Client
A client in DNP3 is a component that communicates (requests data) with a single outstation via a communication channel. By default, the client list is empty. To add a new client, click the 'Add' button.
File:Networking rutos manual dnp3 tcp master add button v2.eps
After clicking 'Add' you will be redirected to the newly added client's configuration page.
TCP Client Configuration
The TCP Client Configuration section is used to configure the parameters of a DNP3 Outstation that the Client (this {{{name}}} device) will be querying with requests. The figure below is an example of the TCP Client Configuration and the table below provides information on the fields contained in that section:
Field | Value | Description |
---|---|---|
Enable | off | on; default: off | Turns communication with the outstation device on or off. |
Name | string; default: none | Name of the TCP client, used for easier management purposes. |
IP address | ip; default: none | DNP3 Outstation IP address. |
Port | integer [0..65535]; default: none | DNP3 Outstation Port. |
Local Address | integer [0..65535]; default: none | Clients Link-Layer address. |
Remote Address | integer [0..65535]; default: none | Outstation Link-Layer address. |
Period | integer [1..60]; default: none | Interval at which requests are sent to the outstation device. |
Timeout | integer [1..60]; default: none | Maximum response wait time. |
Save to flash | off | on; default: off | When enabled, stores request information in device flash. |
Requests Configuration
A DNP3 request is a way of obtaining data from DNP3 Outstations. The client sends a request to an outstation specifying the function codes to be performed. The outstation then sends the requested data back to the DNP3 client.
The Request Configuration list is empty by default. To add a new Request Configuration look to the Add New Instance section. Enter a custom name into the 'New Configuration Name' field and click the 'Add' button:
The new Request Configuration should become visible in the list:
Field | Value | Description |
---|---|---|
Name | string; default: Unnamed | Name of this Request Configuration. Used for easier management purposes. |
Start Index | integer [0..65535]; default: none | Start index of the data subarray. |
End Index | integer [0..65535]; default: none | End index of the data subarray. |
Data Type | Binary | Double Binary | Counter | Frozen Counter | Analog | Octet String | Analog Output Status | Binary Output Status; default: Binary | Data object group of the requested index(-es). |
off/on slider | off | on; default: off | Turns the request on or off. |
Request Configuration Testing
This section is used to check whether the configuration works correctly. Simply click the 'Test' button and a response should appear in the box below. The last value represents the configured request data. A successful response to a test may look something like this:
DNP3 Outstation
An outstation in DNP3 is a component that communicates with a single master via a communication channel. It makes measurements of the physical world and then sends them to a master upon request (solicited) or on its own accord (unsolicited). Occasionally a master requests that it do something by sending it a control. This provides the user with the possibility to get system parameters.
The figure below is an example of the DNP3 Outstation window section and the table below provides information on the fields contained in that window:
Field | Value | Description |
---|---|---|
Enable | off | on; default: off | Turns DNP3 Outstation on or off. |
Local Address | integer [0..65535]; default: none | Outstation Link-Layer address. |
Remote Address | integer [0..65535]; default: none | Master Link-Layer address. |
Unsolicited enabled | off | on; default: none | Enables the transmission of unsolicited messages. |
Protocol | TCP | UDP; default: TCP | Protocol used for DNP3 communications. |
Port | integer [0..65535]; default: none | Port used for DNP3 communications. |
UDP response address | ipv4; default: none | UDP response address. |
UDP response port | integer [0..65535]; default: none | UDP response port. |
Allow Remote Access | off | on; default: off | Allows remote DNP3 connections by adding an exception to the device's firewall on the port specified in the field above. |
[[Category:{{{name}}} Services section]]