Difference between revisions of "Template:Networking rutos manual dlms"
(22 intermediate revisions by 6 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 DLMS functionality in {{{name}}} devices. | This manual page provides an overview of the DLMS functionality in {{{name}}} devices. | ||
− | <b>Note:</b> DLMS is additional software that can be installed from the <b> | + | <b>Note:</b> DLMS is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page. |
− | |||
==Main== | ==Main== | ||
The <b>Main</b> page is used to configure DLMS physical devices and Cosem Groups. | The <b>Main</b> page is used to configure DLMS physical devices and Cosem Groups. | ||
− | + | ===DLMS Client=== | |
+ | ---- | ||
+ | The <b>DLMS Client</b> section is used to enable the service. | ||
− | [[File: | + | [[File:Networking_rutos_manual_dlms_dlms_client.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>Enables DLMS service.</td> | ||
+ | </tr> | ||
+ | </table> | ||
===DLMS Physical devices=== | ===DLMS Physical devices=== | ||
---- | ---- | ||
Interoperable devices in DLMS categorize as server (physical device) and client. Data collection device act as a client that supports system | Interoperable devices in DLMS categorize as server (physical device) and client. Data collection device act as a client that supports system | ||
− | dependent features, parameters, functions and classes requesting data from the server (physical device). In this structure, communication protocol stack is independent of application layer so both devices may communicate different media. To add a new physical device, click the 'Add' button. | + | dependent features, parameters, functions and classes requesting data from the server (physical device). In this structure, communication protocol stack is independent of application layer so both devices may communicate different media. To add a new physical device, enter an new configuration name and click the 'Add' button. |
− | [[File: | + | [[File:Networking_rutos_manual_dlms_dlms_physical_devices_add_button.png|border|class=tlt-border]] |
After clicking 'Add' you will be redirected to the newly added physical device's configuration page. | After clicking 'Add' you will be redirected to the newly added physical device's configuration page. | ||
Line 41: | Line 49: | ||
The <b>DLMS Physical device configuration</b> section is used to configure the parameters of server (physical device). | The <b>DLMS Physical device configuration</b> section is used to configure the parameters of server (physical device). | ||
− | [[File: | + | [[File:Networking_rutos_manual_dlms_dlms_physical_devices_configuration.png|border|class=tlt-border]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 61: | Line 69: | ||
<tr> | <tr> | ||
<td>Name</td> | <td>Name</td> | ||
− | <td>string; default: <b> | + | <td>string; default: <b>previously added device name</b></td> |
<td>Physical device name.</td> | <td>Physical device name.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Server address | + | <td>Server address</td> |
− | |||
− | |||
− | |||
− | |||
− | |||
<td>integer [0..255]; default: <b>1</b></td> | <td>integer [0..255]; default: <b>1</b></td> | ||
<td>DLMS device server address.</td> | <td>DLMS device server address.</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 91: | Line 89: | ||
<tr> | <tr> | ||
<td>Access security</td> | <td>Access security</td> | ||
− | <td>none {{!}} <span style="color:red">Low</span> {{!}} <span style="color:red">High</span> {{!}} <span style="color:red">High MD5</span> {{!}} <span style="color:red">High SHA1</span> {{!}} <span style="color:blue">High GMAC | + | <td>none {{!}} <span style="color:red">Low</span> {{!}} <span style="color:red">High</span> {{!}} <span style="color:red">High MD5</span> {{!}} <span style="color:red">High SHA1</span> {{!}} <span style="color:blue">High GMAC</span>; default: <b>none</b></td> |
<td>DLMS device authentication type.</td> | <td>DLMS device authentication type.</td> | ||
</tr> | </tr> | ||
Line 110: | Line 108: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td><span style="color:brown">Invocation counter OBIS code</span></td> |
<td>string; default: <b>none</b></td> | <td>string; default: <b>none</b></td> | ||
<td>DLMS device invocation counter OBIS code.</td> | <td>DLMS device invocation counter OBIS code.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td><span style="color:blue">Authentication key</span></td> |
<td>string (Length of the value must be 32); default: <b>none</b></td> | <td>string (Length of the value must be 32); default: <b>none</b></td> | ||
<td>DLMS device authentication key.</td> | <td>DLMS device authentication key.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td><span style="color:blue">Block cipher key</span></td> |
<td>string (Length of the value must be 32); default: <b>none</b></td> | <td>string (Length of the value must be 32); default: <b>none</b></td> | ||
<td>DLMS device block cipher key.</td> | <td>DLMS device block cipher key.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td> | + | <td><span style="color:green">Dedicated key</span></td> |
<td>string (Length of the value must be 32); default: <b>none</b></td> | <td>string (Length of the value must be 32); default: <b>none</b></td> | ||
<td>DLMS device dedicated key.</td> | <td>DLMS device dedicated key.</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 143: | Line 136: | ||
===DLMS Cosem groups=== | ===DLMS Cosem groups=== | ||
---- | ---- | ||
− | To add a new cosem group, click the 'Add' button. | + | To add a new cosem group, enter an new configuration name and click the 'Add' button. |
− | [[File: | + | [[File:Networking_rutos_manual_dlms_dlms_cosem_groups_add_button.png|border|class=tlt-border]] |
After clicking 'Add' you will be redirected to the newly added cosem group's configuration page. | After clicking 'Add' you will be redirected to the newly added cosem group's configuration page. | ||
Line 153: | Line 146: | ||
The <b>DLMS Cosem group configuration</b> section is used to configure the parameters of cosem groups. | The <b>DLMS Cosem group configuration</b> section is used to configure the parameters of cosem groups. | ||
− | [[File:Networking_rutos_manual_dlms_dlms_cosem_groups_configuration | + | [[File:Networking_rutos_manual_dlms_dlms_cosem_groups_configuration.png|border|class=tlt-border]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 168: | Line 161: | ||
<tr> | <tr> | ||
<td>Name</td> | <td>Name</td> | ||
− | <td>string; default: <b> | + | <td>string; default: <b>previously added cosem group name</b></td> |
<td>OBIS code group name.</td> | <td>OBIS code group name.</td> | ||
</tr> | </tr> | ||
Line 185: | Line 178: | ||
====DLMS Cosem value==== | ====DLMS Cosem value==== | ||
---- | ---- | ||
− | + | To add a new cosem value, enter an new configuration name and click the 'Add' button. | |
− | [[File: | + | [[File:Networking_rutos_manual_dlms_dlms_cosem_value_add_button.png|border|class=tlt-border]] |
After clicking 'Add' you will be redirected to the newly added cosem value's configuration page. | After clicking 'Add' you will be redirected to the newly added cosem value's configuration page. | ||
− | [[File: | + | [[File:Networking_rutos_manual_dlms_dlms_cosem_value_configuration.png|border|class=tlt-border]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 206: | Line 199: | ||
<tr> | <tr> | ||
<td>Name</td> | <td>Name</td> | ||
− | <td>string; default: <b> | + | <td>string; default: <b>previously added cosem value name</b></td> |
<td>COSEM option name.</td> | <td>COSEM option name.</td> | ||
</tr> | </tr> | ||
Line 221: | Line 214: | ||
<tr> | <tr> | ||
<td>COSEM class id</td> | <td>COSEM class id</td> | ||
− | <td>DATA (ID: 1) {{!}} REGISTER (ID: 3) {{!}} | + | <td>DATA (ID: 1) {{!}} REGISTER (ID: 3) {{!}} REGISTER (ID: 3) {{!}} DEMAND REGISTER (ID: 5) {{!}} REGISTER ACTIVATION (ID: 6) {{!}} <span style="color:red">PROFILE GENERIC (ID: 7)</span> {{!}} CLOCK (ID: 8) {{!}} SCRIPT TABLE (ID: 9); default: <b>DATA (ID: 1)</b></td> |
<td>Object type for OBIS code.</td> | <td>Object type for OBIS code.</td> | ||
</tr> | </tr> | ||
Line 232: | Line 225: | ||
==Connections== | ==Connections== | ||
− | The <b>Connections</b> page is used to configure DLMS connections | + | The <b>Connections</b> page is used to configure DLMS connections. |
===DLMS Connections=== | ===DLMS Connections=== | ||
---- | ---- | ||
− | To add a new connection, click the 'Add' button. | + | To add a new connection, enter an new connection name and click the 'Add' button. |
− | [[File: | + | [[File:Networking_rutos_manual_dlms_dlms_connections_add_button.png|border|class=tlt-border]] |
After clicking 'Add' you will be redirected to the newly added connection's configuration page. | After clicking 'Add' you will be redirected to the newly added connection's configuration page. | ||
Line 246: | Line 239: | ||
The <b>DLMS Connection configuration</b> section is used to configure the parameters of connections. | The <b>DLMS Connection configuration</b> section is used to configure the parameters of connections. | ||
− | [[File: | + | [[File:Networking_rutos_manual_dlms_dlms_connections_configuration.png|border|class=tlt-border]] |
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
Line 271: | Line 264: | ||
<tr> | <tr> | ||
<td><span style="color:red">Serial device</span></td> | <td><span style="color:red">Serial device</span></td> | ||
− | <td>{{ | + | <td>{{#switch: {{{rs232}}}{{{rs485}}} | 1 0 = rs232 | 0 1 = rs485 | 1 1 = rs232 {{!}} rs485}} ; default: <b></b></td> |
<td>DLMS serial device.</td> | <td>DLMS serial device.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Baud rate</td> | + | <td><span style="color:red">Baud rate</span></td> |
− | <td> | + | <td>string; default: <b>none</b></td> |
− | <td> | + | <td>OBIS code value, actions are not executed, only properties are read.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Data bits</td> | + | <td><span style="color:red">Data bits</span></td> |
− | <td> | + | <td>string; default: <b>none</b></td> |
− | <td> | + | <td>OBIS code value, actions are not executed, only properties are read.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Stop bits</td> | + | <td><span style="color:red">Stop bits</span></td> |
− | <td> | + | <td>string; default: <b>none</b></td> |
− | <td> | + | <td>OBIS code value, actions are not executed, only properties are read.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td>Parity</td> | + | <td><span style="color:red">Parity</span></td> |
− | <td> | + | <td>string; default: <b>none</b></td> |
− | <td> | + | <td>OBIS code value, actions are not executed, only properties are read.</td> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | + | <td><span style="color:red">Flow control</span></td> | |
− | + | <td>string; default: <b>none</b></td> | |
− | + | <td>OBIS code value, actions are not executed, only properties are read.</td> | |
− | + | </tr>|}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | <td><span style="color: | ||
− | <td> | ||
− | <td> | ||
− | </tr>| | ||
<tr> | <tr> | ||
<td>IP address</td> | <td>IP address</td> | ||
Line 325: | Line 301: | ||
<td>integer [1..65535]; default: <b>none</b></td> | <td>integer [1..65535]; default: <b>none</b></td> | ||
<td>DLMS device IP port for TCP connection.</td> | <td>DLMS device IP port for TCP connection.</td> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
</tr> | </tr> | ||
</table> | </table> | ||
− | |||
− |
Revision as of 14:21, 2 October 2023
Template:Networking rutos manual fw disclosure
Summary
The DLMS / COSEM standard suite (IEC 62056 / EN 13757- 1) is the most widely accepted international utility meter data exchange standard. DLMS is the application layer protocol that transforms the data into messages and COSEM describes the general object model and can be used for all kinds of presentations.
This manual page provides an overview of the DLMS functionality in {{{name}}} devices.
Note: DLMS is additional software that can be installed from the Services → [[{{{name}}} Package Manager|Package Manager]] page.
Main
The Main page is used to configure DLMS physical devices and Cosem Groups.
DLMS Client
The DLMS Client section is used to enable the service.
Field | Value | Description |
---|---|---|
Enable | off | on; default: off | Enables DLMS service. |
DLMS Physical devices
Interoperable devices in DLMS categorize as server (physical device) and client. Data collection device act as a client that supports system dependent features, parameters, functions and classes requesting data from the server (physical device). In this structure, communication protocol stack is independent of application layer so both devices may communicate different media. To add a new physical device, enter an new configuration name and click the 'Add' button.
After clicking 'Add' you will be redirected to the newly added physical device's configuration page.
DLMS Physical device configuration
The DLMS Physical device configuration section is used to configure the parameters of server (physical device).
Field | Value | Description |
---|---|---|
Enable | off | on; default: off | Enables specific physical device configuration. |
Connection | empty ; default: none | DLMS connection. |
Name | string; default: previously added device name | Physical device name. |
Server address | integer [0..255]; default: 1 | DLMS device server address. |
Logic server address | integer [0..255]; default: 0 | DLMS device logical server address. |
Client address | integer [0..255]; default: 16 | DLMS device client address. |
Access security | none | Low | High | High MD5 | High SHA1 | High GMAC; default: none | DLMS device authentication type. |
Password | string; default: none | DLMS device password if authentication is used. |
Interface type | HDLC | WRAPPER; default: HDLC | DLMS device interface type. |
Transport security | none | Authentication | Encryption | Authentication encryption; default: none | DLMS device message encryption. |
Invocation counter OBIS code | string; default: none | DLMS device invocation counter OBIS code. |
Authentication key | string (Length of the value must be 32); default: none | DLMS device authentication key. |
Block cipher key | string (Length of the value must be 32); default: none | DLMS device block cipher key. |
Dedicated key | string (Length of the value must be 32); default: none | DLMS device dedicated key. |
Test | -(interactive button) | Test device configuration. |
DLMS Cosem groups
To add a new cosem group, enter an new configuration name and click the 'Add' button.
After clicking 'Add' you will be redirected to the newly added cosem group's configuration page.
DLMS Cosem group configuration
The DLMS Cosem group configuration section is used to configure the parameters of cosem groups.
Field | Value | Description |
---|---|---|
Enable | off | on; default: off | Enables Cosem group. |
Name | string; default: previously added cosem group name | OBIS code group name. |
Interval | integer [1..4294967295]; default: 1 | Interval for OBIS code reading (in seconds). |
Test | -(interactive button) | Test cosem group. |
DLMS Cosem value
To add a new cosem value, enter an new configuration name and click the 'Add' button.
After clicking 'Add' you will be redirected to the newly added cosem value's configuration page.
Field | Value | Description |
---|---|---|
Enable | off | on; default: off | Enables Cosem state. |
Name | string; default: previously added cosem value name | COSEM option name. |
Physical device | selection; default: none | Physical device to read from. |
OBIS code | string; default: none | OBIS code value, actions are not executed, only properties are read. |
COSEM class id | DATA (ID: 1) | REGISTER (ID: 3) | REGISTER (ID: 3) | DEMAND REGISTER (ID: 5) | REGISTER ACTIVATION (ID: 6) | PROFILE GENERIC (ID: 7) | CLOCK (ID: 8) | SCRIPT TABLE (ID: 9); default: DATA (ID: 1) | Object type for OBIS code. |
Entries | interger [1..32767]; default: none | How many data objects to read. |
Connections
The Connections page is used to configure DLMS connections.
DLMS Connections
To add a new connection, enter an new connection name and click the 'Add' button.
After clicking 'Add' you will be redirected to the newly added connection's configuration page.
DLMS Connection configuration
The DLMS Connection configuration section is used to configure the parameters of connections.
Field | Value | Description |
---|---|---|
Enable | off | on; default: off | Enables Cosem state. |
Name | string; default: previously added connection name | Name of DLMS connection configuration. |
Connection type | TCP ; default: TCP | DLMS connection type. |
IP address | ip; default: none | DLMS device IP address for TCP connection. |
Port | integer [1..65535]; default: none | DLMS device IP port for TCP connection. |