nymea/doc/guh.qdoc

55 lines
1.7 KiB
Plaintext

/*!
\page index.html
\section1 Overview
The guh daemon consists of three main modules:
\list
\li \l{guhserver}{The guh server}
\list
\li \l{guhserver}{The guh server namespace}
\li \l{Server classes}{The server classes}
\li \l{Rules}{The Rule Engine}
\endlist
\li \l{libguh}{The guh library}
\list
\li \l{Types of libguh}{Types used in the guh system}
\li \l{Device Plugins}{The Device Plugin API}
\li \l{Hardware Resources}{Hardware resources available for plugins}
\li \l{Type Utils}{Global types in guh}
\endlist
\li \l{Plugins}{The guh plugins}
\list
\li \l{RF 433 MHz Plugins}
\li \l{Service Plugins}
\li \l{Network Plugins}
\li \l{Bluetooth Plugins}
\endlist
\endlist
\section1 Write your own plugin
Here you can find some tutorials for developing and working with guh:
\list
\li \l{Set up the build environment}
\li \l{Getting started}
\li \l{The plugin JSON File}
\li \l{Tutorials}
\list
\li \l{Tutorial 1 - The "Minimal" plugin}
\li \l{Tutorial 2 - The "Buttons" plugin}
\li \l{Tutorial 3 - The "Power Button" device}
\li \l{Tutorial 4 - The alternative "Power Button"}
\li \l{Tutorial 5 - The "Network Info" plugin}
\endlist
\endlist
\section1 Quicklinks
Overview of all classes and modules in guh
\list
\li \l{All guh Classes}
\li \l{All guh Modules}
\endlist
*/