[sudo] pip install python-nestNOTE The 4.x version uses the streaming endpoint. To use the older
polling/caching behavior pin your requirements to python-nest<4.0.
NOTE The 3.x version uses the Nest official api. As such, some functionality
was removed as it is not available. To keep the old version and functionality, make sure to set
your requirements to python-nest<3.0.
You will need a Nest developer account, and a Product on the Nest developer portal to use this module:
- Visit Nest Developers, and sign in. Create an account if you don't have one already.
- Fill in the account details:
- The "Company Information" can be anything.
- Submit changes.
- Click "Products" at top of page.
- Click "Create New Product"
- Fill in details:
- Product name must be unique.
- The description, users, urls can all be anything you want.
- For permissions, check every box and if it's an option select the read/write option.
- The description requires a specific format to be accepted.
- Click "Create Product".
- Once the new product page opens the "Product ID" and "Product Secret" are located on the right side. These will be used as client_id and client_secret below.
The version 4.x uses Nest Stream API, so that you can get nearly real time status update of your Nest devices.
- If you use python-nest as a command line tool:
- You don't need to change, but there is a new command line option
--keep-aliveyou can give a try. - If you use python-nest in a poll loop, to query Nest device's property in certain period, there are several noticeable changes:
- The internal cache removed, the
StructureandDeviceobjects will always return their current state presented in Nest API. - A persistence HTTP connection will keep open for each
Nestobject. Therefore, please avoid to create more than one Nest object in your program. - Your poll query would not hit the API rate limit, you can increase your poll frequency.
- The internal cache removed, the
- If you want to change to Push mode:
- You need to listen
Nest.update_event. Please note, any data change in all of your structures an devices will set theupdate_event. You don't know which field got update.
import nest
napi = nest.Nest(client_id=client_id, client_secret=client_secret, access_token_cache_file=access_token_cache_file)
while napi.update_event.wait():
napi.update_event.clear()
# assume you have one Nest Camera
print (napi.structures[0].cameras[0].motion_detected)- If you use asyncio:
- You have to wrap
update_event.wait()in anThreadPoolExecutor, for example:
import asyncio
import nest
napi = nest.Nest(client_id=client_id, client_secret=client_secret, access_token_cache_file=access_token_cache_file)
event_loop = asyncio.get_event_loop()
try:
event_loop.run_until_complete(nest_update(event_loop, napi))
finally:
event_loop.close()
async def nest_update(loop, napi):
with ThreadPoolExecutor(max_workers=1) as executor:
while True:
await loop.run_in_executor(executor, nest.update_event.wait)
nest.update_event.clear()
# assume you have one Nest Camera
print (napi.structures[0].cameras[0].motion_detected)You can import the module as nest.
import nest
import sys
client_id = 'XXXXXXXXXXXXXXX'
client_secret = 'XXXXXXXXXXXXXXX'
access_token_cache_file = 'nest.json'
napi = nest.Nest(client_id=client_id, client_secret=client_secret, access_token_cache_file=access_token_cache_file)
if napi.authorization_required:
print('Go to ' + napi.authorize_url + ' to authorize, then enter PIN below')
if sys.version_info[0] < 3:
pin = raw_input("PIN: ")
else:
pin = input("PIN: ")
napi.request_token(pin)
for structure in napi.structures:
print ('Structure %s' % structure.name)
print (' Away: %s' % structure.away)
print (' Security State: %s' % structure.security_state)
print (' Devices:')
for device in structure.thermostats:
print (' Device: %s' % device.name)
print (' Temp: %0.1f' % device.temperature)
# Access advanced structure properties:
for structure in napi.structures:
print ('Structure : %s' % structure.name)
print (' Postal Code : %s' % structure.postal_code)
print (' Country : %s' % structure.country_code)
print (' num_thermostats : %s' % structure.num_thermostats)
# Access advanced device properties:
for device in structure.thermostats:
print (' Device: %s' % device.name)
print (' Where: %s' % device.where)
print (' Mode : %s' % device.mode)
print (' HVAC State : %s' % device.hvac_state)
print (' Fan : %s' % device.fan)
print (' Fan Timer : %i' % device.fan_timer)
print (' Temp : %0.1fC' % device.temperature)
print (' Humidity : %0.1f%%' % device.humidity)
print (' Target : %0.1fC' % device.target)
print (' Eco High : %0.1fC' % device.eco_temperature.high)
print (' Eco Low : %0.1fC' % device.eco_temperature.low)
print (' hvac_emer_heat_state : %s' % device.is_using_emergency_heat)
print (' online : %s' % device.online)
# The Nest object can also be used as a context manager
# It is only for demo purpose, please do not create more than one Nest object in your program especially after 4.0 release
with nest.Nest(client_id=client_id, client_secret=client_secret, access_token_cache_file=access_token_cache_file) as napi:
for device in napi.thermostats:
device.temperature = 23
# Nest products can be updated to include other permissions. Before you
# can access them with the API, a user has to authorize again. To handle this
# and detect when re-authorization is required, pass in a product_version
client_id = 'XXXXXXXXXXXXXXX'
client_secret = 'XXXXXXXXXXXXXXX'
access_token_cache_file = 'nest.json'
product_version = 1337
# It is only for demo purpose, please do not create more than one Nest object in your program especially after 4.0 release
napi = nest.Nest(client_id=client_id, client_secret=client_secret, access_token_cache_file=access_token_cache_file, product_version=product_version)
print("Never Authorized: %s" % napi.never_authorized)
print("Invalid Token: %s" % napi.invalid_access_token)
print("Client Version out of date: %s" % napi.client_version_out_of_date)
if napi.authorization_required is None:
print('Go to ' + napi.authorize_url + ' to authorize, then enter PIN below')
pin = input("PIN: ")
napi.request_token(pin)
# NOTE: By default all datetime objects are timezone unaware (UTC)
# By passing ``local_time=True`` to the ``Nest`` object datetime objects
# will be converted to the timezone reported by nest. If the ``pytz``
# module is installed those timezone objects are used, else one is
# synthesized from the nest data
napi = nest.Nest(username, password, local_time=True)
print napi.structures[0].weather.current.datetime.tzinfoIn the API, all temperature values are reported and set in the temperature scale
the device is set to (as determined by the device.temperature_scale property).
Helper functions for conversion are in the utils module:
from nest import utils as nest_utils
temp = 23.5
fahrenheit = nest_utils.c_to_f(temp)
temp == nest_utils.f_to_c(fahrenheit)The utils function use decimal.Decimal to ensure precision.
usage: nest [-h] [--conf FILE] [--token-cache TOKEN_CACHE_FILE] [-t TOKEN]
[--client-id ID] [--client-secret SECRET] [-k] [-c] [-s SERIAL]
[-S STRUCTURE] [-i INDEX] [-v]
{temp,fan,mode,away,target,humid,target_hum,show,camera-show,camera-streaming,protect-show}
...
Command line interface to Nest™ Thermostats
positional arguments:
{temp,fan,mode,away,target,humid,target_hum,show,camera-show,camera-streaming,protect-show}
command help
temp show/set temperature
fan set fan "on" or "auto"
mode show/set current mode
away show/set current away status
target show current temp target
humid show current humidity
target_hum show/set target humidty
show show everything
camera-show show everything (for cameras)
camera-streaming show/set camera streaming
protect-show show everything (for Nest Protect)
optional arguments:
-h, --help show this help message and exit
--conf FILE config file (default ~/.config/nest/config)
--token-cache TOKEN_CACHE_FILE
auth access token cache file
-t TOKEN, --token TOKEN
auth access token
--client-id ID product id on developer.nest.com
--client-secret SECRET
product secret for nest.com
-k, --keep-alive keep showing update received from stream API in show
and camera-show commands
-c, --celsius use celsius instead of farenheit
-s SERIAL, --serial SERIAL
optional, specify serial number of nest thermostat to
talk to
-S STRUCTURE, --structure STRUCTURE
optional, specify structure name toscope device
actions
-i INDEX, --index INDEX
optional, specify index number of nest to talk to
-v, --verbose showing verbose logging
examples:
# If your nest is not in range mode
nest --conf myconfig --client-id CLIENTID --client-secret SECRET temp 73
# If your nest is in range mode
nest --conf myconfig --client-id CLIENTID --client-secret SECRET temp 66 73
nest --conf myconfig --client-id CLIENTID --client-secret SECRET fan --auto
nest --conf myconfig --client-id CLIENTID --client-secret SECRET target_hum 35
# nestcam examples
nest --conf myconfig --client-id CLIENTID --client-secret SECRET camera-show
nest --conf myconfig --client-id CLIENTID --client-secret SECRET camera-streaming --enable-camera-streaming
# Stream API example
nest --conf myconfig --client-id CLIENTID --client-secret SECRET --keep-alive show
nest --conf myconfig --client-id CLIENTID --client-secret SECRET --keep-alive camera-show
# Set ETA 5 minutes from now
nest --conf myconfig --client-id CLIENTID --client-secret SECRET away --away --eta 5A configuration file must be specified and used for the credentials to communicate with the NEST Thermostat initially. Once completed and a token is generated, if you're using the default location for the token, the command line option will read from it automatically.
[NEST]
client_id = your_client_id
client_secret = your_client_secret
token_cache = ~/.config/nest/token_cacheThe [NEST] section may also be named [nest] for convenience. Do not use [DEFAULT] as it cannot be read
This module was originally a fork of nest_thermostat which was a fork of pynest
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent