librelink-inovelli-lzw36-adv.groovy

/**
 * =======================================================================================
 *  Copyright 2021 Robert Morris
 *
 *  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.
 *
 * =======================================================================================
 *
 *  Last modified: 2021-04-17
 *
 */ 
 
metadata {
   definition (name: "LibreLink Inovelli LZW36 Advanced (Fan/Light)", namespace: "RMoRobert", author: "Robert Morris", importUrl: "https://raw.githubusercontent.com/RMoRobert/Hubitat-LibreLink/main/drivers/librelink-inovelli-lzw36-adv.groovy") {
      capability "Actuator"
      capability "Refresh"
      capability "Switch"
      capability "SwitchLevel"
      capability "ChangeLevel" // can comment out if don't want or devices don't support
      capability "Light"
      capability "Flash"
      capability "PushableButton"
      capability "HoldableButton"
      capability "DoubleTapableButton"
      capability "ReleasableButton"

      command "setConfigParameter", [[name:"Parameter Number*", type: "NUMBER"], [name:"Value*", type: "NUMBER"], [name:"Size*", type: "NUMBER"]]
      command "setFanIndicator", [[name: "Notification Value*", type: "NUMBER", description: "See https://nathanfiscus.github.io/inovelli-notification-calc to calculate"]]
      command "setFanIndicator", [[name:"Color", type: "ENUM", constraints: ["red", "red-orange", "orange", "yellow", "green", "spring", "cyan", "azure", "blue", "violet", "magenta", "rose", "white"]],
                               [name:"Level", type: "ENUM", description: "Level, 0-100", constraints: [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100]],
                               [name:"Effect", type: "ENUM", description: "Effect name from list", constraints: ["off", "solid", "chase", "fast blink", "slow blink", "pulse"]],
                               [name: "Duration", type: "NUMBER", description: "Duration in seconds, 1-254 or 255 for indefinite"]]
      command "setFanLEDColor", [[name: "Color*", type: "NUMBER", description: "Inovelli format, 0-255"], [name: "Level", type: "NUMBER", description: "Inovelli format, 0-10"]]
      command "setFanLEDColor", [[name: "Color*", type: "ENUM", description: "Color name (from list)", constraints: ["red", "red-orange", "orange", "yellow", "chartreuse", "green", "spring", "cyan", "azure", "blue", "violet", "magenta", "rose", "white"]],
                              [name:"Level", type: "ENUM", description: "Level, 0-100", constraints: [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100]]]
      command "setFanOnLEDLevel", [[name:"Level*", type: "ENUM", description: "Brightess (0-10, 0=off)", constraints: 0..10]]
      command "setFanOffLEDLevel", [[name:"Level*", type: "ENUM", description: "Brightess (0-10, 0=off)", constraints: 0..10]]
      command "setLightIndicator", [[name: "Notification Value*", type: "NUMBER", description: "See https://nathanfiscus.github.io/inovelli-notification-calc to calculate"]]
      command "setLightIndicator", [[name:"Color", type: "ENUM", constraints: ["red", "red-orange", "orange", "yellow", "green", "spring", "cyan", "azure", "blue", "violet", "magenta", "rose", "white"]],
                               [name:"Level", type: "ENUM", description: "Level, 0-100", constraints: [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100]],
                               [name:"Effect", type: "ENUM", description: "Effect name from list", constraints: ["off", "solid", "chase", "fast blink", "slow blink", "pulse"]],
                               [name: "Duration", type: "NUMBER", description: "Duration in seconds, 1-254 or 255 for indefinite"]]
      command "setLightLEDColor", [[name: "Color*", type: "NUMBER", description: "Inovelli format, 0-255"], [name: "Level", type: "NUMBER", description: "Inovelli format, 0-10"]]
      command "setLightLEDColor", [[name: "Color*", type: "ENUM", description: "Color name (from list)", constraints: ["red", "red-orange", "orange", "yellow", "chartreuse", "green", "spring", "cyan", "azure", "blue", "violet", "magenta", "rose", "white"]],
                              [name:"Level", type: "ENUM", description: "Level, 0-100", constraints: [0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100]]]
      command "setLightOnLEDLevel", [[name:"Level*", type: "ENUM", description: "Brightess (0-10, 0=off)", constraints: 0..10]]
      command "setLightOffLEDLevel", [[name:"Level*", type: "ENUM", description: "Brightess (0-10, 0=off)", constraints: 0..10]]
      
      command "syncAttributes"
   }
      
preferences {
      input name: "enableDebug", type: "bool", title: "Enable debug logging", defaultValue: true
      input name: "enableDesc", type: "bool", title: "Enable descriptionText logging", defaultValue: true
   }
}

/* ======== General device and convenience methods ======== */

void installed(){
   log.debug "Installed..."
   initialize()
}

void updated() {
   if (enableDebug) log.debug "Updated..."
   initialize()
}

void initialize() {
   if (enableDebug) log.debug "Initializing"
   int disableMinutes = 30
   if (enableDebug) {
      log.debug "Debug logging will be automatically disabled in ${disableMinutes} minutes"
      runIn(disableMinutes*60, debugOff)
   }
}

void debugOn(Boolean autoDisable=true) {
   log.warn "Enabling debug logging..."
   int disableMinutes = 30
   if (autoDisable) {
      log.debug "Debug logging will be automatically disabled in ${disableMinutes} minutes"
      runIn(disableMinutes*60, debugOff)
   }
   device.updateSetting("enableDebug", [value:"true", type:"bool"])
}

void debugOff() {
   log.warn "Disabling debug logging"
   device.updateSetting("enableDebug", [value:"false", type:"bool"])
}

void doSendEvent(Map eventData, Boolean forceStateChange=false) {
   if (enableDebug) log.debug("doSendEvent(${eventData}...")
   String descriptionText = "${device.displayName} ${eventData.name} is ${eventData.value}${eventData.unit ?: ''}"
   if (enableDesc && (device.currentValue(eventData.name) != eventData.value || eventData.isStateChange)) log.info(descriptionText)
   Map eventProperties = [name: eventData.name, value: eventData.value, descriptionText: descriptionText,
      unit: eventData.unit, phyiscal: eventData.physical, digital: eventData.digital,
      isStateChange: eventData.isStateChange]
   if (forceStateChange) eventProperties["isStateChange"] = true
   sendEvent(eventProperties)
}

// Probably won't happen but...
void parse(String description) {
   log.warn "parse() not implemented: '${description}'"
}

/* ======== LibreLink-specific methods ======== */

void syncAttributes() {
   if (enableDebug) log.debug "syncAttributes()"
   parent.syncAttributesToChildDevice(device.deviceNetworkId)
}

/* ======== Device capability methods ======== */

void refresh() {
   if (enableDebug) log.debug "refresh()"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "refresh")
}

void on() {
   if (enableDebug) log.debug "on()"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "on")
}

void off() {
   if (enableDebug) log.debug "off()"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "off")
}

void setLevel(level) {
   if (enableDebug) log.debug "setLevel($level)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId,
      "setLevel", [level])
}

void setLevel(level, duration) {
   if (enableDebug) log.debug "setLevel($level, $transitionTime)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId,
      "setLevel", [level, (duration != null ? duration.toBigDecimal() : 1)])
}

void startLevelChange(direction) {
   if (enableDebug) log.debug "startLevelChange($direction)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "startLevelChange", [direction])
}

void stopLevelChange() {
   if (enableDebug) log.debug "stopLevelChange()"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "stopLevelChange")
}

void push(btnNum) {
   if (enableDebug) log.debug "push($btnNum)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "push", [btnNum])
}

void hold(btnNum) {
   if (enableDebug) log.debug "hold($btnNum)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "hold", [btnNum])
}

void release(btnNum) {
   if (enableDebug) log.debug "release($btnNum)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "release", [btnNum])
}

void doubleTap(btnNum) {
   if (enableDebug) log.debug "doubleTap($btnNum)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "doubleTap", [btnNum])
}

void setFanIndicator(paramValue) {
   if (enableDebug) log.debug "setFanIndicator($paramValue)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setFanIndicator", [paramValue])
}

void setFanIndicator(color, level, effect, duration) {
   if (enableDebug) log.debug "setFanIndicator($color, $level, $effect, $duration)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setFanIndicator", [color, level, effect, duration])
}

void setFanLEDColor(BigDecimal color, level) {
   if (enableDebug) log.debug "setFanLEDColor(BigDecimal $color, $level)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setFanLEDColor", [color, level])
}

void setFanLEDColor(String color, level) {
   if (enableDebug) log.debug "setFanLEDColor(String $color, $level)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setFanLEDColor", [color, level])
}

void setFanOnLEDLevel(level) {
   if (enableDebug) log.debug "setFanOnLEDLevel($level)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setFanOnLEDLevel", [level])
}

void setFanOffLEDLevel(level) {
   if (enableDebug) log.debug "setFanOffLEDLevel($level)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setFanOffLEDLevel", [level])
}

void setLightIndicator(paramValue) {
   if (enableDebug) log.debug "setLightIndicator($paramValue)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setLightIndicator", [paramValue])
}

void setLightIndicator(color, level, effect, duration) {
   if (enableDebug) log.debug "setLightIndicator($color, $level, $effect, $duration)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setLightIndicator", [color, level, effect, duration])
}

void setLightLEDColor(BigDecimal color, level) {
   if (enableDebug) log.debug "setLightLEDColor(BigDecimal $color, $level)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setLightLEDColor", [color, level])
}

void setLightLEDColor(String color, level) {
   if (enableDebug) log.debug "setLightLEDColor(String $color, $level)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setLightLEDColor", [color, level])
}

void setLightOnLEDLevel(level) {
   if (enableDebug) log.debug "setLightOnLEDLevel($level)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setLightOnLEDLevel", [level])
}

void setLightOffLEDLevel(level) {
   if (enableDebug) log.debug "setLightOffLEDLevel($level)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setLightOffLEDLevel", [level])
}

void setConfigParameter(paramNumber, value, size) {
   if (enableDebug) log.debug "setConfigParameter($paramNumber, $value, $size)"
   parent.sendCommandFromChildDevice(device.deviceNetworkId, "setConfigParameter", [paramNumber, value, size])
}