Skip to content

Repository files navigation

Module: MMM-Ecowatt

This module displays the current level of signal of ecowatt set by RTE for metropolitan france, including description and graph.

Message, Graph and Color Legend display may be enabled or disabled independently. The number of days to display can be fixed.

MMM-Ecowatt Screenshot #1 MMM-Ecowatt Screenshot #2 MMM-Ecowatt Screenshot #3

MagicMirror Project on Github | Ecowatt

⚠️ MMM-Ecowatt 2.1 (December 2023) uses the new EcoWatt API (v5). Don’t forget to subscribe to EcoWatt v5 on RTE API portal and attach it to your application to continue using your current token!

Installation:

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

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/tttooommm56/MMM-Ecowatt

Go to your MMM-Ecowatt's Module folder:

cd ~/MagicMirror/modules/MMM-Ecowatt

Install dependencies:

npm install

Configure the module in your config.js file.

Update:

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

cd ~/MagicMirror/modules/MMM-Ecowatt

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-Ecowatt",
		position: "top_left",
		config: {
			apiTokenBase64: "your_api_token_base64",
		}
	}
]

Options

The following properties can be configured:

Option Description
apiTokenBase64 The Ecowatt API Token (base-64 encoded), which can be obtained by subscribing on RTE API portal and by clicking on the Copier en base 64 button in your applications. It's free!

This value is REQUIRED
days Number of days to display.

Possible values: 1 - 4
Default value: 1 (1 day)
updateInterval How often does the content needs to be fetched? (Milliseconds)

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

Possible values:0 - 5000
Default value: 1000 (1 second)
showText Show the ecowatt message for the next days (for days > 1).

Possible values: true or false
Default value: true
showGraph Show the ecowatt detail graph for each day.

Possible values: true or false
Default value: true
showCarbonFreeProduction Display ecowatt indication for carbon-free production (leaf icon in the chart).

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
apiBaseUrl The RTE API base URL.

Default value: 'https://digital.iservices.rte-france.com'
apiOAuthPath The OAuth API endPoint.

Default value: '/token/oauth/'
apiSignalsPath The Signals API endPoint.

Default value: '/open_api/ecowatt/v4/signals'

License:

This module is licensed under the MIT License

About

A MagicMirror module to display Ecowatt informations

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages