Plugin Freebox_OS

Description

Ce plugin permet de récupérer les informations de votre FreeboxOS (Serveur Freebox Révolution ou 4K ou DELTA ou POP ou Ultra) et d’interagir avec via des widgets ou des scénarios reprenant les commandes créées.

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

Les informations disponibles de votre Freebox Serveur sur Jeedom sont :

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

Modale Appairage

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

Authentification 1

Réglages

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

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

Authentification 2

Authentification

Firmware minimun de la Freebox

Le plugin pour fonctionner nécessite d’avoir un firmware minimum. Le firmware minimum est indiqué sur le changelog au début et au début de cette documentation

Authentification

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

Authentification 3

Vérification des droits

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

Authentification 4

Lier les pièces Freebox avec les Objets Jeedom

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

Il est possible d’activer ou désactiver le Cron “Actualisation Globale des Tiles”

Ne pas oublier de cliquer sur sauvegarder pour prendre en compte les changements

Authentification 4

Scan

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

Authentification 5

Authentification terminée

L’authentification est réussie.

Authentification 6

Problème d’Authentification terminée

en cas de problème d’authentification, il faut fournir les logs du plugin en mode debug Voici un exemple

000|[2024-10-11 18:53:49] INFO  ──────────▶︎ Étape : setting
0001|[2024-10-11 18:53:49] INFO  ───▶︎ IP : mafreebox.freebox.fr
0002|[2024-10-11 18:53:49] INFO  ───▶︎ Nom API : Plugin Freebox OS
0003|[2024-10-11 18:53:49] INFO  ───▶︎ Id API : plugin.freebox.jeedom
0004|[2024-10-11 18:53:49] INFO  ───▶︎ Nom de votre Jeedom : JAG Jeedom-VM2
0005|[2024-10-11 18:53:49] INFO  ───▶︎ Objet par défaut : 13
0006|[2024-10-11 18:53:49] INFO  ───▶︎ Version API Freebox : v12
0007|[2024-10-11 18:53:51] INFO  ──────────▶︎ Étape : authentification
0008|[2024-10-11 18:53:53] INFO  ──────────▶︎ Étape : rights
0009|[2024-10-11 18:53:57] DEBUG  OK  Close Session
0010|[2024-10-11 18:53:57] DEBUG  [Freebox Close Session] : {"uid":"94d2c23d2479819c30954e64ca5981b5","success":false,"msg":"Vous devez vous connecter pour accéder à cette fonction","result":{"password_salt":"orwB6BfzCFmlKTdR+O\/6kUmIYIkXfu0P","challenge":"sQn1Z4f3UT0u21ms1kogF\/pK+lnmuPTr"},"error_code":"invalid_session"}
0011|[2024-10-11 18:53:57] DEBUG  [Freebox Password] : {"success":true,"result":{"logged_in":false,"challenge":"sQn1Z4f3UT0u21ms1kogF\/pK+lnmuPTr","password_salt":"orwB6BfzCFmlKTdR+O\/6kUmIYIkXfu0P","password_set":true}}
0012|[2024-10-11 18:53:57] DEBUG  [get Freebox Open Session Data] : {"result":{"session_token":"eRDFtl35L8ENEND2UGlooFzLhAgmv8CGPbMLiegdyC2n4z3DDr4UEYY+zYMOhSkS","challenge":"sQn1Z4f3UT0u21ms1kogF\/pK+lnmuPTr","password_salt":"orwB6BfzCFmlKTdR+O\/6kUmIYIkXfu0P","permissions":{"parental":true,"contacts":true,"explorer":true,"tv":true,"wdo":true,"downloader":true,"profile":true,"camera":true,"settings":true,"calls":true,"home":true,"pvr":true,"vm":true,"player":true},"password_set":true},"success":true}
0013|[2024-10-11 18:53:57] INFO  ───▶︎ Les droits sont OK
0014|[2024-10-11 18:53:58] INFO  ──────────▶︎ Étape : room
0015|[2024-10-11 18:53:58] INFO  ───▶︎ Cron Global Titles ACTIVATION : NOK
0016|[2024-10-11 18:53:58] INFO  ───▶︎ Compatibilité avec la partie domotique : NOK
0017|[2024-10-11 18:53:58] INFO  ──────────▶︎ Étape : scan
0018|[2024-10-11 18:53:59] INFO  ──────────▶︎ Étape : end

Activation log en debug

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

Paramètres de la Freebox

Paramètres de gestion des accès de la Freebox

Paramètres de gestion des accès de la Freebox

Modification des droits d'accès spécifiques

Les équipements standards

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

Recherche des équipements systèmes

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

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.

Recherche des contrôles parentaux

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

Recherche des équipements spécifiques

Un Cron Journalier permet automatiquement de chercher les nouveaux équipements

Gestion réseau

Cet équipement permet de :

  • Attribuer une adresse IP fixe
  • Gérer le filtrage des adresses MAC
  • Fonction Wake on LAN
  • Modifier le type de périphérique

Attribuer une adresse IP

Modification IP

Il faut avoir les valeurs les champs suivants renseignés

Changer le type de périphérique

Modification des équipements

Il faut avoir les valeurs les champs suivants renseignés

Gérer le filtrage des adresses MAC (WIFI)

Modification des équipements

Il est possible de faire cela avec les commandes depuis les équipements appareils connectés ou wifi Il faut avoir les valeurs les champs suivants renseignés

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

Fonction Wake on LAN

Modification des équipements

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

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

Recherche des équipements spécifiques Freebox delta

Statut Alarme

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

État 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 l'alarme

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 caméras

les caméras sont créées automatiquement si le plugin caméra est installé

Temps de rafraichissement (Cron) des équipements

Les tiles

Chaque équipement n’est pas forcément intégré dans le système vue l’évolution de la FreeboxS

Debug Tiles

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

Équipement tiles 1

Équipement tiles 2

    [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] : └─────────