No description, website, or topics provided.
JavaScript Other
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
2016-06-30_14-34-46.png
2016-11-23_21-43-40.png
20160630_234117.png
LICENSE
MMM-FreeBox-Monitor.js
README.md
freebox.css
freeboxapi.js
node_helper.js
package.json
progressbar.js
push-to.bat
vim.exe.stackdump

README.md

MMM-FreeBox-Monitor: The module for MagicMirror.

Module: MMM-FreeBox-Monitor

This module is intended to be used in MagicMirror²!.

The MMM-FreeBox-Monitor displays data from your FreeBox v6 server (Revolution) from the french ISP free. It can combine multiple data

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
	{
		module: 'MMM-FreeBox-Monitor',
		position: 'top_left',	// This can be any of the regions. Best results in left or right regions.
		config: {
			mirrorName: "My Magic Mirror",
			ip: "http://XXX.XXX.XXX.XXX"
			// See 'Configuration options' for more information.
		}
	}
]

Configuration options

The following properties can be configured:

Option Description
ip The IP address of the FreeBox Server. You can use the internal or external IP address of the FreeBox Server, you can use http://www.myipaddress.com/ service to get it. Default FreeBox Server ip is http://192.168.0.254.

Possible values: any IP address prefixed by http://
maxCallEntries The maximum number of missed calls shown.

Possible values: 0 - 100
Default value: 3
displaySystemData Display missed calls table.

Possible values: true or false
Default value: true
displayDownloads Display downloaded files table.

Possible values: true or false
Default value: true
mirrorName The mirror name used to identify the mirror on Freebox Server. Useful in case of multiple mirrors.

Possible values: string
Default value: My Magic Mirror
requestRefresh The refresh interval in seconds to request refrest on Freebox Server.

Possible values: 30 - 300
Default value: 30

FreeBox Monitor registration:

Before starting the Magic Mirror. Open your Freebox admin page at http://mafreebox.freebox.fr -> Paramètres de la Freebox -> Gestion des accès. Check that Permettre les nouvelles demandes d'association is checked.

MMM-FreeBox-Monitor: Application association

The first time the Magic Mirror starts, a request is sent to Freebox Server to register the application. Select Oui on LCD display to register the mirror.

MMM-FreeBox-Monitor: Registration

Once session is opened, a file freebox.txt is created at the root of Magic Mirror installation directory. If you change the configuration for mirrorName or ip, you must delete this file.

Dependencies

  • installed via npm install