Dokumentation
Alles über BoilerBuddy
Lies, wie du die BoilerBuddy Alpo anschließt und was du im Portal siehst. Installateure finden hier, wie sie mit Kunden und Technikern arbeiten, Entwickler, wie sie eigene Hardware anbinden.
- Für ZuhauseDie Alpo anschließen und koppeln, deine Anlage einrichten und sehen, was deine Solaranlage tut: Diagramme, Meldungen und Ersparnis.Loslegen
- Für InstallateureDeinen Betrieb anmelden, mit Technikern und Kunden arbeiten, Kunden Zugriff geben, und was es kostet.Weiterlesen
- Für EntwicklerEigene Hardware über die API anbinden, mit Beispielen in curl, Python und für den ESP32.Zur API
Erste Schritte
- Erste SchritteWas du brauchst und welche Schritte du gehst, vom Konto bis zu den ersten Messwerten in deinem Portal.
- Die Alpo anschließenDie BoilerBuddy Alpo an deinen Regler, deinen Router und den Strom anschließen und prüfen, ob sie funktioniert.
- Mit einem Code koppelnDie BoilerBuddy Alpo mit ihrem Kopplungscode mit deinem Konto verbinden, und eine neue Alpo mit einem bestehenden Gerät.
- Regelkreis und AnlagendatenSag BoilerBuddy, wie deine Anlage aussieht, mit dem Regelkreis deines Reglers und den Daten für deine Ersparnis.
Das Portal
- Dashboard und DiagrammeWas du im Dashboard siehst, von den aktuellen Werten bis zu Diagrammen über jeden Zeitraum, und wie du es liest.
- MeldungenWelche Meldungen BoilerBuddy sendet, was sie bedeuten und was du prüfen kannst.
- ErsparnisWas dir die Sonne an Wärme, Gas, Geld und CO₂ bringt, und wie wir das schätzen.
- Teilen und StandorteJemandem Zugriff auf dein Gerät geben, deine Geräte nach Ort ordnen und ein Gerät bei einem Umzug übergeben.
- AbonnementWas BoilerBuddy kostet, wie die Testphase funktioniert, wie du bezahlst und kündigst, und was passiert, wenn du nicht bezahlst.
Für Installateure
- Installateur werdenMelde deinen Betrieb als Installateur an. Welche Angaben wir brauchen und was vor und nach der Freigabe passiert.
- Organisation und TechnikerDein Betrieb ist Eigentümer der Geräte. Wer was darf, Kollegen einladen, zwischen deinem eigenen Konto und dem Installateur wechseln und Meldungen pro Mitglied.
- Alle deine Geräte auf einen BlickSieh auf einen Blick, wie es den Anlagen all deiner Kunden geht, welche Aufmerksamkeit brauchen, und finde schnell das richtige Gerät.
- Kunden und StandorteHalte die Geräte eines Kunden zusammen und behalte im Blick, an welchem Standort jedes Gerät steht und wo im Gebäude.
- Zugriff für KundenGib einem Kunden Zugriff auf seine Geräte, auch wenn er noch kein Konto hat. Was er sieht, Meldungen und Zugriff beenden.
- An den Kunden übergebenLass den Kunden selbst bezahlen: Übergib ihm seine Geräte. Er wird Eigentümer, und du verwaltest sie weiter.
- Abrechnung und AbonnementWas BoilerBuddy einen Installateur kostet, die Testphase, das Bezahlen und was passiert, wenn eine Zahlung nicht ankommt.
- Eintrag im InstallateurverzeichnisLass dich im Installateurverzeichnis finden: dein Profil, Arbeitsgebiet, Leistungen und Zertifizierungen, jährliche Zahlung und die eingehenden Anfragen.
API
- API-ÜberblickWas du mit der Geräte-API machen kannst, ihre vier Endpunkte, in welcher Reihenfolge ein Gerät sie nutzt, und die Regeln für Token, JSON und Zeitstempel.
- Koppeln mit helloWie ein Gerät ohne Token sich über POST /device/hello und einen Kopplungscode selbst einen besorgt, und wann ein Schlüssel aus dem Portal einfacher ist.
- Messwerte sendenMesswerte in Stapeln von bis zu 1000 hochladen, die Antwort lesen, was bei jeder Ablehnung zu tun ist und was mit unbekannten Sensorcodes passiert.
- Die Konfiguration abrufenWas GET /device/config liefert, wie du mit ETag und 304 sparsam abfragst und wie ein Gerät den Regler ausliest.
- Puffern und die UhrMesswerte lokal behalten und der Reihe nach senden, nach einem Ausfall innerhalb der Limits aufholen und Messwerte von vor der Uhrsynchronisierung korrigieren lassen.
- Limits und FehlercodesDie Limits pro Token, pro IP-Adresse und pro UUID, was jeder Statuscode bedeutet und was zu tun ist, wann das Portal ein Gerät als offline zeigt, und simulierte Geräte.
- API-ReferenzAlle Endpunkte, Felder und Antworten der API für Geräte, direkt aus dem Vertrag (OpenAPI 3.1).
Beispiele
- Dein eigenes BoilerBuddy bauenMesswerte von deiner eigenen Hardware an das Portal senden: Gerät anlegen, Regelkreis wählen, Token einrichten, und was noch nicht geht.
- Beispiel: curlJeden Endpunkt der API für Geräte mit curl ausprobieren, mit echten Anfragen und Antworten, und die Konfiguration nur abrufen, wenn sie sich geändert hat.
- Beispiel: PythonEin kleiner, vollständiger Python-3-Client für deine eigene Hardware, der sich koppelt, die Konfiguration aktuell hält, Messwerte in SQLite puffert und sie der Reihe nach hochlädt.
- Beispiel: ESP32Ein Arduino-Sketch für den ESP32, der DS18B20-Sensoren ausliest und jede Minute einen Batch an BoilerBuddy hochlädt, mit Hinweisen zu TLS, der Uhr und dem Puffer.