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

Migrate networkdetector plugin documentation

Browse Source
This commit is contained in:
Simon Stürz 2019-06-19 11:05:37 +02:00
parent 2c75e9eb45
commit 6b1b8cfc13
2 changed files with 5 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
networkdetector/README.md Normal file
View File

@ -0,0 +1,5 @@
# Network detector
This plugin allows to find and monitor network devices in your local network by using the hostname of the devices.
> Note: the application `nmap` has to be installed and nymea has to run as `root`.

23
networkdetector/devicepluginnetworkdetector.cpp
View File

@ -21,29 +21,6 @@
* * * *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*!
\page networkdetector.html
\title Network Detector
\brief Plugin to monitor devices in the local network.
\ingroup plugins
\ingroup nymea-plugins
This plugin allows to find and monitor network devices in your local network by using the hostname of the devices.
\underline{NOTE}: the application \c nmap has to be installed and nymea has to run as root.
\chapter Plugin properties
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
\quotefile plugins/deviceplugins/networkdetector/devicepluginnetworkdetector.json
*/
#include "devicepluginnetworkdetector.h" #include "devicepluginnetworkdetector.h"
#include "plugin/device.h" #include "plugin/device.h"