Difference between revisions of "Template:Networking rutos manual mbus"
From Teltonika Networks Wiki
Gytispieze (talk | contribs) 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}}} }} }}") |
|||
| (2 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== |
| + | 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: | ||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
| Line 33: | Line 27: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>Enable</td> |
| − | <td> | + | <td>off | on; default: <b>off</b></td> |
| − | <td> | + | <td>Enables the service.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| Line 41: | Line 35: | ||
<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> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>Database location</td> |
| − | <td> | + | <td>RAM memory | Flash memory; default: <b>RAM memory</b></td> |
| − | + | <td>Specifies where the database will be stored..</td> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | <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]] | ||
| − | === | + | ===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: | + | [[File:Networking_rutos_manual_mbus_record_mbus_record_demo_v2.png|border|class=tlt-border]] |
| − | |||
| − | |||
| − | |||
| − | |||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
| Line 97: | Line 62: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>Enable</td> |
| − | <td>on | + | <td>off | on; default: <b>off</b></td> |
| − | <td> | + | <td>Enables the service.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>Name</td> |
| − | <td> | + | <td>string; default: <b>none</b></td> |
| − | <td> | + | <td>Name used for distinguishing purposes.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>Period</td> |
| − | <td> | + | <td>integer [1..86400]; default: <b>60</b></td> |
| − | <td> | + | <td>Specifies the period how often record data will be collected.</td> |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<tr> | <tr> | ||
| − | < | + | <td>String before data</td> |
| − | + | <td>string; default: <b>none</b></td> | |
| − | + | <td>String that will be appended before request data.</td> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | <td> | ||
| − | |||
| − | <td> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>String between data</td> |
| − | <td> | + | <td>string; default: <b>none</b></td> |
| − | <td> | + | <td>String that will be appended between request data.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>String after data</td> |
| − | <td> | + | <td>string; default: <b>none</b></td> |
| − | <td> | + | <td>String that will be appended after request data.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>Failure mode</td> |
| − | <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> | + | <td>Specifies when whole record is considered as failure.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td><span style="color: red;">Store a failure message</span></td> |
| − | <td> | + | <td>off | on; default: <b>off</b></td> |
| − | <td> | + | <td>Select whether to store a failure message in the database or do nothing on failure.</td> |
</tr> | </tr> | ||
</table> | </table> | ||
| − | == | + | ===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: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | ====Request Configuration Edit==== | |
| − | ===Configuration | ||
---- | ---- | ||
| − | + | [[File:Networking rutos manual mbus record request configuration edit v3.png|border|class=tlt-border]] | |
| − | [[File: | ||
<table class="nd-mantable"> | <table class="nd-mantable"> | ||
| Line 209: | Line 120: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>Enable</td> |
| − | <td> | + | <td>off | on; default: <b>off</b></td> |
| − | <td> | + | <td>Enables request processing.</td> |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>Server address</td> |
| − | <td> | + | <td>int | hexstring; default: <b>none</b></td> |
| − | <td> | + | <td>Address of the server to be inquired.</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>Data type</td> |
| − | <td> | + | <td>XML | HEX | BIN | JSON; default: <b>XML</b></td> |
| − | <td> | + | <td>Data type to process the received data.</td> |
</tr> | </tr> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<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> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>FCB toggle</td> |
| − | <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> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
| − | <td> | + | <td>Test configuration</td> |
| − | <td> | + | <td>button; default: <b>-</b></td> |
| − | <td> | + | <td>Tests the current configuration.</td> |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</tr> | </tr> | ||
</table> | </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: | + | [[File:Networking_rutos_manual_mbus_record_request_configuration_edit_test_configuration_v1.png|border|class=tlt-border]] |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
[[Category:{{{name}}} Services section]] | [[Category:{{{name}}} Services section]] | ||
Revision as of 12:09, 24 October 2023
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.
M-Bus Settings
The M-Bus Settings 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:
| Field | Value | Description |
|---|---|---|
| Enable | off | on; default: off | Enables the service. |
| Baud rate | 300 | 600 | 1200 | 2400 | 4800 | 9600 ; default: 2400 | Specifies the M-Bus server network baud rate. |
| Database location | RAM memory | Flash memory; default: RAM memory | Specifies where the database will be stored.. |
Records
By default there are no Records instances created. To start configuring, add a new record using the Add New Instance section below.
M-Bus Record
The M-Bus Record 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:
| Field | Value | Description |
|---|---|---|
| Enable | off | on; default: off | Enables the service. |
| Name | string; default: none | Name used for distinguishing purposes. |
| Period | integer [1..86400]; default: 60 | Specifies the period how often record data will be collected. |
| String before data | string; default: none | String that will be appended before request data. |
| String between data | string; default: none | String that will be appended between request data. |
| String after data | string; default: none | String that will be appended after request data. |
| Failure mode | Never | Any requests failed | All requests failed; default: Never | Specifies when whole record is considered as failure. |
| Store a failure message | off | on; default: off | Select whether to store a failure message in the database or do nothing on failure. |
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 Add button.
Request Configuration Edit
| Field | Value | Description |
|---|---|---|
| Enable | off | on; default: off | Enables request processing. |
| Server address | int | hexstring; default: none | Address of the server to be inquired. |
| Data type | XML | HEX | BIN | JSON; default: XML | Data type to process the received data. |
| Error value | string; default: none | Changes request data to this value if request fails. |
| FCB toggle | off | on; default: on | FCB (Frame Count-Bit): One-bit counter for reliable server-client communication; some devices have special uses for it. |
| Test configuration | button; default: - | Tests the current configuration. |
Test Configuration
Before saving, you can check if your configuration works accordingly by pressing the Test Configuration button. You should see the data in a field below:
[[Category:{{{name}}} Services section]]
