Monitoring via MQTT: Difference between revisions

Router monitoring via MQTT Linux guide applies to TRBxxx devices and to RUT9xx, RUTXxx routers.

This article provides a guide on how to configure and use a basic MQTT setup on TRBxxx devices and on RUT9xx, RUTXxx routers.

In general an MQTT connection takes place between two Clients and a Broker. A TRBxxx devices and RUT routers can be Broker, Client or both. The MQTT Publisher(Client) present in TRBxxx devices and RUT routers subscribes to two topics by default: '''<TYPE>/get''' and '''get/<SERIAL>/command'''. Where '''<TYPE>''' is device type, for RUT routers type is '''router''' and for TRB1xxx devices type is '''device'''. Parameter  '''<SERIAL>''' is the router's serial number. When a third party client connects to the Broker, it sends the message '''id''' to the the topic '''<TYPE>/get'''. The publisher then sends a response containing its serial number to the topic '''<TYPE>/id'''. Now that the Client knows the router's or device's serial number it can ask for values of various parameters by sending requests to the topic '''<TYPE>/<SERIAL>/parameter_name'''. The MQTT Publisher can send responses containing values of these system parameters, if device supports that parameter:

! style="width: 250px; background: black; color: white;"  | Supported devices

| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRB2xx

| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx

| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx

| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx

| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx

| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx

| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx

| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx

| style="text-align: left; vertical-align: top;" | RUT9xx

| style="text-align: left; vertical-align: top;" | RUT9xx

| style="text-align: left; vertical-align: top;" | RUT9xx and TRB2xx

| style="text-align: left; vertical-align: top;" | TRB2xx

| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx

| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx

It should also be noted that, according to the MQTT protocol, topic names are case-sensitive. For instance, topic ''router'' is not the same as topic ''RoUtEr''.

This section will provide an explanation on how to configure an MQTT Broker and MQTT Publisher on a TRBxxx devices and on RUT routers.

Basic (not counting Security, Bridge and Miscellaneous Broker settings) Broker configuration only contains three fields. Make sure to '''Enable''' the Broker and specify a '''Port''' for connection to the Broker. ''' Enable Remote Access''' if you wish to connect to your router remotely (via WAN). Although in this case your router would need to have a Public IP address. In image below is presented how to configure RUT9xx routers:

[[Image:Configuration examples mqtt broker.png|border|class=tlt-border]]

Configuration for a TRBxxx devices and a RUTXxx routers looks like this:

[[Image:Configuration_examples_publisher_new_design.png|border|class=tlt-border]]

Publisher configuration is similar in its simplicity to the Broker configuration. Make sure to '''Enable''' the Publisher and specify a '''Port''' for connection to a Broker. If you plan on using the router's Broker, specify the same port as the one in the Broker Settings section. '''Hostname''' is the Broker's host name or IP address. If you're using the router's Broker, specify your router's LAN IP address. '''Username''' and '''Password''' are optional and depend on the type of security (if any) that the Broker uses. In image below is presented how configure RUT9xx routers:

[[Image:Configuration examples mqtt publisher.png|border|class=tlt-border]]

 

 

<b>NOTE</b>: If you configuring a TRBxxx devices, it's default hostname is 192.168.2.1.

Now you can use set up Brokers and Clients on your PC. In order to Publish commands and Subscribe to topics on a TRB series devices and RUT routers, you'll need to know the device's '''Serial Number''' and '''TYPE'''. For TRB series device's you'll need to use type : '''device''' and for RUT router's you'll need to use type: '''router'''. Router's serial number you can find in the '''Status → Device''' section of the router's WebUI. For TRB series devices serial number you can find in the '''Status → System''' section of the device WebUI. Or you can subscribe to the topic '''<TYPE>/id''' and publish the message '''id''' to the topic '''<TYPE>/get'''. To do so, enter these commands in separate Terminal windows:

[[Image:Configuration examples mqtt router id v7.png|border|class=tlt-border]]

In example below you can see how to subscribe and publish to the topics '''signal strength''' and '''uptime''' on RUT routers:

[[File:Configuration examples mqtt subscribe publish v5.png|1150px]]