7,849
edits
Changes
Template:Networking rutos manual mqtt (view source)
Revision as of 11:49, 23 February 2024
, 23 Februaryno edit summary
{{Template: Networking_rutos_manual_fw_disclosure
{{Template: Networking_device_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.06.1
| series = {{{series}}}
| series = {{{series}}}
| name = {{{name}}}
| fw_version ={{Template: Networking_device_manual_latest_fw
| series = {{{series}}}
| name = {{{name}}}
}}
}}
}}
{{#ifeq: {{{legacy}}} | 1 |<br><i><b>Note</b>: <b>[[{{{name}}} MQTT (legacy WebUI)|click here]]</b> for the old style WebUI (FW version RUT9XX_R_00.06.08.1 and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} MQTT (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} MQTT (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_device_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
==Summary==
==Summary==
This chapter is an overview of the MQTT page for {{{name}}} devices.
This chapter is an overview of the MQTT page for {{{name}}} devices.
{{#switch: {{{series}}}
| #default =
| TRB2|RUT36X|RUT30X|RUT9|TCR1|RUT2|RUT2M|RUT9M|TRB2M|OTD140|RUT301 =
<u><b>
Note:</b> MQTT is additional software that can be installed from the <b>System → [[{{{name}}} Package Manager|Package Manager]]</b> page.</u>
}}
==MQTT Broker==
==MQTT Broker==
The <b>MQTT Broker</b> is an entity that listens for connections on the specified port and relays received messages to MQTT client. To begin using this devices as an MQTT Broker, enable it in this page. In order to make the device accept MQTT connections from WAN (remote networks), you also need to turn the 'Enable Remote Access' slider on.
The <b>MQTT Broker</b> is an entity that listens for connections on the specified port and relays received messages to MQTT client. To begin using this devices as an MQTT Broker, enable it in this page. In order to make the device accept MQTT connections from WAN (remote networks), you also need to turn the 'Enable Remote Access' slider on.
[[File:Networking_rutos_manual_mqtt_broker.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mqtt_broker_v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>Enable</td>
<td>Enable</td>
<td>off | on; default: <b>off</b></td>
<td>off | on; default: <b>off</b></td>
<td>Toggles MQTT Broker between on and off.</td>
<td>Turn MQTT Broker on or off.</td>
</tr>
<tr>
<td>Custom configuration</td>
<td>off | on; default: <b>off</b></td>
<td>Enables reading of custom configuration.</td>
</tr>
</tr>
<tr>
<tr>
<td>Local Port</td>
<td>Local Port</td>
<td>integer [0..65535]; default: <b>1883</b></td>
<td>integer [0..65535]; default: <b>1883</b></td>
<td>The TCP port on which the MQTT broker will listen for connections.</td>
<td>The TCP port(s) on which the MQTT broker will listen for connections. Click the plus sign to add multiple ports.</td>
</tr>
</tr>
<tr>
<tr>
The <b>Security</b> section is used to configure TLS/SSL .
The <b>Security</b> section is used to configure TLS/SSL .
[[File:Networking_rutos_manual_mqtt_broker_settings_security_2.png|border|class=tlt-border]]
[[File:Networking rutos manual mqtt broker settings security v3.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<th>field name</th>
<th>Field name</th>
<th>value</th>
<th>value</th>
<th>description</th>
<th>description</th>
<td>Certificate based {{!}} <span style="color:darkred">Pre-shared key based</span>; default: '''Certificate based'''</td>
<td>Certificate based {{!}} <span style="color:darkred">Pre-shared key based</span>; default: '''Certificate based'''</td>
<td>Select type of TLS.</td>
<td>Select type of TLS.</td>
</tr>
<tr>
<td>Require certificate</td>
<td>off | on; default: <b>on</b></td>
<td>Demand client certificate and key from the client.</td>
</tr>
</tr>
<tr>
<tr>
<b>Note</b>: this table has a coloring scheme to indicate which fields can be seen with different configuration.
<b>Note</b>: this table has a coloring scheme to indicate which fields can be seen with different configuration.
[[File:Networking_rutos_manual_mqtt_broker_settings_bridge.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mqtt_broker_settings_bridge_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
</tr>
</tr>
<tr>
<tr>
<td><span style="color:blue">On:</span> Bridge CERT File</td>
<td><span style="color:blue">On:</span> Bridge certificate File</td>
<td>.crt file; default: <b>none</b></td>
<td>.crt file; default: <b>none</b></td>
<td>Uploads a server (broker) certificate file. A certificate file is a type of digital certificate that is used by client systems to make authenticated requests to a remote server.</td>
<td>Uploads a server (broker) certificate file. A certificate file is a type of digital certificate that is used by client systems to make authenticated requests to a remote server.</td>
<td>tlsv1 | tlsv1.1 | tlsv1.2; default: <b>tlsv1</b></td>
<td>tlsv1 | tlsv1.1 | tlsv1.2; default: <b>tlsv1</b></td>
<td>TLS version used by the other broker.</td>
<td>TLS version used by the other broker.</td>
</tr>
<tr>
<td><span style="color:blue">On:</span> Bridge ALPN</td>
<td>string; default: <b>none</b></td>
<td>Configure the application layer protocol negotiation option for the TLS session. Useful for brokers that support both websockets and MQTT on the same port. </td>
</tr>
</tr>
<tr>
<tr>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Username for authentication to the remote broker.</td>
<td>Username for authentication to the remote broker.</td>
</tr>
<tr>
<td><span style="color:red">On:</span> Require password</td>
<td>on | off; default: <b>off</b></td>
<td>Password for authentication to the remote broker.</td>
</tr>
</tr>
<tr>
<tr>
<td>off | on; default: <b>off</b></td>
<td>off | on; default: <b>off</b></td>
<td>When turned on, discards session state after connecting or disconnecting.</td>
<td>When turned on, discards session state after connecting or disconnecting.</td>
</tr>
<tr>
<td>Enable notification</td>
<td>off | on; default: <b>off</b></td>
<td>Publish notification messages to the local and remote brokers giving information about the state of the bridge connection.</td>
</tr>
<tr>
<td>Enable local notifications</td>
<td>off | on; default: <b>off</b></td>
<td>Only publish notification messages to the local broker giving information about the state of the bridge connection.</td>
</tr>
<tr>
<td>Keepalive interval</td>
<td>(5-65535); default: <b>60</b></td>
<td>Set the keepalive interval for this bridge connection, in seconds.</td>
</tr>
</tr>
</table>
</table>
You can also create and manage MQTT topics in the <b>Topics</b> list below the Bridge section. To add a new topic, click the 'Add' button.
You can also create and manage MQTT topics in the <b>Topics</b> list below the Bridge section. To add a new topic, click the 'Add' button.
[[File:Networking_rutos_manual_mqtt_broker_settings_bridge_topics_add_button.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mqtt_broker_settings_bridge_topics_add_button v2.png|border|class=tlt-border]]
You can then configure the newly added topic from the same page.
You can then configure the newly added topic from the same page.
[[File:Networking_rutos_manual_mqtt_broker_settings_bridge_topics.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mqtt_broker_settings_bridge_topics v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
The <b>Miscellaneous</b> section is used to configure MQTT broker parameters that are related to neither Security nor Bridge.
The <b>Miscellaneous</b> section is used to configure MQTT broker parameters that are related to neither Security nor Bridge.
[[File:Networking_rutos_manual_mqtt_broker_settings_miscellaneous.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mqtt_broker_settings_miscellaneous v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<tr>
<tr>
<td>Allow Anonymous</td>
<td>Allow Anonymous</td>
<td>off | on; default: <b>on</b></td>
<td>off | on; default: <b>off</b></td>
<td>Turns anonymous access to this broker on or off.</td>
<td>Turns anonymous access to this broker on or off.</td>
</tr>
<tr>
<td>Max queued messages</td>
<td>[0..65535]; default: <b>1000</b></td>
<td>The maximum number of QoS 1 and 2 messages to hold in a queue per client above those that are currently in-flight. Set to 0 for no maximum (not recommended).</td>
</tr>
<tr>
<td>Maximum packet size</td>
<td>[1..268435456]; default: <b>1048576</b></td>
<td>Maximum size of packet before it will be dropped.</td>
</tr>
</tr>
</table>
</table>
<b>Note</b>: this table has coloring scheme to indicate which fields can be seen with different configuration.
<b>Note</b>: this table has coloring scheme to indicate which fields can be seen with different configuration.
[[File:Networking_rutos_manual_mqtt_publisher.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_mqtt_publisher_v2.png|border|class=tlt-border]]
<table class="nd-mantable">
<table class="nd-mantable">
<td>integer [0..65535]; default: <b>1883</b></td>
<td>integer [0..65535]; default: <b>1883</b></td>
<td>Broker's port number.</td>
<td>Broker's port number.</td>
</tr>
<tr>
<td>Client ID</td>
<td>string; default: <b>empty</b></td>
<td>Client ID to send with the data. If empty, a random client ID will be generated.</td>
</tr>
</tr>
<tr>
<tr>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Username used for authentication to the Broker.</td>
<td>Username used for authentication to the Broker.</td>
</tr>
<tr>
<td>Require password</td>
<td>check | uncheck; default: <b>Uncheck</b></td>
<td>Requires password for authentication.</td>
</tr>
</tr>
<tr>
<tr>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>The identity of this client. May be used as the username depending on the server settings.</td>
<td>The identity of this client. May be used as the username depending on the server settings.</td>
</tr>
<tr>
<td>Publish topic prefix</td>
<td>string; default: <b>empty</b></td>
<td>Prefix of the topic to be used during publish. [[Monitoring_via_MQTT#How_MQTT_works|More information.]]</td>
</tr>
<tr>
<td>Subscribe topic prefix</td>
<td>string; default: <b>empty</b></td>
<td>Prefix of the topic to be used during subscription. [[Monitoring_via_MQTT#How_MQTT_works|More information.]] </td>
</tr>
</tr>
</table>
</table>
[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]
