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

improve documentation

Browse Source
This commit is contained in:
Simon Stürz 2015-06-12 17:31:59 +02:00 committed by Michael Zanetti
parent c8d4d82494
commit bb7b2d3f97
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
plugins/deviceplugins/udpcommander/devicepluginudpcommander.cpp
View File

@ -25,8 +25,23 @@
\ingroup plugins
\ingroup network
This plugin allows to receive UDP packages over a certain UDP port and generates an \l{Event} if the command matches the \l{Param} command.
This plugin is ment to be cominend with a \l{Rule}.
This plugin allows to receive UDP packages over a certain UDP port and generates an \l{Event} if the message content matches
the \l{Param} command.
\note This plugin is ment to be cominend with a \l{Rule}.
\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 guh
and allows you to connect this \l{Event} with a \l{Rule}.
\note In this example guh is running on \c localhost
\code
$ echo "Light 1 ON" | nc -u localhost 2323
\endcode
This allows you to execute \l{Action}{Actions} in your home automation system when a certain UDP message will be sent to guh.
\chapter Plugin properties
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}