From 814d55995801a61184f1b25dfee18d7a9adfcffc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Mon, 31 Mar 2014 20:54:26 +0200 Subject: [PATCH] fixed docu --- doc/allclasses.qdoc | 2 +- doc/config.qdocconf | 4 ++-- doc/deviceplugins.qdoc | 2 +- doc/html-template.qdocconf | 2 +- doc/jsonrpc.qdoc | 12 ++++++------ server/guhcore.h | 6 +++--- tests/scripts/addrule.sh | 6 +++--- 7 files changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/allclasses.qdoc b/doc/allclasses.qdoc index 23033287..194d6c0b 100644 --- a/doc/allclasses.qdoc +++ b/doc/allclasses.qdoc @@ -1,6 +1,6 @@ /*! \page classes.html - \title All Hive Classes + \title All guh Classes \generatelist classes */ diff --git a/doc/config.qdocconf b/doc/config.qdocconf index bc694c18..c3636b6b 100644 --- a/doc/config.qdocconf +++ b/doc/config.qdocconf @@ -1,7 +1,7 @@ include(html-template.qdocconf) -project = Hive -description = Hive your Home! +project = guh +description = Gear up your Home! outputdir = html outputformats = HTML diff --git a/doc/deviceplugins.qdoc b/doc/deviceplugins.qdoc index d8b679fa..9539fb47 100644 --- a/doc/deviceplugins.qdoc +++ b/doc/deviceplugins.qdoc @@ -2,7 +2,7 @@ \page deviceplugins.html \title Device Plugins - \brief This is the API for implementing Hive device plugins. + \brief This is the API for implementing guh device plugins. When creating a device plugin, start by subclassing \l{DevicePlugin} and filling in information for the pure virtual methods. diff --git a/doc/html-template.qdocconf b/doc/html-template.qdocconf index 48835161..114284ec 100644 --- a/doc/html-template.qdocconf +++ b/doc/html-template.qdocconf @@ -3,7 +3,7 @@ include(html-styles.qdocconf) HTML.postheader = \ "
\n" \ " \n" \ "
\n" \ "
    \n" \ diff --git a/doc/jsonrpc.qdoc b/doc/jsonrpc.qdoc index 76174718..8f33b868 100644 --- a/doc/jsonrpc.qdoc +++ b/doc/jsonrpc.qdoc @@ -10,7 +10,7 @@ The JSON RPC interface represents a TCP socket connection using plaintext string communication. Messages are exchanged using the JSON format. Please note that this is not a REST API as the transport channel is not based on HTTP. It is an internal RPC mechanism to allow communication - between the Hive Server and the main controller interface. This communication socket is not meant + between the guh Server and the main controller interface. This communication socket is not meant to be exported to the outside of the of the systen as it allows arbitrary commands to manipulate the system. A more limited REST API implementation might be added in the main controller interface. @@ -36,7 +36,7 @@ connections with a some information about the server. Telnet can be used to issue commands for testing. - An example how to communicate with the API using telnet on the same host where the Hive server + An example how to communicate with the API using telnet on the same host where the guh server is running: \code $ telnet localhost 1234 @@ -46,7 +46,7 @@ { "id":0, "status": "connected", - "server":"Hive JSONRPC Interface" + "server":"Guh JSONRPC Interface", "version":"0.0.0" } \endcode @@ -96,8 +96,8 @@ "states": [ "$ref:StateType" ], - "triggers": [ - "$ref:TriggerType" + "events": [ + "$ref:EventType" ] }, ... @@ -140,7 +140,7 @@ "type": "bool" } ], - "triggers": [ + "events": [ { "id": "{7cae711a-a0af-41b4-b3bf-38d3e23b41ba}", "name": "inRange", diff --git a/server/guhcore.h b/server/guhcore.h index bdde32f7..373e9c46 100644 --- a/server/guhcore.h +++ b/server/guhcore.h @@ -1,5 +1,5 @@ -#ifndef HIVECORE_H -#define HIVECORE_H +#ifndef GUHCORE_H +#define GUHCORE_H #include "rule.h" #include "event.h" @@ -32,4 +32,4 @@ private slots: }; -#endif // HIVECORE_H +#endif // GUHCORE_H diff --git a/tests/scripts/addrule.sh b/tests/scripts/addrule.sh index c1c1f6bf..0c2a6c9d 100755 --- a/tests/scripts/addrule.sh +++ b/tests/scripts/addrule.sh @@ -1,8 +1,8 @@ #!/bin/bash if test -z $5; then - echo "usage: $0 host sourceDevice triggerTypeId targetDeviceId actionTypeId" + echo "usage: $0 host sourceDevice eventTypeId targetDeviceId actionTypeId" else - (echo '{"id":1, "method":"Rules.AddRule", "params":{"trigger": {"triggerTypeId": "'$3'", "deviceId":"'$2'", "params":{"power":"true"}}, "actions": [ { "deviceId":"'$4'", "actionTypeId":"'$5'", "params":{"power":"true"}}]}}'; sleep 1) | nc $1 1234 -# (echo '{"id":1, "method":"Rules.AddRule", "params":{"trigger": {"triggerTypeId": "'$2'", "deviceId":"'$3'", "params":{"power":"false"}}, "actions": [ { "deviceId":"'$4'", "name":"rule 1", "params":{"power":"false"}},{ "deviceId":"'$5'", "name":"rule 1", "params":{"power":"true"}}]}}'; sleep 1) | nc $1 1234 + (echo '{"id":1, "method":"Rules.AddRule", "params":{"events": {"eventTypeId": "'$3'", "deviceId":"'$2'", "params":{"power":"true"}}, "actions": [ { "deviceId":"'$4'", "actionTypeId":"'$5'", "params":{"power":"true"}}]}}'; sleep 1) | nc $1 1234 +# (echo '{"id":1, "method":"Rules.AddRule", "params":{"events": {"eventTypeId": "'$2'", "deviceId":"'$3'", "params":{"power":"false"}}, "actions": [ { "deviceId":"'$4'", "name":"rule 1", "params":{"power":"false"}},{ "deviceId":"'$5'", "name":"rule 1", "params":{"power":"true"}}]}}'; sleep 1) | nc $1 1234 fi