MMM-Freebox est un module pour le projet MagicMirror²
Il permet d'afficher, sur votre Mirroir, divers informations de votre Freebox en temps réél.
Plusieurs modules sont disponibles et permet l'affichage suivant:
- Model de la Freebox.
- Bande Passante.
- Adresse IP.
- Appareils connectés.
- Débit utilisé (total et/ou par appareil).
- Ping de votre mirroir vers google.fr (ou autre)
- Type de connexion utilisé par les appareils. (ethernet, wifi, machine virtuelle)
- Clonez le module dans le dossier module:
cd ~/MagicMirror/modules
git clone https://github.com/bugsounet/MMM-Freebox
cd MMM-Freebox
npm install
- Associer
MMM-Freebox
à votre Freebox Server.
cd ~/MagicMirror/modules/MMM-Freebox
npm run register
Merci de vérifier votre écran LCD de votre Freebox Server et autoriser l'enregistrement de l'application.
-
Validez l'association par la flèche de droite de l'écran LCD de votre Freebox Server.
-
Sauvegarder précieusement l'information de connexion.
freebox: {
app_token: 'xxxxxxxxxxxxxxxxxxxxxxxxx',
app_id: 'fbx.MMM-Freebox',
api_domain: 'xxxxx.fbxos.fr',
https_port: xxxx,
api_base_url: '/api/',
api_version: 'xxx.x'
},
Pour afficher le module, inserez ceci dans votre ficher config.js
Remplacer le contenu de freebox
par les valeurs de connexion fourni par votre Freebox Server.
{
module: "MMM-Freebox",
position: "top_left",
animateIn: "fadeInLeft",
animateOut: "fadeOutLeft",
config: {
freebox: { // inserez vos informations de connexion
app_token: 'xxxxxxxxxxxxxxxxxxxxxxxxx',
app_id: 'fbx.MMM-Freebox',
api_domain: 'xxxxx.fbxos.fr',
https_port: xxxx,
api_base_url: '/api/',
api_version: 'xxx.x'
},
}
},
Ceci est la configuration par defaut si vous definissez aucune valeurs
{
module: 'MMM-Freebox',
position: 'top_left',
animateIn: "fadeInLeft",
animateOut: "fadeOutLeft",
config: {
freebox: { // inserez vos informations de connexion
app_token: 'xxxxxxxxxxxxxxxxxxxxxxxxx',
app_id: 'fbx.MMM-Freebox',
api_domain: 'xxxxx.fbxos.fr',
https_port: xxxx,
api_base_url: '/api/',
api_version: 'xxx.x'
},
debug: false,
verbose: false,
updateDelay: 5 * 1000,
zoom: 110,
activeOnly: false,
showModel: true,
showIcon: true,
showButton: true,
showBandWidth: true,
showRate: true,
showClient: true,
showClientRate: true,
showEthClientRate: false,
showClientRateDownOnly: false,
showClientIP: false,
showClientCnxType: true,
showWifiStandard: true,
showFree: true,
showIP: true,
showPing: true,
pingAdress: "google.fr",
textWidth: 250,
excludeMac: [],
sortBy: null,
checkFreePlug: false,
checkSFP: false
}
},
Option | Description | Type | Defaut |
---|---|---|---|
debug | Active le mode de debuguage | Boolean | false |
verbose | Active le mode verbose en console | Boolean | false |
updateDelay | Delai de mise à jour en ms | Number | 5 * 1000 (5 sec) |
zoom | Zoom global du module (en pourcent) 100 est considéré 100% |
Number | 110 |
activeOnly | Affiche uniquement les appareils connectés | Boolean | false |
showModel | Affiche le model de Freebox utilisé | Boolean | true |
showIcon | Affiche les icones personalisés des appareils | Boolean | true |
showButton | Affiche les boutons de status de connexion | Boolean | true |
showBandWidth | Affiche la bande passante de votre connexion | Boolean | true |
showRate | Affiche le débit utilisé de votre connexion | Boolean | true |
showClient | Affiche la liste des appareils | Boolean | true |
showClientRate | Affiche le débit des appareils | Boolean | true |
showEthClientRate | Affiche le débit de connexion de l'appareil connecté sur le port ethernet. Ne fonctionne que si un seul appareil est connecté par port ethernet. Activer sur vous n'utiliser pas de swtich/hub sur votre Freebox! |
Boolean | false |
showClientRateDownOnly | Affiche uniquement le debit descendant des appareils | Boolean | true |
showClientIP | Affiche l'addresse IPv4 des appareils | Boolean | false |
showClientCnxType | Affiche le type de connexion des appareils | Boolean | true |
showWifiStandard | Affiche la norme de connexion utilisée | Bolean | true |
showFree | Affiche les Freebox Player et répéteurs | Boolean | true |
showIP | Affiche l'adresse ip de votre connexion | Boolean | true |
showPing | Affiche le ping entre le mirroir et google.fr | Boolean | true |
pingAdress | personalisation de l'adresse a ping | String | google.fr |
textWidth | Largeur du texte à afficher (mini: 220) | Number | 250 |
excludeMac | Ne pas afficher les appareils connectés avec certaines adresses MAC | Array | [] |
sortBy | Classement des appareils connectés par : "type", "name", "mac" ou null pour classement par defaut | String | null |
checkFreePlug | Permet de verifier et d'afficher les connexions via FreePlug sur le réseau (Freebox Delta uniquement) | Boolean | false |
checkSFP | Permet de verifier et d'afficher les connexions via la carte SFP sur le réseau (Freebox Delta/Ultra uniquement) | Boolean | false |
Connexion depuis le port Ethernet numéro 1
Connexion depuis le port Ethernet numéro 2
Connexion depuis le port Ethernet numéro 3
Connexion depuis le port Ethernet numéro 4
Connexion depuis le port CPL
Connexion depuis le port SFP
Connexion depuis le wifi 2.4Ghz
Connexion depuis le wifi 5Ghz
Connexion depuis le wifi 6Ghz
Connexion depuis le wifi 60Ghz (non disponible)
- R (En rouge) Suivi du signal wifi est la connexion depuis un répéteur Wifi
Machine Virtuelle
Connexion indéterminée
Connexion avec la norme 802.11b (wifi 1)
Connexion avec la norme 802.11a (wifi 2)
Connexion avec la norme 802.11g (wifi 3)
Connexion avec la norme 802.11n (wifi 4)
Connexion avec la norme 802.11ac (wifi 5)
Connexion avec la norme 802.11ax (wifi 6)
Connexion avec la norme 802.11be (wifi 7)
- Utilisez l'interface
FreeboxOS
de votre Freebox Server (Periphériques Réseau) - Utilisez l'application
Freebox Connect
sur votre téléphone (Appareils)
Utilisez cette commande::
cd ~/MagicMirror/modules/MMM-Freebox
npm run update
Mise à jour automatique depuis le module updatenotification
Depuis MagicMirror² v2.27.x, vous pouvez appliquer automatiquement les mises à jours des modules depuis updatenotification
.
Voici la règle a ajouter pour MMM-Freebox
{
module: "updatenotification",
position: "top_center",
config: {
updateAutorestart: true, // restart MagicMirror automaticaly after update
updates: [
// MMM-Freebox rule
{
"MMM-Freebox": "npm run update"
},
]
}
},
- Les essais ont été effectués avec une Freebox Ultra.
- Merci de me confirmer le bon fonctionnement sur les autres Freebox!
- Ne fonctionne pas avec les Freebox Crystal et antérieur (API différante)
- Ultra: api v11.1 (Freebox OS v4.8)
- Révolution: api v10.2 (Freebox OS v4.7)
Si vous aimez ce module, un petit café est bien sympatique :)