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

update links to github

pull/135/head
Michael Zanetti 2018-03-07 12:38:23 +01:00
parent c698861bb3
commit 0ba6db296b
9 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -9,7 +9,7 @@ In order to getting started with *nymea* and find information you can take a loo
* A detailed description how to install and getting started with the *nymea* can be found in the
[nymea | github wiki](https://github.com/guh/guh/wiki).
[nymea | github wiki](https://github.com/guh/nymea/wiki).
* A detailed documentation of the source code can be found in the

2
data/systemd/nymead.service
View File

@ -1,6 +1,6 @@
[Unit]
Description=nymead - IoT server
Documentation=https://github.com/guh/guh/wiki
Documentation=https://github.com/guh/nymea/wiki
After=network.target
Wants=network-online.target

8
debian/man/nymea-generateplugininfo.1 vendored
View File

@ -35,13 +35,13 @@ The plugininfo.h outputFile with the uuid declarations.
The translation files for the plugin.
.SH SEE ALSO
Full developer documentation at: <https://developers.guh.io>
Full developer documentation at: <https://doc.nymea.io>
.br
Wiki on github: <https://github.com/guh/guh/wiki>
Wiki on github: <https://github.com/guh/nymea/wiki>
.SH "REPORTING BUGS"
Issue tracker on github: <https://github.com/guh/guh/issues>
Issue tracker on github: <https://github.com/guh/nymea/issues>
.br
How to report bugs: <https://github.com/guh/guh/wiki/Reporting-bugs>
How to report bugs: <https://github.com/guh/nymea/wiki/Reporting-bugs>
.SH AUTHOR
Written by Simon Stürz
.SH COPYRIGHT

8
debian/man/nymead.1 vendored
View File

@ -134,13 +134,13 @@ The systemd unit file: \fI/lib/systemd/system/nymead.service\fR
.br
The plugins directory: \fI/usr/lib/<arch-triplet>/nymea/plugins/\fR
.SH SEE ALSO
Full developer documentation at: <https://developers.guh.io>
Full developer documentation at: <https://doc.nymea.io>
.br
Wiki on github: <https://github.com/guh/guh/wiki>
Wiki on github: <https://github.com/guh/nymea/wiki>
.SH "REPORTING BUGS"
Issue tracker on github: <https://github.com/guh/guh/issues>
Issue tracker on github: <https://github.com/guh/nymea/issues>
.br
How to report bugs: <https://github.com/guh/guh/wiki/Reporting-bugs>
How to report bugs: <https://github.com/guh/nymea/wiki/Reporting-bugs>
.SH AUTHOR
Written by Simon Stürz and Michael Zanetti
.SH COPYRIGHT

4
doc/api.qdoc
View File

@ -5,10 +5,10 @@
The nymea server provides two different API's:
\list
\li \l{JSON-RPC API}{JSON-RPC}
\li \l{https://github.com/guh/guh/wiki/REST-API}{REST}
\li \l{https://github.com/guh/nymea/wiki/REST-API}{REST}
\endlist
The \l{https://github.com/guh/guh/wiki/REST-API}{REST API} is accessable on the \l{nymeaserver::WebServer}{WebServer}. The JSON-RPC API can be accessed from the \l {nymeaserver::TcpServer}{TcpServer} and the \l {nymeaserver::WebSocketServer}{WebSocketServer} interface. The command line interface \b {\tt nymea-cli} communicates with the \l {nymeaserver::TcpServer}{TcpServer} and \l {JSON-RPC API}. The \b {\tt nymea-webinterface} uses the \l{nymeaserver::WebServer}{WebServer} with the \l{https://github.com/guh/guh/wiki/REST-API}{REST-API} and catches notifications from the \l {nymeaserver::WebSocketServer}{WebSocketServer}.
The \l{https://github.com/guh/nymea/wiki/REST-API}{REST API} is accessable on the \l{nymeaserver::WebServer}{WebServer}. The JSON-RPC API can be accessed from the \l {nymeaserver::TcpServer}{TcpServer} and the \l {nymeaserver::WebSocketServer}{WebSocketServer} interface. The command line interface \b {\tt nymea-cli} communicates with the \l {nymeaserver::TcpServer}{TcpServer} and \l {JSON-RPC API}. The \b {\tt nymea-webinterface} uses the \l{nymeaserver::WebServer}{WebServer} with the \l{https://github.com/guh/nymea/wiki/REST-API}{REST-API} and catches notifications from the \l {nymeaserver::WebSocketServer}{WebSocketServer}.
\image api-overview.png

2
doc/nymea.qdoc
View File

@ -28,7 +28,7 @@
The nymea daemon provides two API's:
\list
\li \l{JSON-RPC API}{JSON-RPC}
\li \l{https://github.com/guh/guh/wiki/REST-API}{REST}
\li \l{https://github.com/guh/nymea/wiki/REST-API}{REST}
\endlist
\section1 Write your own plugin

4
doc/setup-environment.qdoc
View File

@ -20,7 +20,7 @@
You can find a good instructions how to install the nymea repository on your system here:
\b {\unicode{0x2192}} \l{https://github.com/guh/guh/wiki/Install}{nymea install wiki}
\b {\unicode{0x2192}} \l{https://github.com/guh/nymea/wiki/Install}{nymea install wiki}
For example, if you are working on Ubuntu 15.04 Vivid, you can create a source list file and add the nymea repository like this:
@ -56,7 +56,7 @@
\list
\li \underline{\e nymea} \unicode{0x2192} the \tt nymea package is a meta package and will install the \tt nymead, \tt libnymea1 and \tt nymea-plugins package so you can start the nymea daemon.
\li \underline{\e nymea-webinterface} \unicode{0x2192} the \tt nymea-webinterface package will install the webinterface for nymea, which is accessable on \l{http://localhost:3333}.
\li \underline{\e nymea-cli} \unicode{0x2192} the \tt nymea-cli package will install the command line interface for the nymea JSON-RPC API. You can find more infomation \l{https://github.com/guh/guh/wiki/guh-cli}{here}.
\li \underline{\e nymea-cli} \unicode{0x2192} the \tt nymea-cli package will install the command line interface for the nymea JSON-RPC API. You can find more infomation \l{https://github.com/guh/nymea/wiki/nymea-cli}{here}.
\li \underline{\e nymea-doc} \unicode{0x2192} the \tt nymea-doc package will install the offline documentation on your system (this homepage). You can access the documentation in your brwoser with \l{file:///usr/share/doc/nymea/html/index.html}{file:///usr/share/doc/nymea/html/index.html}.
\li \underline{\e libnymea1-dev} \unicode{0x2192} the \tt libnymea1-dev package brings all development files of nymea (header files and lib) which will be needed to write a plugin.
\endlist

4
doc/tutorial1.qdoc
View File

@ -13,7 +13,7 @@
\endlist
\section1 Open the project
Assuming you already have downloaded the \l{https://github.com/guh/plugin-templates}{plugin-templates} you can open the \tt {plugin-templates \unicode{0x2192} minimal \unicode{0x2192} minimal.pro} file with the Qt Creator.
Assuming you already have downloaded the \l{https://github.com/guh/nymea-plugin-template}{nymea-plugin-template} you can open the \tt {plugin-template \unicode{0x2192} minimal \unicode{0x2192} minimal.pro} file with the Qt Creator.
\image minimal-project-open.png "Qt Creator"
@ -84,7 +84,7 @@
Now you can use any nymea client application to examin the new plugin and device. Since the application \b {\tt nymea-cli} (nymea command line interface) was developed for developers, I will show you how this works with the \b {\tt nymea-cli}.
\note You can open two terminal tabs. In the first one you can start \tt nymead with the \tt -n parameter to see the debug output. In the second one you can start \b {\tt nymea-cli} to interact with the server and test your plugin. You can find the documentation for \b {\tt nymea-cli} \l{https://github.com/guh/guh/wiki/guh-cli}{here}.
\note You can open two terminal tabs. In the first one you can start \tt nymead with the \tt -n parameter to see the debug output. In the second one you can start \b {\tt nymea-cli} to interact with the server and test your plugin. You can find the documentation for \b {\tt nymea-cli} \l{https://github.com/guh/nymea/wiki/guh-cli}{here}.
\section2 nymea-cli

2
libnymea-core/webserver.cpp
View File

@ -27,7 +27,7 @@
The \l{WebServer} class provides a HTTP/1.1 web server. The web server
provides access to the nymea-webinterface and the path can be specified
in the \tt /etc/nymea/nymead.conf file and to the nymea \l{https://github.com/guh/guh/wiki/REST-Api-documentation}{REST API}.
in the \tt /etc/nymea/nymead.conf file and to the nymea \l{https://github.com/guh/nymea/wiki/REST-Api-documentation}{REST API}.
The default port for the web server is 3333, which is according to this
\l{https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers}{list}
officially free.