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

Rename to nymea

Browse Source
This commit is contained in:
Simon Stürz 2018-03-14 12:11:00 +01:00 committed by Michael Zanetti
parent 9ee2d46967
commit 5b59c8f96e
6 changed files with 46 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/generate-api-qdoc.py
View File

@ -6,19 +6,19 @@
# #
# Copyright (C) 2018 Simon Stuerz <simon.stuerz@guh.io> #
# #
# This file is part of guh. #
# This file is part of nymea. #
# #
# guh is free software: you can redistribute it and/or modify #
# nymea is free software: you can redistribute it and/or modify #
# it under the terms of the GNU General Public License as published by #
# the Free Software Foundation, version 2 of the License. #
# #
# guh is distributed in the hope that it will be useful, #
# nymea is distributed in the hope that it will be useful, #
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
# GNU General Public License for more details. #
# #
# You should have received a copy of the GNU General Public License #
# along with guh. If not, see <http://www.gnu.org/licenses/>. #
# along with nymea. If not, see <http://www.gnu.org/licenses/>. #
# #
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

42
doc/html-template.qdocconf
View File

@ -4,26 +4,26 @@ HTML.postheader = \
"<div class=\"header\">\n" \
" <nav class=\"nymea-navbar-container nymea-margin nymea-navbar\">\n" \
" <div class=\"nymea-navbar-center\">\n" \
" <div class=\"nymea-navbar-center-left\">\n" \
" <div>\n" \
" <ul class=\"nymea-navbar-nav\">\n" \
" <li><a href=\"index.html\">Home</a></li>\n" \
" <li><a href=\"nymeaserver.html\">Server</a></li>\n" \
" <li><a href=\"libnymea-module.html\">Lib</a></li>\n" \
" </ul>\n" \
" </div>\n" \
" <div class=\"nymea-navbar-center-left\">\n" \
" <div>\n" \
" <ul class=\"nymea-navbar-nav\">\n" \
" <li><a href=\"index.html\">Home</a></li>\n" \
" <li><a href=\"nymeaserver.html\">Server</a></li>\n" \
" <li><a href=\"libnymea-module.html\">Lib</a></li>\n" \
" </ul>\n" \
" </div>\n" \
" <a href=\"index.html\" class=\"indexref nymea-logo\"><img src=\"images/main-logo.svg\" class=\"nymea-main-logo\"/></a>\n" \
" <div class=\"nymea-navbar-center-right\">\n" \
" <div>\n" \
" <ul class=\"guh-navbar-nav\">\n" \
" <li><a href=\"interfaces.html\">Interfaces</a></li>\n" \
" <li><a href=\"api.html\">API</a></li>\n" \
" <li><a href=\"write-plugins.html\">Write Plugins</a></li>\n" \
" </ul>\n" \
" </div>\n" \
" </div>\n" \
" <a href=\"index.html\" class=\"indexref nymea-logo\"><img src=\"images/main-logo.svg\" class=\"nymea-main-logo\"/></a>\n" \
" <div class=\"nymea-navbar-center-right\">\n" \
" <div>\n" \
" <ul class=\"nymea-navbar-nav\">\n" \
" <li><a href=\"interfaces.html\">Interfaces</a></li>\n" \
" <li><a href=\"api.html\">API</a></li>\n" \
" <li><a href=\"write-plugins.html\">Write Plugins</a></li>\n" \
" </ul>\n" \
" </div>\n" \
" </div>\n" \
" </div>\n" \
" </div>\n" \
" </nav>\n" \
"</div>\n"
@ -38,9 +38,9 @@ HTML.footer = \
"</div>\n" \
"</div>\n" \
"<div class=\"footer\">\n" \
" <p>\n" \
" <acronym title=\"Copyright\">&copy;</acronym> 2013-2018 guh GmbH. All rights reserved. <a href=\"license.html\">License</a>"\n \
" </p>\n" \
" <p>\n" \
" <acronym title=\"Copyright\">&copy;</acronym> 2013-2018 guh GmbH. All rights reserved. <a href=\"license.html\">License</a>"\n \
" </p>\n" \
"</div>\n"
#HTML.footer = ""

18
doc/jsonrpc-api.qdoc
View File

@ -1,4 +1,4 @@
In following section you can find a detaild description of the current API version 1.2.
In following section you can find a detaild description of the current API version 1.3.
\list
\li \l{Types}
\li \l{Methods}
@ -986,7 +986,7 @@ Sets the server language to the given language. See also: "GetAvailableLanguages
\endcode
See also: \l{ConfigurationError}
\section3 Configuration.SetServerName
Set the name of the server. Default is guhIO.
Set the name of the server. Default is nymea.
\section4 Params
\code
{
@ -1426,7 +1426,7 @@ Authenticate a client to the api via user & password challenge. Provide a device
\endcode
\section3 JSONRPC.CreateUser
Create a new user in the API. Currently this is only allowed to be called once when a new guh instance is set up. Call Authenticate after this to obtain a device token for this user.
Create a new user in the API. Currently this is only allowed to be called once when a new nymea instance is set up. Call Authenticate after this to obtain a device token for this user.
\section4 Params
\code
{
@ -1442,7 +1442,7 @@ Create a new user in the API. Currently this is only allowed to be called once w
\endcode
See also: \l{UserError}
\section3 JSONRPC.Hello
Upon first connection, guh will automatically send a welcome message containing information about the setup. If this message is lost for whatever reason (connections with multiple hops might drop this if guh sends it too early), the exact same message can be retrieved multiple times by calling this Hello method. Note that the contents might change if the system changed its state in the meantime, e.g. initialSetupRequired might turn false if the initial setup has been performed in the meantime.
Upon first connection, nymea will automatically send a welcome message containing information about the setup. If this message is lost for whatever reason (connections with multiple hops might drop this if nymea sends it too early), the exact same message can be retrieved multiple times by calling this Hello method. Note that the contents might change if the system changed its state in the meantime, e.g. initialSetupRequired might turn false if the initial setup has been performed in the meantime.
\section4 Params
\code
{}
@ -1584,7 +1584,7 @@ Return a list of TokenInfo objects of all the tokens for the current user.
\endcode
See also: \l{TokenInfo}
\section3 JSONRPC.Version
Version of this Guh/JSONRPC interface.
Version of this nymea/JSONRPC interface.
\section4 Params
\code
{}
@ -2351,7 +2351,7 @@ Emitted whenever a Rule was removed.
}
},
"Configuration.SetServerName": {
"description": "Set the name of the server. Default is guhIO.",
"description": "Set the name of the server. Default is nymea.",
"params": {
"serverName": "String"
},
@ -2641,7 +2641,7 @@ Emitted whenever a Rule was removed.
}
},
"JSONRPC.CreateUser": {
"description": "Create a new user in the API. Currently this is only allowed to be called once when a new guh instance is set up. Call Authenticate after this to obtain a device token for this user.",
"description": "Create a new user in the API. Currently this is only allowed to be called once when a new nymea instance is set up. Call Authenticate after this to obtain a device token for this user.",
"params": {
"password": "String",
"username": "String"
@ -2651,7 +2651,7 @@ Emitted whenever a Rule was removed.
}
},
"JSONRPC.Hello": {
"description": "Upon first connection, guh will automatically send a welcome message containing information about the setup. If this message is lost for whatever reason (connections with multiple hops might drop this if guh sends it too early), the exact same message can be retrieved multiple times by calling this Hello method. Note that the contents might change if the system changed its state in the meantime, e.g. initialSetupRequired might turn false if the initial setup has been performed in the meantime.",
"description": "Upon first connection, nymea will automatically send a welcome message containing information about the setup. If this message is lost for whatever reason (connections with multiple hops might drop this if nymea sends it too early), the exact same message can be retrieved multiple times by calling this Hello method. Note that the contents might change if the system changed its state in the meantime, e.g. initialSetupRequired might turn false if the initial setup has been performed in the meantime.",
"params": {},
"returns": {
"authenticationRequired": "Bool",
@ -2739,7 +2739,7 @@ Emitted whenever a Rule was removed.
}
},
"JSONRPC.Version": {
"description": "Version of this Guh/JSONRPC interface.",
"description": "Version of this nymea/JSONRPC interface.",
"params": {},
"returns": {
"protocol version": "String",

10
doc/jsonrpc.qdoc
View File

@ -10,7 +10,7 @@
The JSON RPC interface represents a 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 guh Server and the main controller interface. This communication socket is not meant
between the nymea Server and the main controller interface. This communication socket is not meant
to be exported to the outside of the of the system as it allows arbitrary commands to manipulate
the system.
@ -70,12 +70,12 @@
\code
{
"id": 0,
"name": "guh",
"name": "My nymea",
"protocol version": "1.2",
"authenticationRequired": false,
"initialSetupRequired": false,
"pushButtonAuthAvailable": false,
"server": "guhIO",
"server": "nymea",
"language": "de_DE",
"uuid": "{42842b0f-a7bb-4a94-b624-a55f31c5603e}",
"version": "0.8.3"
@ -134,7 +134,7 @@
also be a compact JSON string ending with the \tt{\n} character.
\code
{"id":122,"params":{"authenticationRequired":false,"id":0,"initialSetupRequired":false,"language":"de_DE","name":"guh gehirn","protocol version":"1.2","pushButtonAuthAvailable":false,"server":"guhIO","uuid":"{42842b0f-a7bb-4a94-b624-a55f31c5603e}","version":"0.8.3"},"status":"success"}
{"id":122,"params":{"authenticationRequired":false,"id":0,"initialSetupRequired":false,"language":"de_DE","name":"My nymea","protocol version":"1.2","pushButtonAuthAvailable":false,"server":"nymea","uuid":"{42842b0f-a7bb-4a94-b624-a55f31c5603e}","version":"0.8.3"},"status":"success"}
\endcode
@ -193,7 +193,7 @@
\section2 Create a user
Currently the guhd server is a single user only system and allows only one user. Creating a new user is only allowed if
Currently the nymead server is a single user only system and allows only one user. Creating a new user is only allowed if
the \l{Handshake}{handshake} property \tt initialSetupRequired is \tt{true}.
Call the \l{JSONRPC.CreateUser} method with the username (should be an email address) and password. The returned \l{UserError}

6
doc/nymea.qdoc
View File

@ -3,7 +3,7 @@
\chapter Developer documentation
Welcome to the guh developer documentation. Here you can find information related to the development for guh.
Welcome to the nymea developer documentation. Here you can find information related to the development for nymea.
\section1 Overview
The nymea daemon consists of three main modules:
@ -30,6 +30,7 @@
\section1 Write your own plugin
Here you can find some tutorials for developing and working with nymea:
\list
\li \l{Set up the build environment}
\li \l{Getting started}
@ -39,6 +40,7 @@
\endlist
\section1 Client developers
\list
\li \l{JSON-RPC API}{The API description}
\li \l{Interfaces for DeviceClasses}
@ -47,10 +49,12 @@
\section1 Quicklinks
Overview of all classes and modules in nymea
\list
\li \l{All nymea Classes}
\li \l{All nymea Modules}
\endlist
*/

5
doc/plugin-json.qdoc
View File

@ -5,8 +5,7 @@
Each \l{DevicePlugin}{Plugin} in nymea will be defined in the corresponding JSON file. You can find information how to read JSON \l{http://json.org/}{here}. This file will be loaded from the \l{DeviceManager} to define the plugin and the corresponding DeviceClasses internal.
\section1 The \b {\tt nymea-generateplugininfo} precompiler
\section1 The nymea-generateplugininfo precompiler
The \tt {\b nymea-generateplugininfo} precompiler will parse this file and generates a \tt plugininfo.h and a \tt extern-plugininfo.h file containing the definitions of:
\list
@ -142,7 +141,7 @@
"name": "deviceClassName",
"displayName": "The name of the device class (translatable)",
"o:deviceIcon": "Icon",
"o:interfaces": [ "String" ],
"o:interfaces": [ "interfacename" ],
"o:basicTags": [
"BasicTag"
],