N.B. : FlexiO n'offre aucune assistance pour la configuration de FlexiO API sur votre propre réseau. Cette fonction est réservée aux utilisateurs techniques. FlexiO -utilisateurs.
Sur cette page, vous pouvez lire ce que les locaux API de votre part FlexiObox Ce document présente le produit et son public cible. Il détaille ensuite les points à vérifier avant de commencer, puis le tableau récapitulant les mesures, les unités, les points d'extrémité et les méthodes. Enfin, il décrit le contrôleur de charge générique : le signal de commande permettant de gérer une charge externe, comme une pompe à chaleur ou une chaudière.
Quel est le local API par FlexiO ?
Toi FlexiObox offre un local API sur votre réseau domestique. Vous souhaitez connecter vos appareils à un système domotique, créer votre propre tableau de bord énergétique ou simplement consulter les données en temps réel de votre batterie ? Voici comment procéder.
Le local API par FlexiO est une interface de lecture qui s'affiche directement sur votre FlexiObox Vous utilisez ce système. Vous en extrayez des mesures en temps réel : le niveau de charge de votre batterie, votre production solaire, les échanges d’électricité avec le réseau et le prix de l’électricité. Ces données ne transitent pas par le cloud.
À qui cela est-il destiné ?
Cette page est destinée aux aspects techniques. FlexiO - les utilisateurs qui souhaitent connecter leur système à des outils locaux : Home Assistant, Node-RED, un tableau de bord Grafana ou toute autre plateforme domotique capable d’envoyer des requêtes HTTP.
Vous n'avez pas besoin d'être développeur de logiciels, mais vous devez connaître les adresses IP. API -appels et réponses JSON.
Ce que vous pouvez en faire
Le FlexiO API vous donne trois choses :
Informations sur l'appareil : la version du firmware et le nom de votre appareil FlexiObox .
Mesures énergétiques en temps réel : valeurs en direct issues du système de contrôle intelligent, telles que la production d’énergie solaire, des batteries, du réseau et la consommation domestique. Ces données sont mises à jour en continu, directement via le cloud.
Paramètres de contrôle de charge : lecture et, dans un cas, écriture des paramètres du contrôleur de charge générique. Utile pour la gestion d’une charge externe, comme une pompe à chaleur, en fonction de l’énergie disponible ou du prix de l’électricité. Plus d’informations à ce sujet en bas de cette page, dans la section « Contrôleur de charge générique ».
Avant de commencer
-
Toi FlexiObox est allumé et connecté à votre réseau local ; - l'appareil avec lequel vous API fait appel à est sur le même réseau que le FlexiObox Vous pouvez ouvrir http: api dans un navigateur. Si la page se charge, tout est en ordre.
-
Impossible d'accéder à myio.local ? Recherchez alors l'adresse IP de FlexiObox ajoutez-le à la liste des périphériques de votre routeur et utilisez-le, par exemple http: api .
Points de terminaison disponibles
Je bereikt de API via http://myio.local/api/\<endpoint\>
Par exemple : http : api
|
Mesures |
Unité |
Description |
Point de terminaison |
Méthode |
|
courant de batterie filtré |
kW |
Courant consommé par la batterie |
/ api /ems |
OBTENIR |
|
tension de la batterie filtrée |
V |
Tension de la batterie |
/ api /ems |
OBTENIR |
|
TotalInvPowerFiltered |
kW |
Mesure de puissance filtrée de l'onduleur |
/ api /ems |
OBTENIR |
|
Chargement filtré |
kW |
Biens retirés par le ménage |
/ api /ems |
OBTENIR |
|
Compteur de puissance filtré |
kW |
Capacité totale vers ou depuis le réseau |
/ api /ems |
OBTENIR |
|
Puissance PV totale filtrée |
kW |
Capacité photovoltaïque totale générée – y compris les installations hybrides et de rénovation |
/ api /ems |
OBTENIR |
|
étatDeChargeFilté |
% |
niveau de charge de la batterie |
/ api /ems |
OBTENIR |
|
étatDeSantéFiltré |
% |
État de la batterie |
/ api /ems |
OBTENIR |
|
powerSetpoint |
kW |
consigne de puissance qui alimente l'onduleur |
/ api /ems |
OBTENIR |
|
consommationPrix de l'électricité |
€/kWh |
Prix de l'électricité utilisé pour les calculs |
/ api /ems |
OBTENIR |
|
powerSetpointGeneric |
kW |
Puissance disponible pour alimenter une charge générique |
/ api /ems/contrôle_de_charge |
OBTENIR |
|
Prix d'électricité maximum générique |
€/kWh |
Prix maximal de l'électricité auquel fonctionne le contrôle de charge générique |
/ api /ems/contrôle_de_charge |
OBTENIR/METTRE |
Bon à savoir
-
Uniquement local. API Ce service n'est pas accessible depuis l'extérieur de votre réseau domestique. Pour y accéder à distance, vous devez configurer vous-même votre routeur à l'aide d'un VPN ou d'une redirection de ports. Nous ne prenons pas en charge cette configuration et nous la déconseillons.
-
En direct, sans passé. API renvoie uniquement les valeurs actuelles. Pour l'historique, les graphiques et les tendances, utilisez la fonction appropriée. MyFlexiO App.
-
Toujours allumé. API fonctionne tant que vous FlexiObox Tout fonctionne. Vous n'avez rien à activer ni à configurer vous-même.
-
Swagger directement sur l'appareil. La version interactive complète est disponible à l' adresse http: api API -référence, avec les diagrammes des requêtes et des réponses.
Contrôleur de charge générique
Souhaitez-vous contrôler vous-même un appareil via notre API Par exemple, une pompe à chaleur ou un climatiseur ? C’est possible grâce au contrôleur de charge générique.
Pour en savoir plus, consultez : API FlexiO - Contrôleur de charge générique