Changes

Template:Networking rutos manual mbus (view source)

Revision as of 15:10, 2 July 2024

10,938 bytes added ,  15:10
no edit summary
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==
 +
 
 +
 
 +
===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]]
 +
 
 +
[[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>Status</td>
 +
        <td>Inactive | Active</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>
 +
        <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>
 +
 
 +
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:
 +
 
 +
===Devices===
 +
----
 +
 
 +
[[File:Networking_rutos_manual_mbus_client_devices_add.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>
 +
        <td>Secondary address</td>
 +
        <td>string of 16 symbols; default: <b>empty</b></td>
 +
        <td>A unique device identifier which commonly includes the serial number.</td>
 +
    </tr>
 +
</table>
 +
 
 +
 
 +
 
 +
===Data collecting groups===
 +
----
 +
 
 +
[[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_client_data_collecting_groups_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 collecting group.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Period</td>
 +
        <td>integer [0..86400]|; default: <b>60</b></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>
 +
 
 +
[[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>
 +
        <td>FCB toggle</td>
 +
        <td>on | off; default: <b>off</b></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>
 +
        <td>Manufacturer information</td>
 +
        <td>on | off; default: <b>off</b></td>
 +
        <td>Should manufacturer information be included in the payload.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Selected parameters</td>
 +
        <td>All | Custom; default: <b>All</b></td>
 +
        <td>Should all parameters be saved from device, or a custom subset of them.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Frame number</td>
 +
        <td>integer [0..15]|; default: <b>60</b></td>
 +
        <td>Frame number.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Record number</td>
 +
        <td>integer [0..63]|; default: <b>60</b></td>
 +
        <td>Record number.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Parameter</td>
 +
        <td>id | frame | Function | StorageNumber | Tariff | Device | Unit | Value | Timestamp; default: <b>id</b></td>
 +
        <td>Parameter.</td>
 +
    </tr>
 +
</table>
 +
 
 +
==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:
 +
 
 +
[[File:Networking rutos manual mbus gateway mbus device 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 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_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">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Raw mode</td>
 +
        <td>on | off; default: <b>on</b></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>
 +
        <td>Inactivity timeout</td>
 +
        <td>integer [0..36000] ; default: <b>300</b></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>
 +
        <td>Serial timeout</td>
 +
        <td>integer [0..1000] ; default: <b>empty</b></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>
 +
        <td>TCP echo</td>
 +
        <td>on | off; default: <b>off</b></td>
 +
        <td>Software TCP echo.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Close connections</td>
 +
        <td>on | off; default: <b>off</b></td>
 +
        <td>Close TCP connections everytime data is sent or received (might result in serial data loss).</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Keep alive</td>
 +
        <td>on | off; default: <b>off</b></td>
 +
        <td>Enable keep alive.</td>
 +
    </tr>
 +
</table>
 +
 
 +
 
 +
 
 +
===IP filter===
 +
----
 +
 
 +
[[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>
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
    
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:  
 
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:  
Line 48: Line 387:     
[[File:Networking_rutos_manual_mbus_records_add_new_instance_v1.png|border|class=tlt-border]]
 
[[File:Networking_rutos_manual_mbus_records_add_new_instance_v1.png|border|class=tlt-border]]
 +
 +
----
    
===M-Bus Record===
 
===M-Bus Record===
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/128416"

Navigation menu