FlexiO API
De FlexiO API gebruiken
Je FlexiObox heeft een lokale verbinding die je kunt gebruiken via je thuisnetwerk. Als je graag apparaten koppelt aan een domoticasysteem, een eigen energieoverzicht wilt maken, of gewoon actuele gegevens van je batterij wilt halen, dan kan dat op deze manier.
Wat is de FlexiO API?
De FlexiO Local API is een systeem dat direct op uw FlexiObox draait. Het zorgt ervoor dat u direct toegang heeft tot actuele informatie, zoals de status van de batterij, hoeveel stroom uw zonnepanelen opwekken, de stroom die van het elektriciteitsnet komt en de prijzen van elektriciteit. Deze gegevens zijn direct beschikbaar, zonder dat ze eerst via een online opslag (de cloud) hoeven te gaan.
Voor wie is dit bedoeld?
Deze pagina is bedoeld voor FlexiO-bezitters die hun systeem willen koppelen aan andere programma's of apparaten, denk aan Home Assistant, Node-RED, een Grafana-dashboard of elk ander slimme-thuisplatform dat informatie kan uitwisselen.
Je hoeft geen softwareontwikkelaar te zijn, maar je moet wel een basisbegrip hebben van zaken als IP-adressen, hoe programma's met elkaar communiceren en hoe gegevens gestructureerd worden teruggestuurd.
LIFEPOWR biedt geen ondersteuning voor het instellen van de FlexiO API op je lokale netwerk. Deze functie is alleen voor FlexiO-eigenaren met technische kennis.
Wat je kan ermee je kan
De FlexiO API biedt drie dingen:
Apparaatgegevens: Controleer de FlexiObox en de apparaatnaam van uw FlexiObox .
Realtime energiemetingen: Bekijk actuele waarden van het systeem dat uw energie regelt, zoals zonne-energie, de batterij, het stroomnet, het verbruik in huis, en meer. Deze gegevens worden continu bijgewerkt, direct en zonder tussenkomst van de cloud.
Instellingen voor het aansturen van apparaten: Hiermee kunt u de algemene instellingen voor het aansturen van apparaten bekijken (en in één geval ook aanpassen). Dit is handig als u een extern apparaat, bijvoorbeeld een warmtepomp, wilt regelen op basis van de beschikbare energie of de stroomprijs. Meer informatie vindt u hier.
Voordat je begint
Zorg ervoor dat:
Je FlexiObox staat aan en is verbonden met je lokale netwerk.
Het apparaat dat je gebruikt om verbinding te maken, bevindt zich op hetzelfde netwerk als de FlexiObox.
Je kan http://myio.local/api/docs openen in een internetbrowser. Als deze pagina dan verschijnt, is alles in orde.
Als myio.local als dat niet lukt, zoek dan het FlexiObox IP adres op in de lijst met apparaten op je router en gebruik dat in plaats daarvan (bijv., http://192.168.1.xx/api).
Beschikbare eindpunten
Access to API via http://myio.local/api/<endpoint>
Bijvoorbeeld: api
Maat | Eenheden | Beschrijving | Eindpunt | Werkwijze |
|---|---|---|---|---|
batteryCurrentInvFiltered | kW | Verbruik van Batterij | api | GET |
batteryVoltageInvFiltered | kW | Batterij | api | GET |
totalInvPowerFiltered | kW | Gemeten vermogen van de omvormer (gefilterd) | api | GET |
LoadPowerFiltered | kW | Stroomverbruik van het huishouden | api | GET |
MeterPowerFiltered | kW | Totaal vermogen dat aan het net wordt geleverd/uit het net wordt afgenomen | api | GET |
totaalPVPowerFiltered | kW | Totaal opgewekt PV-vermogen – van alle aanwezige zonneproductie | api | GET |
stateOfChargeFiltered | % | Batterij state of charge | api | GET |
stateOfHealthFiltered | % | Batterij state of health | api | GET |
powetSetpoint | kW | Vermogensinstelwaarde die naar de omvormer moet worden gestuurd | api | GET |
consumptionElectrictyPrice | €/kWh | De huidige elektriciteitsprijs die voor de berekeningen wordt gebruikt | api | GET |
powerSetpointGeneric | kW | Beschikbaar vermogen voor het aansturen van een Generic Load Controller | api | GET |
genericLoadMaximumElectricityPrice | €/kWh | Maximale elektriciteitsprijs voor het aansturen van een Generic Load Controller | api | GET/PUT |
Goed om te weten
Alleen binnen je eigen netwerk. Je kunt dit systeem niet bereiken als je niet thuis bent. Als je het toch op afstand wilt gebruiken, moet je dit zelf instellen op je eigen internetrouter (denk aan een VPN of het openzetten van poorten). Wij ondersteunen of adviseren dit echter niet officieel.
U ziet de informatie direct, niet achteraf. Dit betekent dat u alleen de meest actuele gegevens te zien krijgt. Voor oudere gegevens, overzichten en ontwikkelingen kunt u de FlexiO app gebruiken.
Altijd beschikbaar. De API is beschikbaar zolang uw FlexiObox werkt — er is geen activering of configuratie van uw kant nodig.
Informatie over de technische werking op het apparaat. Bezoek http://myio.local/api/docs voor de volledige interactieve handleiding, inclusief voorbeelden van hoe je gegevens kunt versturen en ontvangen.