From 42fb3112d4aaf5abb3fcd818517c25cfab0a900f Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Mon, 7 Mar 2011 02:35:36 +0100 Subject: [PATCH] updated manual --- misc/docs/manual.lyx | 126 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 119 insertions(+), 7 deletions(-) diff --git a/misc/docs/manual.lyx b/misc/docs/manual.lyx index af0c6e3..046a3ed 100644 --- a/misc/docs/manual.lyx +++ b/misc/docs/manual.lyx @@ -834,8 +834,8 @@ Alle Anfragen an das Backend müssen einem bestimmten Schema entsprechen. \begin_layout Standard \family typewriter -http://server:port/path/to/volkszaehler/backend.php/kontext/uuid.format?paramters= -values +http://://backend[.php]/[/].?= \end_layout \begin_layout Subsubsection @@ -844,20 +844,62 @@ Kontext (Controller) \begin_layout Standard Das Backend hat verschiedene Aufgaben zu bewältigen. - Für jede dieser Aufgaben gibt es einen eigenen Kontext, der praktisch die - ganze Logik enthällt: + Für jede dieser Aufgaben gibt es einen eigenen Kontext +\begin_inset Foot +status open + +\begin_layout Plain Layout +Eigentlich handelt es sich hier um die Controller des MVC-Konzeptes. + Wir nennen sie nur Kontext um eine Verwechslung mit den Hardware-Controllern + zu vermeiden. +\end_layout + +\end_inset + +. + Diese Kontexte enthalten die Logik des Backends: \end_layout \begin_layout Itemize -Daten erfassen/ausgeben + +\family typewriter +DataController +\family default +: Daten verarbeiten \end_layout \begin_layout Itemize -Entities erstellen/bearbeiten/abfragen + +\family typewriter +EntityController +\family default +: Entities verwalten +\end_layout + +\begin_deeper +\begin_layout Itemize + +\family typewriter +ChannelController +\family default +: für Sensoren und Zähler \end_layout \begin_layout Itemize -Eigenschaften des Backends abfragen + +\family typewriter +AggregatorController +\family default +: für Gruppen/User/Gebäude etc. +\end_layout + +\end_deeper +\begin_layout Itemize + +\family typewriter +CapabilitiesController +\family default +: Eigenschaften/Fähigkeiten des Backends abfragen \end_layout \begin_layout Subsubsection @@ -932,5 +974,75 @@ Dabei ist JSON das bevorzugte Format, das auch von dem Webinterface genutzt wie das JSON Format besitzen. \end_layout +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + +{ +\end_layout + +\begin_layout Plain Layout + + "version": "0.2.git-b449d4b8", +\end_layout + +\begin_layout Plain Layout + + "data": { +\end_layout + +\begin_layout Plain Layout + + "uuid": "a301d8d0-903b-1234-94bb-d943d061b6a8", +\end_layout + +\begin_layout Plain Layout + + "min": [1287971672430, 8.0965, 44], +\end_layout + +\begin_layout Plain Layout + + "max": [1288266637795, 3017.14286, 44], +\end_layout + +\begin_layout Plain Layout + + "average": 14.47368, +\end_layout + +\begin_layout Plain Layout + + "consumption": 10.45, +\end_layout + +\begin_layout Plain Layout + + "count": 476, +\end_layout + +\begin_layout Plain Layout + + "tuples": [ ] +\end_layout + +\begin_layout Plain Layout + + }, +\end_layout + +\begin_layout Plain Layout + + "debug": +\end_layout + +\end_inset + + +\end_layout + \end_body \end_document