Nest Binding - juri8/openhab GitHub Wiki
Note: This Binding is available in 1.7 and later releases.
- Introduction
- Binding Configuration
- Item configuration
- Handling special characters
- Binding Examples
- Logging
- Known Issues
- Change Log
Nest Labs developed the Wi-Fi enabled Nest Learning Thermostat, the Nest Protect Smoke+CO detector, and the Nest Cam. These devices are supported by this binding, which communicates with the Nest API over a secure, RESTful API to Nest's servers. Monitoring ambient temperature and humidity, changing HVAC mode, changing heat or cool setpoints, monitoring and changing your "home/away" status, and monitoring your Nest Protects and Cams can be accomplished through this binding.
For installation of the binding JAR on your system, please see the Wiki page Bindings.
In order to use this binding, you will have to register as a Nest Developer and Register a new client. Make sure to grant all the permissions you intend to use. At this point, you will have your nest:client_id and nest:client_secret.
Once you've created your client as above, paste the Authorization URL into a new tab in your browser. This will have you login to your normal Nest account, and will then present the nest:pin_code. Prepare to copy and paste your values for nest:client_id, nest:client_secret and nest:pin_code in order to configure the binding.
Edit the file openhab.cfg located in ${openhab_home}/configurations/. Paste all three of these values into your openhab.cfg file like so (using your values):
############################## Nest binding ########################################
#
# Data refresh interval in ms (optional, defaults to 60000)
# nest:refresh=60000
# the Client ID for the client you created (replace with your own)
nest:client_id=e5cc5558-ec55-4c55-8555-4b95555f4979
# the Client Secret for the client you created (replace with your own)
nest:client_secret=ZZo28toiuoiurok4WjUya1Bnc
# the PIN code that was generated when you authorized your account to allow
# this client
nest:pin_code=2JTXXXJL
An optional refresh interval setting may also be specified, via the nest:refresh parameter, and defaults to a polling rate of one call per every 60000ms (one minute).
nest:refresh not be set lower than 60000.
nest:refresh=60000
In order to bind an Item to a supported Nest product's properties, you need to provide configuration settings by adding some binding information in your .item file (in configurations/items/). The syntax for the Nest binding configuration string is explained below.
Nest bindings start with a <, > or =, to indicate if the Item receives values from the API (in binding), sends values to the API (out binding), or both (bidirectional binding), respectively.
The first character is then followed by a section between square brackets ([and ] characters):
<[<property>]
where <property> is one of a long list of properties than you can read and optionally change. See the list below, and peruse the Nest API Reference for all specifics as to their meanings.
Since device and structure identifiers are very long, cryptic strings that are hard to learn, binding configurations allow you to use the device's textual name as a reference. Whatever name you see in the web or mobile client is the name you would supply in an Item's binding configuration. So, for example, in order to determine the current humidity detected at the thermostat named 'Living Room', your binding configuration would look like this:
Number NestTStatUpstairs_humidity "Humidity [%d %%]" {nest="<[thermostats(Living Room).humidity]"}
With the convenience of using simple names for structures, thermostats and smoke+CO detectors, comes the price of having to handle special characters in the names. Any characters in a name that could interfere with the parsing of the binding configuration string need to be either 1) removed from the device name in your account at nest.com, or 2) replaced with "URL-encoded" versions. The characters that have to be replaced are [, ], (, ), ,, . and +. Here are some examples:
| What you see at nest.com | The escaped version to use in the Nest binding |
|---|---|
| Dining Room (Ground Floor) | Dining Room %28Ground Floor%29 |
| Den Smoke+CO | Den Smoke%2BCO |
| 123 Main St. | 123 Main St%2E |
| Bogota, Colombia | Bogota%2C Colombia |
| [Basement] | %5BBasement%5D |
To reiterate, you could change the display names of your devices at nest.com, and thereby avoid having to put escaped versions in your binding configuration strings.
In order to change the current HVAC mode of the Living room thermostat between off, heat, cool and heat-cool, your Item would look like:
String NestTStatUpstairs_hvac_mode "HVAC Mode [%s]" {nest="=[thermostats(Living Room).hvac_mode]"}
When you update the device with one of the four possible valid strings, you will change the HVAC mode.
Below are some examples of valid binding configuration strings, as you would define in the your .items file. The examples represent the current set of available properties, and for each property, the example shows if it is an in-binding only (read-only), an out-binding only (write-only), or a bidirectional (read/write) binding only. Note, however, that if a read/write property is only authorized for read-only access in the client you authorized, an attempt to change its value will fail.
In this example, there is a Nest structure called Home, a Thermostat called Upstairs, a Smoke/CO Sensor called Master Bedroom and a Nest Cam called Dining Room.
/* Nest binding Items */
DateTime Nest_last_connection "Last Nest Connection [%1$tm/%1$td %1$tH:%1$tM]" {nest="<[last_connection]"}
/* Structures - change Home to your structure's name */
String NestHome_name "Name [%s]" {nest="<[structures(Home).name]"}
String NestHome_country_code "Country Code [%s]" {nest="<[structures(Home).country_code]"}
String NestHome_postal_code "Postal Code [%s]" {nest="<[structures(Home).postal_code]"}
String NestHome_time_zone "Time Zone [%s]" {nest="<[structures(Home).time_zone]"}
String NestHome_away "Away [%s]" {nest="=[structures(Home).away]"}
String NestHome_structure_id "Structure Id [%s]" {nest="<[structures(Home).structure_id]"}
/* Thermostats - change Upstairs to your thermostat's name */
Number NestTStatUpstairs_humidity "Humidity [%d %%]" {nest="<[thermostats(Upstairs).humidity]"}
String NestTStatUpstairs_locale "Locale [%s]" {nest="<[thermostats(Upstairs).locale]"}
String NestTStatUpstairs_temperature_scale "Temperature Scale [%s]" {nest="<[thermostats(Upstairs).temperature_scale]"}
Switch NestTStatUpstairs_is_using_emergency_heat "Is using emergency heat [%s]" {nest="<[thermostats(Upstairs).is_using_emergency_heat]"}
Switch NestTStatUpstairs_has_fan "Has Fan [%s]" {nest="<[thermostats(Upstairs).has_fan]"}
String NestTStatUpstairs_software_version "Software Version [%s]" {nest="<[thermostats(Upstairs).software_version]"}
Switch NestTStatUpstairs_has_leaf "Has Leaf [%s]" {nest="<[thermostats(Upstairs).has_leaf]"}
String NestTStatUpstairs_device_id "Device Id [%s]" {nest="<[thermostats(Upstairs).device_id]"}
String NestTStatUpstairs_name "Name [%s]" {nest="<[thermostats(Upstairs).name]"}
Switch NestTStatUpstairs_can_heat "Can Heat [%s]" {nest="<[thermostats(Upstairs).can_heat]"}
Switch NestTStatUpstairs_can_cool "Can Cool [%s]" {nest="<[thermostats(Upstairs).can_cool]"}
String NestTStatUpstairs_hvac_mode "HVAC Mode [%s]" {nest="=[thermostats(Upstairs).hvac_mode]"}
Number NestTStatUpstairs_target_temperature_c "Target Temperature [%.1f °C]" {nest="=[thermostats(Upstairs).target_temperature_c]"}
Number NestTStatUpstairs_target_temperature_f "Target Temperature [%.1f °F]" {nest="=[thermostats(Upstairs).target_temperature_f]"}
Number NestTStatUpstairs_target_temperature_high_c "Target Temperature High [%.1f °C]" {nest="=[thermostats(Upstairs).target_temperature_high_c]"}
Number NestTStatUpstairs_target_temperature_high_f "Target Temperature High [%.1f °F]" {nest="=[thermostats(Upstairs).target_temperature_high_f]"}
Number NestTStatUpstairs_target_temperature_low_c "Target Temperature Low [%.1f °C]" {nest="=[thermostats(Upstairs).target_temperature_low_c]"}
Number NestTStatUpstairs_target_temperature_low_f "Target Temperature Low [%.1f °F]" {nest="=[thermostats(Upstairs).target_temperature_low_f]"}
Number NestTStatUpstairs_ambient_temperature_c "Ambient Temperature [%.1f °C]" {nest="<[thermostats(Upstairs).ambient_temperature_c]"}
Number NestTStatUpstairs_ambient_temperature_f "Ambient Temperature [%.1f °F]" {nest="<[thermostats(Upstairs).ambient_temperature_f]"}
Number NestTStatUpstairs_away_temperature_high_c "Away Temperature High [%.1f °C]" {nest="<[thermostats(Upstairs).away_temperature_high_c]"}
Number NestTStatUpstairs_away_temperature_high_f "Away Temperature High [%.1f °F]" {nest="<[thermostats(Upstairs).away_temperature_high_f]"}
Number NestTStatUpstairs_away_temperature_low_c "Away Temperature Low [%.1f °C]" {nest="<[thermostats(Upstairs).away_temperature_low_c]"}
Number NestTStatUpstairs_away_temperature_low_f "Away Temperature Low [%.1f °F]" {nest="<[thermostats(Upstairs).away_temperature_low_f]"}
String NestTStatUpstairs_structure_id "Structure Id [%s]" {nest="<[thermostats(Upstairs).structure_id]"}
Switch NestTStatUpstairs_fan_timer_active "Fan Timer Active [%s]" {nest="=[thermostats(Upstairs).fan_timer_active]"}
DateTime NestTStatUpstairs_fan_timer_timeout "Fan Timer Timeout [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" <calendar> {nest="<[thermostats(Upstairs).fan_timer_timeout]"}
String NestTStatUpstairs_name_long "Name Long [%s]" {nest="<[thermostats(Upstairs).name_long]"}
Switch NestTStatUpstairs_is_online "Is Online [%s]" {nest="<[thermostats(Upstairs).is_online]"}
DateTime NestTStatUpstairs_last_connection "Last Connection [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" <calendar> {nest="<[thermostats(Upstairs).last_connection]"}
/* Added in openHAB 1.7.1: */
String NestTStatUpstairs_hvac_state "HVAC State [%s]" {nest="<[thermostats(Upstairs).hvac_state]"}
/* Smoke+CO detectors - change Master Bedroom to your Smoke+CO detector's name */
String NestSmokeMaster_name "Name [%s]" {nest="<[smoke_co_alarms(Master Bedroom).name]"}
String NestSmokeMaster_locale "Locale [%s]" {nest="<[smoke_co_alarms(Master Bedroom).locale]"}
String NestSmokeMaster_structure_id "Structure Id [%s]" {nest="<[smoke_co_alarms(Master Bedroom).structure_id]"}
String NestSmokeMaster_software_version "Software Version [%s]" {nest="<[smoke_co_alarms(Master Bedroom).software_version]"}
String NestSmokeMaster_device_id "Device Id [%s]" {nest="<[smoke_co_alarms(Master Bedroom).device_id]"}
String NestSmokeMaster_name_long "Name Long [%s]" {nest="<[smoke_co_alarms(Master Bedroom).name_long]"}
Switch NestSmokeMaster_is_online "Is Online [%s]" {nest="<[smoke_co_alarms(Master Bedroom).is_online]"}
DateTime NestSmokeMaster_last_connection "Last Connection [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" <calendar> {nest="<[smoke_co_alarms(Master Bedroom).last_connection]"}
String NestSmokeMaster_battery_health "Battery Health [%s]" {nest="<[smoke_co_alarms(Master Bedroom).battery_health]"}
String NestSmokeMaster_smoke_alarm_state "Smoke Alarm State [%s]" {nest="<[smoke_co_alarms(Master Bedroom).smoke_alarm_state]"}
String NestSmokeMaster_co_alarm_state "CO Alarm State [%s]" {nest="<[smoke_co_alarms(Master Bedroom).co_alarm_state]"}
String NestSmokeMaster_ui_color_state "UI Color State [%s]" {nest="<[smoke_co_alarms(Master Bedroom).ui_color_state]"}
Switch NestSmokeMaster_is_manual_test_active "Is Manual Test Active [%s]" {nest="<[smoke_co_alarms(Master Bedroom).is_manual_test_active]"}
DateTime NestSmokeMaster_last_manual_test_time "Last Manual Test Time [%1$tm/%1$td/%1$tY %1$tH:%1$tM:%1$tS]" <calendar> {nest="<[smoke_co_alarms(Master Bedroom).last_manual_test_time]"}
/* Nest Cams (available as of openHAB 1.8) -- changing Dining Room to your Cam's name */
String NestCamDeviceId "CamDeviceId [%s]" {nest="<[cameras(Dining Room).device_id]"}
String NestCamSWVersion "CamSWVersion [%s]" {nest="<[cameras(Dining Room).software_version]"}
String NestCamName "CamName [%s]" {nest="<[cameras(Dining Room).name]"}
String NestCamNameLong "CamNameLong [%s]" {nest="<[cameras(Dining Room).name_long]"}
Switch NestCamIsOnline "CamIsOnline [%s]" {nest="<[cameras(Dining Room).is_online]"}
Switch NestCamIsStreaming "CamIsStreaming [%s]" {nest="=[cameras(Dining Room).is_streaming]"}
Switch NestCamIsAudioInputEnabled "CamIsAudioInputEnabled [%s]" {nest="<[cameras(Dining Room).is_audio_input_enabled]"}
DateTime NestCamLastIsOnlineChange "CamLastIsOnlineChange [%1$tm/%1$td %1$tH:%1$tM]" {nest="<[cameras(Dining Room).last_is_online_change]"}
Switch NestCamIsVideoHistoryEnabled "CamIsVideoHistoryEnable [%s]" {nest="<[cameras(Dining Room).is_video_history_enabled]"}
String NestCamWebUrl "CamWebUrl [%s]" {nest="<[cameras(Dining Room).web_url]"}
String NestCamAppUrl "CamAppUrl [%s]" {nest="<[cameras(Dining Room).app_url]"}
/* All last_event.* binding config strings require a Nest Aware with Video History subscription */
Switch NestCamLastEventHasSound "CamLastEventHasSound [%s]" {nest="<[cameras(Dining Room).last_event.has_sound]"}
Switch NestCamLastEventHasMotion "CamLastEventHasMotion [%s]" {nest="<[cameras(Dining Room).last_event.has_motion]"}
DateTime NestCamLastEventStartTime "CamLastEventStartTime [%1$tm/%1$td %1$tH:%1$tM]" {nest="<[cameras(Dining Room).last_event.start_time]"}
DateTime NestCamLastEventEndTime "CamLastEventEndTime [%1$tm/%1$td %1$tH:%1$tM]" {nest="<[cameras(Dining Room).last_event.end_time]"}
DateTime NestCamLastEventUrlsExpireTime "CamLastEventUrlsExpireTime [%1$tm/%1$td %1$tH:%1$tM]" {nest="<[cameras(Dining Room).last_event.urls_expire_time]"}
String NestCamLastEventWebUrl "CamLastEventWebUrl [%s]" {nest="<[cameras(Dining Room).last_event.web_url]"}
String NestCamLastEventAppUrl "CamLastEventAppUrl [%s]" {nest="<[cameras(Dining Room).last_event.app_url]"}
String NestCamLastEventImageUrl "CamLastEventImageUrl [%s]" {nest="<[cameras(Dining Room).last_event.image_url]"}
String NestCamLastEventAnimatedImageUrl "CamLastEventAnimatedImageUrl [%s]" {nest="<[cameras(Dining Room).last_event.animated_image_url]"}
/* You can reference a device in a specific structure in the case that there are duplicate names
* in multiple structures. If you have duplicate-named thermostats or smoke+CO detectors in the
* same structure, or duplicate-named structures, you will have to rename them at nest.com.
*/
Number NestHome_temp "Home temperature [%.1f °F]" {nest="<[structures(Home).thermostats(Dining Room).ambient_temperature_f]"}
Number NestCondo_temp "Condo temperature [%.1f °F]" {nest="<[structures(Condo).thermostats(Dining Room).ambient_temperature_f]"}
In order to configure logging for this binding to be generated in a separate file add the following to your /configuration/logback.xml file;
<appender name="NESTFILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>logs/nest.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- weekly rollover and archiving -->
<fileNamePattern>logs/nest-%d{yyyy-ww}.log.zip</fileNamePattern>
<!-- keep 30 days' worth of history -->
<maxHistory>30</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger{30}[:%line]- %msg%n%ex{5}</pattern>
</encoder>
</appender>
<!-- Choose level ERROR, WARN, INFO, DEBUG or TRACE for detailed logging -->
<logger name="org.openhab.binding.nest" level="TRACE" additivity="false">
<appender-ref ref="NESTFILE" />
</logger>- Multiple instance support (allowing the binding to access multiple Nest accounts at once) conflicts with Prohibition 3 of the Nest Developer Terms of Service, and so is not implemented.
- The Nest API rounds humidity to 5%, degrees Fahrenheit to whole degrees, and degrees Celsius to 0.5 degrees, so your Nest app will likely show slightly different values from what is available from the API.
- There is currently a bug where attempting to update an Item with a binding configuration of this form will not work:
Number NestCondo_temp "Condo Temperature [%.1f °F]" {nest="=[structures(Condo).thermostats(Dining Room).target_temperature_f]"}
While this form should work:
Number NestCondo_temp "Condo Temperature [%.1f °F]" {nest="=[thermostats(Dining Room).target_temperature_f]"}
- Added the property
hvac_statethat was added to the Nest API in May 2015. Please note that if you created your Nest client before the addition of this property to the API, your client's permissions may be set to "Thermostat read/write v2," which does not have access to this new property. To access it, you will have to edit your client to update the permission to v3. Click the little gear icon to edit your client, click the Change Permissions button, and generate a newnest:pin_codefor your nest.com account to put intoopenhab.cfgto replace the oldernest:pin_code. (#2659) - Very rarely, some updates to DateTime items would attempt to echo back as changes to the Nest API, generating log errors. (#2930)
- Added support for monitoring and turning on or off streaming from your Nest Cams. (#3232)