Giter Site home page Giter Site logo

mmm-nest's Introduction

Module: MMM-Nest

The MMM-Nest module is a MagicMirror addon. This module displays your Nest's data on your Mirror

Nest Display Mode (Only 1 Thermostat at a time) List Display Mode (Good for multiple Thermostats)

Installing the module

run git clone https://github.com/mochman/MMM-Nest.git 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-Nest',
		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

mmm-nest's People

Contributors

mochman avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.