Compare commits

..

1 Commits

Author SHA1 Message Date
Vladimir
06a95dda00 MSA-1386: nest proper 2016-07-05 18:23:34 -05:00
2 changed files with 471 additions and 600 deletions

View File

@@ -0,0 +1,471 @@
/**
* Nest Protect (Direct)
* Author: chad@monroe.io
* Author: nick@nickhbailey.com
* Author: dianoga7@3dgo.net
* Date: 2016.01.24
*
*
* INSTALLATION
* =========================================
* 1) Create a new device type from code (https://graph.api.smartthings.com/ide/devices)
* Copy and paste the below, save, publish "For Me"
*
* 2) Create a new device (https://graph.api.smartthings.com/device/list)
* Name: Your Choice
* Device Network Id: Your Choice
* Type: Nest Protect (should be the last option)
* Location: Choose the correct location
* Hub/Group: Leave blank
*
* 3) Update device preferences
* Click on the new device to see the details.
* Click the edit button next to Preferences
* Fill in your information.
* To find your serial number, login to http://home.nest.com. Click on the smoke detector
* you want to see. Under settings, go to Technical Info. Your serial number is
* the second item.
*
* Original design/inspiration provided by:
* -> https://github.com/sidjohn1/SmartThings-NestProtect
* -> https://gist.github.com/Dianoga/6055918
*
* Copyright (C) 2016 Chad Monroe <chad@monroe.io>
* Copyright (C) 2014 Nick Bailey <nick@nickhbailey.com>
* Copyright (C) 2013 Brian Steere <dianoga7@3dgo.net>
*
* 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.
**/
/**
* Static info
*/
private NEST_LOGIN_URL() { "https://home.nest.com/user/login" }
private USER_AGENT_STR() { "Nest/1.1.0.10 CFNetwork/548.0.4" }
preferences
{
input( "username", "text", title: "Username", description: "Your Nest Username (usually an email address)", required: true, displayDuringSetup: true )
input( "password", "password", title: "Password", description: "Your Nest Password", required: true, displayDuringSetup: true )
input( "mac", "text", title: "MAC Address", description: "The MAC address of your smoke detector", required: true, displayDuringSetup: true )
}
metadata
{
definition( name: "Nest Protect - Direct", author: "chad@monroe.io", namespace: "cmonroe" )
{
capability "Polling"
capability "Refresh"
capability "Battery"
capability "Smoke Detector"
capability "Carbon Monoxide Detector"
attribute "alarm_state", "string"
attribute "night_light", "string"
attribute "line_power", "string"
attribute "co_previous_peak", "string"
attribute "wifi_ip", "string"
attribute "version_hw", "string"
attribute "version_sw", "string"
attribute "secondary_status", "string"
}
simulator
{
/* TODO */
}
tiles( scale: 2 )
{
multiAttributeTile( name:"alarm_state", type: "lighting", width: 6, height: 4 )
{
tileAttribute( "device.alarm_state", key: "PRIMARY_CONTROL" )
{
attributeState( "default", label:'--', icon: "st.unknown.unknown.unknown" )
attributeState( "clear", label:"CLEAR", icon:"st.alarm.smoke.clear", backgroundColor:"#44b621" )
attributeState( "smoke", label:"SMOKE", icon:"st.alarm.smoke.smoke", backgroundColor:"#e86d13" )
attributeState( "co", label:"CO", icon:"st.alarm.carbon-monoxide.carbon-monoxide", backgroundColor:"#e86d13" )
attributeState( "tested", label:"TEST", icon:"st.alarm.smoke.test", backgroundColor:"#e86d13" )
}
tileAttribute( "device.status_text", key: "SECONDARY_CONTROL" )
{
attributeState( "status_text", label: '${currentValue}', unit:"" )
}
}
standardTile( "smoke", "device.smoke", width: 2, height: 2 )
{
state( "default", label:'UNK', icon: "st.unknown.unknown.unknown" )
state( "clear", label:"OK", icon:"st.alarm.smoke.clear", backgroundColor:"#44B621" )
state( "detected", label:"SMOKE", icon:"st.alarm.smoke.smoke", backgroundColor:"#e86d13" )
state( "tested", label:"TEST", icon:"st.alarm.smoke.test", backgroundColor:"#e86d13" )
}
standardTile( "carbonMonoxide", "device.carbonMonoxide", width: 2, height: 2 )
{
state( "default", label:'UNK', icon: "st.unknown.unknown.unknown" )
state( "clear", label:"OK", icon:"st.alarm.carbon-monoxide.carbon-monoxide", backgroundColor:"#44B621" )
state( "detected", label:"CO", icon:"st.alarm.carbon-monoxide.clear", backgroundColor:"#e86d13" )
state( "tested", label:"TEST", icon:"st.alarm.carbon-monoxide.test", backgroundColor:"#e86d13" )
}
standardTile( "night_light", "device.night_light", width: 2, height: 2 )
{
state( "default", label:'UNK', icon: "st.unknown.unknown.unknown" )
state( "unk", label:'UNK', icon: "st.unknown.unknown.unknown" )
state( "on", label: 'ON', icon: "st.switches.light.on", backgroundColor: "#44B621" )
state( "low", label: 'LOW', icon: "st.switches.light.on", backgroundColor: "#44B621" )
state( "med", label: 'MED', icon: "st.switches.light.on", backgroundColor: "#44B621" )
state( "high", label: 'HIGH', icon: "st.switches.light.on", backgroundColor: "#44B621" )
state( "off", label: 'OFF', icon: "st.switches.light.off", backgroundColor: "#ffffff" )
}
valueTile( "version_hw", "device.version_hw", width: 2, height: 2, decoration: "flat" )
{
state( "default", label: 'Hardware ${currentValue}' )
}
valueTile( "co_previous_peak", "device.co_previous_peak", width: 2, height: 2 )
{
state( "co_previous_peak", label: '${currentValue}', unit: "ppm",
backgroundColors: [
[value: 69, color: "#44B621"],
[value: 70, color: "#e86d13"]
]
)
}
valueTile( "version_sw", "device.version_sw", width: 2, height: 2, decoration: "flat" )
{
state( "default", label: 'Software ${currentValue}' )
}
standardTile("refresh", "device.refresh", inactiveLabel: false, width: 2, height: 2, decoration: "flat")
{
state( "default", label:'refresh', action:"polling.poll", icon:"st.secondary.refresh-icon" )
}
valueTile("wifi_ip", "device.wifi_ip", inactiveLabel: false, width: 4, height: 2, decoration: "flat")
{
state( "default", label:'IP: ${currentValue}', height: 1, width: 2, inactiveLabel: false )
}
main "alarm_state"
details( ["alarm_state", "smoke", "carbonMonoxide", "night_light", "version_hw", "co_previous_peak", "version_sw", "wifi_ip", "refresh"] )
}
}
/**
* handle commands
*/
def installed()
{
log.info "Nest Protect - Direct ${textVersion()}: ${textCopyright()} Installed"
do_update()
}
def initialize()
{
log.info "Nest Protect - Direct ${textVersion()}: ${textCopyright()} Initialized"
do_update()
}
def updated()
{
log.info "Nest Protect - Direct ${textVersion()}: ${textCopyright()} Updated"
data.auth = null
}
def poll()
{
log.debug "poll for protect with MAC: " + settings.mac.toUpperCase()
do_update()
}
def refresh()
{
log.debug "refresh for protect with MAC: " + settings.mac.toUpperCase()
do_update()
}
def reschedule()
{
log.debug "re-scheduling update for protect with MAC: " + settings.mac.toUpperCase()
runIn( 300, 'do_update' )
}
def do_update()
{
log.debug "refresh for device with MAC: " + settings.mac.toUpperCase()
api_exec( 'status', [] )
{
def status_text = ""
data.topaz = it.data.topaz.getAt( settings.mac.toUpperCase() )
//log.debug data.topaz
data.topaz.smoke_status = data.topaz.smoke_status == 0 ? 'clear' : 'detected'
data.topaz.co_status = data.topaz.co_status == 0 ? 'clear' : 'detected'
data.topaz.battery_health_state = data.topaz.battery_health_state == 0 ? 'ok' : 'low'
data.topaz.kl_software_version = "v" + data.topaz.kl_software_version.split('Software ')[-1]
data.topaz.model = "v" + data.topaz.model.split('-')[-1]
if ( data.topaz.night_light_enable )
{
switch ( data.topaz.night_light_brightness )
{
case 1:
data.topaz.night_light_brightness = "low"
break
case 2:
data.topaz.night_light_brightness = "med"
break
case 3:
data.topaz.night_light_brightness = "high"
break
default:
data.topaz.night_light_brightness = "on"
break
}
}
else
{
data.topaz.night_light_brightness = "off"
}
if ( data.topaz.line_power_present )
{
data.topaz.line_power_present = "ok"
}
else
{
data.topaz.line_power_present = "dead"
}
if ( !data.topaz.co_previous_peak )
{
/* protect 2.0 units do not support this */
data.topaz.co_previous_peak = 'N/A'
}
else
{
data.topaz.co_previous_peak = "${data.topaz.co_previous_peak}ppm"
}
sendEvent( name: 'smoke', value: data.topaz.smoke_status, descriptionText: "${device.displayName} smoke ${data.topaz.smoke_status}", displayed: false )
sendEvent( name: 'carbonMonoxide', value: data.topaz.co_status, descriptionText: "${device.displayName} carbon monoxide ${data.topaz.co_status}", displayed: false )
sendEvent( name: 'battery', value: data.topaz.battery_health_state, descriptionText: "${device.displayName} battery is ${data.topaz.battery_health_state}", displayed: false )
sendEvent( name: 'night_light', value: data.topaz.night_light_brightness, descriptionText: "${device.displayName} night light is ${data.topaz.night_light_brightness}", displayed: true )
sendEvent( name: 'line_power', value: data.topaz.line_power_present, descriptionText: "${device.displayName} line power is ${data.topaz.line_power_present}", displayed: false )
sendEvent( name: 'co_previous_peak', value: data.topaz.co_previous_peak, descriptionText: "${device.displayName} previous CO peak (PPM) is ${data.topaz.co_previous_peak}", displayed: false )
sendEvent( name: 'wifi_ip', value: data.topaz.wifi_ip_address, descriptionText: "${device.displayName} WiFi IP is ${data.topaz.wifi_ip_address}", displayed: false )
sendEvent( name: 'version_hw', value: data.topaz.model, descriptionText: "${device.displayName} hardware model is ${data.topaz.model}", displayed: false )
sendEvent( name: 'version_sw', value: data.topaz.kl_software_version, descriptionText: "${device.displayName} software version is ${data.topaz.kl_software_version}", displayed: false )
app_alarm_sm()
status_text = "Line Power: ${device.currentState('line_power').value} Battery: ${device.currentState('battery').value}"
sendEvent( name: 'status_text', value: status_text, descriptionText: status_text, displayed: false )
log.debug "Smoke: ${data.topaz.smoke_status}"
log.debug "CO: ${data.topaz.co_status}"
log.debug "Battery: ${data.topaz.battery_health_state}"
log.debug "Night Light: ${data.topaz.night_light_brightness}"
log.debug "Line Power: ${data.topaz.line_power_present}"
log.debug "CO Previous Peak (PPM): ${data.topaz.co_previous_peak}"
log.debug "WiFi IP: ${data.topaz.wifi_ip_address}"
log.debug "Hardware Version: ${data.topaz.model}"
log.debug "Software Version: ${data.topaz.kl_software_version}"
}
reschedule()
}
/**
* state machine for setting global alarm state of app
*/
def app_alarm_sm()
{
def alarm_state = "clear"
def smoke = data.topaz.smoke_status
def co = data.topaz.co_status
switch( smoke )
{
case 'clear':
if ( co != "clear" )
{
alarm_state = "co"
}
break
case 'detected':
alarm_state = "smoke"
break
case 'tested':
default:
/**
* ensure that real co alarm is not set before sending tested alarm for smoke
*/
if ( co == 'detected' )
{
alarm_state = "co"
}
break
}
log.info "alarm state machine finished, sending event.."
log.info "alarm_state: ${alarm_state} smoke: ${smoke} CO: ${co}"
sendEvent( name: 'alarm_state', value: alarm_state, descriptionText: "Alarm: ${alarm_state} (Smoke/CO: ${smoke}/${co})", type: "physical", displayed: true, isStateChange: true )
}
/**
* main entry point for nest API calls
*/
def api_exec(method, args = [], success = {})
{
log.debug "API exec method: ${method} with args: ${args}"
if( !logged_in() )
{
log.debug "login required"
login(method, args, success)
return
}
if( method == null )
{
log.info "API exec with no method passed and we are already logged in; bailing"
return
}
def methods =
[
'status':
[
uri: "/v2/mobile/${data.auth.user}", type: 'get'
],
]
def request = methods.getAt( method )
log.debug "already logged in"
handle_request( request.uri, args, request.type, success )
}
/**
* handle_request() only works once logged in, therefor
* call api_exec() rather than this method directly.
*/
def handle_request(uri, args, type, success)
{
log.debug "handling request type: ${type} at URI: ${uri} with args: ${args}"
if( uri.charAt(0) == '/' )
{
uri = "${data.auth.urls.transport_url}${uri}"
}
def params =
[
uri: uri,
headers:
[
'X-nl-protocol-version': 1,
'X-nl-user-id': data.auth.userid,
'Authorization': "Basic ${data.auth.access_token}",
'Accept-Language': 'en-us',
'userAgent': USER_AGENT_STR()
],
body: args
]
def post_request = { response ->
if( response.getStatus() == 302 )
{
def locations = response.getHeaders( "Location" )
def location = locations[0].getValue()
log.debug "redirecting to ${location}"
handle_request( location, args, type, success )
}
else
{
success.call( response )
}
}
try
{
if( type == 'get' )
{
httpGet( params, post_request )
}
}
catch( Throwable e )
{
login()
}
}
def login(method = null, args = [], success = {})
{
def params =
[
uri: NEST_LOGIN_URL(),
body: [ username: settings.username, password: settings.password ]
]
httpPost( params ) { response ->
data.auth = response.data
data.auth.expires_in = Date.parse('EEE, dd-MMM-yyyy HH:mm:ss z', response.data.expires_in).getTime()
log.debug data.auth
api_exec( method, args, success )
}
}
def logged_in()
{
if( !data.auth )
{
log.debug "data.auth is missing, not logged in"
return false
}
def now = new Date().getTime();
return( data.auth.expires_in > now )
}
private def textVersion()
{
def text = "Version 1.6"
}
private def textCopyright()
{
def text = "Copyright © 2016 Chad Monroe <chad@monroe.io>"
}

View File

@@ -1,600 +0,0 @@
/**
* Nest Direct
*
* Author: dianoga7@3dgo.net
* Code: https://github.com/smartthings-users/device-type.nest
*
* INSTALLATION
* =========================================
* 1) Create a new device type (https://graph.api.smartthings.com/ide/devices)
* Name: Nest
* Author: dianoga7@3dgo.net
* Capabilities:
* Polling
* Relative Humidity Measurement
* Thermostat
* Temperature Measurement
* Presence Sensor
* Sensor
* Custom Attributes:
* temperatureUnit
* Custom Commands:
* away
* present
* setPresence
* heatingSetpointUp
* heatingSetpointDown
* coolingSetpointUp
* coolingSetpointDown
* setFahrenheit
* setCelsius
*
* 2) If you want to switch from slider controls to buttons, comment out the slider details line and uncomment the button details line.
*
* 3) Create a new device (https://graph.api.smartthings.com/device/list)
* Name: Your Choice
* Device Network Id: Your Choice
* Type: Nest (should be the last option)
* Location: Choose the correct location
* Hub/Group: Leave blank
*
* 4) Update device preferences
* Click on the new device to see the details.
* Click the edit button next to Preferences
* Fill in your information.
* To find your serial number, login to http://home.nest.com. Click on the thermostat
* you want to control. Under settings, go to Technical Info. Your serial number is
* the second item.
*
* 5) That's it, you're done.
*
* Copyright (C) 2013 Brian Steere <dianoga7@3dgo.net>
* 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.
*/
preferences {
input("username", "text", title: "Username", description: "Your Nest username (usually an email address)")
input("password", "password", title: "Password", description: "Your Nest password")
input("serial", "text", title: "Serial #", description: "The serial number of your thermostat")
}
// for the UI
metadata {
definition (name: "Nest", namespace: "smartthings-users", author: "dianoga7@3dgo.net") {
capability "Polling"
capability "Relative Humidity Measurement"
capability "Thermostat"
capability "Temperature Measurement"
capability "Presence Sensor"
capability "Sensor"
command "away"
command "present"
command "setPresence"
command "heatingSetpointUp"
command "heatingSetpointDown"
command "coolingSetpointUp"
command "coolingSetpointDown"
command "setFahrenheit"
command "setCelsius"
attribute "temperatureUnit", "string"
}
simulator {
// TODO: define status and reply messages here
}
tiles {
valueTile("temperature", "device.temperature", canChangeIcon: true, canChangeBackground:true) {
state("temperature", label: '${currentValue}°', backgroundColors: [
// Celsius Color Range
[value: 0, color: "#153591"],
[value: 7, color: "#1e9cbb"],
[value: 15, color: "#90d2a7"],
[value: 23, color: "#44b621"],
[value: 29, color: "#f1d801"],
[value: 33, color: "#d04e00"],
[value: 36, color: "#bc2323"],
// Fahrenheit Color Range
[value: 40, color: "#153591"],
[value: 44, color: "#1e9cbb"],
[value: 59, color: "#90d2a7"],
[value: 74, color: "#44b621"],
[value: 84, color: "#f1d801"],
[value: 92, color: "#d04e00"],
[value: 96, color: "#bc2323"]
]
)
}
standardTile("thermostatMode", "device.thermostatMode", inactiveLabel: true, decoration: "flat") {
state("auto", action:"thermostat.off", icon: "st.thermostat.auto")
state("off", action:"thermostat.cool", icon: "st.thermostat.heating-cooling-off")
state("cool", action:"thermostat.heat", icon: "st.thermostat.cool")
state("heat", action:"thermostat.auto", icon: "st.thermostat.heat")
}
standardTile("thermostatFanMode", "device.thermostatFanMode", inactiveLabel: true, decoration: "flat") {
state "auto", action:"thermostat.fanOn", icon: "st.thermostat.fan-auto"
state "on", action:"thermostat.fanCirculate", icon: "st.thermostat.fan-on"
state "circulate", action:"thermostat.fanAuto", icon: "st.thermostat.fan-circulate"
}
valueTile("heatingSetpoint", "device.heatingSetpoint") {
state "default", label:'${currentValue}°', unit:"Heat", backgroundColor:"#bc2323"
}
valueTile("coolingSetpoint", "device.coolingSetpoint") {
state "default", label:'${currentValue}°', unit:"Cool", backgroundColor:"#1e9cbb"
}
standardTile("thermostatOperatingState", "device.thermostatOperatingState", inactiveLabel: false, decoration: "flat") {
state "idle", action:"polling.poll", label:'${name}', icon: "st.sonos.pause-icon"
state "cooling", action:"polling.poll", label:' ', icon: "st.thermostat.cooling", backgroundColor:"#1e9cbb"
state "heating", action:"polling.poll", label:' ', icon: "st.thermostat.heating", backgroundColor:"#bc2323"
state "fan only", action:"polling.poll", label:'${name}', icon: "st.Appliances.appliances11"
}
valueTile("humidity", "device.humidity", inactiveLabel: false) {
state "default", label:'${currentValue}%', unit:"Humidity"
}
standardTile("presence", "device.presence", inactiveLabel: false, decoration: "flat") {
state "present", label:'${name}', action:"away", icon: "st.Home.home2"
state "not present", label:'away', action:"present", icon: "st.Transportation.transportation5"
}
standardTile("refresh", "device.thermostatMode", inactiveLabel: false, decoration: "flat") {
state "default", action:"polling.poll", icon:"st.secondary.refresh"
}
standardTile("temperatureUnit", "device.temperatureUnit", canChangeIcon: false) {
state "fahrenheit", label: "°F", icon: "st.alarm.temperature.normal", action:"setCelsius"
state "celsius", label: "°C", icon: "st.alarm.temperature.normal", action:"setFahrenheit"
}
controlTile("heatSliderControl", "device.heatingSetpoint", "slider", height: 1, width: 2, inactiveLabel: false) {
state "setHeatingSetpoint", label:'Set temperature to', action:"thermostat.setHeatingSetpoint"
}
controlTile("coolSliderControl", "device.coolingSetpoint", "slider", height: 1, width: 2, inactiveLabel: false) {
state "setCoolingSetpoint", label:'Set temperature to', action:"thermostat.setCoolingSetpoint"
}
standardTile("heatingSetpointUp", "device.heatingSetpoint", canChangeIcon: false, inactiveLabel: false, decoration: "flat") {
state "heatingSetpointUp", label:' ', action:"heatingSetpointUp", icon:"st.thermostat.thermostat-up", backgroundColor:"#bc2323"
}
standardTile("heatingSetpointDown", "device.heatingSetpoint", canChangeIcon: false, inactiveLabel: false, decoration: "flat") {
state "heatingSetpointDown", label:' ', action:"heatingSetpointDown", icon:"st.thermostat.thermostat-down", backgroundColor:"#bc2323"
}
standardTile("coolingSetpointUp", "device.coolingSetpoint", canChangeIcon: false, inactiveLabel: false, decoration: "flat") {
state "coolingSetpointUp", label:' ', action:"coolingSetpointUp", icon:"st.thermostat.thermostat-up", backgroundColor:"#1e9cbb"
}
standardTile("coolingSetpointDown", "device.coolingSetpoint", canChangeIcon: false, inactiveLabel: false, decoration: "flat") {
state "coolingSetpointDown", label:' ', action:"coolingSetpointDown", icon:"st.thermostat.thermostat-down", backgroundColor:"#1e9cbb"
}
main(["temperature", "thermostatOperatingState", "humidity"])
// ============================================================
// Slider or Buttons...
// To expose buttons, comment out the first detials line below and uncomment the second details line below.
// To expose sliders, uncomment the first details line below and comment out the second details line below.
details(["temperature", "thermostatOperatingState", "humidity", "thermostatMode", "thermostatFanMode", "presence", "heatingSetpoint", "heatSliderControl", "coolingSetpoint", "coolSliderControl", "temperatureUnit", "refresh"])
// details(["temperature", "thermostatOperatingState", "humidity", "thermostatMode", "thermostatFanMode", "presence", "heatingSetpointDown", "heatingSetpoint", "heatingSetpointUp", "coolingSetpointDown", "coolingSetpoint", "coolingSetpointUp", "temperatureUnit", "refresh"])
// ============================================================
}
}
// parse events into attributes
def parse(String description) {
}
// handle commands
def setHeatingSetpoint(temp) {
def latestThermostatMode = device.latestState('thermostatMode')
def temperatureUnit = device.latestValue('temperatureUnit')
switch (temperatureUnit) {
case "celsius":
if (temp) {
if (temp < 9) {
temp = 9
}
if (temp > 32) {
temp = 32
}
if (latestThermostatMode.stringValue == 'auto') {
api('temperature', ['target_change_pending': true, 'target_temperature_low': temp]) {
sendEvent(name: 'heatingSetpoint', value: heatingSetpoint, unit: temperatureUnit, state: "heat")
}
} else if (latestThermostatMode.stringValue == 'heat') {
api('temperature', ['target_change_pending': true, 'target_temperature': temp]) {
sendEvent(name: 'heatingSetpoint', value: heatingSetpoint, unit: temperatureUnit, state: "heat")
}
}
}
break;
default:
if (temp) {
if (temp < 51) {
temp = 51
}
if (temp > 89) {
temp = 89
}
if (latestThermostatMode.stringValue == 'auto') {
api('temperature', ['target_change_pending': true, 'target_temperature_low': fToC(temp)]) {
sendEvent(name: 'heatingSetpoint', value: heatingSetpoint, unit: temperatureUnit, state: "heat")
}
} else if (latestThermostatMode.stringValue == 'heat') {
api('temperature', ['target_change_pending': true, 'target_temperature': fToC(temp)]) {
sendEvent(name: 'heatingSetpoint', value: heatingSetpoint, unit: temperatureUnit, state: "heat")
}
}
}
break;
}
poll()
}
def coolingSetpointUp(){
int newSetpoint = device.currentValue("coolingSetpoint") + 1
log.debug "Setting cool set point up to: ${newSetpoint}"
setCoolingSetpoint(newSetpoint)
}
def coolingSetpointDown(){
int newSetpoint = device.currentValue("coolingSetpoint") - 1
log.debug "Setting cool set point down to: ${newSetpoint}"
setCoolingSetpoint(newSetpoint)
}
def setCoolingSetpoint(temp) {
def latestThermostatMode = device.latestState('thermostatMode')
def temperatureUnit = device.latestValue('temperatureUnit')
switch (temperatureUnit) {
case "celsius":
if (temp) {
if (temp < 9) {
temp = 9
}
if (temp > 32) {
temp = 32
}
if (latestThermostatMode.stringValue == 'auto') {
api('temperature', ['target_change_pending': true, 'target_temperature_high': temp]) {
sendEvent(name: 'coolingSetpoint', value: coolingSetpoint, unit: temperatureUnit, state: "cool")
}
} else if (latestThermostatMode.stringValue == 'cool') {
api('temperature', ['target_change_pending': true, 'target_temperature': temp]) {
sendEvent(name: 'coolingSetpoint', value: coolingSetpoint, unit: temperatureUnit, state: "cool")
}
}
}
break;
default:
if (temp) {
if (temp < 51) {
temp = 51
}
if (temp > 89) {
temp = 89
}
if (latestThermostatMode.stringValue == 'auto') {
api('temperature', ['target_change_pending': true, 'target_temperature_high': fToC(temp)]) {
sendEvent(name: 'coolingSetpoint', value: coolingSetpoint, unit: temperatureUnit, state: "cool")
}
} else if (latestThermostatMode.stringValue == 'cool') {
api('temperature', ['target_change_pending': true, 'target_temperature': fToC(temp)]) {
sendEvent(name: 'coolingSetpoint', value: coolingSetpoint, unit: temperatureUnit, state: "cool")
}
}
}
break;
}
poll()
}
def heatingSetpointUp(){
int newSetpoint = device.currentValue("heatingSetpoint") + 1
log.debug "Setting heat set point up to: ${newSetpoint}"
setHeatingSetpoint(newSetpoint)
}
def heatingSetpointDown(){
int newSetpoint = device.currentValue("heatingSetpoint") - 1
log.debug "Setting heat set point down to: ${newSetpoint}"
setHeatingSetpoint(newSetpoint)
}
def setFahrenheit() {
def temperatureUnit = "fahrenheit"
log.debug "Setting temperatureUnit to: ${temperatureUnit}"
sendEvent(name: "temperatureUnit", value: temperatureUnit)
poll()
}
def setCelsius() {
def temperatureUnit = "celsius"
log.debug "Setting temperatureUnit to: ${temperatureUnit}"
sendEvent(name: "temperatureUnit", value: temperatureUnit)
poll()
}
def off() {
setThermostatMode('off')
}
def heat() {
setThermostatMode('heat')
}
def emergencyHeat() {
setThermostatMode('heat')
}
def cool() {
setThermostatMode('cool')
}
def auto() {
setThermostatMode('range')
}
def setThermostatMode(mode) {
mode = mode == 'emergency heat'? 'heat' : mode
api('thermostat_mode', ['target_change_pending': true, 'target_temperature_type': mode]) {
mode = mode == 'range' ? 'auto' : mode
sendEvent(name: 'thermostatMode', value: mode)
poll()
}
}
def fanOn() {
setThermostatFanMode('on')
}
def fanAuto() {
setThermostatFanMode('auto')
}
def fanCirculate() {
setThermostatFanMode('circulate')
}
def setThermostatFanMode(mode) {
def modes = [
on: ['fan_mode': 'on'],
auto: ['fan_mode': 'auto'],
circulate: ['fan_mode': 'duty-cycle', 'fan_duty_cycle': 900]
]
api('fan_mode', modes.getAt(mode)) {
sendEvent(name: 'thermostatFanMode', value: mode)
poll()
}
}
def away() {
setPresence('away')
sendEvent(name: 'presence', value: 'not present')
}
def present() {
setPresence('present')
sendEvent(name: 'presence', value: 'present')
}
def setPresence(status) {
log.debug "Status: $status"
api('presence', ['away': status == 'away', 'away_timestamp': new Date().getTime(), 'away_setter': 0]) {
poll()
}
}
def poll() {
log.debug "Executing 'poll'"
api('status', []) {
data.device = it.data.device.getAt(settings.serial)
data.shared = it.data.shared.getAt(settings.serial)
data.structureId = it.data.link.getAt(settings.serial).structure.tokenize('.')[1]
data.structure = it.data.structure.getAt(data.structureId)
data.device.fan_mode = data.device.fan_mode == 'duty-cycle'? 'circulate' : data.device.fan_mode
data.structure.away = data.structure.away ? 'away' : 'present'
log.debug(data.shared)
def humidity = data.device.current_humidity
def temperatureType = data.shared.target_temperature_type
def fanMode = data.device.fan_mode
def heatingSetpoint = '--'
def coolingSetpoint = '--'
temperatureType = temperatureType == 'range' ? 'auto' : temperatureType
sendEvent(name: 'humidity', value: humidity)
sendEvent(name: 'thermostatFanMode', value: fanMode)
sendEvent(name: 'thermostatMode', value: temperatureType)
def temperatureUnit = device.latestValue('temperatureUnit')
switch (temperatureUnit) {
case "celsius":
def temperature = Math.round(data.shared.current_temperature)
def targetTemperature = Math.round(data.shared.target_temperature)
if (temperatureType == "cool") {
coolingSetpoint = targetTemperature
} else if (temperatureType == "heat") {
heatingSetpoint = targetTemperature
} else if (temperatureType == "auto") {
coolingSetpoint = Math.round(data.shared.target_temperature_high)
heatingSetpoint = Math.round(data.shared.target_temperature_low)
}
sendEvent(name: 'temperature', value: temperature, unit: temperatureUnit, state: temperatureType)
sendEvent(name: 'coolingSetpoint', value: coolingSetpoint, unit: temperatureUnit, state: "cool")
sendEvent(name: 'heatingSetpoint', value: heatingSetpoint, unit: temperatureUnit, state: "heat")
break;
default:
def temperature = Math.round(cToF(data.shared.current_temperature))
def targetTemperature = Math.round(cToF(data.shared.target_temperature))
if (temperatureType == "cool") {
coolingSetpoint = targetTemperature
} else if (temperatureType == "heat") {
heatingSetpoint = targetTemperature
} else if (temperatureType == "auto") {
coolingSetpoint = Math.round(cToF(data.shared.target_temperature_high))
heatingSetpoint = Math.round(cToF(data.shared.target_temperature_low))
}
sendEvent(name: 'temperature', value: temperature, unit: temperatureUnit, state: temperatureType)
sendEvent(name: 'coolingSetpoint', value: coolingSetpoint, unit: temperatureUnit, state: "cool")
sendEvent(name: 'heatingSetpoint', value: heatingSetpoint, unit: temperatureUnit, state: "heat")
break;
}
switch (device.latestValue('presence')) {
case "present":
if (data.structure.away == 'away') {
sendEvent(name: 'presence', value: 'not present')
}
break;
case "not present":
if (data.structure.away == 'present') {
sendEvent(name: 'presence', value: 'present')
}
break;
}
if (data.shared.hvac_ac_state) {
sendEvent(name: 'thermostatOperatingState', value: "cooling")
} else if (data.shared.hvac_heater_state) {
sendEvent(name: 'thermostatOperatingState', value: "heating")
} else if (data.shared.hvac_fan_state) {
sendEvent(name: 'thermostatOperatingState', value: "fan only")
} else {
sendEvent(name: 'thermostatOperatingState', value: "idle")
}
}
}
def api(method, args = [], success = {}) {
if(!isLoggedIn()) {
log.debug "Need to login"
login(method, args, success)
return
}
def methods = [
'status': [uri: "/v2/mobile/${data.auth.user}", type: 'get'],
'fan_mode': [uri: "/v2/put/device.${settings.serial}", type: 'post'],
'thermostat_mode': [uri: "/v2/put/shared.${settings.serial}", type: 'post'],
'temperature': [uri: "/v2/put/shared.${settings.serial}", type: 'post'],
'presence': [uri: "/v2/put/structure.${data.structureId}", type: 'post']
]
def request = methods.getAt(method)
log.debug "Logged in"
doRequest(request.uri, args, request.type, success)
}
// Need to be logged in before this is called. So don't call this. Call api.
def doRequest(uri, args, type, success) {
log.debug "Calling $type : $uri : $args"
if(uri.charAt(0) == '/') {
uri = "${data.auth.urls.transport_url}${uri}"
}
def params = [
uri: uri,
headers: [
'X-nl-protocol-version': 1,
'X-nl-user-id': data.auth.userid,
'Authorization': "Basic ${data.auth.access_token}"
],
body: args
]
def postRequest = { response ->
if (response.getStatus() == 302) {
def locations = response.getHeaders("Location")
def location = locations[0].getValue()
log.debug "redirecting to ${location}"
doRequest(location, args, type, success)
} else {
success.call(response)
}
}
try {
if (type == 'post') {
httpPostJson(params, postRequest)
} else if (type == 'get') {
httpGet(params, postRequest)
}
} catch (Throwable e) {
login()
}
}
def login(method = null, args = [], success = {}) {
def params = [
uri: 'https://home.nest.com/user/login',
body: [username: settings.username, password: settings.password]
]
httpPost(params) {response ->
data.auth = response.data
data.auth.expires_in = Date.parse('EEE, dd-MMM-yyyy HH:mm:ss z', response.data.expires_in).getTime()
log.debug data.auth
api(method, args, success)
}
}
def isLoggedIn() {
if(!data.auth) {
log.debug "No data.auth"
return false
}
def now = new Date().getTime();
return data.auth.expires_in > now
}
def cToF(temp) {
return (temp * 1.8 + 32).toDouble()
}
def fToC(temp) {
return ((temp - 32) / 1.8).toDouble()
}