Difference between revisions of "Template:Networking rutos manual dnp3"
From Teltonika Networks Wiki
Gytispieze (talk | contribs) |
Gytispieze (talk | contribs) m (Text replacement - "\{\{Template: Networking_rutos_manual_fw_disclosure (.*) (.*) (.*) (.*) \}\}" to "{{Template: Networking_device_manual_fw_disclosure | series = {{{series}}} | name = {{{name}}} | fw_version ={{Template: Networking_device_manual_latest_fw | series = {{{series}}} | name = {{{name}}} }} }}") Tags: Mobile edit Mobile web edit |
||
| (15 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Template: | + | {{Template: Networking_device_manual_fw_disclosure |
| − | | fw_version ={{Template: | + | | series = {{{series}}} |
| + | | name = {{{name}}} | ||
| + | | fw_version ={{Template: Networking_device_manual_latest_fw | ||
| series = {{{series}}} | | series = {{{series}}} | ||
| name = {{{name}}} | | name = {{{name}}} | ||
| Line 8: | Line 10: | ||
==Summary== | ==Summary== | ||
| − | <b>Distributed Network Protocol 3 (DNP3)</b> is a set of communications protocols used between components in process automation systems. It is primarily used for communications between a | + | <b>Distributed Network Protocol 3 (DNP3)</b> 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. | 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>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u> |
==DNP3 Parameters== | ==DNP3 Parameters== | ||
| Line 62: | Line 64: | ||
|TRB142= | |TRB142= | ||
|TRB145= | |TRB145= | ||
| − | | | + | |#default= |
<tr> | <tr> | ||
<td>LAN MAC Address</td> | <td>LAN MAC Address</td> | ||
| Line 213: | Line 215: | ||
<td>Counter</td> | <td>Counter</td> | ||
</tr> | </tr> | ||
| − | | | + | |{{#ifeq:{{{series}}}|TRB5|| |
<tr> | <tr> | ||
<td>Mobile data received today</td> | <td>Mobile data received today</td> | ||
| Line 273: | Line 275: | ||
<td>31</td> | <td>31</td> | ||
<td>Counter</td> | <td>Counter</td> | ||
| − | </tr> | + | </tr>}} |
}} | }} | ||
}} | }} | ||
| Line 493: | Line 495: | ||
}} | }} | ||
| − | ==TCP | + | ==TCP Client== |
| − | A | + | 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.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 client's configuration page. |
| − | ===TCP | + | ===TCP Client Configuration=== |
---- | ---- | ||
| − | The <b>TCP | + | 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 521: | Line 523: | ||
<td>Name</td> | <td>Name</td> | ||
<td>string; default: <b>none</b></td> | <td>string; default: <b>none</b></td> | ||
| − | <td>Name of the TCP | + | <td>Name of the TCP client, used for easier management purposes.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Line 536: | Line 538: | ||
<td>Local Address</td> | <td>Local Address</td> | ||
<td>integer [0..65535]; default: <b>none</b></td> | <td>integer [0..65535]; default: <b>none</b></td> | ||
| − | <td> | + | <td>Clients Link-Layer address.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Line 556: | Line 558: | ||
<td>Save to flash</td> | <td>Save to flash</td> | ||
<td>off | on; default: <b>off</b></td> | <td>off | on; default: <b>off</b></td> | ||
| − | <td>When enabled, stores | + | <td>When enabled, stores request information in device flash.</td> |
</tr> | </tr> | ||
</table> | </table> | ||
| Line 562: | Line 564: | ||
===Requests Configuration=== | ===Requests Configuration=== | ||
---- | ---- | ||
| − | A DNP3 <b>request</b> is a way of obtaining data from DNP3 Outstations. The | + | A DNP3 <b>request</b> 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 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: | ||
| Line 612: | Line 614: | ||
{{#ifeq:{{{serial}}} | 1 | | {{#ifeq:{{{serial}}} | 1 | | ||
| − | ==Serial | + | ==Serial Client== |
| + | |||
| + | The <b>Serial Client</b> page is used to configure the device as a DNP3 RTU Client. DNP3 RTU (remote terminal unit) is a serial communication protocol mainly used in communication via serial interfaces. | ||
| − | + | By default, the list is empty. To add a new client instance, enter the instance name, select serial interface and click the 'Add' button. | |
| − | ===Serial | + | [[File:Networking_rutos_manual_generic_serial_instance_add_button_rs232_{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|1|0}}v3.png|border|class=tlt-border]] |
| + | |||
| + | After clicking 'Add' you will be redirected to the newly added client instance configuration page. | ||
| + | |||
| + | ===Serial Client Configuration=== | ||
---- | ---- | ||
| − | The <b>Serial | + | 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 630: | Line 638: | ||
<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 636: | Line 644: | ||
<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 client, used for easier management purposes.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Serial port</td> | <td>Serial port</td> | ||
| − | <td>{{ | + | <td>{{Template: Networking rutos manual serial ports| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}; default: <b>{{Template: Networking rutos manual default serial port| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}</b></td> |
<td>Selects which serial port to use for communication.</td> | <td>Selects which serial port to use for communication.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Baud rate</td> | <td>Baud rate</td> | ||
| − | <td>300 | + | <td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200{{#ifeq: {{{rs485}}} | 1 | {{!}} 230400 {{!}} 460800 {{!}} 921600 {{!}} 1000000 {{!}} 3000000|}}; default: <b>115200</b></td> |
<td>Serial data transmission rate (in bits per second).</td> | <td>Serial data transmission rate (in bits per second).</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Data bits</td> | <td>Data bits</td> | ||
| − | <td>5 | + | <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td> |
<td>Number of data bits for each character.</td> | <td>Number of data bits for each character.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Stop bits</td> | <td>Stop bits</td> | ||
| − | <td | + | <td>1{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} 2|}}; default: <b>1</b></td> |
<td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td> | <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>Parity</td> | <td>Parity</td> | ||
| − | <td> | + | <td>Even {{!}} Odd{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} Mark {{!}} Space|}} {{!}} None; default: <b>None</b></td> |
<td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check. | <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check. | ||
<ul> | <ul> | ||
<li><b>None</b> (<b>N</b>) - no parity method is used.</li> | <li><b>None</b> (<b>N</b>) - no parity method is used.</li> | ||
<li><b>Odd</b> (<b>O</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li> | <li><b>Odd</b> (<b>O</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li> | ||
| − | <li><b>Even</b> (<b>E</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be even.</li> | + | <li><b>Even</b> (<b>E</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be even.</li>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<li><b>Space</b> (<b>s</b>) - the parity bit will always be a binary 0.</li> |
| + | <li><b>Mark</b> (<b>M</b>) - the parity bit will always be a binary 1.</li>|}} | ||
</ul> | </ul> | ||
</td> | </td> | ||
| Line 671: | Line 680: | ||
<tr> | <tr> | ||
<td>Flow control</td> | <td>Flow control</td> | ||
| − | <td>None | + | <td>None {{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} RTS/CTS {{!}} Xon/Xoff|}}; default: <b>None</b></td> |
<td>In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking. | <td>In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking. | ||
| − | + | {{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<ul> | |
| − | <li><b> | + | <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li> |
<li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li> | <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li> | ||
| − | </ul> | + | </ul>|}} |
</td> | </td> | ||
| − | </tr> | + | </tr>{{#ifeq: {{{rs485}}} | 1 | |
| + | <tr> | ||
| + | <td><span style="color:blue">RS485:</span> Full Duplex</td> | ||
| + | <td>off {{!}} on; default: <b>off</b></td> | ||
| + | <td>Enables RS485 full duplex.</td> | ||
| + | </tr>|}} | ||
<tr> | <tr> | ||
<td>Open delay</td> | <td>Open delay</td> | ||
| Line 687: | Line 701: | ||
<td>Local Address</td> | <td>Local Address</td> | ||
<td>integer [0..65535]; default: <b>none</b></td> | <td>integer [0..65535]; default: <b>none</b></td> | ||
| − | <td> | + | <td>Client Link-Layer address.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Line 703: | Line 717: | ||
<td>integer [1..60]; default: <b>none</b></td> | <td>integer [1..60]; default: <b>none</b></td> | ||
<td>Maximum response wait time.</td> | <td>Maximum response wait time.</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>Save to flash</td> | ||
| + | <td>off {{!}} on; default: <b>off</b></td> | ||
| + | <td>When enabled, stores request information in device flash.</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
| Line 708: | Line 727: | ||
===Requests Configuration=== | ===Requests Configuration=== | ||
---- | ---- | ||
| − | A DNP3 <b>request</b> is a way of obtaining data from DNP3 Outstations. The | + | A DNP3 <b>request</b> 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 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: | ||
| Line 741: | Line 760: | ||
<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>off/on slider</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> | ||
| Line 760: | Line 779: | ||
==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 client via a communication channel. It makes measurements of the physical world and then sends them to a client upon request (solicited) or on its own accord (unsolicited). Occasionally a client 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: | ||
| Line 785: | Line 804: | ||
<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>Client Link-Layer address.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Line 799: | Line 818: | ||
<tr> | <tr> | ||
<td>Port</td> | <td>Port</td> | ||
| − | <td>integer [0..65535]; default: <b> | + | <td>integer [0..65535]; default: <b>none</b></td> |
<td>Port used for DNP3 communications.</td> | <td>Port used for DNP3 communications.</td> | ||
</tr> | </tr> | ||
| Line 818: | Line 837: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| + | {{#ifeq:{{{serial}}} | 1 | | ||
| + | ==DNP3 Serial Outstation== | ||
| + | |||
| + | An outstation in DNP3 is a component that communicates with a single client via a communication channel. It makes measurements of the physical world and then sends them to a client upon request (solicited) or on its own accord (unsolicited). Occasionally a client 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=== | ||
| + | ---- | ||
| + | The <b>DNP3 Serial Outstation Configuration</b> page is used to configure the device as a DNP3 RTU Outstation. DNP3 RTU (remote terminal unit) is a serial communication protocol mainly used in communication via serial interfaces. | ||
| + | |||
| + | By default, the list is empty. To add a new outstation instance, enter the instance name, select serial interface and click the 'Add' button. | ||
| + | |||
| + | [[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 outstation instance configuration page. | ||
| + | |||
| + | ===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 Client devices. The figure below is an example of the Serial Outstation 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]] | ||
| + | |||
| + | <table class="nd-mantable"> | ||
| + | <tr> | ||
| + | <th>Field</th> | ||
| + | <th>Value</th> | ||
| + | <th>Description</th> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>Enable</td> | ||
| + | <td>off {{!}} on; default: <b>off</b></td> | ||
| + | <td>Turns communication with the outstation device on or off.</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>Name</td> | ||
| + | <td>string; default: <b>none</b></td> | ||
| + | <td>Name of the Serial outstation, used for easier management purposes.</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>Serial port</td> | ||
| + | <td>{{Template: Networking rutos manual serial ports| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}; default: <b>{{Template: Networking rutos manual default serial port| rs232={{{rs232}}}| rs485={{{rs485}}}| usb = {{{usb}}}}}</b></td> | ||
| + | <td>Selects which serial port to use for communication.</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>Baud rate</td> | ||
| + | <td>300 {{!}} 1200 {{!}} 2400 {{!}} 4800 {{!}} 9600 {{!}} 19200 {{!}} 38400 {{!}} 57600 {{!}} 115200{{#ifeq: {{{rs485}}} | 1 | {{!}} 230400 {{!}} 460800 {{!}} 921600 {{!}} 1000000 {{!}} 3000000|}}; default: <b>115200</b></td> | ||
| + | <td>Serial data transmission rate (in bits per second).</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>Data bits</td> | ||
| + | <td>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|{{#ifeq:{{{series}}}|TRB2||5 {{!}} 6 {{!}}}} 7 {{!}} |}}8; default: <b>8</b></td> | ||
| + | <td>Number of data bits for each character.</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>Stop bits</td> | ||
| + | <td>1{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} 2|}}; default: <b>1</b></td> | ||
| + | <td>Stop bits sent at the end of every character allow the receiving signal hardware to detect the end of a character and to resynchronise with the character stream. Electronic devices usually use one stop bit. Two stop bits are required if slow electromechanical devices are used.</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>Parity</td> | ||
| + | <td>Even {{!}} Odd{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} Mark {{!}} Space|}} {{!}} None; default: <b>None</b></td> | ||
| + | <td>In serial transmission, parity is a method of detecting errors. An extra data bit is sent with each data character, arranged so that the number of 1 bits in each character, including the parity bit, is always odd or always even. If a byte is received with the wrong number of 1s, then it must have been corrupted. However, an even number of errors can pass the parity check. | ||
| + | <ul> | ||
| + | <li><b>None</b> (<b>N</b>) - no parity method is used.</li> | ||
| + | <li><b>Odd</b> (<b>O</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be odd.</li> | ||
| + | <li><b>Even</b> (<b>E</b>) - the parity bit is set so that the number of "logical ones (1s)" has to be even.</li>{{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<li><b>Space</b> (<b>s</b>) - the parity bit will always be a binary 0.</li> | ||
| + | <li><b>Mark</b> (<b>M</b>) - the parity bit will always be a binary 1.</li>|}} | ||
| + | </ul> | ||
| + | </td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>Flow control</td> | ||
| + | <td>None {{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1| {{!}} RTS/CTS {{!}} Xon/Xoff|}}; default: <b>None</b></td> | ||
| + | <td>In many circumstances a transmitter might be able to send data faster than the receiver is able to process it. To cope with this, serial lines often incorporate a "handshaking" method, usually distinguished between hardware and software handshaking. | ||
| + | {{#ifeq:{{#expr: {{{rs232}}} or {{{usb}}}}} |1|<ul> | ||
| + | <li><b>RTS/CTS</b> - hardware handshaking. RTS and CTS are turned OFF and ON from alternate ends to control data flow, for instance when a buffer is almost full.</li> | ||
| + | <li><b>Xon/Xoff</b> - software handshaking. The Xon and Xoff characters are sent by the receiver to the sender to control when the sender will send data, i.e., these characters go in the opposite direction to the data being sent. The circuit starts in the "sending allowed" state. When the receiver's buffers approach capacity, the receiver sends the Xoff character to tell the sender to stop sending data. Later, after the receiver has emptied its buffers, it sends an Xon character to tell the sender to resume transmission.</li> | ||
| + | </ul>|}} | ||
| + | </td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>Local Address</td> | ||
| + | <td>integer [0..65535]; default: <b>none</b></td> | ||
| + | <td>Outstation Link-Layer address.</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>Remote Address</td> | ||
| + | <td>integer [0..65535]; default: <b>none</b></td> | ||
| + | <td>Client Link-Layer address.</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td>Unsolicited enabled</td> | ||
| + | <td>off {{!}} on; default: <b>none</b></td> | ||
| + | <td>Enables the transmission of unsolicited messages.</td> | ||
| + | </tr>{{#ifeq: {{{rs485}}} | 1 | | ||
| + | <tr> | ||
| + | <td><span style="color:blue">RS485:</span> Full Duplex</td> | ||
| + | <td>off {{!}} on; default: <b>off</b></td> | ||
| + | <td>Enables RS485 full duplex.</td> | ||
| + | </tr>|}} | ||
| + | </table> | ||
| + | |}} | ||
[[Category:{{{name}}} Services section]] | [[Category:{{{name}}} Services section]] | ||
Revision as of 12:10, 24 October 2023
The information in this page is updated in accordance with firmware version .
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 System → [[{{{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.
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 client via a communication channel. It makes measurements of the physical world and then sends them to a client upon request (solicited) or on its own accord (unsolicited). Occasionally a client 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 | Client 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]]
