ETM-Schurig
/
nymea
mirror of https://github.com/nymea/nymea.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix some docs typos

pull/135/head
Michael Zanetti 2017-06-19 23:43:46 +02:00
parent 4355be5b4b
commit 3577f37e1e
14 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/plugin-json.qdoc
View File

@ -217,7 +217,7 @@
\section2 The ParamType definition
A \l{DeviceClass} can have a list of \l{ParamType}{ParamTypes} which will be filled out during the setup and describe the device. Each device should have a parameter "name" to allow the user to give a device an individual name like: "Desk lamp in the living room". \l{ParamType}{ParamTypes} will be used for \e discoveryParamType in the \l{DeviceClass} definition and in the \l{ActionType} and \l{EventType} definition.
A \l{DeviceClass} can have a list of \l{ParamType}{ParamTypes} which will be filled in during the setup and describe the device. Each device should have a parameter "name" to allow the user to give a device an individual name like: "Desk lamp in the living room". \l{ParamType}{ParamTypes} will be used for \e discoveryParamType in the \l{DeviceClass} definition and in the \l{ActionType} and \l{EventType} definition.
\code
}
@ -314,7 +314,7 @@ A \l{StateType} has following parameters:
\li - \underline{\e id:} The actual uuid (\l{StateTypeId}) of the \l{StateType} \unicode{0x2192} \l{StateType::id()}.
\li - \underline{\e index:} The order index of the \l{StateType} \unicode{0x2192} \l{StateType::index()}. This index will be used for sorting the \l{State}{States} of a \l{Device} to make sure the types looks the same on all clients. Please make sure all \l{StateType}{StateTypes} together will create a list from \tt 0 to \tt x.
\li - \underline{\e type:} The data type of this state \unicode{0x2192} \l{StateType::type()}.
\li - \underline{\e ruleRelevant:} Optional: Since not all \l{State}{States} make sense for the user in a rule, with this flag can be specidied if this state should be visible in the rule engine for the user or not. This flag has no effect to the ruleengine mechanism and is only ment to filter out not interesting \l{State}{States}. By default, every state is rule relevant.
\li - \underline{\e ruleRelevant:} Optional: Since not all \l{State}{States} make sense for the user in a rule, with this flag can be specified if this state should be visible in the rule engine for the user or not. This flag has no effect to the ruleengine mechanism and is only ment to filter out not interesting \l{State}{States}. By default, every state is rule relevant.
\li - \underline{\e graphRelevant:} Optional: This flag indicates that this \l{State} is interesting to be shown in a graph/chart. By default every state is \underline not \tt {graphRelevant}. The corresponding EventType will not be graphRelevant, because the graph will be generated from the \l{State} logs.
\li - \underline{\e eventRuleRelevant:} Optional: The same thing as \e {ruleRelevat}, but this flag is for the \l{EventType}, which will be generated for this \l{StateType}.
\li - \underline{\e eventTypeName:} Will be used for the name of the created \l EventType for this \l StateType. It is good practice to name the event \tt{"<stateName> changed"}.

6
doc/tutorial5.qdoc
View File

@ -7,7 +7,7 @@
\section1 Topics
This tutorial will show you how to:
\list
\li \unicode{0x25B6} Use hardware resource \l{NetworkManager}
\li \unicode{0x25B6} Use the hardware resource \l{NetworkManager}
\endlist
@ -257,7 +257,7 @@ In order to get started with our new \b {"Network Info"} plugin we use the minim
For more details about how to write the JSON file please take a look at \l{The Plugin JSON file} documentation.
\note As you can see in this example the \l Vendor for this \l DevicePlugin is the \e guh. Of course you can define here a new Vendor (using \tt uuidgen to generate a new UUID). Please take a look at the existing \l{Vendor}{Vendors} and check if your \l Vendor allready exists. If the \l{Vendor} exists, please copy the \e name, \e idName and \e id to make shore all \l{Device}{Devices} from one \l{Vendor} will be together in the system like in this example for \e guh.
\note As you can see in this example the \l Vendor for this \l DevicePlugin is the \e guh. Of course you can define here a new Vendor (using \tt uuidgen to generate a new UUID). Please take a look at the existing \l{Vendor}{Vendors} and check if your \l Vendor already exists. If the \l{Vendor} exists, please copy the \e name, \e idName and \e id to make shore all \l{Device}{Devices} from one \l{Vendor} will be together in the system like in this example for \e guh.
Our new plugin will have the name \b {"Network Info"}, the corresponding logging categorie will be \tt dcNetworkInfo (defined from the \e {idName}). There will be one new \l{DeviceClass} with the \e name \b {Info about Network}. This \l{DeviceClass} has 6 \l{StateType}{StateTypes} and one \l{ActionType}.
@ -385,7 +385,7 @@ In order to get started with our new \b {"Network Info"} plugin we use the minim
\endcode
All defined states are allready availabe in the system and initialized with the \e defaultValue
All defined states are already availabe in the system and initialized with the \e defaultValue
parameter from \l{The Plugin JSON file}.
\section2 Define the required hardware resource

2
libguh/devicemanager.cpp
View File

@ -48,7 +48,7 @@
\value HardwareResourceNetworkManager
Allows to send network requests and receive replies.
\value HardwareResourceUpnpDisovery
Allowes to search a UPnP devices in the network.
Allows to search a UPnP devices in the network.
\value HardwareResourceBluetoothLE
Allows to interact with bluetooth low energy devices.
*/

2
libguh/network/avahi/qtavahiservice.cpp
View File

@ -22,7 +22,7 @@
/*!
\class QtAvahiService
\brief Allowes to publish an avahi service to the network.
\brief Allows to publish an avahi service to the network.
\inmodule libguh
*/

2
libguh/network/avahi/qtavahiservicebrowser.cpp
View File

@ -22,7 +22,7 @@
/*!
\class QtAvahiServiceBrowser
\brief Allowes to browse avahi services in the local network.
\brief Allows to browse avahi services in the local network.
\ingroup hardware
\inmodule libguh

2
libguh/plugin/deviceclass.cpp
View File

@ -45,7 +45,7 @@
\value CreateMethodAuto
The device will be created automaticaly.
\value CreateMethodDiscovery
The device will be discovered and added by the user by specifying the DeviceDescriptorId.
The device will be discovered and added by the user by selecting the DeviceDescriptorId from the list of discovered possible ones.
*/
/*! \enum DeviceClass::SetupMethod

4
plugins/deviceplugins/datetime/deviceplugindatetime.cpp
View File

@ -76,11 +76,11 @@
Special times of a day (\l{https://en.wikipedia.org/wiki/Twilight#/media/File:Twilight_description_full_day.svg}{original source})
\chapter Alarm
The alarm plugin allowes you to define an alarm which depends on a certain time, weekday or special day time like sunrise or
The alarm plugin allows you to define an alarm which depends on a certain time, weekday or special day time like sunrise or
sunset. An offset can also be definend.
\chapter Countdown
The countdown plugin allowes you to define a countown which triggers an \l{Event} on timeout.
The countdown plugin allows you to define a countown which triggers an \l{Event} on timeout.
\chapter Plugin properties
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}

2
plugins/deviceplugins/kodi/devicepluginkodi.cpp
View File

@ -28,7 +28,7 @@
\ingroup plugins
\ingroup guh-plugins
This plugin allowes you to controll the media center \l{http://kodi.tv/}{Kodi}. If you want to discover
This plugin allows you to controll the media center \l{http://kodi.tv/}{Kodi}. If you want to discover
and control Kodi with guh, you need to activate the remote access and the UPnP service.
\chapter "Activate UPnP"

2
plugins/deviceplugins/mailnotification/devicepluginmailnotification.cpp
View File

@ -23,7 +23,7 @@
/*!
\page mailnotification.html
\title Mail Notification
\brief Plugin which allowes to get mail notification from guh.
\brief Plugin which allows to get mail notification from guh.
\ingroup plugins
\ingroup guh-plugins

2
plugins/deviceplugins/plantcare/devicepluginplantcare.cpp
View File

@ -29,7 +29,7 @@
\ingroup plugins
\ingroup guh-plugins-merkur
This allowes to controll the guh plantcare demo for 6LoWPAN networks.
This allows to controll the guh plantcare demo for 6LoWPAN networks.
\chapter Plugin properties
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}

2
plugins/deviceplugins/ws2812/devicepluginws2812.cpp
View File

@ -29,7 +29,7 @@
\ingroup plugins
\ingroup guh-plugins-merkur
The plugin for the \l{http://cdn.sparkfun.com/datasheets/Components/LED/WS2812.pdf}{ws2812} led module. This plugin allowes to control a ws2812 module over a 6LoWPAN network.
The plugin for the \l{http://cdn.sparkfun.com/datasheets/Components/LED/WS2812.pdf}{ws2812} led module. This plugin allows to control a ws2812 module over a 6LoWPAN network.
\chapter Plugin properties
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}

2
server/bluetoothserver.cpp
View File

@ -27,7 +27,7 @@
\inherits TransportInterface
The bluetooth server allowes clients to connect to the JSON-RPC API using an RFCOMM bluetooth connection. If the server is enabled, a client
The bluetooth server allows clients to connect to the JSON-RPC API using an RFCOMM bluetooth connection. If the server is enabled, a client
can discover the services running on this host. The service for the JSON-RPC api is called \tt guhIO and has the uuid \tt 997936b5-d2cd-4c57-b41b-c6048320cd2b .
\sa TransportInterface

2
server/jsonrpc/jsontypes.cpp
View File

@ -26,7 +26,7 @@
\ingroup json
\inmodule core
This class represents all JSON-RPC API types and allowes to transform Json
This class represents all JSON-RPC API types and allows to transform Json
objects into c++ objects and vers visa.
*/

2
server/tcpserver.cpp
View File

@ -28,7 +28,7 @@
\inherits TransportInterface
The TCP server allowes clients to connect to the JSON-RPC API.
The TCP server allows clients to connect to the JSON-RPC API.
\sa WebSocketServer, TransportInterface
*/