Elk-M1-Driver-Output.groovy

/***********************************************************************************************************************
 *
 *  A Hubitat Child Driver supporting Elk M1 Outputs.
 *
 *  License:
 *  This program is free software: you can redistribute it and/or modify it under the terms of the GNU
 *  General Public License as published by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
 *  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 *  for more details.
 *
 *  Name: Elk M1 Driver Outputs
 *
 *  I am not a programmer so alot of this work is through trial and error. I also spent a good amount of time looking
 *  at other integrations on various platforms.
 *
 *** See Release Notes at the bottom***
 ***********************************************************************************************************************/

public static String version() { return "v0.1.9" }

metadata {
	definition(name: "Elk M1 Driver Outputs", namespace: "belk", author: "Mike Magrann") {
		capability "Actuator"
		capability "Switch"
		command "push", [[name: "duration", type: "NUMBER"]]
		command "refresh"
	}
	preferences {
		input name: "txtEnable", type: "bool", title: "Enable descriptionText logging", defaultValue: true
	}
}

void updated() {
	log.warn "${device.label} Updated..."
	log.warn "${device.label} description logging is: ${txtEnable}"
}

hubitat.device.HubAction installed() {
	log.warn "${device.label} Installed..."
	device.updateSetting("txtEnable", [type: "bool", value: true])
	refresh()
}

void uninstalled() {
}

void parse(String description) {
	if (device.currentState("switch")?.value == null || device.currentState("switch").value != description) {
		String descriptionText = "${device.label} is ${description}"
		if (txtEnable)
			log.info descriptionText
		sendEvent(name: "switch", value: description, descriptionText: descriptionText)
	}
}

void parse(List description) {
	log.warn "${device.label} parse(List description) received ${description}"
}

hubitat.device.HubAction push(String duration = "1") {
	on(duration)
}

hubitat.device.HubAction on(String duration = "0") {
	String output = device.deviceNetworkId
	output = output.substring(output.length() - 3).take(3)
	parent.sendMsg(parent.ControlOutputOn(output.toInteger(), duration))
}

hubitat.device.HubAction off() {
	String output = device.deviceNetworkId
	output = output.substring(output.length() - 3).take(3)
	parent.sendMsg(parent.ControlOutputOff(output.toInteger()))
}

hubitat.device.HubAction refresh() {
	parent.refreshOutputStatus()
}

/***********************************************************************************************************************
 *
 * Release Notes (see Known Issues Below)
 *
 * 0.1.9
 * Strongly typed commands
 *
 * 0.1.8
 * Added descriptionText to switch events
 *
 * 0.1.7
 * Changed logging and events to only occur when state changes
 *
 * 0.1.6
 * Added Refresh Command
 * Simplified logging and event code
 *
 * 0.1.5
 * Strongly typed variables for performance
 *
 * 0.1.4
 * Added info logging
 *
 * 0.1.3
 * Added Momentary capability
 *
 * 0.1.2
 * Cleaned up code
 *
 * 0.1.1
 * New child driver to Elk M1 Outputs
 *
 ***********************************************************************************************************************/
/***********************************************************************************************************************
 *
 * Feature Request & Known Issues
 *
 *
 ***********************************************************************************************************************/