9,608
edits
Changes
Template:Networking rutos manual mbus (view source)
Revision as of 15:05, 13 April 2022
, 15:05, 13 April 2022Created page with "{{Template: Networking_rutos_manual_fw_disclosure | fw_version ={{Template: Networking_rutos_manual_latest_fw | series = {{{series}}} }} }} ==Summary== The <b>M-Bus (Meter..."
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
}}
}}
==Summary==
The <b>M-Bus (Meter Bus)</b> is a cost-effective fieldbus communication protocol for transmitting energy consumption data. A central master – in this case {{{name}}} – communicates via a two-wire bus (up to max. 250 slaves 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.
==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]]
<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 the service.</td>
</tr>
<tr>
<td>Baud rate</td>
<td>300 | 600 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400; default: <b>2400</b></td>
<td>Specifies the M-Bus slave network baud rate.</td>
</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>
</tr>
</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]]
===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_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>Enables the service.</td>
</tr>
<tr>
<td>Name</td>
<td>string; default: <b>none</b></td>
<td>Name used for distinguishing purposes.</td>
</tr>
<tr>
<td>Period</td>
<td>integer [1..86400]; default: <b>none</b></td>
<td>Specifies the period how often record data will be collected.</td>
</tr>
<tr>
<td>String before data</td>
<td>string; default: <b>none</b></td>
<td>String that will be appended before request data.</td>
</tr>
<tr>
<td>String between data</td>
<td>string; default: <b>none</b></td>
<td>String that will be appended between request data.</td>
</tr>
<tr>
<td>String after data</td>
<td>string; default: <b>none</b></td>
<td>String that will be appended after request data.</td>
</tr>
<tr>
<td>Failure mode</td>
<td>Never | Any requests failed | All requests failed; default: <b>Never</b></td>
<td>Specifies when whole record is considered as failure.</td>
</tr>
<tr>
<td>Store a failure message</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>
</tr>
</table>
===Request Configuration===
----
In this section, you can configure requests from slaves. 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_v1.png|border|class=tlt-border]]
====Request Configuration Edit====
----
[[File:Networking_rutos_manual_mbus_record_request_configuration_edit_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>Enables request processing.</td>
</tr>
<tr>
<td>Slave address</td>
<td>int | hexstring; default: <b>none</b></td>
<td>Address of the slave to be inquired.</td>
</tr>
<tr>
<td>Data type</td>
<td>XML | HEX | BIN; default: <b>XML</b></td>
<td>Data type to process the received data.</td>
</tr>
<tr>
<td>Error value</td>
<td>string; default: <b>none</b></td>
<td>Changes request data to this value if request fails.</td>
</tr>
<tr>
<td>Test configuration</td>
<td>button; default: <b>-</b></td>
<td>Tests the current configuration.</td>
</tr>
</table>
====Test Configuration====
----
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]]
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
}}
}}
==Summary==
The <b>M-Bus (Meter Bus)</b> is a cost-effective fieldbus communication protocol for transmitting energy consumption data. A central master – in this case {{{name}}} – communicates via a two-wire bus (up to max. 250 slaves 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.
==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]]
<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 the service.</td>
</tr>
<tr>
<td>Baud rate</td>
<td>300 | 600 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400; default: <b>2400</b></td>
<td>Specifies the M-Bus slave network baud rate.</td>
</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>
</tr>
</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]]
===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_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>Enables the service.</td>
</tr>
<tr>
<td>Name</td>
<td>string; default: <b>none</b></td>
<td>Name used for distinguishing purposes.</td>
</tr>
<tr>
<td>Period</td>
<td>integer [1..86400]; default: <b>none</b></td>
<td>Specifies the period how often record data will be collected.</td>
</tr>
<tr>
<td>String before data</td>
<td>string; default: <b>none</b></td>
<td>String that will be appended before request data.</td>
</tr>
<tr>
<td>String between data</td>
<td>string; default: <b>none</b></td>
<td>String that will be appended between request data.</td>
</tr>
<tr>
<td>String after data</td>
<td>string; default: <b>none</b></td>
<td>String that will be appended after request data.</td>
</tr>
<tr>
<td>Failure mode</td>
<td>Never | Any requests failed | All requests failed; default: <b>Never</b></td>
<td>Specifies when whole record is considered as failure.</td>
</tr>
<tr>
<td>Store a failure message</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>
</tr>
</table>
===Request Configuration===
----
In this section, you can configure requests from slaves. 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_v1.png|border|class=tlt-border]]
====Request Configuration Edit====
----
[[File:Networking_rutos_manual_mbus_record_request_configuration_edit_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>Enables request processing.</td>
</tr>
<tr>
<td>Slave address</td>
<td>int | hexstring; default: <b>none</b></td>
<td>Address of the slave to be inquired.</td>
</tr>
<tr>
<td>Data type</td>
<td>XML | HEX | BIN; default: <b>XML</b></td>
<td>Data type to process the received data.</td>
</tr>
<tr>
<td>Error value</td>
<td>string; default: <b>none</b></td>
<td>Changes request data to this value if request fails.</td>
</tr>
<tr>
<td>Test configuration</td>
<td>button; default: <b>-</b></td>
<td>Tests the current configuration.</td>
</tr>
</table>
====Test Configuration====
----
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]]
