Documentatie
Alles over BoilerBuddy
Lees hoe je de BoilerBuddy Alpo aansluit en wat je in het portaal ziet. Installateurs lezen hier hoe ze met klanten en monteurs werken, ontwikkelaars hoe ze hun eigen hardware koppelen.
- Voor thuisDe Alpo aansluiten en koppelen, je installatie instellen, en zien wat je zonneboiler doet: grafieken, meldingen en besparing.Aan de slag
- Voor installateursJe bedrijf aanmelden, werken met monteurs en klanten, klanten laten meekijken en wat het kost.Lees verder
- Voor ontwikkelaarsJe eigen hardware koppelen via de API, met voorbeelden in curl, Python en voor de ESP32.Naar de API
Aan de slag
- Aan de slagWat je nodig hebt en welke stappen je zet, van account tot de eerste metingen in je portaal.
- De Alpo aansluitenDe BoilerBuddy Alpo aansluiten op je regelaar, je router en de stroom, en controleren of hij werkt.
- Koppelen met een codeDe BoilerBuddy Alpo met zijn koppelcode aan je account koppelen, en een nieuwe Alpo aan een bestaand apparaat.
- Regelkring en installatiegegevensVertel BoilerBuddy hoe je installatie eruitziet, met de regelkring van je regelaar en de gegevens voor je besparing.
Het portaal
- Dashboard en grafiekenWat je op het dashboard ziet, van de waarden van nu tot grafieken over elke periode, en hoe je het leest.
- MeldingenWelke meldingen BoilerBuddy stuurt, wat ze betekenen en wat je dan controleert.
- BesparingWat de zon je oplevert aan warmte, gas, geld en CO₂, en hoe we dat schatten.
- Delen en locatiesIemand laten meekijken met je apparaat, je apparaten indelen per plek, en een apparaat overdragen als je verhuist.
- AbonnementWat BoilerBuddy kost, hoe de proefperiode werkt, hoe je betaalt en opzegt, en wat er gebeurt als je niet betaalt.
Voor installateurs
- Installateur wordenMeld je bedrijf aan als installateur. Welke gegevens we vragen, en wat er gebeurt voor en na de goedkeuring.
- Organisatie en monteursJe bedrijf is eigenaar van de apparaten. Wie wat mag, collega's uitnodigen, wisselen tussen je eigen account en de installateur, en meldingen per lid.
- Al je apparaten in één overzichtZie in één oogopslag hoe alle installaties van je klanten het doen, welke aandacht nodig hebben, en zoek snel het juiste apparaat.
- Klanten en locatiesZet de apparaten van een klant bij elkaar, en houd bij in welke vestiging en waar in het gebouw elk apparaat hangt.
- Klanten laten meekijkenLaat een klant meekijken met zijn apparaten, ook als hij nog geen account heeft. Wat hij ziet, meldingen, en meekijken stoppen.
- Overdragen aan de klantLaat de klant zelf betalen: draag zijn apparaten over. Hij wordt eigenaar, jullie blijven ze beheren.
- Kosten en abonnementWat BoilerBuddy een installateur kost, de proefperiode, betalen, en wat er gebeurt als er niet betaald wordt.
- Vermelding in de installateursindexLaat mensen je vinden in de installateursindex: je profiel, werkgebied, diensten en certificeringen, betalen per jaar, en de aanvragen die binnenkomen.
API
- API-overzichtWat je met de apparaat-API kunt, de vier endpoints, de volgorde waarin een apparaat ze gebruikt en de afspraken over tokens, JSON en tijden.
- Koppelen via helloHoe een apparaat zonder token met POST /device/hello en een koppelcode zelf aan zijn token komt, en wanneer een sleutel uit het portaal handiger is.
- Metingen insturenMetingen in batches tot 1000 insturen, het antwoord lezen, wat je met elke afwijzing doet en wat er met onbekende sensorcodes gebeurt.
- Configuratie ophalenWat GET /device/config teruggeeft, hoe je goedkoop pollt met ETag en 304, en hoe een apparaat de regelaar uitleest.
- Bufferen en de klokMetingen lokaal bewaren en op volgorde versturen, inhalen na een storing binnen de limieten, en metingen van voor de kloksynchronisatie laten corrigeren.
- Limieten en foutcodesDe limieten per token, per IP-adres en per uuid, wat elke statuscode betekent en wat je doet, hoe het portaal offline bepaalt, en gesimuleerde apparaten.
- API-referentieAlle endpoints, velden en antwoorden van de API voor apparaten, rechtstreeks uit het contract (OpenAPI 3.1).
Voorbeelden
- Je eigen BoilerBuddy bouwenMet eigen hardware metingen naar het portaal sturen: apparaat aanmaken, regelkring kiezen, token instellen, en wat nu nog niet kan.
- Voorbeeld: curlElk endpoint van de apparaat-API uitproberen met curl, met echte verzoeken en antwoorden, en de configuratie alleen ophalen als hij veranderd is.
- Voorbeeld: PythonEen kleine, complete client in Python 3 voor je eigen hardware, die koppelt, de configuratie bijhoudt, metingen buffert in SQLite en ze op volgorde instuurt.
- Voorbeeld: ESP32Een Arduino-sketch voor de ESP32 die DS18B20-sensoren leest en elke minuut een batch naar BoilerBuddy stuurt, met uitleg over TLS, de klok en de buffer.