Difference between revisions of "Plugin:MQTT"

From collectd Wiki
Jump to: navigation, search
Line 9: Line 9:
 
   | Manpage={{Manpage|collectd.conf|5|plugin_mqtt}}
 
   | Manpage={{Manpage|collectd.conf|5|plugin_mqtt}}
 
}}
 
}}
 +
 
The '''MQTT plugin''' transmits or receives values collected by ''collectd'' via the [http://mqtt.org/ MQTT] protocol.
 
The '''MQTT plugin''' transmits or receives values collected by ''collectd'' via the [http://mqtt.org/ MQTT] protocol.
 +
MQTT is a "light weight" publish-subscribe messaging protocol for use on top of the TCP/IP protocol.
 
Data is sent to or received from a MQTT Server, also known as a message broker.
 
Data is sent to or received from a MQTT Server, also known as a message broker.
 
The values are encoded and parsed in the [[plain text protocol]].
 
The values are encoded and parsed in the [[plain text protocol]].
 +
It is possible to use three different levels of Quality of Service (QoS), which offer different levels of assurance that the message will be delivered.
 +
  
 
== Synopsis ==
 
== Synopsis ==

Revision as of 08:34, 8 September 2015

MQTT plugin
Type: read, write
Callbacks: config, init, write
Status: supported
First version: 5.6
Copyright: 2014-2015 Florian octo Forster
2014 Marc Falzon
License: MIT license
Manpage: collectd.conf(5)
List of Plugins

The MQTT plugin transmits or receives values collected by collectd via the MQTT protocol. MQTT is a "light weight" publish-subscribe messaging protocol for use on top of the TCP/IP protocol. Data is sent to or received from a MQTT Server, also known as a message broker. The values are encoded and parsed in the plain text protocol. It is possible to use three different levels of Quality of Service (QoS), which offer different levels of assurance that the message will be delivered.


Synopsis

<Plugin "mqtt">
  # Send values to an MQTT server
  <Publish "some_name">
    Host "localhost"
#   Port "1883"
#   User "mqttuser"
#   Password "password"
#   ClientId "collectd-hostname"
#   QoS 0
#   Prefix "collectd"
#   Retain true
#   StoreRates false
  </Publish>
  
  # Receive values from an MQTT server
  <Subscribe "some_name">
    Host "localhost"
#   Port "1883"
#   User "mqttuser"
#   Password "password"
#   ClientId "collectd-hostname"
#   QoS 0
#   CleanSession false
#   Topic "subscribetopic"
  </Subscribe>
</Plugin>



Dependencies

See also