Intégration domotique IPX800, gratuite et open source
GCE IPX800 V4 et V5 sur votre réseau : relais, entrées, fil pilote (X-4FP), capteurs X-THL.
Publiée par LM1LC3N7
- Appareils
- Version 0.1.1
- Nécessite Gladys >=5.1.0
- ★ 0
Amène dans Gladys un IPX800 V4 ou V5 de GCE Electronics par son API HTTP locale : ses relais, ses entrées, les zones de fil pilote de ses extensions X-4FP et ses capteurs X-THL (température, humidité, luminosité).
Jamais testé avec un vrai appareil : écrit d’après la documentation GCE de l’API V4 et les bibliothèques libres des intégrations Home Assistant (pypx800, pypx800v5). Dites-nous ce que vous voyez sur le vôtre. Sans lien avec GCE Electronics.
Installation
- Dans l’IPX800, créez une clé d’API : V5 dans Système > API, V4 dans Réseau > API (cochez l’accès API).
- Dans Gladys, Intégrations > IPX800 : choisissez le modèle (V5 ou V4),
saisissez l’adresse de l’IPX800 (par ex.
192.168.1.50, donnez-lui une adresse fixe dans votre box) et la clé d’API, puis enregistrez. - « Tester la connexion » lit l’IPX800 tout de suite (une fois un intervalle passé depuis la dernière lecture) et montre ce qu’il a trouvé.
- Dans Découverte, créez les appareils voulus.
L’IPX800 veut la clé d’API dans l’adresse de chaque requête, en http simple : qui peut écouter votre réseau local peut la lire, comme avec les applis de l’IPX800. La clé est gardée par Gladys dans sa base, jamais réaffichée, envoyée seulement à l’IPX800, et jamais écrite dans les journaux ni dans les fichiers de l’intégration.
Ce que vous obtenez
| Sur l’IPX800 | Dans Gladys | Code (dans le nom) |
|---|---|---|
| Relais (V4 1-56, V5 1-8) | lecture seule, ou interrupteur / lumière si vous le listez | R3 |
| Sortie d’un X-8R (V5) | idem | X8R12-3 (12 : son id) |
| Entrée (V4 1-56, V5 1-8) | une entrée binaire (lecture seule) | D3 |
| Entrée d’un X-8D / X-24D (V5) | idem | X8D5-2, X24D6-10 |
| Zone d’un X-4FP | fil pilote (Arrêt, Hors-gel, Éco, Confort, Confort -1, Confort -2) | FP5 (V4), X4FP7-2 (V5) |
| X-THL | température (°C), humidité (%), luminosité (lux) | THL1 (V4), XTHL9 (V5) |
V5 : l’intégration liste elle-même les extensions. V4 : l’API répond
56 relais et 56 entrées, câblés ou non ; l’intégration montre les 8 relais et
8 entrées de l’IPX, et ce que vous listez dans « Extensions d’un IPX800 V4 »,
par ex. R9-R16, D9-D16, FP1-FP4, THL1 (la zone n de fil pilote de la V4 est
la zone z du X-4FP e : n = 4 × (e − 1) + z).
L’IPX800 est lu toutes les 10 secondes par défaut (5 s au moins). Une valeur que l’IPX800 ne donne pas (absente, un texte, hors plage) n’est pas publiée : jamais comme 0.
Relais : en lecture seule sauf ceux que vous listez
Tous les relais sont en lecture seule par défaut. Pour en piloter un
depuis Gladys, listez-le dans « Relais pilotables par Gladys », par ex.
R1, R3:light, X8R12-2 (:light en fait une lumière, sinon un
interrupteur). Un interrupteur ou une lumière obéit à tout « éteins tout » de
Google, Alexa, du MCP et des scènes : n’y mettez jamais une pompe, un
congélateur, une VMC, un chauffage, une gâche ni une vanne. Un relais retiré
de la liste repasse aussitôt en lecture seule : ses commandes sont refusées,
et une extinction que l’intégration tenait encore pour lui est abandonnée (en
mémoire et dans /data, au redémarrage aussi). Son ancienne fonctionnalité
reste dans Gladys : supprimez-la si vous voulez.
Fil pilote
- Arrêt et Hors-gel n’ont besoin d’aucune option et passent avant
tout le reste : pendant une pause après des lectures en échec, avec une clé
d’API refusée, avec la file de commandes pleine, et avant la première
lecture après un redémarrage (les identifiants V5 sont gardés dans
/data). Cliqués, ils interrompent toute requête en cours (une lecture, une relecture, une commande, un renvoi), sauf un autre Arrêt ou Hors-gel cliqué juste avant. De même pour l’extinction d’un relais que vous avez listé. - Éco, Confort, Confort -1, Confort -2 pilotent le chauffage : ils sont
désactivés par défaut. Cochez « Autoriser Éco et Confort depuis Gladys »
pour les permettre ; tout utilisateur de Gladys, toute scène et
l’application Gladys peuvent alors les choisir. Ils sont refusés tant que
l’état ne peut pas être écrit dans
/data.
Un Arrêt ou un Hors-gel n’est refusé que si : l’adresse ou la clé d’API
manque ; la zone n’est pas connue (V4 : absente des extensions ; V5 : jamais
lue, même avant un redémarrage) ; la valeur n’est pas l’un des six modes.
L’extinction d’un relais est refusée si le relais n’est pas listé. Cliqué
avant que la configuration soit lue dans Gladys (la clé d’API n’est gardée
que là, jamais dans /data), il la demande aussitôt à Gladys et attend 3 s ;
si elle n’est pas venue, il est gardé en mémoire et envoyé dès que la clé
d’API est connue (relue 5 s après, puis toutes les minutes au plus), avant
tout envoi vers Gladys ; si la sortie s’avère inconnue ou non listée, l’état
le dit. Un Arrêt gardé dans /data part de même au démarrage, sans attendre
Gladys. Quand l’IPX800 ne le prend pas en 3,5 s (pas de connexion), il est
gardé et renvoyé dès que l’IPX800 est libre, avant les relectures, par les
lectures suivantes qui montrent un autre mode, et après un redémarrage. Un
Arrêt cliqué pendant qu’un autre reste sans réponse depuis 1 s
l’interrompt. Un renvoi interrompu par un clic avant d’être parti repart
juste derrière ce clic.
Un Arrêt ou Hors-gel que les lectures ne montrent pas est renvoyé, 3 fois au plus ; puis l’état le dit (vérifiez sur place). Une zone V5 avec plusieurs modes actifs est signalée comme telle dans l’état et reçoit l’Arrêt à nouveau. Il reste tenu jusqu’à ce qu’une commande plus récente sur cette zone parte (votre clic), un autre Arrêt / Hors-gel, ou, une fois appliqué, un autre mode lu deux fois de suite (changé sur l’IPX800 lui-même, par ses scénarios ou sa page) : jamais par le temps. Ce qui a été demandé avant un Arrêt sur la même zone et pas encore envoyé est annulé, y compris un Hors-gel qui attend un nouvel essai : rien ne part après lui. Un mode envoyé par l’intégration avant l’Arrêt et resté sans réponse (coupé par l’Arrêt, par exemple), si l’IPX800 l’applique quand même dans les 5 s après son départ, n’est pas un changement sur l’IPX800 : l’Arrêt est renvoyé.
Commandes
Une commande est écrite dans les 3,5 s du clic ou refusée avec « rien n’a été envoyé ». Elle est ensuite relue sur l’IPX800 : la valeur demandée est un succès ; une autre valeur est « pas encore appliquée » ; pas de réponse à temps donne « envoyée, sans confirmation ». Deux lectures suivent, 5 s et 20 s après. Les commandes d’une scène sont écrites l’une après l’autre, puis relues une fois.
Pauses et refus
Une lecture en échec met en pause 10 s, 30 s, 1 min, 2 min puis 5 min (une minute au moins quand l’IPX800 répond 429 ou 503), pause gardée au redémarrage ; Éco, Confort et l’allumage d’un relais sont refusés jusqu’à la fin de la pause. Une clé d’API refusée par l’IPX800 (401, 403) arrête les lectures jusqu’à ce que vous changiez la clé ou que « Tester la connexion » aboutisse.
Limites
- X-8R, X-8D, X-24D, X-4FP et X-THL seulement ; compteurs, volets X-4VR, variateurs, X-PWM, entrées et sorties virtuelles ne sont pas dans cette version.
- Un IPX800 par intégration.
- http seulement (l’IPX800 répond en http sur le réseau local).
Paramètres de configuration
Voici les paramètres demandés par IPX800 dans son écran de configuration dans Gladys.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| Votre IPX800 | section | Non | Amène dans Gladys un IPX800 V4 ou V5 de GCE Electronics par son API HTTP locale et sa clé d’API : relais (en lecture seule sauf ceux listés ci-dessous), entrées, zones de fil pilote des X-4FP et capteurs X-THL. Fil pilote : Arrêt et Hors-gel passent en premier, sans option (limites dans le guide) ; Éco et Confort seulement une fois autorisés ci-dessous. Jamais testé avec un vrai appareil. Sans lien avec GCE Electronics. |
| Modèle | select | Non | |
| Adresse de l’IPX800 | string | Oui | Son adresse IP (ou son nom) sur votre réseau, sans chemin ni clé ; donnez-lui une adresse fixe dans votre box. |
| Port | number | Non | 80 sauf si vous avez changé le port de son serveur web. |
| Clé d’API | secret | Oui | Créée dans l’IPX800 (V5 : Système > API, V4 : Réseau > API). L’IPX800 la veut dans l’adresse de chaque requête, en http simple : qui peut écouter votre réseau peut la lire, comme avec les applis de l’IPX800. Gardée par Gladys dans sa base, jamais réaffichée, envoyée seulement à l’IPX800, jamais écrite dans les journaux. |
| Relais pilotables par Gladys | string | Non | Les autres relais sont en lecture seule. Codes comme dans les noms des appareils : R1 à R8 (V4 : jusqu’à R56), X8R<id>-<n> pour un X-8R de la V5 ; ajoutez :light pour une lumière, par ex. « R1, R3:light, X8R12-2 ». Un relais listé ici obéit à tout « éteins tout » de Google, Alexa, du MCP et des scènes : n’y mettez jamais une pompe, un congélateur, une VMC, un chauffage, une gâche ni une vanne. |
| Extensions d’un IPX800 V4 | string | Non | V4 seulement (la V5 liste elle-même ses extensions) : ce que votre IPX800 V4 a en plus de ses 8 relais et 8 entrées, par ex. « R9-R16, D9-D16, FP1-FP4, THL1 » (FP : zones de fil pilote 1 à 16, quatre par X-4FP). |
| Fil pilote | section | Non | Arrêt et Hors-gel n’ont besoin d’aucune option et passent avant tout le reste, pendant une pause ou avant la première lecture ; ils ne sont refusés que si l’IPX800 ou la zone n’est pas encore connu (voir le guide). Éco, Confort, Confort -1 et Confort -2 pilotent le chauffage : ils sont désactivés par défaut. Une fois autorisés, tout utilisateur de Gladys, toute scène et l’application Gladys peuvent les choisir. |
| Autoriser Éco et Confort depuis Gladys | boolean | Non | |
| Lecture toutes les (secondes) | number | Non | Fréquence de lecture de l’IPX800 : 10 s par défaut, 5 s au moins. |
| Langue des noms | select | Non | Sert aux noms des appareils et fonctionnalités ajoutés désormais. |
Comment installer IPX800 dans Gladys
- Dans Gladys, ouvrez Intégrations : IPX800 apparaît dans le catalogue, aux côtés des intégrations natives, avec un badge communautaire.
- Cliquez sur Installer. Gladys télécharge l'image Docker (
ghcr.io/lm1lc3n7/gladys-ipx800:0.1.1), la démarre dans un bac à sable isolé du cœur, et génère l'interface de l'intégration (appareils, découverte et configuration). - Ouvrez l'écran Configuration de l'intégration, remplissez les paramètres, puis enregistrez.
- Vous pouvez aussi l'installer directement depuis l'URL de son dépôt : https://github.com/LM1LC3N7/gladys-ipx800.
IPX800 nécessite Gladys >=5.1.0. Le catalogue dans Gladys se rafraîchit toutes les heures : une nouvelle version est donc disponible au plus tard une heure après sa sortie.
Vous n'utilisez pas encore Gladys ? C'est gratuit et open source : suivez le guide d'installation pour démarrer.
À propos des intégrations externes
IPX800 est une intégration externe : une intégration communautaire empaquetée dans un conteneur Docker et publiée sur GitHub, que Gladys installe en un clic et exécute dans un bac à sable isolé de son cœur. Elle est publiée et maintenue par LM1LC3N7, et non par l'équipe cœur de Gladys.
- Parcourir toutes les intégrations, natives et communautaires
- Créer et publier votre propre intégration externe
- Code source sur GitHub — source de cette documentation