Description

Ce plugin permet de récupérer les informations de votre FreeboxOS (Serveur Freebox Révolution ou 4K ou DELTA ou POP).

Toutes les infos ne sont pas encore disponibles pour la Freebox POP

Il est nécessaire d’avoir la Freebox Serveur en version 4.2 pour que le plugin fonctionne

Les informations disponibles de votre Freebox Serveur sur Jeedom sont :

• Les informations système :
  • Couper le wifi
  • Redémarrer votre Freebox
  • Les débits internet
  • L’état de votre connexion
  • Gestion du filtrage des appels
• Téléphone : sur les dernieres 24h
  • Le nombre d’appels en absence
  • Le nombre d’appels passés
  • Le nombre d’appels reçus
• Disque Dur :
  • La place disponible dans vos disques connectés à la Freebox Serveur.
• Appareils connectés sur le LAN et le Wifi Invité:
  • L’état de chaque équipement DHCP
  • Possibilité d’utiliser la commande Wake on LAN uniquement par scénario
• Domotique (uniquement pour la DELTA) :
  • Récupère les infos de la maison connectée

Installation et Configuration

Une fois le plugin installé et actif, aucune configuration n’est nécessaire.

Appairage (Authentification)

Il faut se rendre dans la page principale du plugin et cliquer

Il faut ensuite suivre les différents écrans pour valider l’appairage

Réglages

Dans la fenêtre ci-dessous, il est possible de modifier

• IP Freebox : Adresse de connexion de la Freebox (par défaut : mafreebox.freebox.fr)
• Nom de l’équipement connecté : Le nom de la Jeedom (ce champ est verrouillé)
• Ajouter automatiquement les équipements détectés dans : : Indiquer la pièce par défaut
• Il est possible de cliquer sur le bouton Reset configuration pour avoir les paramètres par défaut
• Ne pas oublier de cliquer sur Sauvegarder

Il est impératif que votre Jeedom soit nommé pour continuer l’appairage du plugin avec votre Freebox

Authentification

Dans la fenêtre ci-dessous, il va être réalisée l’authentification sur la Freebox

• Cliquer sur le bouton Lancement de l’Authentification
• Suivre à la fois les identifications sur cet écran ainsi que sur la Freebox

Vérification des droits

Dans la fenêtre ci-dessous, Le système va contrôler les droits qui sont attribués à l’application

• Voir la section des Droits d’accès (dans cette documentation) pour modifier les droits sur la Freebox
• Une fois les droits réglés, cliquer sur le bouton Vérification des droits

  Si les droits sont OK, le bouton va disparaitre Les droits obligatoires sont en gras

Lier les pièces Freebox avec les Objets Jeedom

Cette fenêtre n’apparait uniquement que si la Freebox est une DELTA

Scan

Dans la fenêtre ci-dessous, Il est possible de lancer le scan des différents équipements.

Authentification terminée

L’authentification est réussie.

Droits d’accès

Certains droits d’accès supplémentaires sont nécessaires pour l’utilisation du plugin, ils doivent être obligatoirement attribués et modifiés directement depuis l’OS de la Freebox

• Se connecter à l’interface de la Freebox (http://mafreebox.freebox.fr)
• Ouvrir les paramètres de la Freebox

• Ouvrir la gestion des accès de la Freebox (ce réglage se trouve dans le mode avancé)

• Cliquer sur l’onglet Applications
• Dans la liste, choisir l’Application déclarée lors de l’installation du Plugin (par défaut : Jeedom Core)

• Autoriser tous les droits d’accès

Les équipements standards

Cliquer sur le bouton Scan équipements standards, le plugin va créer les différents équipements standards de la Freebox.

Les équipements et les commandes suivants vont être créés :

• Air Média
  • Player actuel AirMedia
  • AirMedia Start
  • AirMedia Stop
• Appareils connectés et Appareils connectés Wifi Invité
  • Ensemble des appareils connectés à la Freebox
  • Possibilité d’utiliser la commande Wake on LAN uniquement par scénario
• Disque Dur
  • Occupation du disque
• Freebox Débits
  • Freebox rate down
  • Freebox rate up
  • Freebox bandwidth up
  • Freebox bandwidth down
  • Freebox media
  • Freebox state
• Player
  • Mac
  • Type
  • Modèle
  • Version
  • API disponible
  • Disponible sur le réseau
  • Etat (allumé ou éteint)

    La commande est créée uniquement si le player renvoie son état. Il faut absolument que le player soit sous tension et pas en veille prolongée. (Révolution) Les Player mini4K ne sont pas compatibles, les players POP ne sont pas encore compatibles.

• Partage Windows - Mac
  • Activer / Désactiver le Partage de fichiers Mac
  • Activer / Désactiver le Partage de fichiers Windows
  • Activer / Désactiver le Partage Imprimante
  • Activer / Désactiver Partage FTP
• Système
  • Update
  • Reboot
  • Freebox firmware version
  • Mac
  • Vitesse ventilateur
  • Températures (temp sw, temp cpub, temp cpum)
  • Allumée depuis
  • board name
  • serial
  • 4G si la carte est présente dans la Freebox
• Téléphone sur les dernieres 24h
  • Nombre Appels Manqués / Reçus / Passés
  • Liste Appels Manqués / Reçus / Passés
• Téléchargements
  • Nombre de tâches
  • Nombre de tâches actives
  • Nombre de tâches en extraction
  • Nombre de tâches en réparation
  • Nombre de tâches en vérification
  • Nombre de tâches en attente
  • Nombre de tâches en erreur
  • Nombre de tâches stoppées
  • Nombre de tâches terminées
  • Téléchargement en cours
  • Vitesse réception
  • Vitesse émission
  • Start DL
  • Stop DL
• Wifi
  • Statut du wifi
  • Wifi On
  • Wifi Off
  • Gestion du filtrage des appels

Spécificité de Home Adapters (Uniquement Freebox Delta), Appareils connectés, Disque Dur et système

Ces quatre équipements sont vides par défaut lors de leur création sauf pour le système qui intègre les infos communes à toutes les Freebox.

Ouvrir chaque équipement et cliquer sur le bouton “Rechercher”

Le plugin recherchera et créera les différentes commandes associées

Un Cron Journalier permet automatiquement de chercher les nouveaux équipements

Le contrôle parental

Cliquer sur le bouton Scan Contrôle parental, le plugin va créer les différents équipements système de la Freebox.

Ces contrôles ont été implantés avec la version 4.2 de la Freebox.

• Les équipements et les commandes suivants vont être créés :

  • Etat
  • Bloquer
  • Autoriser
  • Bloquer 30min/1h/2h

Attribuer une adresse IP fixe

Cette gestion se fait uniquement par scénario

• Adresse Mac : Indiquer l’adresse mac de l’appareil
• Méthode : Sélectionner la méthode

  • Ajout
  • Supprimer
  • Modifier le commentaire
  • Modifier le type de générique

• IP : Indiquer l’adresse IP de l’appareil
• Nom l’équipement : Indiquer le nom de l’appareil
• Commentaires
• Type de Périphérique : Sélectionner le type de périphérique

Gérer le filtrage des adresses MAC

Cette gestion se fait uniquement par scénario

• Adresse Mac : Indiquer l’adresse mac de l’appareil
• Méthode : sélectionner la méthode

  • Ajout
  • Supprimer

• Type de filtrage : sélectionner le filtre

  • Liste blanche
  • Liste noire

• Commentaires

A savoir : l’appareil n’est pas automatiquement supprimer d’une liste si un changement de type de filtrage est fait.

Fonction Wake on LAN

Cette gestion se fait par la modale depuis le widget des appareils connectés ou depuis un scénario.

• Adresse Mac : indiquer l’adresse mac de l’appareil
• Mot de Passe : indiquer le mot de passe

  Si pas de mot de passe, laisser la case vide

Freebox Delta

La Freebox Delta permet d’avoir un pack de sécurité ainsi que la connexion avec certains équipements.

Cliquer sur le bouton Scan Tiles,les équipements et les commandes des différents équipements connectés vont être créés

Statut Alarme

Le plugin remonte l’état de l’alarme par la commande “Etat de l alarme”

Les valeurs possibles sont :

• idle = Alarme désactivée
• alarm_1_arming = L’alarme principale est activée, c’est un compte à rebours lorsque seuls les capteurs ne se trouvant pas dans la zone peuvent déclencher l’alerte
• alarm_2_arming = L’alarme partielle est activée, c’est un compte à rebours lorsque seuls les capteurs ne se trouvant pas dans la zone peuvent déclencher l’alerte
• alarm_1_armed = Alarme totale activée
• alarm_2_armed = Alarme partielle activée
• alarm1_alert_timer = L’alarme principale a été déclenchée par un capteur dans le fuseau horaire et la sirène sonnera après un compte à rebours
• alarm2_alert_timer = L’alarme de nuit a été déclenchée par un capteur dans le fuseau horaire et la sirène sonnera après un compte à rebours
• alert = La sirène sonne

le système d’alarme est compatible avec Homebridge et l’application mobile : aucune configuration n’est à faire. Pour permettre l’intégration, des commandes d’infos ont été ajoutées pour permettre d’interagir avec le plugin Alarme.

• Actif = Info Binaire (1 = Alarme Activée)
• Statut = Info Binaire (1 = Sirène active)

Statut de la télécommande

Le plugin remonte l’historique de la télécommande, il affichera la dernière action faite par la télécommande.

• Les valeurs possibles sont :

  null ou 0 = Aucun état 1 = Alarme principale 2 = Désactivation 3 = Alarme secondaire

Les caméras

les caméras sont créées, avec votre accord, dans le plugin caméra, si celui-ci est installé.

Temps de rafraichissement (cron) des équipements

• Il est possible de modifier le cron de rafraichissement de chaque équipement, par défaut :

  Home Adapter, FREEBOX - Télécommande (Alarme), Contrôle parental et Mes équipements sauf disque Dur = Cron réglé à 5 minutes Disque Dur = Cron réglé à 1 heure Ensemble des Tiles sauf FREEBOX - Télécommande (Alarme) = Cron réglé à 1 minute

Ce cron permet de rafraichir les différentes commandes de type infos, l’équipement est actualisé automatiquement en cas d’action d’une commande. Les commandes d’action ne sont pas concernées par ce cron.

Plus le temps est court, plus il y aura de la charge sur la CPU de la Freebox.

Les tiles

Chaque équipement n’est pas forcement intégré dans le système vue l’évolution de la Freebox

• Afin de pouvoir intégrer les nouveaux systèmes, il faut :

  Mettre le plugin en mode débug Redémarrer le Démon Faire Scan des tiles

Ouvrir un sujet (si aucun sujet ne traite pas déjà cette demande) sur le community et fournir les infos suivantes

• Faire une copie d’écran de l’équipement

• Faire une copie d’écran des commandes de l’équipement

• Fournir les logs sous forme de texte et non une copie d’écran

  Voir le paragraphe 11 Formatez correctement

    [2020-08-24 07:37:41][DEBUG] : ┌───────── Commande trouvée pour l'équipement FREEBOX : FREEBOX - Eclairage Canapé -- Pièce : Salon (Node ID 9)
[2020-08-24 07:37:41][DEBUG] : │ Label : Enclenché -- Name : switch_state
[2020-08-24 07:37:41][DEBUG] : │ Type (eq) : light -- Action (eq): intensity_picker
[2020-08-24 07:37:41][DEBUG] : │ Index : 0 -- Value Type : bool -- Access : rw
[2020-08-24 07:37:41][DEBUG] : │ Valeur actuelle :
[2020-08-24 07:37:41][DEBUG] : │ Range : ----- -- Range color : -
[2020-08-24 07:37:41][DEBUG] : │ Name: Etat -- Type : info -- LogicalID : 0 -- Template Widget / Ligne : core::light/0-- Type de générique : LIGHT_STATE -- Inverser : 0 -- Icône :  -- Min/Max : default/default
[2020-08-24 07:37:41][DEBUG] : │ No Repeat pour l'info avec le nom : Etat
[2020-08-24 07:37:41][DEBUG] : │ Name: On -- Type : action -- LogicalID : PB_On -- Template Widget / Ligne : core::light/1-- Type de générique : LIGHT_ON -- Inverser : 0 -- Icône :  -- Min/Max : default/default
[2020-08-24 07:37:41][DEBUG] : │ Name: Off -- Type : action -- LogicalID : PB_Off -- Template Widget / Ligne : core::light/0-- Type de générique : LIGHT_OFF -- Inverser : 0 -- Icône :  -- Min/Max : default/default
[2020-08-24 07:37:41][DEBUG] : └─────────
[2020-08-24 07:37:41][DEBUG] : ┌───────── Commande trouvée pour l'équipement FREEBOX : FREEBOX - Eclairage Canapé -- Pièce : Salon (Node ID 9)
[2020-08-24 07:37:41][DEBUG] : │ Label : Luminosité -- Name : luminosity
[2020-08-24 07:37:41][DEBUG] : │ Type (eq) : light -- Action (eq): intensity_picker
[2020-08-24 07:37:41][DEBUG] : │ Index : 2 -- Value Type : int -- Access : rw
[2020-08-24 07:37:41][DEBUG] : │ Valeur actuelle : 254
[2020-08-24 07:37:41][DEBUG] : │ Range : ----- -- Range color : -
[2020-08-24 07:37:41][DEBUG] : │ Name: Etat Luminosité -- Type : info -- LogicalID : 2 -- Template Widget / Ligne : /0-- Type de générique : LIGHT_COLOR -- Inverser : 0 -- Icône :  -- Min/Max : 0/255
[2020-08-24 07:37:41][DEBUG] : │ No Repeat pour l'info avec le nom : Etat Luminosité
[2020-08-24 07:37:41][DEBUG] : │ Name: Luminosité -- Type : action -- LogicalID : 2 -- Template Widget / Ligne : default/0-- Type de générique : LIGHT_SET_COLOR -- Inverser : 0 -- Icône :  -- Min/Max : 0/255
[2020-08-24 07:37:41][DEBUG] : └─────────

Troubleshotting

Je n’ai pas le message d’autorisation qui apparait sur la Freebox

• Vérifier dans les réglages de l’OS de la Freebox que le paramètre Permettre les nouvelles demandes d’associations est coché (Paramètres de la Freebox -> Gestion des accès -> Onglet paramètres)

  

Je n’ai pas le niveau de batterie sur le capteur de présence de la Freebox et/ou sur la télécommande

• ces infos ne sont pas remontées à la Freebox donc impossible de les avoir dans Jeedom.

  Elles ne sont donc pas disponibles sur la page santé (il est indiqué secteur ou N/A)

Je ne peux pas commander la sirène de l’alarme de la Freebox

• Il n’est pas possible de commander directement cette sirène

  Voir Bugtracker Freebox FS#30650

J’ai le message “Version d’API inconnue”

• Le micrologiciel de la Freebox doit être au minimun en version 4.2.x.

J’ai le message “unknown host, use ip address or mafreebox.freebox.fr” et le Demon NOK

• Suite à la mise à jour de la Freebox 4.2.3

  Free a changé l’adresse de la Freebox mafreebox.free.fr, celle-ci ne fonctionne plus il faut remplacer par mafreebox.freebox.fr

  Voir le paragraphe Installation et Configuration

J’ai le widget des appareils connectés qui n’est plus disponible

• Le widget a été renommé lors de la dernière mise à jour

  Il faut faire une recherche des équipements supplémentaires pour avoir le nouveau widget

J’ai les messages suivants qui apparaissent “Missing device_name” ou “Votre Jeedom n’a pas de Nom, il est impossible de continuer” lors de l’appairage

• Votre Jeedom n’a pas de Nom

  Il est impératif que votre Jeedom soit nommé pour continuer l’appairage du plugin avec votre Freebox

  Se rendre dans Réglages -> Système -> Configuration -> onglet Général et mettre un nom

  Recommencer ensuite l’authentification en n’oubliant pas de faire un reset de la configuration

  

  

J’ai le messages suivant qui apparait “API incorrecte”

Il est nécessaire d’avoir la Freebox en version 4.2 minimum pour que le plugin fonctionne

Erreur CronDaily avec des noms d’appareils avec des icônes

• Il ne faut pas que les noms d’appareils comportent des icônes.

Les nouveaux “Appareils connectés” et “Appareils connectés Wifi Invité” n’apparaissent pas lors de l’actualisation de l’équipement

• Les nouveaux équipements ne sont pas ajoutés lors de l’actualisation mais uniquement avec le Cron Journalier