Intégration domotique SFR Box, gratuite et open source
Ligne, connexion Internet, Wi-Fi et appareils connectés de votre SFR Box, en local.
Publiée par guim31
- Appareils
- Version 1.0.2
- Nécessite Gladys >=5.1.0
- ★ 0
Suivez votre SFR Box depuis Gladys : ligne, connexion Internet, Wi-Fi, appareils connectés, et redémarrez-la depuis une scène ou le tableau de bord. Tout reste sur votre réseau local : Gladys interroge la box une fois par minute par son API locale, sans compte cloud.
Développée sans le matériel : retours bienvenus. Cette intégration a été écrite à partir de la documentation publique de l’API de la box et de vraies réponses recueillies par la bibliothèque libre hacf-fr/sfrbox-api (Home Assistant). Si quelque chose manque ou est faux sur votre box, ouvrez une issue avec votre modèle et votre firmware (affichés par le bouton Tester la connexion).
Cette intégration n’est pas affiliée à SFR.
Box compatibles
La box doit exposer l’API locale « neufbox » (http://192.168.1.1/api/1.0/).
| Box | État |
|---|---|
| NB4, NB5, NB6, NB6V, NB6VAC | L’API est documentée pour ces modèles. |
Firmwares récents (BOX10H, 3DCM / FTTB) | Informations système confirmées par de vraies réponses ; le reste n’est pas testé. |
| SFR Box 8 et 8X | Inconnu : ni la documentation de l’API ni Home Assistant ne les citent. Les firmwares récents ci-dessus laissent penser qu’elles répondent. Vos retours sont bienvenus. |
Box sans cette API (ex. NCC) | Non prises en charge. |
Prérequis
- Gladys 5.1 ou plus récent.
- Gladys et la box sur le même réseau local.
- Facultatif : le mot de passe administrateur de la box. Par défaut, c’est
la clé Wi-Fi inscrite sur l’étiquette de la box, sauf si vous l’avez changé
dans l’interface de la box (
http://192.168.1.1).
Configuration
- Installez l’intégration depuis le catalogue de Gladys, puis ouvrez son onglet Configuration.
- Adresse de la box :
192.168.1.1, sauf si votre réseau en utilise une autre. - Identifiant (
admin) et mot de passe administrateur : facultatifs. Sans eux, vous avez la ligne, la connexion Internet et les informations système. Avec eux, vous avez aussi l’état du Wi-Fi et le redémarrage. - Découvrir les appareils connectés : liste les appareils vus par la box, pour la détection de présence.
- Langue des noms de fonctionnalités : les noms donnés aux fonctionnalités quand vous ajoutez un appareil (ils ne changent plus ensuite).
- Enregistrez, puis cliquez sur Tester la connexion : le résultat indique le modèle, le firmware, la ligne, le nombre d’appareils connectés et si le mot de passe est accepté.
- Ouvrez l’onglet Découverte et ajoutez l’appareil SFR Box, ainsi que les appareils connectés que vous voulez suivre.
Le mot de passe est conservé par Gladys et n’est jamais écrit dans les journaux.
Ce que vous obtenez
L’appareil « SFR Box »
| Fonctionnalité | Quand |
|---|---|
| Connexion Internet (connectée ou non) | toujours |
| Connexion IPv6 | toujours |
| Adresse IPv4 publique | toujours |
| Type de ligne (ADSL, FTTH…) | toujours |
| Ligne DSL synchronisée | ligne DSL |
| Débits DSL descendant et montant (kbit/s) | ligne DSL |
| Atténuation et marge de bruit, descendantes et montantes | ligne DSL |
| Ligne fibre active | ligne fibre |
| Wi-Fi activé | avec le mot de passe administrateur |
| Durée de fonctionnement (heures) | toujours |
| Température de la box | si la box a une sonde de température |
| Modèle, firmware | toujours |
La ligne fibre n’expose aucun débit par cette API : les débits ne concernent que le DSL. Si vous ajoutez le mot de passe plus tard ou si votre ligne passe à la fibre, l’onglet Découverte propose de Mettre à jour l’appareil.
Appareils connectés (présence)
Chaque appareil vu par la box peut être ajouté comme appareil Gladys avec une fonctionnalité Présence, affichée « vu il y a N minutes ». Elle est rafraîchie quand l’appareil apparaît sur le réseau, puis toutes les 5 minutes tant qu’il reste connecté. Pour marquer quelqu’un absent, utilisez l’action de scène de Gladys Vérifier la présence d’un utilisateur avec un délai de 10 minutes ou plus.
Les téléphones utilisent souvent une adresse Wi-Fi privée (aléatoire) par réseau : désactivez-la pour le réseau de la maison dans les réglages Wi-Fi du téléphone, sinon l’appareil apparaît sous une nouvelle adresse. Selon le firmware, la box ne donne cette liste qu’avec le mot de passe administrateur.
Scènes
- Connexion Internet perdue (déclencheur) : la box signale sa connexion Internet coupée. Pas déclenché pendant un redémarrage demandé par Gladys.
- Connexion Internet rétablie (déclencheur) : la connexion est revenue. Les
actions suivantes lisent la durée de la coupure avec
{{triggerEvent.data.outage_seconds}}(à une minute près environ, vide si la coupure a commencé avant que Gladys ne surveille). - Redémarrer la SFR Box (action) : Internet, TV et téléphone sont coupés quelques minutes. Nécessite le mot de passe administrateur.
Ces déclencheurs reposent sur ce que dit la box : si la box elle-même est injoignable (éteinte, en redémarrage), rien n’est déclenché.
Tableau de bord
Le widget SFR Box affiche la connexion Internet, l’état de la ligne, les débits DSL, la durée de fonctionnement et la température. Son réglage Afficher un bouton de redémarrage ajoute un bouton de redémarrage, avec confirmation, quand le mot de passe est configuré.
Actions
- Tester la connexion : interroge la box maintenant et vérifie le mot de passe.
- Redémarrer la box : cochez Je confirme le redémarrage, puis lancez l’action.
Dépannage
- « SFR Box injoignable » : vérifiez l’adresse, et que Gladys tourne sur le même réseau que la box (un VPN ou un second routeur entre les deux empêche l’accès).
- « Mot de passe refusé par la box » : vérifiez le mot de passe dans l’interface de la box. Gladys arrête d’essayer après un refus, pour ne pas bloquer le compte : enregistrez de nouveau la configuration pour réessayer.
- « La box n’accepte que l’authentification par bouton » : la box désactive l’authentification par mot de passe. Activez-la dans l’interface de la box pour l’état du Wi-Fi et le redémarrage.
- Une valeur reste vide : votre firmware ne la fournit peut-être pas. Lancez Tester la connexion et partagez le résultat dans une issue.
- Les journaux de l’intégration sont disponibles dans Gladys, dans l’onglet
Journaux de l’intégration. En fonctionnement normal, ils restent calmes :
démarrage, connexion, pannes et leur rétablissement, et vos actions. Réglez
LOG_LEVEL=debugpour plus de détails ; mots de passe et jetons n’y figurent jamais.
Paramètres de configuration
Voici les paramètres demandés par SFR Box dans son écran de configuration dans Gladys.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| Votre SFR Box | section | Non | Gladys interroge la box sur votre réseau local une fois par minute. Sans mot de passe : ligne, connexion Internet et informations système. Avec le mot de passe administrateur de la box (par défaut, la clé Wi-Fi inscrite sur l’étiquette de la box) : état du Wi-Fi et redémarrage. Développée sans le matériel : retours bienvenus. Sans lien avec SFR. |
| Adresse de la box | string | Oui | Adresse IP ou nom de la box sur votre réseau, 192.168.1.1 par défaut. |
| Identifiant administrateur | string | Non | Identifiant de l’interface web de la box, admin sauf si vous l’avez changé. |
| Mot de passe administrateur | secret | Non | Facultatif. Nécessaire pour l’état du Wi-Fi et le redémarrage. Conservé par Gladys, jamais écrit dans les journaux. |
| Découvrir les appareils connectés | boolean | Non | Liste dans l’onglet Découverte les appareils vus par la box, pour la détection de présence par adresse MAC. |
| Langue des noms de fonctionnalités | select | Non | Noms donnés aux fonctionnalités quand vous ajoutez un appareil à Gladys. |
Comment installer SFR Box dans Gladys
- Dans Gladys, ouvrez Intégrations : SFR Box 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-sfr-box:1.0.2), 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-sfr-box.
SFR Box 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
SFR Box 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 externes
- Découvrir les intégrations natives intégrées à Gladys
- Créer et publier votre propre intégration externe
- Code source sur GitHub — source de cette documentation