Migrate mqttclient plugin documentation

master
Simon Stürz 2019-06-18 17:31:40 +02:00
parent aa800f70fe
commit cf2fb7d17e
2 changed files with 16 additions and 31 deletions

16
mqttclient/README.md Normal file
View File

@ -0,0 +1,16 @@
# MQTT client
This plugin allows to subscribe and publish to MQTT brokers (the nymea internal broker and external ones).
> This plugin is ment to be combined with a rule.
## Example
A device is configured to publish its state to a MQTT broker. Using this plugin the user can subscribe to
the same topic on that broker and monitor the device's state.
Publishing is also supported. This allows use cases such as controlling IoT things via MQTT by publishing
to topics such devices are subscribed to. Other possibilities are to use nymea as a "translator" between other
transport layers to MQTT. For instance a sensor might deliver sensor data via Bluetooth to Nymea and using this
MQTT plugin and a rule nymea can be configured to forward all those sensor values to a MQTT broker.

View File

@ -20,37 +20,6 @@
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*!
\page mqtt.html
\title Generic MQTT
\brief Plugin for subscribing and publishing to an MQTT broker.
\ingroup plugins
\ingroup nymea-plugins-maker
This plugin allows to subscribe and publish to MQTT brokers (the nymea internal broker and external ones).
\note This plugin is ment to be combined with a \l{nymeaserver::Rule}.
\section3 Example
A device is configured to publish its state to a MQTT broker. Using this plugin the user can subscribe to
the same topic on that broker and monitor the device's state.
Publishing is also supported. This allows use cases such as controlling IoT things via MQTT by publishing
to topics such devices are subscribed to. Other possibilities are to use nymea as a "translator" between other
transport layers to MQTT. For instance a sensor might deliver sensor data via Bluetooth to Nymea and using this
MQTT plugin and a \l{nymeaserver::Rule} nymea can be configured to forward all those sensor values to a MQTT broker.
\chapter Plugin properties
The plugin implements the inputtrigger and outputtrigger interfaces, adding parameters for topic and payload to
the trigger action and triggered event.
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
\quotefile plugins/deviceplugins/mqtt/devicepluginmqttclient.json
*/
#include "devicepluginmqttclient.h"
#include "plugin/device.h"
#include "plugininfo.h"