ETM-Schurig/etm-powersync-plugins
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

document the MQTT plugin

Browse Source
This commit is contained in:
Michael Zanetti 2018-11-28 12:32:50 +01:00
parent 853da01e0c
commit 21d775e91e
1 changed files with 11 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
mqtt/devicepluginmqtt.cpp
View File

@ -23,39 +23,32 @@
/*! /*!
\page mqtt.html \page mqtt.html
\title Generic MQTT \title Generic MQTT
\brief Plugin for catching UDP commands from the network. \brief Plugin for subscribing and publishing to an MQTT broker.
\ingroup plugins \ingroup plugins
\ingroup nymea-plugins-maker \ingroup nymea-plugins-maker
This plugin allows to receive UDP packages over a certain UDP port and generates an \l{Event} if the message content matches This plugin allows to subscribe and publish to MQTT brokers (the nymea internal broker and external ones).
the \l{Param} command.
\note This plugin is ment to be combined with a \l{nymeaserver::Rule}. \note This plugin is ment to be combined with a \l{nymeaserver::Rule}.
\section3 Example \section3 Example
If you create an UDP Commander on port 2323 and with the command \c{"Light 1 ON"}, following command will trigger an \l{Event} in nymea A device is configured to publish its state to a MQTT broker. Using this plugin the user can subscribe to
and allows you to connect this \l{Event} with a \l{nymeaserver::Rule}. the same topic on that broker and monitor the device's state.
\note In this example nymea is running on \c localhost 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
\code transport layers to MQTT. For instance a sensor might deliver sensor data via Bluetooth to Nymea and using this
$ echo "Light 1 ON" | nc -u localhost 2323 MQTT plugin and a \l{nymeaserver::Rule} nymea can be configured to forward all those sensor values to a MQTT broker.
OK
\endcode
This allows you to execute \l{Action}{Actions} in your home automation system when a certain UDP message will be sent to nymea.
If the command will be recognized from nymea, the sender will receive as answere a \c{"OK"} string.
\chapter Plugin properties \chapter Plugin properties
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses} The plugin implements the inputtrigger and outputtrigger interfaces, adding parameters for topic and payload to
and \l{Vendor}{Vendors} of this \l{DevicePlugin}. 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}. For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
\quotefile plugins/deviceplugins/udpcommander/devicepluginudpcommander.json \quotefile plugins/deviceplugins/mqtt/devicepluginmqtt.json
*/ */
#include "devicepluginmqtt.h" #include "devicepluginmqtt.h"