31,703
edits
Changes
Template:Networking rutos manual mqtt (view source)
Revision as of 09:43, 22 November 2022
, 09:43, 22 November 2022no edit summary
{{Template:Networking_rutos_manual_fw_disclosure
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.05.1
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| series = {{{series}}}
| series = {{{series}}}
| name = {{{name}}}
}}
}}
}}
{{#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_rutos_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_rutos_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 =
<u><b>
Note:</b> MQTT is additional software that can be installed from the <b>Services → [[{{{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_v2.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>
<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>
<tr>
<tr>
<td>Use TLS/SSL</td>
<td>Use TLS/SSL</td>
<td>Certificate based {{!}} <span style="color:darkred">Pre-shared key based</span>; default: '''Certificate based'''</td>
<td>off | on; default: <b>off</b></td>
<td>Turns the use of TLS/SSL for this MQTT connection on or off.</td>
<td>Turns the use of TLS/SSL for this MQTT connection on or off.</td>
</tr>
</tr>
<tr>
<tr>
<th>TLS type</th>
<td>TLS type</td>
<th></th>
<td>Certificate based {{!}} <span style="color:darkred">Pre-shared key based</span>; default: '''Certificate based'''</td>
<th>description</th>
<td>Select type of TLS.</td>
</tr>
</tr>
<tr>
<tr>
<td>string; default: <b>none</b></td>
<td>string; default: <b>none</b></td>
<td>Name of the Bridge connection. This is used for easier management purposes.</td>
<td>Name of the Bridge connection. This is used for easier management purposes.</td>
</tr>
<tr>
<td>Protocol version</td>
<td>3.1 | 3.1.1; default: <b>3.1</b></td>
<td>Selects protocol version</td>
</tr>
</tr>
<tr>
<tr>
<td>off | on; default: <b>off</b></td>
<td>off | on; default: <b>off</b></td>
<td>Allows connections without verifying server authenticity.</td>
<td>Allows connections without verifying server authenticity.</td>
</tr>
<tr>
<td>TLS type</td>
<td>Certificate based {{!}} <span style="color:darkred">Pre-shared key based</span>; default: '''Certificate based'''</td>
<td>Select type of TLS.</td>
</tr>
</tr>
<tr>
<tr>
<td>.key file; default: <b>none</b></td>
<td>.key file; default: <b>none</b></td>
<td>Key file used in Transport Layer Security.</td>
<td>Key file used in Transport Layer Security.</td>
</tr>
<tr>
<td><span style="color:darkred">Pre-shared key based:</span> Pre-Shared-Key</td>
<td>string; default: <b>none</b></td>
<td>The pre-shared-key in hex format with no leading "0x".</td>
</tr>
<tr>
<td><span style="color:darkred">Pre-shared key based:</span> Identity</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>
</tr>
</tr>
</table>
</table>
[[Category:{{{name}}} Services section]]
[[Category:{{{name}}} Services section]]
