Merge pull request #1673 from larsfinander/ICP-280_Instruction_for_Phlips_Hue_staging

ICP-280 Instruction for Phlips Hue

smartapps/smartthings/hue-connect.src/hue-connect.groovy

@@ -17,14 +17,14 @@
  */
 
 definition(
-	name: "Hue (Connect)",
+		name: "Hue (Connect)",
-	namespace: "smartthings",
+		namespace: "smartthings",
-	author: "SmartThings",
+		author: "SmartThings",
-	description: "Allows you to connect your Philips Hue lights with SmartThings and control them from your Things area or Dashboard in the SmartThings Mobile app. Adjust colors by going to the Thing detail screen for your Hue lights (tap the gear on Hue tiles).\n\nPlease update your Hue Bridge first, outside of the SmartThings app, using the Philips Hue app.",
+		description: "Allows you to connect your Philips Hue lights with SmartThings and control them from your Things area or Dashboard in the SmartThings Mobile app. Adjust colors by going to the Thing detail screen for your Hue lights (tap the gear on Hue tiles).\n\nPlease update your Hue Bridge first, outside of the SmartThings app, using the Philips Hue app.",
-	category: "SmartThings Labs",
+		category: "SmartThings Labs",
-	iconUrl: "https://s3.amazonaws.com/smartapp-icons/Partner/hue.png",
+		iconUrl: "https://s3.amazonaws.com/smartapp-icons/Partner/hue.png",
-	iconX2Url: "https://s3.amazonaws.com/smartapp-icons/Partner/hue@2x.png",
+		iconX2Url: "https://s3.amazonaws.com/smartapp-icons/Partner/hue@2x.png",
-	singleInstance: true
+		singleInstance: true
 )
 
 preferences {
@@ -85,7 +85,8 @@ def bridgeDiscovery(params=[:])
 	}
 
 	return dynamicPage(name:"bridgeDiscovery", title:"Discovery Started!", nextPage:"bridgeBtnPush", refreshInterval:refreshInterval, uninstall: true) {
-		section("Please wait while we discover your Hue Bridge. Discovery can take five minutes or more, so sit back and relax! Select your device below once discovered.") {
+		section("Please wait while we discover your Hue Bridge. Kindly note that you must first configure your Hue Bridge and Lights using the Philips Hue application. " +
+				"Discovery can take five minutes or more, so sit back and relax! Select your device below once discovered.") {
 			input "selectedHue", "enum", required:false, title:"Select Hue Bridge (${numFound} found)", multiple:false, options:options, submitOnChange: true
 		}
 	}
@@ -178,7 +179,7 @@ def bulbDiscovery() {
 	}
 
 	if (bulbRefreshCount > 200 && numFound == 0) {
-		// Time out to avoid endless discovery
+		// Time out after 10 minutes
 		state.inBulbDiscovery = false
 		bulbRefreshCount = 0
 		return dynamicPage(name:"bulbDiscovery", title:"Light Discovery Failed!", nextPage:"", refreshInterval:0, install:true, uninstall: true) {
@@ -216,32 +217,32 @@ private sendDeveloperReq() {
 	def token = app.id
 	def host = getBridgeIP()
 	sendHubCommand(new physicalgraph.device.HubAction([
-		method: "POST",
+			method: "POST",
-		path: "/api",
+			path: "/api",
-		headers: [
+			headers: [
-			HOST: host
+					HOST: host
-		],
+			],
-		body: [devicetype: "$token-0"]], "${selectedHue}", [callback: "usernameHandler"]))
+			body: [devicetype: "$token-0"]], "${selectedHue}", [callback: "usernameHandler"]))
 }
 
 private discoverHueBulbs() {
 	def host = getBridgeIP()
 	sendHubCommand(new physicalgraph.device.HubAction([
-		method: "GET",
+			method: "GET",
-		path: "/api/${state.username}/lights",
+			path: "/api/${state.username}/lights",
-		headers: [
+			headers: [
-			HOST: host
+					HOST: host
-		]], "${selectedHue}", [callback: "lightsHandler"]))
+			]], "${selectedHue}", [callback: "lightsHandler"]))
 }
 
 private verifyHueBridge(String deviceNetworkId, String host) {
 	log.trace "Verify Hue Bridge $deviceNetworkId"
 	sendHubCommand(new physicalgraph.device.HubAction([
-		method: "GET",
+			method: "GET",
-		path: "/description.xml",
+			path: "/description.xml",
-		headers: [
+			headers: [
-			HOST: host
+					HOST: host
-		]], deviceNetworkId, [callback: "bridgeDescriptionHandler"]))
+			]], deviceNetworkId, [callback: "bridgeDescriptionHandler"]))
 }
 
 private verifyHueBridges() {
@@ -399,7 +400,7 @@ def addBulbs() {
 					log.debug "$dni in not longer paired to the Hue Bridge or ID changed"
 				}
 			} else {
-			 	//backwards compatable
+				//backwards compatable
 				newHueBulb = bulbs.find { (app.id + "/" + it.id) == dni }
 				d = addChildBulb(dni, "Extended Color Light", newHueBulb?.value?.name, newHueBulb?.value?.hub)
 				d?.completedSetup = true
@@ -1151,7 +1152,7 @@ def setColorTemperature(childDevice, huesettings) {
 	def ct = hueSettings == 6500 ? 153 : Math.round(1000000/huesettings)
 	createSwitchEvent(childDevice, "on")
 	put("lights/$id/state", [ct: ct, on: true])
-	return "Setting color temperature to $percent"
+	return "Setting color temperature to $ct"
 }
 
 def setColor(childDevice, huesettings) {
@@ -1226,7 +1227,7 @@ private poll() {
 	def uri = "/api/${state.username}/lights/"
 	log.debug "GET: $host$uri"
 	sendHubCommand(new physicalgraph.device.HubAction("GET ${uri} HTTP/1.1\r\n" +
-		"HOST: ${host}\r\n\r\n", physicalgraph.device.Protocol.LAN, selectedHue))
+			"HOST: ${host}\r\n\r\n", physicalgraph.device.Protocol.LAN, selectedHue))
 }
 
 private isOnline(id) {
@@ -1243,10 +1244,10 @@ private put(path, body) {
 	log.debug "BODY: ${bodyJSON}"
 
 	sendHubCommand(new physicalgraph.device.HubAction("PUT $uri HTTP/1.1\r\n" +
-		"HOST: ${host}\r\n" +
+			"HOST: ${host}\r\n" +
-		"Content-Length: ${length}\r\n" +
+			"Content-Length: ${length}\r\n" +
-		"\r\n" +
+			"\r\n" +
-		"${bodyJSON}", physicalgraph.device.Protocol.LAN, "${selectedHue}"))
+			"${bodyJSON}", physicalgraph.device.Protocol.LAN, "${selectedHue}"))
 }
 
 /*