mirror of
https://github.com/mtan93/SmartThingsPublic.git
synced 2026-03-08 05:31:56 +00:00
Merge pull request #1889 from SmartThingsCommunity/MSA-1883-3
MSA-1883: EZMultipli 3:1 MultiSensor wall powered
This commit is contained in:
Vinay Rao
426
devicetypes/drzwave/ezmultipli.src/ezmultipli.groovy
Normal file
426
devicetypes/drzwave/ezmultipli.src/ezmultipli.groovy
Normal file
@@ -0,0 +1,426 @@
|
||||
// Express Controls EZMultiPli Multi-sensor
|
||||
// Motion Sensor - Temperature - Light level - 8 Color Indicator LED - Z-Wave Range Extender - Wall Powered
|
||||
// driver for SmartThings
|
||||
// The EZMultiPli is also known as the HSM200 from HomeSeer.com
|
||||
//
|
||||
// 2017-04-10 - DrZwave (with help from Don Kirker) - changed fingerprint to the new format, lowered the OnTime
|
||||
// and other parameters to be "more in line with ST user expectations", get the luminance in LUX so it reports in lux all the time.
|
||||
// 2016-10-06 - erocm1231 - Added "updated" method to run when configuration options are changed. Depending on model of unit, luminance is being
|
||||
// reported as a relative percentace or as a lux value. Added the option to configure this in the handler.
|
||||
// 2016-01-28 - erocm1231 - Changed the configuration method to use scaledConfiguration so that it properly formatted negative numbers.
|
||||
// Also, added configurationGet and a configurationReport method so that config values can be verified.
|
||||
// 2015-12-04 - erocm1231 - added range value to preferences as suggested by @Dela-Rick.
|
||||
// 2015-11-26 - erocm1231 - Fixed null condition error when adding as a new device.
|
||||
// 2015-11-24 - erocm1231 - Added refresh command. Made a few changes to how the handler maps colors to the LEDs. Fixed
|
||||
// the device not having its on/off status updated when colors are changed.
|
||||
// 2015-11-23 - erocm1231 - Changed the look to match SmartThings v2 devices.
|
||||
// 2015-11-21 - erocm1231 - Made code much more efficient. Also made it compatible when setColor is passed a hex value.
|
||||
// Mapping of special colors: Soft White - Default - Yellow, White - Concentrate - White,
|
||||
// Daylight - Energize - Teal, Warm White - Relax - Yellow
|
||||
// 2015-11-19 - erocm1231 - Fixed a couple incorrect colors, changed setColor to be more compatible with other apps
|
||||
// 2015-11-18 - erocm1231 - Added to setColor for compatibility with Smart Lighting
|
||||
// v0.1.0 - DrZWave - chose better icons, Got color LED to work - first fully functional version
|
||||
// v0.0.9 - jrs - got the temp and luminance to work. Motion works. Debugging the color wheel.
|
||||
// v0.0.8 - DrZWave 2/25/2015 - change the color control to be tiles since there are only 8 colors.
|
||||
// v0.0.7 - jrs - 02/23/2015 - Jim Sulin
|
||||
|
||||
metadata {
|
||||
definition (name: "EZmultiPli", namespace: "DrZWave", author: "Eric Ryherd", oauth: true) {
|
||||
capability "Actuator"
|
||||
capability "Sensor"
|
||||
capability "Motion Sensor"
|
||||
capability "Temperature Measurement"
|
||||
capability "Illuminance Measurement"
|
||||
capability "Switch"
|
||||
capability "Color Control"
|
||||
capability "Configuration"
|
||||
capability "Refresh"
|
||||
|
||||
fingerprint mfr: "001E", prod: "0004", model: "0001" // new format for Fingerprint which is unique for every certified Z-Wave product
|
||||
} // end definition
|
||||
|
||||
simulator {
|
||||
// messages the device returns in response to commands it receives
|
||||
status "motion" : "command: 7105000000FF07, payload: 07"
|
||||
status "no motion" : "command: 7105000000FF07, payload: 00"
|
||||
|
||||
for (int i = 0; i <= 100; i += 20) {
|
||||
status "temperature ${i}F": new physicalgraph.zwave.Zwave().sensorMultilevelV5.sensorMultilevelReport(
|
||||
scaledSensorValue: i, precision: 1, sensorType: 1, scale: 1).incomingMessage()
|
||||
}
|
||||
for (int i = 0; i <= 100; i += 20) {
|
||||
status "luminance ${i} %": new physicalgraph.zwave.Zwave().sensorMultilevelV5.sensorMultilevelReport(
|
||||
scaledSensorValue: i, precision: 0, sensorType: 3).incomingMessage()
|
||||
}
|
||||
|
||||
} //end simulator
|
||||
|
||||
|
||||
tiles (scale: 2){
|
||||
multiAttributeTile(name:"switch", type: "lighting", width: 6, height: 4, canChangeIcon: true){
|
||||
tileAttribute ("device.switch", key: "PRIMARY_CONTROL", icon: "st.Lighting.light18") {
|
||||
attributeState "on", label:'${name}', action:"switch.off", icon:"st.switches.light.on", backgroundColor:"#79b821", nextState:"turningOff"
|
||||
attributeState "off", label:'${name}', action:"switch.on", icon:"st.switches.light.off", backgroundColor:"#ffffff", nextState:"turningOn"
|
||||
attributeState "turningOn", label:'${name}', icon:"st.switches.light.on", backgroundColor:"#79b821"
|
||||
attributeState "turningOff", label:'${name}', icon:"st.switches.light.off", backgroundColor:"#ffffff"
|
||||
}
|
||||
tileAttribute ("device.color", key: "COLOR_CONTROL") {
|
||||
attributeState "color", action:"setColor"
|
||||
}
|
||||
tileAttribute ("statusText", key: "SECONDARY_CONTROL") {
|
||||
attributeState "statusText", label:'${currentValue}'
|
||||
}
|
||||
}
|
||||
|
||||
standardTile("motion", "device.motion", width: 2, height: 2, canChangeIcon: true, canChangeBackground: true) {
|
||||
state "active", label:'motion', icon:"st.motion.motion.active", backgroundColor:"#53a7c0"
|
||||
state "inactive", label:'no motion', icon:"st.motion.motion.inactive", backgroundColor:"#ffffff"
|
||||
}
|
||||
valueTile("temperature", "device.temperature", width: 2, height: 2) {
|
||||
state "temperature", label:'${currentValue}°', unit:"F", icon:"", // would be better if the units would switch to the desired units of the system (imperial or metric)
|
||||
backgroundColors:[
|
||||
[value: 0, color: "#1010ff"], // blue=cold
|
||||
[value: 65, color: "#a0a0f0"],
|
||||
[value: 70, color: "#e0e050"],
|
||||
[value: 75, color: "#f0d030"], // yellow
|
||||
[value: 80, color: "#fbf020"],
|
||||
[value: 85, color: "#fbdc01"],
|
||||
[value: 90, color: "#fb3a01"],
|
||||
[value: 95, color: "#fb0801"] // red=hot
|
||||
]
|
||||
}
|
||||
|
||||
// icons to use would be st.Weather.weather2 or st.alarm.temperature.normal - see http://scripts.3dgo.net/smartthings/icons/ for a list of icons
|
||||
valueTile("illuminance", "device.illuminance", width: 2, height: 2, inactiveLabel: false) {
|
||||
// jrs 4/7/2015 - Null on display
|
||||
//state "luminosity", label:'${currentValue} ${unit}'
|
||||
state "luminosity", label:'${currentValue}', unit:'${currentValue}', icon:"",
|
||||
backgroundColors:[
|
||||
[value: 25, color: "#404040"],
|
||||
[value: 50, color: "#808080"],
|
||||
[value: 75, color: "#a0a0a0"],
|
||||
[value: 90, color: "#e0e0e0"],
|
||||
//lux measurement values
|
||||
[value: 150, color: "#404040"],
|
||||
[value: 300, color: "#808080"],
|
||||
[value: 600, color: "#a0a0a0"],
|
||||
[value: 900, color: "#e0e0e0"]
|
||||
]
|
||||
}
|
||||
standardTile("refresh", "device.switch", inactiveLabel: false, decoration: "flat", width: 2, height: 2) {
|
||||
state "default", label:"", action:"refresh.refresh", icon:"st.secondary.refresh"
|
||||
}
|
||||
standardTile("configure", "device.configure", inactiveLabel: false, width: 2, height: 2, decoration: "flat") {
|
||||
state "configure", label:'', action:"configuration.configure", icon:"st.secondary.configure"
|
||||
}
|
||||
|
||||
main (["temperature","motion", "switch"])
|
||||
details(["switch", "motion", "temperature", "illuminance", "refresh", "configure"])
|
||||
} // end tiles
|
||||
|
||||
preferences {
|
||||
input "OnTime", "number", title: "No Motion Interval", description: "N minutes lights stay on after no motion detected [0, 1-127]", range: "0..127", defaultValue: 2, displayDuringSetup: true, required: false
|
||||
input "OnLevel", "number", title: "Dimmer Onlevel", description: "Dimmer OnLevel for associated node 2 lights [-1, 0, 1-99]", range: "-1..99", defaultValue: -1, displayDuringSetup: true, required: false
|
||||
input "LiteMin", "number", title: "Luminance Report Frequency", description: "Luminance report sent every N minutes [0-127]", range: "0..127", defaultValue: 6, displayDuringSetup: true, required: false
|
||||
input "TempMin", "number", title: "Temperature Report Frequency", description: "Temperature report sent every N minutes [0-127]", range: "0..127", defaultValue: 6, displayDuringSetup: true, required: false
|
||||
input "TempAdj", "number", title: "Temperature Calibration", description: "Adjust temperature up/down N tenths of a degree F [(-127)-(+128)]", range: "-127..128", defaultValue: 0, displayDuringSetup: true, required: false
|
||||
input("lum", "enum", title:"Illuminance Measurement", description: "Percent or Lux", defaultValue: 2 ,required: false, displayDuringSetup: true, options:
|
||||
[1:"Percent",
|
||||
2:"Lux"])
|
||||
}
|
||||
|
||||
} // end metadata
|
||||
|
||||
|
||||
// Parse incoming device messages from device to generate events
|
||||
def parse(String description){
|
||||
//log.debug "==> New Zwave Event: ${description}"
|
||||
def result = []
|
||||
def cmd = zwave.parse(description, [0x31: 5]) // 0x31=SensorMultilevel which we force to be version 5
|
||||
if (cmd) {
|
||||
def cmdData = zwaveEvent(cmd)
|
||||
if (cmdData != [:])
|
||||
result << createEvent(cmdData)
|
||||
}
|
||||
|
||||
def statusTextmsg = ""
|
||||
if (device.currentState('temperature') != null && device.currentState('illuminance') != null) {
|
||||
statusTextmsg = "${device.currentState('temperature').value} ° - ${device.currentState('illuminance').value} ${(lum == "" || lum == null || lum == 1) ? "%" : "LUX"}"
|
||||
sendEvent("name":"statusText", "value":statusTextmsg, displayed:false)
|
||||
}
|
||||
if (result != [null] && result != []) log.debug "Parse returned ${result}"
|
||||
|
||||
|
||||
return result
|
||||
}
|
||||
|
||||
|
||||
// Event Generation
|
||||
def zwaveEvent(physicalgraph.zwave.commands.sensormultilevelv5.SensorMultilevelReport cmd){
|
||||
def map = [:]
|
||||
switch (cmd.sensorType) {
|
||||
case 0x01: // SENSOR_TYPE_TEMPERATURE_VERSION_1
|
||||
def cmdScale = cmd.scale == 1 ? "F" : "C"
|
||||
map.value = convertTemperatureIfNeeded(cmd.scaledSensorValue, cmdScale, cmd.precision)
|
||||
map.unit = getTemperatureScale()
|
||||
map.name = "temperature"
|
||||
log.debug "Temperature report"
|
||||
break;
|
||||
case 0x03 : // SENSOR_TYPE_LUMINANCE_VERSION_1
|
||||
map.value = cmd.scaledSensorValue.toInteger().toString()
|
||||
if(lum == "" || lum == null || lum == 1) map.unit = "%"
|
||||
else map.unit = "lux"
|
||||
map.name = "illuminance"
|
||||
log.debug "Luminance report"
|
||||
break;
|
||||
}
|
||||
return map
|
||||
}
|
||||
|
||||
def zwaveEvent(physicalgraph.zwave.commands.configurationv2.ConfigurationReport cmd) {
|
||||
log.debug "${device.displayName} parameter '${cmd.parameterNumber}' with a byte size of '${cmd.size}' is set to '${cmd.configurationValue}'"
|
||||
}
|
||||
|
||||
def zwaveEvent(physicalgraph.zwave.commands.notificationv3.NotificationReport cmd) {
|
||||
def map = [:]
|
||||
if (cmd.notificationType==0x07) { // NOTIFICATION_TYPE_BURGLAR
|
||||
if (cmd.event==0x07 || cmd.event==0x08) {
|
||||
map.name = "motion"
|
||||
map.value = "active"
|
||||
map.descriptionText = "$device.displayName motion detected"
|
||||
log.debug "motion recognized"
|
||||
} else if (cmd.event==0) {
|
||||
map.name = "motion"
|
||||
map.value = "inactive"
|
||||
map.descriptionText = "$device.displayName no motion detected"
|
||||
log.debug "No motion recognized"
|
||||
}
|
||||
}
|
||||
if (map.name != "motion") {
|
||||
log.debug "unmatched parameters for cmd: ${cmd.toString()}}"
|
||||
}
|
||||
return map
|
||||
}
|
||||
|
||||
def zwaveEvent(physicalgraph.zwave.commands.basicv1.BasicReport cmd) {
|
||||
if (cmd.value == 0 && device.latestState("color").value != "#ffffff") {
|
||||
sendEvent(name: "color", value: "#ffffff", displayed: true)
|
||||
}
|
||||
[name: "switch", value: cmd.value ? "on" : "off", type: "digital"]
|
||||
}
|
||||
|
||||
def updated()
|
||||
{
|
||||
log.debug "updated() is being called"
|
||||
|
||||
def cmds = configure()
|
||||
|
||||
if (cmds != []) response(cmds)
|
||||
}
|
||||
|
||||
def on() {
|
||||
log.debug "Turning Light 'on'"
|
||||
delayBetween([
|
||||
zwave.basicV1.basicSet(value: 0xFF).format(),
|
||||
zwave.basicV1.basicGet().format()
|
||||
], 500)
|
||||
}
|
||||
|
||||
def off() {
|
||||
log.debug "Turning Light 'off'"
|
||||
delayBetween([
|
||||
zwave.basicV1.basicSet(value: 0x00).format(),
|
||||
zwave.basicV1.basicGet().format()
|
||||
], 500)
|
||||
}
|
||||
|
||||
|
||||
def setColor(value) {
|
||||
log.debug "setColor() : ${value}"
|
||||
def myred
|
||||
def mygreen
|
||||
def myblue
|
||||
def hexValue
|
||||
def cmds = []
|
||||
|
||||
if ( value.level == 1 && value.saturation > 20) {
|
||||
def rgb = huesatToRGB(value.hue as Integer, 100)
|
||||
myred = rgb[0] >=128 ? 255 : 0
|
||||
mygreen = rgb[1] >=128 ? 255 : 0
|
||||
myblue = rgb[2] >=128 ? 255 : 0
|
||||
}
|
||||
else if ( value.level > 1 ) {
|
||||
def rgb = huesatToRGB(value.hue as Integer, value.saturation as Integer)
|
||||
myred = rgb[0] >=128 ? 255 : 0
|
||||
mygreen = rgb[1] >=128 ? 255 : 0
|
||||
myblue = rgb[2] >=128 ? 255 : 0
|
||||
}
|
||||
else if (value.hex) {
|
||||
def rgb = value.hex.findAll(/[0-9a-fA-F]{2}/).collect { Integer.parseInt(it, 16) }
|
||||
myred = rgb[0] >=128 ? 255 : 0
|
||||
mygreen = rgb[1] >=128 ? 255 : 0
|
||||
myblue = rgb[2] >=128 ? 255 : 0
|
||||
}
|
||||
else {
|
||||
myred=value.red >=128 ? 255 : 0 // the EZMultiPli has just on/off for each of the 3 channels RGB so convert the 0-255 value into 0 or 255.
|
||||
mygreen=value.green >=128 ? 255 : 0
|
||||
myblue=value.blue>=128 ? 255 : 0
|
||||
}
|
||||
//log.debug "Red: ${myred} Green: ${mygreen} Blue: ${myblue}"
|
||||
//cmds << zwave.colorControlV1.stateSet(stateDataLength: 3, VariantGroup1: [0x02, myred], VariantGroup2:[ 0x03, mygreen], VariantGroup3:[0x04,myblue]).format() // ST support for this command as of 2015/02/23 does not support the color IDs so this command cannot be used.
|
||||
// So instead we'll use these commands to hack around the lack of support of the above command
|
||||
cmds << zwave.basicV1.basicSet(value: 0x00).format() // As of 2015/02/23 ST is not supporting stateSet properly but found this hack that works.
|
||||
if (myred!=0) {
|
||||
cmds << zwave.colorControlV1.startCapabilityLevelChange(capabilityId: 0x02, startState: myred, ignoreStartState: True, updown: True).format()
|
||||
cmds << zwave.colorControlV1.stopStateChange(capabilityId: 0x02).format()
|
||||
}
|
||||
if (mygreen!=0) {
|
||||
cmds << zwave.colorControlV1.startCapabilityLevelChange(capabilityId: 0x03, startState: mygreen, ignoreStartState: True, updown: True).format()
|
||||
cmds << zwave.colorControlV1.stopStateChange(capabilityId: 0x03).format()
|
||||
}
|
||||
if (myblue!=0) {
|
||||
cmds << zwave.colorControlV1.startCapabilityLevelChange(capabilityId: 0x04, startState: myblue, ignoreStartState: True, updown: True).format()
|
||||
cmds << zwave.colorControlV1.stopStateChange(capabilityId: 0x04).format()
|
||||
}
|
||||
cmds << zwave.basicV1.basicGet().format()
|
||||
hexValue = rgbToHex([r:myred, g:mygreen, b:myblue])
|
||||
if(hexValue) sendEvent(name: "color", value: hexValue, displayed: true)
|
||||
delayBetween(cmds, 100)
|
||||
}
|
||||
|
||||
def zwaveEvent(physicalgraph.zwave.Command cmd) {
|
||||
// Handles all Z-Wave commands we aren't interested in
|
||||
[:]
|
||||
}
|
||||
|
||||
// ensure we are passing acceptable param values for LiteMin & TempMin configs
|
||||
def checkLiteTempInput(value) {
|
||||
if (value == null) {
|
||||
value=60
|
||||
}
|
||||
def liteTempVal = value.toInteger()
|
||||
switch (liteTempVal) {
|
||||
case { it < 0 }:
|
||||
return 60 // bad value, set to default
|
||||
break
|
||||
case { it > 127 }:
|
||||
return 127 // bad value, greater then MAX, set to MAX
|
||||
break
|
||||
default:
|
||||
return liteTempVal // acceptable value
|
||||
}
|
||||
}
|
||||
|
||||
// ensure we are passing acceptable param value for OnTime config
|
||||
def checkOnTimeInput(value) {
|
||||
if (value == null) {
|
||||
value=10
|
||||
}
|
||||
def onTimeVal = value.toInteger()
|
||||
switch (onTimeVal) {
|
||||
case { it < 0 }:
|
||||
return 10 // bad value set to default
|
||||
break
|
||||
case { it > 127 }:
|
||||
return 127 // bad value, greater then MAX, set to MAX
|
||||
break
|
||||
default:
|
||||
return onTimeVal // acceptable value
|
||||
}
|
||||
}
|
||||
|
||||
// ensure we are passing acceptable param value for OnLevel config
|
||||
def checkOnLevelInput(value) {
|
||||
if (value == null) {
|
||||
value=99
|
||||
}
|
||||
def onLevelVal = value.toInteger()
|
||||
switch (onLevelVal) {
|
||||
case { it < -1 }:
|
||||
return -1 // bad value set to default
|
||||
break
|
||||
case { it > 99 }:
|
||||
return 99 // bad value, greater then MAX, set to MAX
|
||||
break
|
||||
default:
|
||||
return onLevelVal // acceptable value
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// ensure we are passing an acceptable param value for TempAdj configs
|
||||
def checkTempAdjInput(value) {
|
||||
if (value == null) {
|
||||
value=0
|
||||
}
|
||||
def tempAdjVal = value.toInteger()
|
||||
switch (tempAdjVal) {
|
||||
case { it < -127 }:
|
||||
return 0 // bad value, set to default
|
||||
break
|
||||
case { it > 128 }:
|
||||
return 128 // bad value, greater then MAX, set to MAX
|
||||
break
|
||||
default:
|
||||
return tempAdjVal // acceptable value
|
||||
}
|
||||
}
|
||||
|
||||
def refresh() {
|
||||
def cmd = []
|
||||
cmd << zwave.switchColorV3.switchColorGet().format()
|
||||
cmd << zwave.sensorMultilevelV5.sensorMultilevelGet(sensorType:1, scale:1).format()
|
||||
cmd << zwave.sensorMultilevelV5.sensorMultilevelGet(sensorType:3, scale:1).format()
|
||||
cmd << zwave.basicV1.basicGet().format()
|
||||
delayBetween(cmd, 1000)
|
||||
}
|
||||
|
||||
def configure() {
|
||||
log.debug "OnTime=${settings.OnTime} OnLevel=${settings.OnLevel} TempAdj=${settings.TempAdj}"
|
||||
def cmd = delayBetween([
|
||||
zwave.configurationV1.configurationSet(parameterNumber: 1, size: 1, scaledConfigurationValue: checkOnTimeInput(settings.OnTime)).format(),
|
||||
zwave.configurationV1.configurationSet(parameterNumber: 2, size: 1, scaledConfigurationValue: checkOnLevelInput(settings.OnLevel)).format(),
|
||||
zwave.configurationV1.configurationSet(parameterNumber: 3, size: 1, scaledConfigurationValue: checkLiteTempInput(settings.LiteMin)).format(),
|
||||
zwave.configurationV1.configurationSet(parameterNumber: 4, size: 1, scaledConfigurationValue: checkLiteTempInput(settings.TempMin)).format(),
|
||||
zwave.configurationV1.configurationSet(parameterNumber: 5, size: 1, scaledConfigurationValue: checkTempAdjInput(settings.TempAdj)).format(),
|
||||
zwave.configurationV1.configurationGet(parameterNumber: 1).format(),
|
||||
zwave.configurationV1.configurationGet(parameterNumber: 2).format(),
|
||||
zwave.configurationV1.configurationGet(parameterNumber: 3).format(),
|
||||
zwave.configurationV1.configurationGet(parameterNumber: 4).format(),
|
||||
zwave.configurationV1.configurationGet(parameterNumber: 5).format()
|
||||
], 100)
|
||||
//log.debug cmd
|
||||
cmd + refresh()
|
||||
}
|
||||
|
||||
def huesatToRGB(float hue, float sat) {
|
||||
while(hue >= 100) hue -= 100
|
||||
int h = (int)(hue / 100 * 6)
|
||||
float f = hue / 100 * 6 - h
|
||||
int p = Math.round(255 * (1 - (sat / 100)))
|
||||
int q = Math.round(255 * (1 - (sat / 100) * f))
|
||||
int t = Math.round(255 * (1 - (sat / 100) * (1 - f)))
|
||||
switch (h) {
|
||||
case 0: return [255, t, p]
|
||||
case 1: return [q, 255, p]
|
||||
case 2: return [p, 255, t]
|
||||
case 3: return [p, q, 255]
|
||||
case 4: return [t, p, 255]
|
||||
case 5: return [255, p, q]
|
||||
}
|
||||
}
|
||||
def rgbToHex(rgb) {
|
||||
def r = hex(rgb.r)
|
||||
def g = hex(rgb.g)
|
||||
def b = hex(rgb.b)
|
||||
def hexColor = "#${r}${g}${b}"
|
||||
|
||||
hexColor
|
||||
}
|
||||
private hex(value, width=2) {
|
||||
def s = new BigInteger(Math.round(value).toString()).toString(16)
|
||||
while (s.size() < width) {
|
||||
s = "0" + s
|
||||
}
|
||||
s
|
||||
}
|
||||
Reference in New Issue
Block a user