Skip to content

jclarke0000/MMM-MyNest

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Module: MMM-MyNest

The MMM-MyNest module is a MagicMirror addon.

It is a fork of MMM-Nest by Luke Moch https://github.com/mochman/MMM-Nest

This module displays your Nest Thermostat data on your Mirror

Screenshot 1 Screenshot 2

NOTE I haven't tested this with multiple thermostats, or with list mode. I only have one Nest in my home, and list mode kind of defeats the reason why I modified this module, which was to make the module look very close to what you see in the Nest app.

Installing the module

run git clone https://github.com/jclarke0000/MMM-MyNest from inside your MagicMirror/modules folder

Getting the Nest Token

Run getToken.sh. This will walk you through getting a token to allow this module to get data from your Nest. It requires you to set up a Nest Developer Account.

Known Issues

If you have a family account, make sure you get the PIN with your master account's login (not a account you shared the thermostat with).

Using the module

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

modules: [
	{
		module: 'MMM-MyNest',
		position: 'bottom_right',	// This can be any of the regions.
									// Best results in one of the side regions like: top_left
		config: {
			// See 'Configuration options' for more information.
			token: '1234567890zbcdefghijkl', //Nest Token - REQUIRED
			thermNum: 3, //Choose which thermostat - REQUIRED if you have multiple thermostats on the same account
			displayName: true, //Display the thermostat name
			displayType: "nest" //Choose either the Nest display or a list
		}
	}
]

Choosing your thermostat

Do not enter a thermNum: in your config.js. The module will list your available thermostats. You will then be presented with a list of your thermostats to pick from.

Choose Thermostat

Configuration options

The following properties can be configured:

Option Description
token Used to get data from your Nest

Example: c.alkjsfkljadsfj234....
This value is REQUIRED
thermNum Used to choose which thermostat is shown

Example: 2
This value is REQUIRED only if you have multiple thermostats
displayName Display the thermostat name

Example: true
Default value: false
displayType Choose how the data is displayed

Possible values: "list", "nest"
Default value: "nest"
units What units to use. Specified by config.js

Possible values: config.units = Specified by config.js, metric = Celsius, imperial =Fahrenheit
Default value: config.units
updateInterval How often this refreshes

Example: 60000
Nest recommends a call every minute or greater.
Default value: 60000

Using the Akkurat font

The Nest Thermostst's display and the Nest app both use a font called Akkurat. The module will use this font if available, but as it is a licensed font, it is not included in this repo. It is optional -- the module will fall back to Roboto if Akkurat isn;t available -- but if you would like to use it, accquire the font on your own in webfopnt format, either woff or woff2.

the font must be named akkurat-webfont.woff or akkurat-webfont.woff2, and it needs to be in a folder named Akkurat in MagicMirror's fonts folder.

About

Display Nest Thermostat data on your MagicMirror

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 57.8%
  • CSS 30.3%
  • Shell 11.9%