/** * Netatmo Connect */ import java.text.DecimalFormat import groovy.json.JsonSlurper private getApiUrl() { "https://api.netatmo.com" } private getVendorName() { "netatmo" } private getVendorAuthPath() { "${apiUrl}/oauth2/authorize?" } private getVendorTokenPath(){ "${apiUrl}/oauth2/token" } private getVendorIcon() { "https://s3.amazonaws.com/smartapp-icons/Partner/netamo-icon-1%402x.png" } private getClientId() { appSettings.clientId } private getClientSecret() { appSettings.clientSecret } private getServerUrl() { appSettings.serverUrl } private getShardUrl() { return getApiServerUrl() } private getCallbackUrl() { "${serverUrl}/oauth/callback" } private getBuildRedirectUrl() { "${serverUrl}/oauth/initialize?appId=${app.id}&access_token=${state.accessToken}&apiServerUrl=${shardUrl}" } // Automatically generated. Make future change here. definition( name: "Netatmo (Connect)", namespace: "dianoga", author: "Brian Steere", description: "Netatmo Integration", category: "SmartThings Labs", iconUrl: "https://s3.amazonaws.com/smartapp-icons/Partner/netamo-icon-1.png", iconX2Url: "https://s3.amazonaws.com/smartapp-icons/Partner/netamo-icon-1%402x.png", oauth: true, singleInstance: true ){ appSetting "clientId" appSetting "clientSecret" appSetting "serverUrl" } preferences { page(name: "Credentials", title: "Fetch OAuth2 Credentials", content: "authPage", install: false) page(name: "listDevices", title: "Netatmo Devices", content: "listDevices", install: false) } mappings { path("/oauth/initialize") {action: [GET: "oauthInitUrl"]} path("/oauth/callback") {action: [GET: "callback"]} } def authPage() { log.debug "In authPage" def description def uninstallAllowed = false def oauthTokenProvided = false if (!state.accessToken) { log.debug "About to create access token." state.accessToken = createAccessToken() } if (canInstallLabs()) { def redirectUrl = getBuildRedirectUrl() // log.debug "Redirect url = ${redirectUrl}" if (state.authToken) { description = "Tap 'Next' to proceed" uninstallAllowed = true oauthTokenProvided = true } else { description = "Click to enter Credentials." } if (!oauthTokenProvided) { log.debug "Show the login page" return dynamicPage(name: "Credentials", title: "Authorize Connection", nextPage:"listDevices", uninstall: uninstallAllowed, install:false) { section() { paragraph "Tap below to log in to the netatmo and authorize SmartThings access." href url:redirectUrl, style:"embedded", required:false, title:"Connect to ${getVendorName()}:", description:description } } } else { log.debug "Show the devices page" return dynamicPage(name: "Credentials", title: "Credentials Accepted!", nextPage:"listDevices", uninstall: uninstallAllowed, install:false) { section() { input(name:"Devices", style:"embedded", required:false, title:"${getVendorName()} is now connected to SmartThings!", description:description) } } } } else { def upgradeNeeded = """To use SmartThings Labs, your Hub should be completely up to date. To update your Hub, access Location Settings in the Main Menu (tap the gear next to your location name), select your Hub, and choose "Update Hub".""" return dynamicPage(name:"Credentials", title:"Upgrade needed!", nextPage:"", install:false, uninstall: true) { section { paragraph "$upgradeNeeded" } } } } def oauthInitUrl() { log.debug "In oauthInitUrl" state.oauthInitState = UUID.randomUUID().toString() def oauthParams = [ response_type: "code", client_id: getClientId(), client_secret: getClientSecret(), state: state.oauthInitState, redirect_uri: getCallbackUrl(), scope: "read_station" ] // log.debug "REDIRECT URL: ${getVendorAuthPath() + toQueryString(oauthParams)}" redirect (location: getVendorAuthPath() + toQueryString(oauthParams)) } def callback() { // log.debug "callback()>> params: $params, params.code ${params.code}" def code = params.code def oauthState = params.state if (oauthState == state.oauthInitState) { def tokenParams = [ client_secret: getClientSecret(), client_id : getClientId(), grant_type: "authorization_code", redirect_uri: getCallbackUrl(), code: code, scope: "read_station" ] // log.debug "TOKEN URL: ${getVendorTokenPath() + toQueryString(tokenParams)}" def tokenUrl = getVendorTokenPath() def params = [ uri: tokenUrl, contentType: 'application/x-www-form-urlencoded', body: tokenParams ] // log.debug "PARAMS: ${params}" httpPost(params) { resp -> def slurper = new JsonSlurper() resp.data.each { key, value -> def data = slurper.parseText(key) state.refreshToken = data.refresh_token state.authToken = data.access_token state.tokenExpires = now() + (data.expires_in * 1000) // log.debug "swapped token: $resp.data" } } // Handle success and failure here, and render stuff accordingly if (state.authToken) { success() } else { fail() } } else { log.error "callback() failed oauthState != state.oauthInitState" } } def success() { log.debug "in success" def message = """

We have located your """ + getVendorName() + """ account.

Tap 'Done' to continue to Devices.

""" connectionStatus(message) } def fail() { log.debug "in fail" def message = """

The connection could not be established!

Click 'Done' to return to the menu.

""" connectionStatus(message) } def connectionStatus(message, redirectUrl = null) { def redirectHtml = "" if (redirectUrl) { redirectHtml = """ """ } def html = """ ${getVendorName()} Connection
Vendor icon connected device icon SmartThings logo ${message}
""" render contentType: 'text/html', data: html } def refreshToken() { log.debug "In refreshToken" def oauthParams = [ client_secret: getClientSecret(), client_id: getClientId(), grant_type: "refresh_token", refresh_token: state.refreshToken ] def tokenUrl = getVendorTokenPath() def params = [ uri: tokenUrl, contentType: 'application/x-www-form-urlencoded', body: oauthParams, ] // OAuth Step 2: Request access token with our client Secret and OAuth "Code" try { httpPost(params) { response -> def slurper = new JsonSlurper(); response.data.each {key, value -> def data = slurper.parseText(key); // log.debug "Data: $data" state.refreshToken = data.refresh_token state.accessToken = data.access_token state.tokenExpires = now() + (data.expires_in * 1000) return true } } } catch (Exception e) { log.debug "Error: $e" } // We didn't get an access token if ( !state.accessToken ) { return false } } String toQueryString(Map m) { return m.collect { k, v -> "${k}=${URLEncoder.encode(v.toString())}" }.sort().join("&") } def installed() { log.debug "Installed with settings: ${settings}" initialize() } def updated() { log.debug "Updated with settings: ${settings}" unsubscribe() unschedule() initialize() } def initialize() { log.debug "Initialized with settings: ${settings}" // Pull the latest device info into state getDeviceList(); settings.devices.each { def deviceId = it def detail = state?.deviceDetail[deviceId] try { switch(detail?.type) { case 'NAMain': log.debug "Base station" createChildDevice("Netatmo Basestation", deviceId, "${detail.type}.${deviceId}", detail.module_name) break case 'NAModule1': log.debug "Outdoor module" createChildDevice("Netatmo Outdoor Module", deviceId, "${detail.type}.${deviceId}", detail.module_name) break case 'NAModule3': log.debug "Rain Gauge" createChildDevice("Netatmo Rain", deviceId, "${detail.type}.${deviceId}", detail.module_name) break case 'NAModule4': log.debug "Additional module" createChildDevice("Netatmo Additional Module", deviceId, "${detail.type}.${deviceId}", detail.module_name) break } } catch (Exception e) { log.error "Error creating device: ${e}" } } // Cleanup any other devices that need to go away def delete = getChildDevices().findAll { !settings.devices.contains(it.deviceNetworkId) } log.debug "Delete: $delete" delete.each { deleteChildDevice(it.deviceNetworkId) } // Do the initial poll poll() // Schedule it to run every 5 minutes runEvery5Minutes("poll") } def uninstalled() { log.debug "In uninstalled" removeChildDevices(getChildDevices()) } def getDeviceList() { log.debug "In getDeviceList" def deviceList = [:] state.deviceDetail = [:] state.deviceState = [:] apiGet("/api/devicelist") { response -> response.data.body.devices.each { value -> def key = value._id deviceList[key] = "${value.station_name}: ${value.module_name}" state.deviceDetail[key] = value state.deviceState[key] = value.dashboard_data } response.data.body.modules.each { value -> def key = value._id deviceList[key] = "${state.deviceDetail[value.main_device].station_name}: ${value.module_name}" state.deviceDetail[key] = value state.deviceState[key] = value.dashboard_data } } return deviceList.sort() { it.value.toLowerCase() } } private removeChildDevices(delete) { log.debug "In removeChildDevices" log.debug "deleting ${delete.size()} devices" delete.each { deleteChildDevice(it.deviceNetworkId) } } def createChildDevice(deviceFile, dni, name, label) { log.debug "In createChildDevice" try { def existingDevice = getChildDevice(dni) if(!existingDevice) { log.debug "Creating child" def childDevice = addChildDevice("dianoga", deviceFile, dni, null, [name: name, label: label, completedSetup: true]) } else { log.debug "Device $dni already exists" } } catch (e) { log.error "Error creating device: ${e}" } } def listDevices() { log.debug "In listDevices" def devices = getDeviceList() dynamicPage(name: "listDevices", title: "Choose devices", install: true) { section("Devices") { input "devices", "enum", title: "Select Device(s)", required: false, multiple: true, options: devices } section("Preferences") { input "rainUnits", "enum", title: "Rain Units", description: "Millimeters (mm) or Inches (in)", required: true, options: [mm:'Millimeters', in:'Inches'] } } } def apiGet(String path, Map query, Closure callback) { if(now() >= state.tokenExpires) { refreshToken(); } query['access_token'] = state.accessToken def params = [ uri: getApiUrl(), path: path, 'query': query ] // log.debug "API Get: $params" try { httpGet(params) { response -> callback.call(response) } } catch (Exception e) { // This is most likely due to an invalid token. Try to refresh it and try again. log.debug "apiGet: Call failed $e" if(refreshToken()) { log.debug "apiGet: Trying again after refreshing token" httpGet(params) { response -> callback.call(response) } } } } def apiGet(String path, Closure callback) { apiGet(path, [:], callback); } def poll() { log.debug "In Poll" getDeviceList(); def children = getChildDevices() log.debug "State: ${state.deviceState}" settings.devices.each { deviceId -> def detail = state?.deviceDetail[deviceId] def data = state?.deviceState[deviceId] def child = children?.find { it.deviceNetworkId == deviceId } log.debug "Update: $child"; switch(detail?.type) { case 'NAMain': log.debug "Updating NAMain $data" child?.sendEvent(name: 'temperature', value: cToPref(data['Temperature']) as float, unit: getTemperatureScale()) child?.sendEvent(name: 'carbonDioxide', value: data['CO2']) child?.sendEvent(name: 'humidity', value: data['Humidity']) child?.sendEvent(name: 'pressure', value: data['Pressure']) child?.sendEvent(name: 'noise', value: data['Noise']) break; case 'NAModule1': log.debug "Updating NAModule1 $data" child?.sendEvent(name: 'temperature', value: cToPref(data['Temperature']) as float, unit: getTemperatureScale()) child?.sendEvent(name: 'humidity', value: data['Humidity']) break; case 'NAModule3': log.debug "Updating NAModule3 $data" child?.sendEvent(name: 'rain', value: rainToPref(data['Rain']) as float, unit: settings.rainUnits) child?.sendEvent(name: 'rainSumHour', value: rainToPref(data['sum_rain_1']) as float, unit: settings.rainUnits) child?.sendEvent(name: 'rainSumDay', value: rainToPref(data['sum_rain_24']) as float, unit: settings.rainUnits) child?.sendEvent(name: 'units', value: settings.rainUnits) break; case 'NAModule4': log.debug "Updating NAModule4 $data" child?.sendEvent(name: 'temperature', value: cToPref(data['Temperature']) as float, unit: getTemperatureScale()) child?.sendEvent(name: 'carbonDioxide', value: data['CO2']) child?.sendEvent(name: 'humidity', value: data['Humidity']) break; } } } def cToPref(temp) { if(getTemperatureScale() == 'C') { return temp } else { return temp * 1.8 + 32 } } def rainToPref(rain) { if(settings.rainUnits == 'mm') { return rain } else { return rain * 0.039370 } } def debugEvent(message, displayEvent) { def results = [ name: "appdebug", descriptionText: message, displayed: displayEvent ] log.debug "Generating AppDebug Event: ${results}" sendEvent (results) } private Boolean canInstallLabs() { return hasAllHubsOver("000.011.00603") } private Boolean hasAllHubsOver(String desiredFirmware) { return realHubFirmwareVersions.every { fw -> fw >= desiredFirmware } } private List getRealHubFirmwareVersions() { return location.hubs*.firmwareVersionString.findAll { it } }