/*	HubiThings Replica Color Bulb Driver
		HubiThings Replica Applications Copyright 2023 by Bloodtick
		Replica Color Bulb Copyright 2023 by Dave Gutheinz

	Licensed under the Apache License, Version 2.0 (the "License"); 
	you may not use this file except in compliance with the License.
	You may obtain a copy of the License at:
	      http://www.apache.org/licenses/LICENSE-2.0
	Unless required by applicable law or agreed to in writing, software 
	distributed under the License is distributed on an "AS IS" BASIS, 
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 
	implied. See the License for the specific language governing 
	permissions and limitations under the License.

Changes:
1.0-1:	
a.	Changed link to help file.
b.	Added logging prefs to library logging.

Issues with this driver: Contact davegut via Private Message on the
Hubitat Community site: https://community.hubitat.com/
==========================================================================*/
import groovy.json.JsonOutput
def driverVer() { return "1.0-1" }
def appliance() { return "ReplicaColorBulb" }

metadata {
	definition (name: appliance(),
				namespace: "replica",
				author: "David Gutheinz",
				importUrl: "https://raw.githubusercontent.com/DaveGut/HubithingsReplica/main/Drivers/${appliance()}.groovy"
			   ){
		capability "Light"
		capability "Switch"
		capability "Switch Level"
		capability "Change Level"
		capability "Color Temperature"
//		command "setColorTemperature", [[
//			name: "Color Temperature", type: "NUMBER"]]
		capability "Color Mode"
		capability "Color Control"
		capability "Refresh"
		capability "Actuator"
		capability "Configuration"
		
		attribute "healthStatus", "enum", ["offline", "online"]
	}
	preferences {
		input ("ctLow", "number", title: "lowerLimit of Color Temp", defaultValue: 2000)
		input ("ctHigh", "number", title: "UpperLimit of Color Temp", defaultValue: 9000)
	}
}

String helpLogo() { return "" }

def installed() {
	initialize()	
}

def updated() {
	unschedule()
	def updStatus = [:]
	initialize()
	if (!getDataValue("driverVersion") || getDataValue("driverVersion") != driverVer()) {
		updateDataValue("driverVersion", driverVer())
		updStatus << [driverVer: driverVer()]
	}
	if (logEnable) { runIn(1800, debugLogOff) }
	updStatus << [logEnable: logEnable, infoLog: infoLog]
	runIn(5, refresh)
	pauseExecution(5000)
	listAttributes(true)
	logInfo("updated: ${updStatus}")
}

def initialize() {
    updateDataValue("triggers", groovy.json.JsonOutput.toJson(getReplicaTriggers()))
    updateDataValue("commands", groovy.json.JsonOutput.toJson(getReplicaCommands()))
}

//	===== HubiThings Device Settings =====
Map getReplicaCommands() {
	Map replicaCommands = [ 
		setSwitchValue:[[name:"switch*",type:"ENUM"]], 
		setLevelValue:[[name:"level*",type:"NUMBER"]] ,
		setColorTemperatureValue:[[name: "colorTemperature", type: "NUMBER"]],
		setHueValue:[[name: "hue*", type: "NUMBER"]],
		setSaturationValue:[[name: "saturation*", type: "NUMBER"]],
		setColorValue:[[name: "color*", type: "STRING"]],
		setHealthStatusValue:[[name:"healthStatus*",type:"ENUM"]]]
	return replicaCommands
}

Map getReplicaTriggers() {
	def replicaTriggers = [
		off:[], on:[], refresh:[],
		setLevel: [
			[name:"level*", type: "NUMBER"],
			[name:"rate", type:"NUMBER", data: "rate"]],
		setColorTemperature: [
			[name:"colorTemperature*", type: "NUMBER"]],
		setColor: [
			[name: "color*", type: "string"]]]
	return replicaTriggers
}

def configure() {
	logInfo("configure: configured default rules")
    initialize()
    updateDataValue("rules", getReplicaRules())
	sendCommand("configure")
}

String getReplicaRules() {
	return """{"version":1,"components":[{"trigger":{"name":"refresh","label":"command: refresh()","type":"command"},"command":{"name":"refresh","type":"command","capability":"refresh","label":"command: refresh()"},"type":"hubitatTrigger"},{"trigger":{"name":"setColor","label":"command: setColor(color*)","type":"command","parameters":[{"name":"color*","type":"OBJECT"}]},"command":{"name":"setColor","arguments":[{"name":"color","optional":false,"schema":{"title":"COLOR_MAP","type":"object","additionalProperties":false,"properties":{"hue":{"type":"number"},"saturation":{"type":"number"},"hex":{"type":"string","maxLength":7},"level":{"type":"integer"},"switch":{"type":"string","maxLength":3}}}}],"type":"command","capability":"colorControl","label":"command: setColor(color*)"},"type":"hubitatTrigger"},{"trigger":{"name":"off","label":"command: off()","type":"command"},"command":{"name":"off","type":"command","capability":"switch","label":"command: off()"},"type":"hubitatTrigger"},{"trigger":{"name":"on","label":"command: on()","type":"command"},"command":{"name":"on","type":"command","capability":"switch","label":"command: on()"},"type":"hubitatTrigger"},{"trigger":{"name":"setColorTemperature","label":"command: setColorTemperature(colorTemperature*)","type":"command","parameters":[{"name":"colorTemperature*","type":"NUMBER"}]},"command":{"name":"setColorTemperature","arguments":[{"name":"temperature","optional":false,"schema":{"type":"integer","minimum":1,"maximum":30000}}],"type":"command","capability":"colorTemperature","label":"command: setColorTemperature(temperature*)"},"type":"hubitatTrigger"},{"trigger":{"type":"attribute","properties":{"value":{"title":"SwitchState","type":"string"}},"additionalProperties":false,"required":["value"],"capability":"switch","attribute":"switch","label":"attribute: switch.*"},"command":{"name":"setSwitchValue","label":"command: setSwitchValue(switch*)","type":"command","parameters":[{"name":"switch*","type":"ENUM"}]},"type":"smartTrigger"},{"trigger":{"title":"IntegerPercent","type":"attribute","properties":{"value":{"type":"integer","minimum":0,"maximum":100},"unit":{"type":"string","enum":["%"],"default":"%"}},"additionalProperties":false,"required":["value"],"capability":"switchLevel","attribute":"level","label":"attribute: level.*"},"command":{"name":"setLevelValue","label":"command: setLevelValue(level*)","type":"command","parameters":[{"name":"level*","type":"NUMBER"}]},"type":"smartTrigger"},{"trigger":{"type":"attribute","properties":{"value":{"type":"integer","minimum":1,"maximum":30000},"unit":{"type":"string","enum":["K"],"default":"K"}},"additionalProperties":false,"required":["value"],"capability":"colorTemperature","attribute":"colorTemperature","label":"attribute: colorTemperature.*"},"command":{"name":"setColorTemperatureValue","label":"command: setColorTemperatureValue(colorTemperature)","type":"command","parameters":[{"name":"colorTemperature","type":"NUMBER"}]},"type":"smartTrigger"},{"trigger":{"type":"attribute","properties":{"value":{"title":"PositiveNumber","type":"number","minimum":0}},"additionalProperties":false,"required":[],"capability":"colorControl","attribute":"hue","label":"attribute: hue.*"},"command":{"name":"setHueValue","label":"command: setHueValue(hue*)","type":"command","parameters":[{"name":"hue*","type":"NUMBER"}]},"type":"smartTrigger"},{"trigger":{"type":"attribute","properties":{"value":{"title":"PositiveNumber","type":"number","minimum":0}},"additionalProperties":false,"required":[],"capability":"colorControl","attribute":"saturation","label":"attribute: saturation.*"},"command":{"name":"setSaturationValue","label":"command: setSaturationValue(saturation*)","type":"command","parameters":[{"name":"saturation*","type":"NUMBER"}]},"type":"smartTrigger"},{"trigger":{"type":"attribute","properties":{"value":{"title":"String","type":"string","maxLength":255}},"additionalProperties":false,"required":[],"capability":"colorControl","attribute":"color","label":"attribute: color.*"},"command":{"name":"setColorValue","label":"command: setColorValue(color*)","type":"command","parameters":[{"name":"color*","type":"STRING"}]},"type":"smartTrigger"},{"trigger":{"type":"attribute","properties":{"value":{"title":"HealthState","type":"string"}},"additionalProperties":false,"required":["value"],"capability":"healthCheck","attribute":"healthStatus","label":"attribute: healthStatus.*"},"command":{"name":"setHealthStatusValue","label":"command: setHealthStatusValue(healthStatus*)","type":"command","parameters":[{"name":"healthStatus*","type":"ENUM"}]},"type":"smartTrigger"},{"trigger":{"name":"setLevel","label":"command: setLevel(level*, rate)","type":"command","parameters":[{"name":"level*","type":"NUMBER"},{"name":"rate","type":"NUMBER","data":"rate"}]},"command":{"name":"setLevel","arguments":[{"name":"level","optional":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"rate","optional":true,"schema":{"title":"PositiveInteger","type":"integer","minimum":0}}],"type":"command","capability":"switchLevel","label":"command: setLevel(level*, rate)"},"type":"hubitatTrigger"}]}"""
}

//	===== HubiThings Send Command and Device Health =====
def setHealthStatusValue(value) {    
    sendEvent(name: "healthStatus", value: value, descriptionText: "${device.displayName} healthStatus set to $value")
}

private def sendCommand(String name, def value=null, String unit=null, data=[:]) {
    parent?.deviceTriggerHandler(device, [name:name, value:value, unit:unit, data:data, now:now])
}

void refresh() {
	sendCommand("refresh")
}

//	===== Mono, CT, Color Bulb commands =====
def on() {
	sendCommand("on")
}

def off() {
	sendCommand("off")
}

def setSwitchValue(onOff) {
    sendEvent(name: "switch", value: onOff)
	logDebug("setSwitchValue: [switch: ${onOff}]")
}

def setLevel(level, transTime = transTime) {
	if (level == null || level < 0) {
		level = 0
	} else if (level > 100) {
		level = 100
	}
	if (transTime == null || transTime < 0) {
		transTime = 0
	} else if (transTime > 8) {
		transTime = 8
	}
	if (level == 0) {
		off()
	} else {
		sendCommand("setLevel", level, null, [rate:transTime])
	}
}

def startLevelChange(direction) {
	unschedule(levelUp)
	unschedule(levelDown)
	if (direction == "up") { levelUp() }
	else { levelDown() }
}

def stopLevelChange() {
	unschedule(levelUp)
	unschedule(levelDown)
}

def levelUp() {
	def curLevel = device.currentValue("level").toInteger()
	if (curLevel == 100) { return }
	def newLevel = curLevel + 4
	if (newLevel > 100) { newLevel = 100 }
	setLevel(newLevel, 0)
	runIn(1, levelUp)
}

def levelDown() {
	def curLevel = device.currentValue("level").toInteger()
	if (curLevel == 0 || device.currentValue("switch") == "off") { return }
	def newLevel = curLevel - 4
	if (newLevel < 0) { off() }
	else {
		setLevel(newLevel, 0)
		runIn(1, levelDown)
	}
}

def setLevelValue(level) {
	sendEvent(name: "level", value: level, unit: "%")
	//	Update attribute color if in color mode
	if (device.currentValue("colorMode") == "COLOR") {
		runIn(3, setHslValue)
	}
	logDebug("setLevelValue: [level: ${level}%]")
}

//	===== CT and Color Bulb Commands =====
def setColorTemperature(colorTemp, level = device.currentValue("level"), transTime=null) {
//def setColorTemperature(colorTemp) {
	if (colorTemp > ctHigh) { colorTemp = ctHigh}
	else if (colorTemp < ctLow) { colorTemp = ctLow}
	sendEvent(name: "colorMode", value: "CT")
	sendCommand("setColorTemperature", colorTemp)
//	added single line
	setLevel(level, transTime)
	if(device.currentValue("colorTemperature") == colorTemp) {
		setColorTemperatureValue(colorTemp)
	}
}

def setColorTemperatureValue(colorTemp) {
	def logData = [colorTemperature: "${colorTemp}°K"]
	sendEvent(name: "colorTemperature", value: colorTemp, unit: "°K")
	if (device.currentValue("colorMode") == "CT") {
		def colorName = convertTemperatureToGenericColorName(colorTemp.toInteger())
		sendEvent(name: "colorName", value: colorName, isChange: true)
		logData << [colorName: colorName]
	}
	logDebug("setColorTemperatureValue: ${logData}")
}

//	===== Color Bulb Commands =====
def setHue(hue) { 
	hue = (hue + 0.5).toInteger()
	if (hue < 0) { hue = 0 }
	else if (hue > 100) { hue = 100 }
	setColor([hue: hue])
}

def setSaturation(saturation) {
	saturation = (saturation +0.5).toInteger()
	if (saturation < 0) { saturation = 0 }
	else if (saturation > 100) { saturation = 100 }
	setColor([saturation: saturation])
}

def setColor(color) {
	log.trace color
	if (color == null) {
		LogWarn("setColor: Color map is null. Command not executed.")
	} else {
		def level = device.currentValue("level")
		if (color.level != null) { level = color.level }
		//	ST setColor does not always implement "level".  For Hubitat
		//	compatibility reasons, do a separate setLevel (rate = 0).
		setLevel(level, 0)
		pauseExecution(200)
		def hue = device.currentValue("hue")
		if (color.hue != null) { hue = color.hue }
		def saturation = device.currentValue("saturation")
		if (color.saturation != null) { saturation = color.saturation }
		//	create hex value of HSL
		def rgbData = hubitat.helper.ColorUtils.hsvToRGB([hue, saturation, level])
		def rgbHex = hubitat.helper.HexUtils.integerToHexString(rgbData[0], 1)
		rgbHex += hubitat.helper.HexUtils.integerToHexString(rgbData[1], 1)
		rgbHex += hubitat.helper.HexUtils.integerToHexString(rgbData[2], 1)
		def newColor = """{"hue":${hue}, "saturation":${saturation}, "level":${level}, "hex": "${rgbHex}"}"""
		sendEvent(name: "colorMode", value: "COLOR")
		sendCommand("setColor", newColor)
		logDebug("setColor: [color: ${newColor}, colorMode: COLOR]")
	}
}

def setHueValue(hue) {
	def logData = [:]
	hue = (hue + 0.5).toInteger()
	sendEvent(name: "hue", value: hue, unit: "%")
	logData << [hue: "${hue}%"]
	if (device.currentValue("colorMode") == "COLOR") {
		def colorName = convertHueToGenericColorName(hue)
		sendEvent(name: "colorName", value: colorName)
		logData << [colorName: colorName]
	}
	runIn(3, setHslValue)
	logDebug("setHueValue: ${logData}")
}

def setSaturationValue(saturation) {
	saturation = (saturation + 0.5).toInteger()
	sendEvent(name: "saturation", value: saturation, unit: "%")
	runIn(3, setHslValue)
	logInfo("setSaturationValue: [saturation: ${saturation}%]")
}

def setHslValue() {
	String color = """{"hue": ${device.currentValue("hue")},"""
	color += """"saturation": ${device.currentValue("saturation")},"""
	color += """"level": ${device.currentValue("level")}}"""
	setColorAttrs(color, true)
}

def setColorValue(color) {
	setColorAttrs(color, false)
}

def setColorAttrs(color, internal) {
	Map logData = [:]
	logData << [color: color, internal: internal]
	if (color != null) {
		color = parseJson(color)
		sendEvent(name: "color", value: color)
		if (!internal) {
			sendEvent(name: "colorMode", value: "COLOR")
			sendEvent(name: "hue", value: color.hue)
			sendEvent(name: "saturation", value: color.saturation)
			sendEvent(name: "level", value: color.level)
			def colorName = convertHueToGenericColorName(color.hue)
			sendEvent(name: "colorName", value: colorName)
			logData << [colorName: colorName, colorMode: "COLOR"]
		}
	} else {
		logData << [staus: "ERROR", reason: "null data from SmartThings"]
	}
	logDebug("setColorValue: ${logData}")
}

//	===== Data Logging =====
def listAttributes(trace = false) {
	def attrs = device.getSupportedAttributes()
	def attrList = [:]
	attrs.each {
		def val = device.currentValue("${it}")
		attrList << ["${it}": val]
	}
	if (trace == true) {
		logInfo("Attributes: ${attrList}")
	} else {
		logDebug("Attributes: ${attrList}")
	}
}

def logTrace(msg){
	log.trace "${device.displayName}-${driverVer()}: ${msg}"
}

def logInfo(msg) { 
	if (textEnable) {
		log.info "${device.displayName}-${driverVer()}: ${msg}"
	}
}

def debugLogOff() {
	if (logEnable) {
		device.updateSetting("logEnable", [type:"bool", value: false])
	}
	logInfo("debugLogOff")
}

def logDebug(msg) {
	if (logEnable) {
		log.debug "${device.displayName}-${driverVer()}: ${msg}"
	}
}

def logWarn(msg) { log.warn "${device.displayName}-${driverVer()}: ${msg}" }