Difference between revisions of "Template:Networking rutos manual mbus"

From Teltonika Networks Wiki
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}}} }} }}")
 
(5 intermediate revisions by 2 users not shown)
Line 14: Line 14:
 
This manual page provides an overview of the M-Bus functionality in {{{name}}} devices.
 
This manual page provides an overview of the M-Bus functionality in {{{name}}} devices.
  
==M-Bus Settings==
+
==Client==
  
The <b>M-Bus Settings</b> section is used to configure the general service functionality. The figure below is an example of the M-Bus Settings and the table below provides information on the fields contained in that section:
 
  
[[File:Networking_rutos_manual_mbus_mbus_settings_v1.png|border|class=tlt-border]]
+
===General settings===
 +
----
 +
 
 +
The M-Bus device configuration section is used to configure the general service functionality. The figure below is an example of the M-Bus Settings and the table below provides information on the fields contained in that section:
 +
 
 +
[[File:Networking_rutos_manual_mbus_client_general_settings.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 27: Line 31:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Enable</td>
+
         <td>Status</td>
         <td>off | on; default: <b>off</b></td>
+
         <td>Inactive | Active</td>
         <td>Enables the service.</td>
+
         <td>Status of service, whether it is currently running. If it is active, it will also show how long it has been running.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 35: Line 39:
 
         <td>300 | 600 | 1200 | 2400 | 4800 | 9600 ; default: <b>2400</b></td>
 
         <td>300 | 600 | 1200 | 2400 | 4800 | 9600 ; default: <b>2400</b></td>
 
         <td>Specifies the M-Bus server network baud rate.</td>
 
         <td>Specifies the M-Bus server network baud rate.</td>
 +
    </tr>
 +
</table>
 +
 +
 +
 +
===Devices===
 +
----
 +
 +
To add new device to configuration press <b>Add</b> button which is shown below.
 +
 +
[[File:Networking_rutos_manual_mbus_client_devices_add.png|border|class=tlt-border]]
 +
 +
 +
 +
The Devices section is used to configure the general device instance. The figure below is an example of the M-Bus device and the table below provides information on the fields contained in that section:
 +
 +
[[File:Networking_rutos_manual_mbus_client_device_configuration.png|border|class=tlt-border]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Name</td>
 +
        <td>String; default: <b>Device 1</b></td>
 +
        <td>Display name of device configuration.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Address type</td>
 +
        <td>Primary | Secondary ; default: <b>Primary</b></td>
 +
        <td>Primary address which will be used when sending requests.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Primary address</td>
 +
        <td>integer [0..250]; default: <b>empty</b></td>
 +
        <td>Primary address which will be used when sending requests.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Database location</td>
+
         <td>Secondary address</td>
         <td>RAM memory | Flash memory; default: <b>RAM memory</b></td>
+
         <td>string of 16 symbols; default: <b>empty</b></td>
         <td>Specifies where the database will be stored..</td>
+
         <td>A unique device identifier which commonly includes the serial number.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
  
==Records==
 
  
By default there are no <b>Records</b> instances created. To start configuring, add a new record using the <b>Add New Instance</b> section below.
 
  
[[File:Networking_rutos_manual_mbus_records_add_new_instance_v1.png|border|class=tlt-border]]
+
===Data collecting groups===
 +
----
  
===M-Bus Record===
+
To reach data collecting groups configuration press <b>Edit</b> button as shown below.
----
+
 
The <b>M-Bus Record</b> section is used to configure the general record instance. The figure below is an example of the M-Bus Record and the table below provides information on the fields contained in that section:
+
[[File:Networking_rutos_manual_mbus_client_data_collecting_groups.png|border|class=tlt-border]]
 +
 
 +
 
 +
 
 +
Before saving, you can check if your configuration works accordingly by pressing the Test Configuration button. You should see the data in a pop-up field.
  
[[File:Networking_rutos_manual_mbus_record_mbus_record_demo_v2.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_mbus_client_data_collecting_groups_configuration.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 62: Line 107:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Enable</td>
+
         <td>Enabled</td>
         <td>off | on; default: <b>off</b></td>
+
         <td>on | off; default: <b>off</b></td>
         <td>Enables the service.</td>
+
         <td>Button to enable/disable data collecting group.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Name</td>
+
         <td>Period</td>
         <td>string; default: <b>none</b></td>
+
         <td>integer [0..86400]|; default: <b>60</b></td>
         <td>Name used for distinguishing purposes.</td>
+
         <td>Time duration between data retrievals (in seconds).</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Data type</td>
 +
        <td>JSON | XML | ASCII | Hexadecimal | Binary; default: <b>JSON</b></td>
 +
        <td>Data type to process the received data.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Test</td>
 +
        <td>Interactive button</td>
 +
        <td>A unique device identifier which commonly includes the serial number.</td>
 +
    </tr>
 +
</table>
 +
 
 +
 
 +
 
 +
To reach group values configuration press <b>Edit</b> button as shown below.
 +
 
 +
[[File:Networking_rutos_manual_mbus_client_data_collecting_groups_value_edit.png|border|class=tlt-border]]
 +
 
 +
[[File:Networking_rutos_manual_mbus_client_data_collecting_groups_value_edit_configuration.png|border|class=tlt-border]]
 +
 
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Enabled</td>
 +
        <td>on | off; default: <b>off</b></td>
 +
        <td>Button to enable/disable data group value.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Period</td>
+
         <td>FCB toggle</td>
         <td>integer [1..86400]; default: <b>60</b></td>
+
         <td>on | off; default: <b>off</b></td>
         <td>Specifies the period how often record data will be collected.</td>
+
         <td>FCB (Frame Count-Bit): One-bit counter for reliable server-client communication. Some devices may have different uses for it.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>String before data</td>
+
         <td>Manufacturer information</td>
         <td>string; default: <b>none</b></td>
+
         <td>on | off; default: <b>off</b></td>
         <td>String that will be appended before request data.</td>
+
         <td>Should manufacturer information be included in the payload.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>String between data</td>
+
         <td>Selected parameters</td>
         <td>string; default: <b>none</b></td>
+
         <td>All | Custom; default: <b>All</b></td>
         <td>String that will be appended between request data.</td>
+
         <td>Should all parameters be saved from device, or a custom subset of them.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>String after data</td>
+
         <td>Frame number</td>
         <td>string; default: <b>none</b></td>
+
         <td>integer [0..15]|; default: <b>60</b></td>
         <td>String that will be appended after request data.</td>
+
         <td>Frame number.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Failure mode</td>
+
         <td>Record number</td>
         <td>Never | <span style="color: red;">Any requests failed</span> | <span style="color: red;">All requests failed</span>; default: <b>Never</b></td>
+
         <td>integer [0..63]|; default: <b>60</b></td>
         <td>Specifies when whole record is considered as failure.</td>
+
         <td>Record number.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td><span style="color: red;">Store a failure message</span></td>
+
         <td>Parameter</td>
         <td>off | on; default: <b>off</b></td>
+
         <td>id | frame | Function | StorageNumber | Tariff | Device | Unit | Value | Timestamp; default: <b>id</b></td>
         <td>Select whether to store a failure message in the database or do nothing on failure.</td>
+
         <td>Parameter.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
  
===Request Configuration===
+
==Gateway==
 +
 
 +
 
 +
===M-Bus device configuration===
 
----
 
----
In this section, you can configure requests from servers. By default there are no instances created. To add a new instance and start configuring press the <b>Add</b> button.
 
  
[[File:Networking_rutos_manual_mbus_record_request_configuration_v2.png|border|class=tlt-border]]
+
The M-Bus device configuration section is used to configure the general service functionality. The figure below is an example of the M-Bus Settings and the table below provides information on the fields contained in that section:
 +
 
 +
[[File:Networking rutos manual mbus gateway mbus device configuration.png|border|class=tlt-border]]
  
====Request Configuration Edit====
+
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Enabled</td>
 +
        <td>on | off; default: <b>off</b></td>
 +
        <td>Button to enable/disable service.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Baud rate</td>
 +
        <td>300 | 600 | 1200 | 2400 | 4800 | 9600 ; default: <b>2400</b></td>
 +
        <td>Specifies the M-Bus server network baud rate.</td>
 +
    </tr>
 +
</table>
 +
 
 +
 
 +
 
 +
===Configuration settings===
 
----
 
----
[[File:Networking rutos manual mbus record request configuration edit v3.png|border|class=tlt-border]]
+
 
 +
[[File:Networking_rutos_manual_mbus_gateway_configuration_settings_general.png|border|class=tlt-border]]
 +
 
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Mode</td>
 +
        <td>Server | Client | Client+server | Bidirect(legacy mode, not recommended); default: <b>Server</b></td>
 +
        <td>
 +
            <ul>
 +
                <li>Server - launches service in server mode and listens on the selected port.</li>
 +
                <li>Client - launches service in client mode, which connects to one or several servers with the selected addresses and ports.</li>
 +
                <li>Client + server - launches service in server and client(s) mode simultaneously.</li>
 +
                <li>Bidirect(legacy) - launches service in bidirect mode, which means that the service keeps changing between server and client modes. If server mode fails it switches to client mode and vice versa.</li>
 +
            </ul>
 +
      </td>
 +
    </tr>
 +
    <tr>
 +
        <td>Protocol</td>
 +
        <td>TCP | UDP; default: <b>TCP</b></td>
 +
        <td>Select which protocol to use for data transmission.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Listening port</td>
 +
        <td>integer [1..65535]; default: <b>empty</b></td>
 +
        <td>Specify port number for server to listen.</td>
 +
    </tr>
 +
</table>
 +
 
 +
 
 +
 
 +
[[File:Networking_rutos_manual_mbus_gateway_configuration_settings_security.png|border|class=tlt-border]]
 +
 
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Use TLS/SSL</td>
 +
        <td>on | off; default: <b>off</b></td>
 +
        <td>Button to use TLS/SSL for connection.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>TLS version</td>
 +
        <td>tlsv1.0 | tlsv1.1 | tlsv1.2 | tlsv1.3 | Support all ; default: <b>Support all</b></td>
 +
        <td>Minimum TLS version allowed to be used.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>TLS type</td>
 +
        <td>Certificate based | <span style="color: red">Pre-Shared-Key based</span>; default: <b>Certificate based</b></td>
 +
        <td>Select the type of TLS encryption.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: red">Pre-Shared-Key</span></td>
 +
        <td>hexadecimal string of symbols; default: <b>empty</b></td>
 +
        <td>The pre-shared-key in hex format with no leading “0x”.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color: red">Identity</span></td>
 +
        <td>string of symbols; default: <b>empty</b></td>
 +
        <td>Specify the identity.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Require certificate</td>
 +
        <td>on | off; default: <b>on</b></td>
 +
        <td>Demand certificate and key from peer and verify them against certificate authority.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Certificate files from device</td>
 +
        <td>on | off; default: <b>off</b></td>
 +
        <td>Choose this option if you want to select certificate files from device.</td>
 +
    </tr>
 +
</table>
 +
 
 +
 
 +
 
 +
[[File:Networking_rutos_manual_mbus_gateway_configuration_settings_advanced.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 120: Line 302:
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Enable</td>
+
        <td>Raw mode</td>
         <td>off | on; default: <b>off</b></td>
+
        <td>on | off; default: <b>on</b></td>
         <td>Enables request processing.</td>
+
         <td>Enable to transmit all data transparently.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Remove all zeros</td>
 +
         <td>on | off; default: <b>off</b></td>
 +
         <td>Remove all zero bytes from received data.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Server address</td>
+
         <td>Inactivity timeout</td>
         <td>int | hexstring; default: <b>none</b></td>
+
         <td>integer [0..36000] ; default: <b>300</b></td>
         <td>Address of the server to be inquired.</td>
+
         <td>Specifies period of time in seconds, where server connection must be inactive, to disconnect client. To disable timeout input 0.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Data type</td>
+
         <td>Serial timeout</td>
         <td>XML | HEX | BIN | JSON; default: <b>XML</b></td>
+
         <td>integer [0..1000] ; default: <b>empty</b></td>
         <td>Data type to process the received data.</td>
+
         <td>Specifies the maximum milliseconds to wait for serial data.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Max clients</td>
 +
        <td>integer [1..32] ; default: <b>4</b></td>
 +
        <td>Specify (1-32) how many clients are allowed to connect simultaneously.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Error value</td>
+
         <td>TCP echo</td>
         <td>string; default: <b>none</b></td>
+
         <td>on | off; default: <b>off</b></td>
         <td>Changes request data to this value if request fails.</td>
+
         <td>Software TCP echo.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>FCB toggle</td>
+
         <td>Close connections</td>
         <td>off | on; default: <b>on</b></td>
+
         <td>on | off; default: <b>off</b></td>
         <td>FCB (Frame Count-Bit): One-bit counter for reliable server-client communication; some devices have special uses for it.</td>
+
         <td>Close TCP connections everytime data is sent or received (might result in serial data loss).</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Test configuration</td>
+
         <td>Keep alive</td>
         <td>button; default: <b>-</b></td>
+
         <td>on | off; default: <b>off</b></td>
         <td>Tests the current configuration.</td>
+
         <td>Enable keep alive.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
  
====Test Configuration====
+
 
 +
===IP filter===
 
----
 
----
Before saving, you can check if your configuration works accordingly by pressing the <b>Test Configuration</b> button. You should see the data in a field below:
 
  
[[File:Networking_rutos_manual_mbus_record_request_configuration_edit_test_configuration_v1.png|border|class=tlt-border]]
+
The IP Filter section is used for configuring which network is allowed to communicate with the device. You may add a new instance by selecting the Interface and pressing Add.
 +
 
 +
[[File:Networking_rutos_manual_mbus_gateway_ip_filter.png|border|class=tlt-border]]
 +
 
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Allow IP</td>
 +
        <td>IPv4 and IPv6 addresses with or without mask prefix are accepted. E.g 192.168.1.0/24.</td>
 +
        <td>Allow IP connecting to server, write 0.0.0.0/0 for allowing all</td>
 +
    </tr>
 +
</table>
  
 
[[Category:{{{name}}} Services section]]
 
[[Category:{{{name}}} Services section]]

Latest revision as of 16:18, 2 July 2024

The information in this page is updated in accordance with firmware version .

Summary

The M-Bus (Meter Bus) is a cost-effective fieldbus communication protocol for transmitting energy consumption data. A central client – in this case {{{name}}} – communicates via a two-wire bus (up to max. 250 servers per segment) with bus devices (e.g., heat meter, water meter, electric meter, gas meter).

This manual page provides an overview of the M-Bus functionality in {{{name}}} devices.

Client

General settings


The M-Bus device configuration section is used to configure the general service functionality. The figure below is an example of the M-Bus Settings and the table below provides information on the fields contained in that section:

Networking rutos manual mbus client general settings.png

Field Value Description
Status Inactive | Active Status of service, whether it is currently running. If it is active, it will also show how long it has been running.
Baud rate 300 | 600 | 1200 | 2400 | 4800 | 9600 ; default: 2400 Specifies the M-Bus server network baud rate.


Devices


To add new device to configuration press Add button which is shown below.

Networking rutos manual mbus client devices add.png


The Devices section is used to configure the general device instance. The figure below is an example of the M-Bus device and the table below provides information on the fields contained in that section:

Networking rutos manual mbus client device configuration.png

Field Value Description
Name String; default: Device 1 Display name of device configuration.
Address type Primary | Secondary ; default: Primary Primary address which will be used when sending requests.
Primary address integer [0..250]; default: empty Primary address which will be used when sending requests.
Secondary address string of 16 symbols; default: empty A unique device identifier which commonly includes the serial number.


Data collecting groups


To reach data collecting groups configuration press Edit button as shown below.

Networking rutos manual mbus client data collecting groups.png


Before saving, you can check if your configuration works accordingly by pressing the Test Configuration button. You should see the data in a pop-up field.

Networking rutos manual mbus client data collecting groups configuration.png

Field Value Description
Enabled on | off; default: off Button to enable/disable data collecting group.
Period integer [0..86400]|; default: 60 Time duration between data retrievals (in seconds).
Data type JSON | XML | ASCII | Hexadecimal | Binary; default: JSON Data type to process the received data.
Test Interactive button A unique device identifier which commonly includes the serial number.


To reach group values configuration press Edit button as shown below.

Networking rutos manual mbus client data collecting groups value edit.png

Networking rutos manual mbus client data collecting groups value edit configuration.png

Field Value Description
Enabled on | off; default: off Button to enable/disable data group value.
FCB toggle on | off; default: off FCB (Frame Count-Bit): One-bit counter for reliable server-client communication. Some devices may have different uses for it.
Manufacturer information on | off; default: off Should manufacturer information be included in the payload.
Selected parameters All | Custom; default: All Should all parameters be saved from device, or a custom subset of them.
Frame number integer [0..15]|; default: 60 Frame number.
Record number integer [0..63]|; default: 60 Record number.
Parameter id | frame | Function | StorageNumber | Tariff | Device | Unit | Value | Timestamp; default: id Parameter.

Gateway

M-Bus device configuration


The M-Bus device configuration section is used to configure the general service functionality. The figure below is an example of the M-Bus Settings and the table below provides information on the fields contained in that section:

Networking rutos manual mbus gateway mbus device configuration.png

Field Value Description
Enabled on | off; default: off Button to enable/disable service.
Baud rate 300 | 600 | 1200 | 2400 | 4800 | 9600 ; default: 2400 Specifies the M-Bus server network baud rate.


Configuration settings


Networking rutos manual mbus gateway configuration settings general.png

Field Value Description
Mode Server | Client | Client+server | Bidirect(legacy mode, not recommended); default: Server
  • Server - launches service in server mode and listens on the selected port.
  • Client - launches service in client mode, which connects to one or several servers with the selected addresses and ports.
  • Client + server - launches service in server and client(s) mode simultaneously.
  • Bidirect(legacy) - launches service in bidirect mode, which means that the service keeps changing between server and client modes. If server mode fails it switches to client mode and vice versa.
Protocol TCP | UDP; default: TCP Select which protocol to use for data transmission.
Listening port integer [1..65535]; default: empty Specify port number for server to listen.


Networking rutos manual mbus gateway configuration settings security.png

Field Value Description
Use TLS/SSL on | off; default: off Button to use TLS/SSL for connection.
TLS version tlsv1.0 | tlsv1.1 | tlsv1.2 | tlsv1.3 | Support all ; default: Support all Minimum TLS version allowed to be used.
TLS type Certificate based | Pre-Shared-Key based; default: Certificate based Select the type of TLS encryption.
Pre-Shared-Key hexadecimal string of symbols; default: empty The pre-shared-key in hex format with no leading “0x”.
Identity string of symbols; default: empty Specify the identity.
Require certificate on | off; default: on Demand certificate and key from peer and verify them against certificate authority.
Certificate files from device on | off; default: off Choose this option if you want to select certificate files from device.


Networking rutos manual mbus gateway configuration settings advanced.png

Field Value Description
Raw mode on | off; default: on Enable to transmit all data transparently.
Remove all zeros on | off; default: off Remove all zero bytes from received data.
Inactivity timeout integer [0..36000] ; default: 300 Specifies period of time in seconds, where server connection must be inactive, to disconnect client. To disable timeout input 0.
Serial timeout integer [0..1000] ; default: empty Specifies the maximum milliseconds to wait for serial data.
Max clients integer [1..32] ; default: 4 Specify (1-32) how many clients are allowed to connect simultaneously.
TCP echo on | off; default: off Software TCP echo.
Close connections on | off; default: off Close TCP connections everytime data is sent or received (might result in serial data loss).
Keep alive on | off; default: off Enable keep alive.


IP filter


The IP Filter section is used for configuring which network is allowed to communicate with the device. You may add a new instance by selecting the Interface and pressing Add.

Networking rutos manual mbus gateway ip filter.png

Field Value Description
Allow IP IPv4 and IPv6 addresses with or without mask prefix are accepted. E.g 192.168.1.0/24. Allow IP connecting to server, write 0.0.0.0/0 for allowing all

[[Category:{{{name}}} Services section]]