A Python CLI Nest Thermostat controller and dashborading tool
Project description
Version: v0.0.1-a1
py-nest-thermostat
Python CLI Nest Controller and Reporting Tool.
Disclaimer: This project is very much work in progress while in version 0 anything can change, anything can break and some parts of the code are probably very ugly. Feel free to test it, contribute (see CONTRIBUTING.md), report bugs
Get device stats:
Set Device Temperature:
Features:
- print device stats
- set target temperature
Future Features:
- capture device statistics into a database
- plot device statistics over time
- some ML?
Installation
The tool is intallable from PyPI via pip
or pipx
. But you must first set up access via Google's Developer console (which currently costs a one time $5 fee and is a bit of a pain).
Set Up Google and Authorization
This part of the process is a real pain, especially if you've never set up Authorization via Google. Luckily Wouter Nieuwerth made a really nice guide with pictures that I encourage you to check out
Google Documentation Links
Google has some pretty extensive documentation:
Once setup, you will be able to access your nest devicesc, and manage your authorizations in the following places:
If you have issues, and neither the step by step guide from Wouter nor the links above help you feel free to open an issue and if I have time I'll try and help out.
Install py-nest-thermostat
If you want to be able to access the tool from anywhere I recomment setting it up via pipx. Pipx will give you access to py-nest
globally while keeping it in an isolated python virtual environment. The best of both worlds really!
You can install with pipx like so:
pipx install py-nest-thermostat
Create your credentials file
nest
expects your credentials and other handy authentication parameters to be in an file named config.yaml
and it should be placed at this location ~/.py-nest-thermostat/
. We might implement the possibility to pass a custom location later. If you're too impatient feel free to help out! :)
You can find an example of this file here
If you prefer to use regular pip
, follow those steps:
- create a python3 virtual environment (with
venv
orvirtualenv
--up to you) - activate the virtual environment (
source /path/to/virtual/environment
) pip install py-nest-thermostat
Usage
Until I write some more extensive docs, once you have installed the tool use use the CLI --help
command
nest --help
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for py-nest-thermostat-0.0.1a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68117e7393bbd890dd9605391d3ca88ef5e9a6ebe5933fb039ee9411016789ef |
|
MD5 | 98ee4491181f40b110e37059c2a6f351 |
|
BLAKE2b-256 | d8f49b348a69b25ce494a814b8c4141c858bf599f3c82502f69b2cdfec44265f |
Hashes for py_nest_thermostat-0.0.1a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eedea30943e87d8b722c5e4147911ed29fc6ed7baab969c7f25487540ff3b440 |
|
MD5 | 29dce770c5bada0281b2686f5626c45d |
|
BLAKE2b-256 | b38f3e027cc4ca73043fc1060fa66b6486e5a85891daee5f243e30ac84196c40 |