Changes

Monitoring via MQTT (view source)

Revision as of 14:43, 30 September 2021

104 bytes removed ,  14:43, 30 September 2021
no edit summary
Line 1: Line 1: −
Router monitoring via MQTT Linux guide applies to TRB14x devices and to RUT9xx, RUTXxx routers.
+
Router monitoring via MQTT Linux guide applies to TRBxxx devices and to RUT9xx, RUTXxx routers.
 
==Introduction==
 
==Introduction==
    
'''MQTT (MQ Telemetry Transport or Message Queue Telemetry Transport)''' is an ISO standard (ISO/IEC PRF 20922) publish-subscribe-based messaging protocol. It works on top of the TCP/IP protocol. It is designed for connections with remote locations where a "small code footprint" is required or the network bandwidth is limited. The publish-subscribe messaging pattern requires a message broker.  
 
'''MQTT (MQ Telemetry Transport or Message Queue Telemetry Transport)''' is an ISO standard (ISO/IEC PRF 20922) publish-subscribe-based messaging protocol. It works on top of the TCP/IP protocol. It is designed for connections with remote locations where a "small code footprint" is required or the network bandwidth is limited. The publish-subscribe messaging pattern requires a message broker.  
   −
This article provides a guide on how to configure and use a basic MQTT setup on TRB14x devices and on 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.
    
==How MQTT works==
 
==How MQTT works==
−
In general an MQTT connection takes place between two Clients and a Broker. A TRB14x devices and RUT routers can be Broker, Client or both. The MQTT Publisher(Client) present in TRB14x 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 TRB14x 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:
+
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:
    
{| class="wikitable"
 
{| class="wikitable"
Line 22: Line 22:  
! style="text-align: left; vertical-align: top;" | operator
 
! style="text-align: left; vertical-align: top;" | operator
 
| style="text-align: left; vertical-align: top;" | Current operator’s name
 
| style="text-align: left; vertical-align: top;" | Current operator’s name
−
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRB2xx and TRB14x
+
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx
 
|-
 
|-
 
! style="text-align: left; vertical-align: top;" | signal
 
! style="text-align: left; vertical-align: top;" | signal
 
| style="text-align: left; vertical-align: top;" | Signal strength in dBm
 
| style="text-align: left; vertical-align: top;" | Signal strength in dBm
−
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRB2xx and TRB14x
+
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx
 
|-
 
|-
 
! style="text-align: left; vertical-align: top;" | network
 
! style="text-align: left; vertical-align: top;" | network
 
| style="text-align: left; vertical-align: top;" | Network state
 
| style="text-align: left; vertical-align: top;" | Network state
−
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRB2xx and TRB14x
+
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx
−
|-
   
! style="text-align: left; vertical-align: top;" | connection
 
! style="text-align: left; vertical-align: top;" | connection
 
| style="text-align: left; vertical-align: top;" | Current connection type (2G, 3G, 4G)
 
| style="text-align: left; vertical-align: top;" | Current connection type (2G, 3G, 4G)
−
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRB2xx and TRB14x
+
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx
−
|-
   
! style="text-align: left; vertical-align: top;" | wan
 
! style="text-align: left; vertical-align: top;" | wan
 
| style="text-align: left; vertical-align: top;" | WAN IP address
 
| style="text-align: left; vertical-align: top;" | WAN IP address
−
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRB2xx and TRB14x
+
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx
 
|-
 
|-
 
! style="text-align: left; vertical-align: top;" | uptime
 
! style="text-align: left; vertical-align: top;" | uptime
 
| style="text-align: left; vertical-align: top;" | System uptime in seconds
 
| style="text-align: left; vertical-align: top;" | System uptime in seconds
−
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRB2xx and TRB14x
+
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx
 
|-
 
|-
 
! style="text-align: left; vertical-align: top;" | name
 
! style="text-align: left; vertical-align: top;" | name
 
| style="text-align: left; vertical-align: top;" | Device's device code
 
| style="text-align: left; vertical-align: top;" | Device's device code
−
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRB2xx and TRB14x
+
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx
 
|-
 
|-
 
! style="text-align: left; vertical-align: top;" | digital1
 
! style="text-align: left; vertical-align: top;" | digital1
Line 66: Line 64:  
! style="text-align: left; vertical-align: top;" | pin3
 
! style="text-align: left; vertical-align: top;" | pin3
 
| style="text-align: left; vertical-align: top;" | Value of 3's pin state
 
| style="text-align: left; vertical-align: top;" | Value of 3's pin state
−
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRB2xx and TRB14x
+
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx
 
|-
 
|-
 
! style="text-align: left; vertical-align: top;" | pin4
 
! style="text-align: left; vertical-align: top;" | pin4
 
| style="text-align: left; vertical-align: top;" | Value of 4's pin state
 
| style="text-align: left; vertical-align: top;" | Value of 4's pin state
−
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRB2xx and TRB14x
+
| style="text-align: left; vertical-align: top;" | RUT9xx, RUTXxx, TRBxxx
 
|-
 
|-
 
|}
 
|}
Line 83: Line 81:  
==Configuring the device==
 
==Configuring the device==
   −
This section will provide an explanation on how to configure an MQTT Broker and MQTT Publisher on a TRB14x devices and on RUT routers.
+
This section will provide an explanation on how to configure an MQTT Broker and MQTT Publisher on a TRBxxx devices and on RUT routers.
    
===Broker===
 
===Broker===
Line 92: Line 90:       −
Configuration for a TRB14x devices and a RUTXxx routers looks like this:
+
Configuration for a TRBxxx devices and a RUTXxx routers looks like this:
    
[[Image:Configuration_examples_publisher_new_design.png|border|class=tlt-border]]
 
[[Image:Configuration_examples_publisher_new_design.png|border|class=tlt-border]]
Line 104: Line 102:       −
Configuration for a TRB14x devices and a RUTXxx routers looks like this:
+
Configuration for a TRBxxx devices and a RUTXxx routers looks like this:
    
[[Image:Configuration examples mqtt publisher_new_design.png.png|border|class=tlt-border]]
 
[[Image:Configuration examples mqtt publisher_new_design.png.png|border|class=tlt-border]]
   −
<b>NOTE</b>: If you configuring a TRB14x devices, it's default hostname is 192.168.2.1.
+
<b>NOTE</b>: If you configuring a TRBxxx devices, it's default hostname is 192.168.2.1.
     
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/84557"

Navigation menu