Migrate wakeonlan plugin documentation

master
Simon Stürz 2019-06-19 12:15:04 +02:00
parent 349244c665
commit 9b9ad15027
2 changed files with 7 additions and 24 deletions

7
wakeonlan/README.md Normal file
View File

@ -0,0 +1,7 @@
# Wake on LAN
Wake-on-LAN (WOL) is an Ethernet computer networking standard that allows a computer
to be turned on or awakened by a network message. This plugin allows you to send a
a "magic packet" to a certain mac address in the local network.
> Note: The WOL service has to be enabled on the host computer.

View File

@ -20,30 +20,6 @@
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*!
\page wakeonlan.html
\title Wake On Lan
\brief Plugin for wake up devices in the LAN (wol).
\ingroup plugins
\ingroup nymea-plugins
Wake-on-LAN (WOL) is an Ethernet computer networking standard that allows a computer
to be turned on or awakened by a network message. This plugin allows you to send a
a "magic packet" to a certain mac address in the local network.
\underline{NOTE}: The WOL service has to be enabled on the host computer.
\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/wakeonlan/devicepluginwakeonlan.json
*/
#include "devicepluginwakeonlan.h"
#include "plugin/device.h"