chriseng / nestgraph

Create pretty charts of your Nest thermostat data

nestgraph

Create pretty charts of your Nest thermostat data.

Background

The point of this project was to see how well the Nest algorithms work. In particuar, the Nest claims to minimize overshoot, which is a common problem with cast-iron radiators. It also claims to know when to start heating in order to hit your target temperature exactly at the time you scheduled it.

Unfortunately, you can't actually access historical temperature data on the Nest website or via the iOS app. It shows you when heating was turned on/off and what the temperature targets were at those times, but it doesn't give you any indication of how well or how poorly the thermostat performed. This could be by design, as it's a lot of information to store.

This project uses an unofficial Nest API to pull your temperature readings periodically and store them in a database so that you can inspect the data yourself in an easily consumable form.

I also wanted an excuse to play with the D3 (Data-Driven Documents) library a little.

Features

• Polls Nest website to collect thermostat telemetry
• Stores selected data in local MySQL database
• Generates a nice visualization of actual temp vs. set point
• Lower mini-chart is interactive pan-and-zoom of the upper chart
• Hover over the gray circles to get the exact timestamp and temperature

Dependencies

• LAMP stack
• Unofficial nest-api library by Guillaume Boudreau

Getting Started

Clone this repo into your web root.

cd [your-web-root]
git clone https://github.com/chriseng/nestgraph.git

Grab a copy of nest-api and unzip into the nestgraph directory you created in the previous step. It should create a subdirectory called nest-api-master.

cd nestgraph
wget https://github.com/gboudreau/nest-api/archive/master.zip
unzip master.zip
rm -f master.zip

Open inc/config.php in a text editor and update the nest_user and nest_pass variables with your username and password for nest.com. Update the local_tz variable to reflect your time zone.

As of January 2020, the nest-api library is unable to authenticate directly to the Google Nest API. So instead you have to copy/paste in a session credential which will be cached and used until it expires. At which point you have to do it again. Run the nest-api-php-workaround-login.php script (copied into this repo from its original location), and follow the instructions.

php nest-api-php-workaround-login.php

Once you've done that, run the test script to make sure that the API is able to pull your thermostat data correctly from nest.com.

php test.php

If this works, you should see a bunch of stuff fly across the screen, ending with something like this:

Heating             : 0
Timestamp           : 2013-01-15 22:10:39
Target temperature  : 67.00
Current temperature : 67.53
Current humidity    : 29

Choose a password for your local MySQL nest database, and update it in two places: inc/config.php (the db_pass variable) and dbsetup.

As root or using a DBA account, run the commands in dbsetup to create the MySQL database that will be used to store historical data.

mysql -u root < dbsetup

Create a cron job to poll the website periodically and update the local database. The thermostat does not phone home on a fixed schedule, but typically it updates in 5 to 30 minute intervals. The script will only insert into the database if there is new data available. Obviously, update the path to insert.php if it's not in /var/www/html/nestgraph.

*/5 * * * *     /usr/bin/php /var/www/html/nestgraph/insert.php > /dev/null

Optionally, create a cron job to check periodically if your cached session credential is still valid and if your thermostat has gone offline. I have mine run every 30 minutes; adjust as appropriate. Populate the recipient email(s) in check_nest.sh if you want email notifications, then add the crontab entry, again updating the below to use the appropriate execution path for your system.

*/30 * * * *    /var/www/html/nestgraph/check_nest.sh

Point web browser to the nestgraph directory on your webserver! Admire pretty graphs (actually, they won't be all that pretty until it has collected some data).

Known Issues

• Only checks for heating on/off, not cooling (I don't have cooling)
• Only supports a single Nest thermostat (I only have one)
• Heating on/off trendline lazily mapped on to the temperature graph
• Assumes you want temperatures displayed in Fahrenheit
• Doesn't automatically redraw when you resize the browser window
• Labels (current/target/heating) don't follow the trend lines when you pan/zoom
• Have to manually update session credential each time it expires due to Jan 2020 login changes

nestgraph's Issues

Working in celcius

Trying to decode the index.html to find the setting for changing the y axis so it is a sensible range for degrees celcius - any ideas?

fetch.php should be parent directory agnostic

Thanks for this. I'm amazed Nest doesn't have this type of funcionality built into their app... Anyways,

I used /nest/ on my web server rather than /nestgraph/ and it looks like you have one line that relies on /nestgraph/ directory being used. Line 144 of index.html is:

// fetch the data
d3.tsv("/nestgraph/fetch.php?hrs=" + hours, function(error, data) {

I suggest:
// fetch the data
d3.tsv("fetch.php?hrs=" + hours, function(error, data) {

Current and Target Temperature is not correct

Heating : 0 Timestamp : 2013-04-10 22:09:06 Target temperature : 166.79 Current temperature : 167.94 Current humidity : 47

Update to 'official' Nest API?

Hi,

This looks like exactly what I want. Are there any plans to update it to use the 'official' Nest API?

https://developers.nest.com/

Andy

Google takeout data json

I don't know if you are aware but Google takeout let's you export all your data as far as three years. Was hoping to use this repo to graph but you use a different method for the data.

Weather data?

It'd be very cool to graph outdoor temperature as well. And then maybe even runtime normalized by heating degree days. ;)