From bb7b2d3f97bb82060d3d458bd5478b38a81ee7bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Fri, 12 Jun 2015 17:31:59 +0200 Subject: [PATCH] improve documentation --- .../udpcommander/devicepluginudpcommander.cpp | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/plugins/deviceplugins/udpcommander/devicepluginudpcommander.cpp b/plugins/deviceplugins/udpcommander/devicepluginudpcommander.cpp index 85e0b794..16cddbce 100644 --- a/plugins/deviceplugins/udpcommander/devicepluginudpcommander.cpp +++ b/plugins/deviceplugins/udpcommander/devicepluginudpcommander.cpp @@ -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}