A module for the MagicMirror to display informations about your rooms climate from your Netatmo system.
JavaScript CSS
Clone or download
Latest commit bea324e Apr 8, 2018

README.md

Build Status Known Vulnerabilities code climate api License

MagicMirror-Netatmo-Module

A module to integrale informations from a Netatmo weather station into the MagicMirror.

Netatmo visualisation

Usage

Prerequisites

  • requires MagicMirror v2.0.0
  • a Netatmo weather station at home or at least access to a Netatmo weather station account

To use this module with the old module system, use this branch: https://github.com/CFenner/MagicMirror-Netatmo-Module/tree/rel-1.0

To use this module, just clone this repository to your modules folder of your MagicMirror: git clone https://github.com/CFenner/MagicMirror-Netatmo-Module.git netatmo

Now just add the module to your config.js file (config entries).

Access Your Data

To be able to access your data, you need to have an Netatmo Application and grant this application access to your data.

Register an App

Your can register a new app here. Afterwards you will get an APP_ID and an APP_SECRET which you will need to enter in the config entries.

Grant Access to Your Data

To allow the app to access your data, you need to send a POST request to the auth server and register the app.

cURL

One option is to use the command line tool cURL.

curl --data "grant_type=password&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&username=YOUR_NETATMO_USERNAME&password=YOUR_NETATMO_PASSWORD&scope=read_station" "https://api.netatmo.com/oauth2/token"

The POST request will return the following data:

{"access_token":"abc","refresh_token":"xyz","scope":["read_station"],"expires_in":10800,"expire_in":10800}

The REFRESH_TOKEN will be needed in the config entries.

Hurl.it

You can also send a POST request with Hurl.it(Git) to the Netatmo auth url: https://api.netatmo.com/oauth2/token

Also you need to provide the following data (add as parameters):

  • grant_type: password
  • client_id: [APP_ID]
  • client_secret: [APP_SECRET]
  • username: [USER_MAIL]
  • password: [USER_PASSWORD]
  • scope: read_station

The POST request will return the following data:

  • access_token: [ACCESS_TOKEN]
  • expires_in: 10800
  • refresh_token: [REFRESH_TOKEN]

The REFRESH_TOKEN will be needed in the config entries.

Configuration

The module needs the default configuration block in your config.js to work.

{
	module: 'netatmo',
	position: 'bottom_left', // the location where the module should be displayed
	config: {
		clientId: '', // your app id
		clientSecret: '', // your app secret
		refreshToken: '' // your generated refresh token
	}
}

The following properties can be configured:

Option Description
clientId The ID of your Netatmo application.

This value is REQUIRED
clientSecret The app secret of your Netatmo application.

This value is REQUIRED
refreshToken The generated refresh token you got from the POST request to the auth api.

This value is REQUIRED
refreshInterval How often does the content needs to be updated? (Minutes)
Data is updated by netatmo every 10 minutes.

Default value: 3
moduleOrder The rendering order of your weather modules, ommit a module to hide the output.

Example: ["Kitchen","Kid's Bedroom","Garage","Garden"]
Be aware that you need to use the module names that you set in the netatmo configuration.
dataOrder The rendering order of the data types of a module, ommit a data type to hide the output.

Example: ["Noise","Pressure","CO2","Humidity","Temperature","Rain"]