https://github.com/jasonmit/nest-cli
Unofficial command-line tool to control Nest devices
https://github.com/jasonmit/nest-cli
Last synced: about 2 months ago
JSON representation
Unofficial command-line tool to control Nest devices
- Host: GitHub
- URL: https://github.com/jasonmit/nest-cli
- Owner: jasonmit
- License: mit
- Created: 2015-08-16T05:19:36.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-12-09T03:24:13.000Z (over 8 years ago)
- Last Synced: 2025-04-18T00:55:05.283Z (about 2 months ago)
- Language: JavaScript
- Size: 60.5 KB
- Stars: 13
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# nest-cli
[](http://badge.fury.io/js/nest-cli)
An unofficial command-line tool for managing your Nest thermostat. This was built as an exercise for learning the API. Pull requests are welcome if you experience issues or want to improve the feature set.
## Requirements
* node 6
## Installing
### From Source
* `git clone [email protected]:jasonmit/nest-cli.git`
* `cd nest-cli && npm install && npm link`
### From npm
* `npm install nest-cli`
### Configuring the application
* Register a Nest application https://developers.nest.com/products/new
* Set the Return URI to `https://localhost:8000/auth`
* Be sure to check: Away, Thermostat, Smoke+CO Alarm all with read/write access
* Copy the generated product ID and product secret
* `nest-cli config PRODUCT_ID `
* `nest-cli config PRODUCT_SECRET `
* `nest-cli login` (if a window does not open, navigate to `http://localhost:3000/auth/nest`)
* Done, you never have to do this again.
## Usage
`nest-cli --help`
```sh
Commands:
login login to your nest account via oauth
logout logout of nest account
config [value] get/set a configuration option
default-thermostat sets the default thermostat device id
devices|ls [options] get a list of known devices
temp|t [thermostatId] modes: cool, heat, heat-cool
away [structureId] available modes: home, away, auto-away, unknown
structures [options] list of structures associated with account
state|s [thermostatId] available modes: cool, heat, heat-cool, off
read|r [thermostatId] read a thermostat by device id
off [thermostatId] turns off the HVAC
Options:
-h, --help output usage information
-V, --version output the version number
```
## Set Default Thermostat
To avoid the tedious task of entering in your thermostat device ID each time, you can mark a thermostat as the default.
List all devices linked to your account:
`nest-cli ls`
Once you determine which device you want to mark as your default:
`nest-cli default-thermostat `
## TODO
* Live UI for monitoring stats (https://github.com/yaronn/blessed-contrib)
* Fan mode
* Fan scheduling
* Away mode
* Support Nest cam and Nest protect
## License
The MIT License (MIT)
Copyright (c) 2015
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.