Intégration domotique OpenFamily, gratuite et open source

Le calendrier familial, la liste de courses et les tâches d'OpenFamily dans Gladys.
Présentation
OpenFamily est un organisateur familial libre et auto-hébergé : calendrier, liste de courses, tâches, repas, budget. Cette intégration fait entrer dans Gladys ce qui sert au quotidien dans la maison :
- Le calendrier familial devient un calendrier Gladys, tenu à jour, visible dans la vue Calendrier et utilisable par les scènes (« un événement du calendrier approche »). Les rendez-vous récurrents et les journées entières sont pris en charge, sur un mois d'historique et douze mois à venir.
- Trois widgets de tableau de bord : les rendez-vous du jour, la liste de courses et les tâches. Les deux derniers ont un bouton pour ajouter et un bouton pour cocher.
- Quatre actions de scène : ajouter un article à la liste de courses, ajouter une tâche, lire la liste de courses, lire les tâches. Les deux dernières donnent leur résultat aux actions suivantes de la scène (par exemple pour l'annoncer sur une enceinte).
- Trois déclencheurs de scène : un article ajouté à la liste, une tâche terminée, une tâche à faire aujourd'hui.
Gladys ne modifie jamais le calendrier d'OpenFamily. Elle n'écrit dans OpenFamily que lorsque vous ajoutez ou cochez un article ou une tâche, depuis un widget ou une scène.
Prérequis
- Gladys Assistant 5.2.0 ou plus récent.
- Un serveur OpenFamily que Gladys peut joindre sur votre réseau, dans une version qui propose les jetons d'API (Paramètres → Jetons d'API).
- Un jeton d'API créé par un compte parent. Choisissez Lecture et écriture pour pouvoir ajouter et cocher depuis Gladys ; un jeton en lecture seule suffit pour afficher.
- Pour des heures justes : OpenFamily enregistre les heures locales de la famille. Avec OpenFamily 2.0 ou plus récent, l'intégration lit le fuseau horaire de la famille dans OpenFamily lui-même. Avec un serveur plus ancien, elle utilise celui réglé dans les paramètres de Gladys.
Configuration
- Dans OpenFamily, ouvrez Paramètres → Jetons d'API, donnez un nom (« Gladys »), choisissez la portée et créez le jeton. Copiez-le tout de suite : il n'est affiché qu'une fois.
- Dans Gladys, ouvrez la page de l'intégration et renseignez :
- Adresse d'OpenFamily : celle que vous ouvrez dans le navigateur, par exemple
http://192.168.1.20:3000. Depuis Gladys,localhostdésigne le conteneur de l'intégration : utilisez l'adresse IP ou le nom de la machine. - Jeton d'API : le jeton copié, qui commence par
ofk_.
- Adresse d'OpenFamily : celle que vous ouvrez dans le navigateur, par exemple
- Cliquez sur Tester la connexion : le message donne le compte que le jeton représente.
- Pour le calendrier, activez l'intégration dans le bloc Mes calendriers. Le calendrier « OpenFamily » apparaît, privé au départ : partagez-le avec le foyer pour le voir sur le tableau de bord et l'utiliser dans les scènes. Le calendrier est le même pour toute la famille : un seul utilisateur doit l'activer, sinon chaque événement apparaît en double.
- Ajoutez les widgets depuis l'édition du tableau de bord : ils s'appellent « OpenFamily : aujourd'hui », « OpenFamily : liste de courses » et « OpenFamily : tâches ».
Réglages facultatifs :
- Intervalle d'actualisation : fréquence de lecture d'OpenFamily, cinq minutes par défaut. Les changements arrivent en général en quelques secondes, par le canal temps réel d'OpenFamily.
- Catégorie des articles ajoutés : la catégorie OpenFamily donnée aux articles ajoutés depuis Gladys (« Autre » par défaut).
- Fuseau horaire de la famille : à renseigner seulement si les heures apparaissent décalées avec un OpenFamily antérieur à la 2.0 (voir le dépannage).
Les rappels passent par le déclencheur natif de Gladys « Un événement du calendrier approche », avec le calendrier OpenFamily partagé : vous choisissez le délai et filtrez sur le nom.
Dépannage
- « Le serveur OpenFamily est injoignable » : vérifiez l'adresse, sans rien après le port, et
qu'elle répond depuis la machine de Gladys.
localhostne fonctionne pas (voir plus haut). - « OpenFamily a refusé le jeton d'API » : le jeton a été révoqué, ou le compte qui l'a créé a quitté la famille. Créez-en un nouveau et collez-le dans la configuration.
- « Ce jeton d'API est en lecture seule » : l'affichage fonctionne, mais ajouter et cocher demandent un jeton Lecture et écriture.
- « OpenFamily a répondu par une erreur » : l'adresse n'est sans doute pas celle d'un serveur OpenFamily, ou sa version est trop ancienne pour les jetons d'API.
- Les événements apparaissent en double : deux utilisateurs ont activé le calendrier. Désactivez-le pour l'un des deux et partagez celui qui reste avec le foyer.
- Les heures sont décalées : avec OpenFamily 2.0 ou plus récent, vérifiez le fuseau horaire
de la famille dans OpenFamily, sous Paramètres, puis Fuseau horaire. Avec un serveur
plus ancien, le fuseau n'est pas réglé dans les paramètres de Gladys (l'intégration tourne
alors en UTC), ou il diffère de celui de la famille : réglez-le dans Gladys, ou renseignez
Fuseau horaire de la famille dans la configuration de l'intégration, par exemple
Europe/Paris. - Un bouton répond qu'il demande une Gladys plus récente : les formulaires des widgets existent depuis Gladys 5.2.
- Le calendrier ne se met pas à jour : utilisez Synchroniser maintenant sur la page de l'intégration, et vérifiez que le calendrier n'est pas désactivé dans « Mes calendriers ».
Un problème, une idée : https://github.com/NexaFlowFrance/gladys-openfamily/issues.
Paramètres de configuration
Voici les paramètres demandés par OpenFamily dans son écran de configuration dans Gladys.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| Connecter votre serveur OpenFamily | section | Non | OpenFamily est un organisateur familial libre et auto-hébergé. Dans OpenFamily, ouvrez Paramètres, puis Jetons d'API, et créez un jeton « Lecture et écriture » pour Gladys. Collez-le ci-dessous avec l'adresse de votre serveur, telle que Gladys l'atteint sur votre réseau. |
| Adresse d'OpenFamily | string | Oui | L'adresse à laquelle vous ouvrez OpenFamily, sans rien après le port. |
| Jeton d'API | secret | Oui | Commence par ofk_. Un jeton en lecture seule affiche les données ; ajouter depuis Gladys demande « Lecture et écriture ». |
| Intervalle d'actualisation (min) | number | Non | Fréquence de lecture d'OpenFamily. Les changements arrivent en général plus tôt, par son canal temps réel. |
| Catégorie des articles ajoutés | string | Non | La catégorie OpenFamily donnée aux articles ajoutés depuis Gladys. |
| Fuseau horaire de la famille | string | Non | Seulement avec un OpenFamily antérieur à la 2.0, si les heures sont décalées dans Gladys : le fuseau dans lequel OpenFamily est utilisé. Vide : celui de la famille, donné par OpenFamily 2.0, sinon celui réglé dans les paramètres de Gladys. |
Comment installer OpenFamily dans Gladys
- Dans Gladys, ouvrez Intégrations : OpenFamily 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/nexaflowfrance/gladys-openfamily:0.2.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/NexaFlowFrance/gladys-openfamily.
OpenFamily nécessite Gladys >=5.2.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
OpenFamily 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 NexaFlowFrance, 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