9,948
edits
Changes
Template:Networking rutos manual mbus (view source)
Revision as of 12:09, 24 October 2023
, 12:09, 24 October 2023Text 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}}} }} }}"
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.
==Client==
==M-Bus Settings==
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]]
[[File:Networking_rutos_manual_mbus_client_general_settings.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Status</td>
<td>Enable</td>
<td>Inactive | Active</td>
<td>off | on; default: <b>off</b></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>
<td>Enables the service.</td>
</tr>
</tr>
<tr>
<tr>
<td>Specifies the M-Bus server network baud rate.</td>
<td>Specifies the M-Bus server network baud rate.</td>
</tr>
</tr>
<tr>
<tr>
<td>Database location</td>
<td>RAM memory | Flash memory; default: <b>RAM memory</b></td>
<td>Specifies where the database will be stored..</td>
<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>
</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===
----
----
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_record_mbus_record_demo_v2.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mbus_client_data_collecting_groups.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Enabled</td>
<td>Enable</td>
<td>on | off; default: <b>off</b></td>
<td>off | on; default: <b>off</b></td>
<td>Button to enable/disable data collecting group.</td>
<td>Enables the service.</td>
</tr>
</tr>
<tr>
<tr>
<td>Period</td>
<td>Name</td>
<td>integer [0..86400]|; default: <b>60</b></td>
<td>string; default: <b>none</b></td>
<td>Time duration between data retrievals (in seconds).</td>
<td>Name used for distinguishing purposes.</td>
</tr>
</tr>
<tr>
<tr>
<td>Data type</td>
<td>Period</td>
<td>JSON | XML | ASCII | Hexadecimal | Binary; default: <b>JSON</b></td>
<td>integer [1..86400]; default: <b>60</b></td>
<td>Data type to process the received data.</td>
<td>Specifies the period how often record data will be collected.</td>
</tr>
</tr>
<tr>
<tr>
<td>Test</td>
<td>String before data</td>
<td>Interactive button</td>
<td>string; default: <b>none</b></td>
<td>A unique device identifier which commonly includes the serial number.</td>
<td>String that will be appended before request data.</td>
</tr>
</tr>
<tr>
<tr>
<td>String between data</td>
<td>string; default: <b>none</b></td>
<td>String that will be appended between request data.</td>
<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>FCB toggle</td>
<td>String after data</td>
<td>on | off; default: <b>off</b></td>
<td>string; default: <b>none</b></td>
<td>FCB (Frame Count-Bit): One-bit counter for reliable server-client communication. Some devices may have different uses for it.</td>
<td>String that will be appended after request data.</td>
</tr>
</tr>
<tr>
<tr>
<td>Manufacturer information</td>
<td>Failure mode</td>
<td>on | off; default: <b>off</b></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>Should manufacturer information be included in the payload.</td>
<td>Specifies when whole record is considered as failure.</td>
</tr>
</tr>
<tr>
<tr>
<td>Selected parameters</td>
<td><span style="color: red;">Store a failure message</span></td>
<td>off | on; default: <b>off</b></td>
<td>Select whether to store a failure message in the database or do nothing on failure.</td>
<td>integer [0..15]|; default: <b>60</b></td>
<td>Frame number.</td>
</tr>
</tr>
</table>
</table>
==Gateway==
===Request 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]]
[[File:Networking rutos manual mbus gateway mbus device configuration.png|border|class=tlt-border]]
====Request Configuration Edit====
===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">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td>Mode</td>
<td>Enable</td>
<td>Server | Client | Client+server | Bidirect(legacy mode, not recommended); default: <b>Server</b></td>
<td>off | on; default: <b>off</b></td>
<td>
<td>Enables request processing.</td>
</tr>
</tr>
<tr>
<tr>
<td>Protocol</td>
<td>Server address</td>
<td>TCP | UDP; default: <b>TCP</b></td>
<td>int | hexstring; default: <b>none</b></td>
<td>Select which protocol to use for data transmission.</td>
<td>Address of the server to be inquired.</td>
</tr>
</tr>
<tr>
<tr>
<td>Listening port</td>
<td>Data type</td>
<td>integer [1..65535]; default: <b>empty</b></td>
<td>XML | HEX | BIN | JSON; default: <b>XML</b></td>
<td>Specify port number for server to listen.</td>
<td>Data type to process the received data.</td>
</tr>
</tr>
<tr>
<tr>
<th>Field</th>
<td>Error value</td>
<th>Value</th>
<td>string; default: <b>none</b></td>
<th>Description</th>
<td>Changes request data to this value if request fails.</td>
</tr>
</tr>
<tr>
<tr>
<td>Use TLS/SSL</td>
<td>FCB toggle</td>
<td>on | off; default: <b>off</b></td>
<td>off | on; default: <b>on</b></td>
<td>FCB (Frame Count-Bit): One-bit counter for reliable server-client communication; some devices have special uses for it.</td>
<td>Minimum TLS version allowed to be used.</td>
</tr>
</tr>
<tr>
<tr>
<td>Raw mode</td>
<td>Test configuration</td>
<td>on | off; default: <b>on</b></td>
<td>button; default: <b>-</b></td>
<td>Tests the current configuration.</td>
<td>Remove all zero bytes from received data.</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]]
[[File:Networking_rutos_manual_mbus_gateway_ip_filter.png|border|class=tlt-border]]
[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]