Home

Welcome to the MMM-FreeBox-Monitor wiki!

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:

	<tr>
		<td><code>maxCallEntries</code></td>
		<td>The maximum number of missed calls shown.<br>
			<br><b>Possible values:</b> <code>0</code> - <code>100</code>
			<br><b>Default value:</b> <code>3</code>
		</td>
	</tr>
	<tr>
		<td><code>displaySystemData</code></td>
		<td>Display a system data (Temperature/Download Speed).<br>
			<br><b>Possible values:</b> <code>true</code> or <code>false</code>
			<br><b>Default value:</b> <code>true</code>
		</td>
	</tr>
	<tr>
		<td><code>displayMissedCalls</code></td>
		<td>Display missed calls table.<br>
			<br><b>Possible values:</b> <code>true</code> or <code>false</code>
			<br><b>Default value:</b> <code>true</code>
		</td>
	</tr>
	<tr>
		<td><code>displayDownloads</code></td>
		<td>Display downloaded files table.<br>
			<br><b>Possible values:</b> <code>true</code> or <code>false</code>
			<br><b>Default value:</b> <code>true</code>
		</td>
	</tr>
	<tr>
		<td><code>mirrorName</code></td>
		<td>The mirror name used to identify the mirror on Freebox Server. Useful in case of multiple mirrors.<br>
			<br><b>Possible values:</b> <code>string</code>
			<br><b>Default value:</b> <code>My Magic Mirror</code>
		</td>
	</tr>
	<tr>
		<td><code>requestRefresh</code></td>
		<td>The refresh interval in seconds to request refrest on Freebox Server.<br>
			<br><b>Possible values:</b> <code>30</code> - <code>300</code>
			<br><b>Default value:</b> <code>30</code>
		</td>
	</tr>
</tbody>

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://

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

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.

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

Known issues