Skip to content
forked from zpeters/nerdnest

Control your Nest device from the command line

License

Notifications You must be signed in to change notification settings

tturner/nerdnest

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

nerdnest

Control your Nest device from the command line

Build Status Go Report Card Github All Releases

Setup

  1. Enable developer mode and allow access to your nest
  1. Register nerdnest with your developer account
  1. Choose the device you want to control
  1. Make sure your settings from step 2 and 3 are saved into your nerdnest.toml file. This file can be in:
  • $HOME/.nerdnest/nerdnest.toml
  • CURRENTDIRECTORY/nerdnest.toml
  • Submit a new issue for additional paths

Usage

Usage:
  nerdnest [command]

Available Commands:
  away        'home' or 'away'
  status      Current Status
  temp        Set target temp
  register    Register with nest
  list        List devices

Flags:
  -h, --help   help for nest

Use "nerdnest [command] --help" for more information about a command.

Current Status

./nerdnest status
Name: Nest
Current Temp: 69
Target Temp: 69
Humidity: 45
State: off
Device ID: KoTA9-raY9xdYrYY036u2rgaeP_lJ-mg
Structure ID: Suha_CVEVHdOreQFLWC-XlHaPXSRHcEwOb8dKkwYIjcVN0XCBSnKLQ

Set away status

No output is sent after the command runs

./nerdnest away home
./nerdnest away home

Set temperature

./nerdnest temp 70
./nerdnest status
Name: Nest
Current Temp: 69
Target Temp: 70
Humidity: 45
State: heating
Device ID: KoTA9-raY9xdYrYY036u2rgaeP_lJ-mg
Structure ID: Suha_CVEVHdOreQFLWC-XlHaPXSRHcEwOb8dKkwYIjcVN0XCBSnKLQ

./nerdnest temp 68
./nerdnest status
Name: Nest
Current Temp: 69
Target Temp: 68
Humidity: 45
State: off
Device ID: KoTA9-raY9xdYrYY036u2rgaeP_lJ-mg
Structure ID: Suha_CVEVHdOreQFLWC-XlHaPXSRHcEwOb8dKkwYIjcVN0XCBSnKLQ

Set default device

./nerdnest setdefault
Nest: raY9xdYrYY036u2rgaeP_lJ
Kitchen: ku34h5kjefhkdsjfhsdf
Enter default device ID from above list: ku34h5kjefhkdsjfhsdf 

./nerdnest status
Name: Kitchen
Current Temp: 69
Target Temp: 70
Humidity: 45
State: heating
Device ID: ku34h5kjefhkdsjfhsdf
Structure ID: Suha_CVEVHdOreQFLWC-XlHaPXSRHcEwOb8dKkwYIjcVN0XCBSnKLQ

./nerdnest status ku34h5kjefhkdsjfhsdf
Name: Nest
Current Temp: 69
Target Temp: 68
Humidity: 45
State: off
Device ID: KoTA9-raY9xdYrYY036u2rgaeP_lJ-mg
Structure ID: Suha_CVEVHdOreQFLWC-XlHaPXSRHcEwOb8dKkwYIjcVN0XCBSnKLQ

Multiple device support

All commands that interact with a Nest can either use the default device from your config file or you can specify a device ID e.g.

./nerdnest temp 70
./nerdnest temp 75 ku34h5kjefhkdsjfhsdf
./nerdnest status
./nerdnset status ku34h5kjefhkdsjfhsdf

To set the default device, even you only have one, run the setdefault command:

./nerdnest setdefault
Nest: raY9xdYrYY036u2rgaeP_lJ
Kitchen: ku34h5kjefhkdsjfhsdf
Enter default device ID from above list: ku34h5kjefhkdsjfhsdf

Configuration keys

accesstoken = "ACCESSTOKEN"

mythermostat = "MYDEVICEID"

units = "[f|F|c|C]"

logfile = "/PATH/TO/OPTIONAL/LOG/FILE"

logformat = "[csv|json]"

Choosing units for temperature

By default nerdnest uses Farenheit for temperature both to display the status and when setting temperature. You can override this behavior by adding a configuration key called units and setting it to either "c" or "C".

For Farenheit you must specify the temperature in whole numbers e.g. 70, 75 For Celcius you can specify half units as well e.g. 19, 20.5, 23.5

Saving a log

If you specify the logfile configuration option, whenever you run ./nerdnest status it will append the information it receives to that file in either csv or json format. You could use this with crontab to record statistics for your Nest over long periods (and even plot them on charts).

Use the logformat configuration option to specify if you want csv or json. The csv format contains fewer fields.

NOTE: If you use this library to create an application for other people, you should read the Nest Developer Terms of Service as there is a specific rule about how long you are allowed to retain the data.

About

Control your Nest device from the command line

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 96.2%
  • Shell 3.8%