Let op: FlexiO geeft geen ondersteuning bij het opzetten van de FlexiO API op je eigen netwerk. Deze functie is alleen bedoeld voor technische FlexiO-gebruikers.
Op deze pagina lees je wat de lokale API van je FlexiObox is en voor wie ze bedoeld is. Daarna volgt wat je moet nakijken voor je begint, en de tabel met alle metingen, eenheden, endpoints en methodes. Onderaan staat de Generic Load Controller: het stuursignaal waarmee je een externe last aanstuurt, bijvoorbeeld een warmtepomp of een boiler.
Wat is de lokale API van FlexiO?
Je FlexiObox biedt een lokale API aan op je thuisnetwerk. Wil je je toestellen koppelen aan een domoticasysteem, een eigen energiedashboard bouwen of gewoon live gegevens uit je batterij halen? Dan doe je dat zo.
De lokale API van FlexiO is een leesinterface die rechtstreeks op je FlexiObox draait. Je haalt er live metingen uit: hoe vol je batterij zit, je zonneproductie, het vermogen van en naar het net, en de elektriciteitsprijs. Dat gaat niet via de cloud.
-
Je vindt de API op http://myio.local/api
-
De interactieve documentatie (Swagger) zit in je toestel zelf: http://myio.local/api/docs
-
Beide adressen werken alleen wanneer je computer of telefoon op hetzelfde wifi-netwerk zit als je FlexiObox.
Voor wie is dit bedoeld?
Deze pagina is voor technische FlexiO-gebruikers die hun systeem willen koppelen aan lokale tools: Home Assistant, Node-RED, een Grafana-dashboard of elk ander domoticaplatform dat HTTP-verzoeken kan versturen.
Je hoeft geen softwareontwikkelaar te zijn, maar je moet wel weg kunnen met IP-adressen, API-calls en JSON-antwoorden.
Wat je ermee kan doen
De FlexiO API geeft je drie dingen:
Toestelinformatie: de firmwareversie en de naam van je FlexiObox.
Live energiemetingen: live waarden uit de slimme sturing, zoals zon, batterij, net en verbruik van het huishouden. Die worden continu bijgewerkt, zonder omweg via de cloud.
Parameters voor laststuring: de instellingen van de generieke laststuring uitlezen, en in één geval ook schrijven. Handig als je een externe last aanstuurt, bijvoorbeeld een warmtepomp, op basis van beschikbare energie of de elektriciteitsprijs. Hoe dat werkt, lees je onderaan deze pagina bij Generic Load Controller.
Voor je begint
-
Je FlexiObox aan staat en is met je lokale netwerk verbonden; - het toestel waarmee je de API aanspreekt op hetzelfde netwerk zit als de FlexiObox; - je http://myio.local/api/docs kan openen in een browser. Laadt die pagina, dan zit je goed.
-
Lukt het niet om myio.local te bereiken? Zoek dan het IP-adres van de FlexiObox op in de toestellenlijst van je router en gebruik dat, bijvoorbeeld http://192.168.1.xx/api.
Beschikbare endpoints
Je bereikt de API via http://myio.local/api/\<endpoint\>
Bijvoorbeeld: http://myio.local/api/ems/LoadPowerFiltered
|
Meting |
Eenheid |
Omschrijving |
Endpoint |
Methode |
|
batteryCurrentInvFiltered |
kW |
Stroom die de batterij opneemt |
/api/ems |
GET |
|
batteryVoltageInvFiltered |
V |
Spanning van de batterij |
/api/ems |
GET |
|
TotalInvPowerFiltered |
kW |
Gefilterde vermogensmeting van de omvormer |
/api/ems |
GET |
|
LoadPowerFiltered |
kW |
Vermogen dat het huishouden opneemt |
/api/ems |
GET |
|
MeterPowerFiltered |
kW |
Totaal vermogen naar of van het net |
/api/ems |
GET |
|
totalPVPowerFiltered |
kW |
Totaal opgewekt PV-vermogen – inclusief hybride en retrofit |
/api/ems |
GET |
|
stateOfChargeFiltered |
% |
Laadtoestand van de batterij |
/api/ems |
GET |
|
stateOfHealthFiltered |
% |
Gezondheidstoestand van de batterij |
/api/ems |
GET |
|
powerSetpoint |
kW |
Vermogenssetpoint dat naar de omvormer gaat |
/api/ems |
GET |
|
consumptionElectricityPrice |
€/kWh |
Elektriciteitsprijs die voor de berekeningen gebruikt wordt |
/api/ems |
GET |
|
powerSetpointGeneric |
kW |
Vermogen dat beschikbaar is om een generieke last aan te sturen |
/api/ems/load_control |
GET |
|
genericLoadMaximumElectricityPrice |
€/kWh |
Maximale elektriciteitsprijs waarbij de generieke laststuring werkt |
/api/ems/load_control |
GET/PUT |
Goed om te weten
-
Alleen lokaal. De API is niet bereikbaar van buiten je thuisnetwerk. Wil je toegang van op afstand, dan regel je dat zelf op je router, met een VPN of poortdoorschakeling. Wij ondersteunen dat niet en raden het ook niet aan.
-
Live, geen geschiedenis. De API geeft alleen de huidige waarden terug. Voor historiek, grafieken en trends gebruik je de MyFlexiO App.
-
Altijd aan. De API werkt zolang je FlexiObox draait. Je hoeft zelf niets te activeren of in te stellen.
-
Swagger op het toestel zelf. Op http://myio.local/api/docs vind je de volledige interactieve API-referentie, met de schema's van de verzoeken en de antwoorden.
Generic Load Controller
Wil je zelf een toestel aansturen via onze API zoals een warmtepomp of airco? Dan kan dat via de Generic Load Controller.
Lees hier meer: FlexiO API - Generic Load Controller