Skip to content
Magic Mirror Module displaying the current level of vigilance of weather phenomena in metropolitan france
JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE
MMM-VigilanceMeteoFrance.css
MMM-VigilanceMeteoFrance.js
MMM-VigilanceMeteoFrance_screenshot1.png
MMM-VigilanceMeteoFrance_screenshot2.png
MMM-VigilanceMeteoFrance_screenshot3.png
MMM-VigilanceMeteoFrance_screenshots.png
README.md
node_helper.js
package.json

README.md

Module: MMM-VigilanceMeteoFrance

This module displays the current level of vigilance of weather phenomena set by Météo France for each department of metropolitan france, including description and the associated risks.

Description, Risk legend and Color Legend display may be enabled or disabled independently. The max-width of the description can be fixed.

MMM-VigilanceMeteoFrance Screenshot #1 MMM-VigilanceMeteoFrance Screenshot #2 MMM-VigilanceMeteoFrance Screenshot #3

MagicMirror Project on Github | Vigilance on Météo France

Installation:

In your terminal, go to your MagicMirror's Module folder:

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/grenagit/MMM-VigilanceMeteoFrance

Go to your MMM-VigilanceMeteoFrance's Module folder:

cd ~/MagicMirror/modules/MMM-VigilanceMeteoFrance

Install dependencies:

npm install

Configure the module in your config.js file.

Update:

In your terminal, go to your MMM-VigilanceMeteoFrance's Module folder:

cd ~/MagicMirror/modules/MMM-VigilanceMeteoFrance

Incorporate changes from this repository:

git pull

Install dependencies:

npm install

Configuration:

Basic configuration

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

modules: [
	{
		module: "MMM-VigilanceMeteoFrance",
		position: "top_left",
		config: {
			department: 75, // Department number
		}
	}
]

Options

The following properties can be configured:

Option Description
department The department number (metropolitan france only).

This value is REQUIRED
updateInterval How often does the content needs to be fetched? (Milliseconds)

Possible values: 1000 - 86400000
Default value: 1 * 60 * 60 * 1000 (1 hour)
animationSpeed Speed of the update animation. (Milliseconds)

Possible values:0 - 5000
Default value: 1000 (1 second)
maxTextWidth Maximum width for desription display. If set to 0, there is no limit. (Pixels)

Possible values:0 - 5000
Default value: 0 (no limit)
showDescription Show the description.

Possible values: true or false
Default value: false
showRiskLegend Show the risk legend.

Possible values: true or false
Default value: true
useColorLegend Use the colored icons.

Possible values: true or false
Default value: true
initialLoadDelay The initial delay before loading. If you have multiple modules that use the same API key, you might want to delay one of the requests. (Milliseconds)

Possible values: 1000 - 5000
Default value: 0
retryDelay The delay before retrying after a request failure. (Milliseconds)

Possible values: 1000 - 60000
Default value: 2500
apiBase The Météo France API base URL.

Default value: 'http://www.vigilance.weatherfrance.com/'
vigiEndpoint The Vigilance API endPoint.

Default value: 'data/NXFR33_LFPW_.xml'

Todo:

  • Manage risks at different levels in the same department.
  • Display an notification at the start of the MagicMirror in case of vigilance level 2 to 4.
  • Display an notification in case of new risk.

License:

This module is licensed under the MIT License

You can’t perform that action at this time.