API

Das ist die Visualisierung der Werte, i.d.R. also ein Browser, in dem der Verlauf der Stromverbrauchswerte angezeigt wird. Alternativ zum Browser sind aber auch andere Frontends angedacht: eine direkte Anzeige des aktuellen Verbrauchswertes z.B. via Chumby.

Hierbei handelt es sich im Wesentlichen um einen Wrapper um die Datenbank. Sämtliche Kommunikation in Richtung Datenbank wird über die Middleware abgewickelt.

Diese definiert die Kommunikation zwischen dem Frontend und der Middleware.

Das ist jetzt leicht: die Middleware-API beschreibt die Kommunikation zwischen dem Messgerät (AVR Net-IO, Flukso, …) und der Middleware.

Hier geht's zur Referenz

• die komplette Kommunikation mit der Middleware übernehmen (Logging, Auswertung & Verwaltung)
• die Möglichkeit bieten Daten in Paketen an den Middleware-Server schicken, um die Netzwerkverbindung zu entlasten und dadurch Strom zu sparen oder Verbindungsprobleme zum Middleware-Server abfangen können
• nicht nur Pulse übertragen können, sondern auch Messwerte anderer Sensoren (Temperatur, Wind, Luftdruck etc.).
• eine eindeutige Versionierung beinhalten
• jeden Kanal eindeutig referenzieren (UCID - 'u'nique 'c'hannel 'i'd)
• Fehlfunktionen der Sensoren/Controller übermitteln können

Die gesamte Kommunikation mit der Middleware wird ausnahmslos über HTTP-Anfragen abgewickelt. Beim Entwurf der API wurde auf folgende Punkte geachtet:

HTTP-Protokoll

• wird nur selten in Netzwerken gefiltert
• kann getunnelt oder durch Proxies benutzt werden
• ermöglicht einfache Auswertung über einen Webserver mit PHP
• ist durch vorhande Bibliotheken gut nutzbar und weit verbreitet

REST-Architektur

• Adressierbarkeit
• Unterschiedliche Repräsentationen
• Zustandslosigkeit (es ist Aufgabe des Frontends eine Session zu verwalten)
• Wohldefinierte Operationen

JSON-Format

• von Menschen lesbar
• geringer Overload im Vergleich zu XML
• performante Verarbeitung der Daten mit Javascript

(nachträgliches) Auslesen von Zählerständen zum 01. des laufenden Monats

(alles auf eine Zeile schreiben)

http://IP/middleware.php/data.csv?
  uuid[]=...&
  uuid[]=...&
  group=month&
  options=raw&
  to=first%20day%20of%20this%20month%20midnight

Man kann beliebig viele `uuid[]=…` (also auch nur einen einzigen) Abschnitte angeben und erhält ein CSV zurück, in dem die Zählerstände zum 01. des Monats Mitternacht enthalten sind.