Intégration domotique Homebox, gratuite et open source
Votre inventaire Homebox : objets, valeur totale, garanties qui expirent, entretiens à faire.
Publiée par guim31
- Appareils
- Version 1.0.0
- Nécessite Gladys >=5.1.0
- ★ 0
Suivez l'inventaire de votre maison dans Gladys grâce à Homebox, le logiciel d'inventaire et de rangement auto-hébergé : combien d'objets vous possédez, ce qu'ils valent, les garanties qui expirent bientôt et les entretiens à faire. Tout reste sur votre réseau local : Gladys parle directement à Homebox, et se contente de le lire.
Testée contre de vrais serveurs Homebox, 0.26.2 et 0.21.0 (l'image Docker officielle). Vos retours sont les bienvenus sur le forum Gladys.
Prérequis
- Gladys Assistant 5.1 ou plus récent.
- Un serveur Homebox joignable depuis la machine Gladys, sur le port 7745 par défaut, ou derrière un proxy inverse.
- Avec Homebox 0.26 ou plus récent : une clé d'API (Homebox → votre profil → Clés d'API). Avec un Homebox plus ancien : l'e-mail et le mot de passe d'un utilisateur Homebox. L'intégration voit l'inventaire (le « groupe ») de cet utilisateur.
Configuration
- Ouvrez l'onglet Configuration de l'intégration.
- Dans Adresse de Homebox, saisissez l'adresse IP du serveur, par exemple
192.168.1.50: l'intégration utilise alors le port 7745. Ajoutez un port si le vôtre diffère (192.168.1.50:3100). Derrière un proxy inverse, saisissez l'adresse complète (https://example.org/homebox). - Collez une clé d'API, ou remplissez E-mail et Mot de passe. La clé d'API l'emporte si les deux sont remplis.
- Garantie expirant sous (jours) : une garantie compte comme bientôt expirée ce nombre de jours avant sa fin (30 par défaut).
- Entretien à venir sous (jours) : jusqu'où un entretien planifié compte comme à venir (7 par défaut).
- Un appareil par emplacement (désactivé par défaut) ajoute un appareil pour chaque emplacement principal de Homebox.
- Lire Homebox toutes les : 5, 15 (par défaut), 30 ou 60 minutes.
- Langue des noms et messages fixe les noms des fonctionnalités (figés à l'ajout de l'appareil), les textes et les dates des variables de scène. Français par défaut.
- Enregistrez, puis utilisez Tester la connexion : elle affiche la version de Homebox et le nombre d'objets et d'emplacements.
- Dans l'onglet Découverte, ajoutez les appareils à suivre.
Appareils
Homebox (un appareil pour votre inventaire) :
| Fonctionnalité | Valeur |
|---|---|
| Objets | nombre d'objets, hors objets archivés |
| Emplacements | nombre d'emplacements |
| Valeur totale | prix d'achat × quantité de chaque objet, dans la monnaie du groupe |
| Garanties bientôt expirées | objets dont la garantie se termine dans la fenêtre réglée |
| Entretiens en retard | entretiens planifiés dont la date est passée |
| Entretiens à venir | entretiens planifiés dans la fenêtre réglée |
| Prochain entretien | nom, objet et date du prochain entretien, ou « Aucun » |
| Prochaine fin de garantie | objet et date de la prochaine garantie qui expire, ou « Aucun » |
Gladys a une unité pour l'euro, le dollar et la livre sterling ; une autre monnaie apparaît dans le nom de la fonctionnalité, par exemple « Valeur totale (CHF) ». Les garanties à vie ne finissent jamais ; les garanties déjà terminées ne sont pas comptées.
Un emplacement (option) : Objets (nombre d'objets rangés là, sous-emplacements compris) et Valeur. Seuls les emplacements principaux ont un appareil.
Widget de tableau de bord
Inventaire de la maison : quatre tuiles (objets, valeur, garanties, entretiens à faire) et la liste de ce qui arrive, au plus tôt d'abord : entretiens en retard (en rouge), entretiens à venir, garanties qui expirent. Lecture seule.
Déclencheurs de scène
- Garantie bientôt expirée : la garantie d'un objet entre dans la fenêtre réglée. Une fois par objet et date de fin. Variables : objet, emplacement, date de fin, jours restants.
- Entretien à faire : un entretien planifié atteint sa date sans être terminé. Une fois par entretien. Variables : entretien, objet, date prévue, jours de retard.
La première lecture après l'installation est silencieuse : ce qui est déjà en attente est affiché sur l'appareil, pas annoncé. Les déclencheurs partent à la première lecture qui suit le changement (après minuit, dans l'intervalle réglé).
Actions de scène
Chercher un objet dans Homebox : donnez un nom (Piles AA) ; l'action lit
Homebox et renvoie Trouvé, Objets correspondants, Objet,
Emplacement (le chemin complet, Garage / Étagère) et Quantité. Le nom
exact l'emporte, puis les noms qui le contiennent ; les objets archivés sont
ignorés.
Exemples de scènes
- Rappel d'entretien : déclencheur « Entretien à faire » → envoyer un message « C'est l'heure de {{triggerEvent.data.maintenance}} sur {{triggerEvent.data.item}} ».
- Garantie : déclencheur « Garantie bientôt expirée » → message « La garantie de {{triggerEvent.data.item}} se termine le {{triggerEvent.data.expires}} ».
- Vérifier un stock : chaque dimanche à 10 h → « Chercher un objet dans
Homebox » (
Piles AA) → continuer seulement si la quantité est inférieure à 4 → message « Plus beaucoup de piles AA (rangées dans …) ».
Dépannage
- « Accès refusé » : vérifiez la clé d'API (elle a pu expirer, ou être supprimée dans Homebox), ou l'e-mail et le mot de passe. Les clés d'API n'existent qu'à partir de Homebox 0.26 : sur une version plus ancienne, utilisez l'e-mail et le mot de passe.
- « Homebox ne répond pas » : vérifiez l'adresse et le port depuis la
machine Gladys. Le conteneur est sur un réseau en pont :
localhostdésigne le conteneur lui-même, saisissez plutôt l'adresse IP du serveur. - « Cette adresse ne répond pas comme Homebox » : une page de connexion de proxy répond à la place de Homebox. Saisissez l'adresse de Homebox lui-même, ou laissez passer la machine Gladys.
- Pour plus de détails dans les journaux de l'intégration, réglez
LOG_LEVEL=debug.
Limites
- Lecture seule : l'intégration ne modifie jamais votre inventaire.
- Chaque lecture fait environ cinq requêtes (dont l'export CSV de tout l'inventaire) : gardez un intervalle long sur un très gros inventaire.
- Un seul groupe Homebox, celui de la clé d'API ou de l'utilisateur.
- Sans lien avec le projet Homebox.
Paramètres de configuration
Voici les paramètres demandés par Homebox dans son écran de configuration dans Gladys.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| Connecter Homebox | section | Non | Saisissez l'adresse de votre serveur Homebox (port 7745 par défaut). Avec Homebox 0.26 ou plus récent, créez une clé d'API dans votre profil Homebox et collez-la ci-dessous. Avec un Homebox plus ancien, saisissez plutôt l'e-mail et le mot de passe d'un utilisateur Homebox. L'intégration ne fait que lire votre inventaire. |
| Adresse de Homebox | string | Oui | |
| Clé d'API (Homebox 0.26+) | secret | Non | Profil → Clés d'API dans Homebox. Laissez vide pour utiliser l'e-mail et le mot de passe. |
| E-mail (sans clé d'API) | string | Non | |
| Mot de passe (sans clé d'API) | secret | Non | |
| Garantie expirant sous (jours) | number | Non | Une garantie compte comme bientôt expirée ce nombre de jours avant sa fin. |
| Entretien à venir sous (jours) | number | Non | |
| Un appareil par emplacement | boolean | Non | Nombre d'objets et valeur de chaque emplacement principal, sous-emplacements compris. |
| Lire Homebox toutes les | select | Non | |
| Langue des noms et messages | select | Non | Les noms des fonctionnalités sont fixés à l'ajout d'un appareil dans Gladys. |
Comment installer Homebox dans Gladys
- Dans Gladys, ouvrez Intégrations : Homebox 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/guim31/gladys-homebox:1.0.0), 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/guim31/gladys-homebox.
Homebox 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
Homebox 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 guim31, 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