hegelAmp.groovy

 /*
 * Hegel Amp Telnet Driver
 *
 *  Licensed Virtual 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.
 *
 *  Change History:
 *
 *    Date        Who            What
 *    ----        ---            ----
 *    18Jan2022	  thebearmay    Add a forced reconnect option
 *    18Jan2022   thebearmay    Sync current state when sendMsg used
 *    26Jan2022   thebearmay	For input 1 default volume to 85
 */
import groovy.transform.Field
@Field iVals = ['Balanced','Analog 1','Analog 2','Coaxial','Optical 1','Optical 2','Optical 3','USB','Network']
@SuppressWarnings('unused')
static String version() {return "0.1.1"}

metadata {
    definition (
        name: "Hegel Amp", 
        namespace: "thebearmay", 
        author: "Jean P. May, Jr.",
        importUrl:"https://raw.githubusercontent.com/thebearmay/hubitat/main/hegelAmp.groovy"
    ) {
        
        capability "Telnet"
        capability "Switch"
        
        attribute "mute", "ENUM", ["on", "off"]
        attribute "input", "STRING"
        attribute "lastStatusMessage", "STRING"
        attribute "lastParseMessage", "STRING"
        attribute "lastMessage", "STRING"
        attribute "lastVolume", "NUMBER"

        command "connectTelnet"
        command "disconnectTelnet"
        command "powerToggle"
        command "volUp"
        command "volDown"
        command "setVolume", [[name:"level*", type:"NUMBER", description:"Level to set volume to, % of Max", range:"0..100"]] 
        command "muteOn"
        command "muteOff"
        command "muteToggle"
        command "setInput", [[name:"inputNum*", type:"NUMBER", description:"Input Number", range:"1..9"]]
        command "clearMsg"

    }   
}

preferences {

    input(name: "ipAddr", type: "string", title:"IP Address", required: true)
    input(name: "portNum", type: "number", title: "Port Number", required: true)
    input(name: "volume", type: "number", title: "Starting Volume Level", defaultValue: 50, range:"0..100", submitOnChange: true)
    input(name: "startInput", type: "number", title: "Input at Power On (0 to use last value)", defaultValue: 0, range:"0..9", submitOnChange:true)
    input(name: "keepAlive", type: "bool", title: "Use device keep alive", defaultValue: false, submitOnChange: true)
}

@SuppressWarnings('unused')
def installed() {

}

def updated(){
    if(volume == null) device.updateSetting("volume",[value:50,type:"number"])
    if(startInput == null) device.updateSetting("startInput",[value:0,type:"number"])
    if(keepAlive) 
        runIn(120, "sendReset")
    else 
        unschedule()
}

void updateAttr(String aKey, aValue, String aUnit = "", String aDesc = ""){
    sendEvent(name:aKey, value:aValue, unit:aUnit, descriptionText:aDesc)
}

def clearMsg(){
    updateAttr("lastMessage","-")
    updateAttr("lastStatusMessage","-")
    updateAttr("lastParseMessage","-")    
}

def connectTelnet(){
    try{
        telnetConnect([termChars:[13]], ipAddr, (int)portNum, null, null)
		updateAttr("networkStatus", "online")
    } catch (ex) {
        updateAttr("lastMessage", ex)
    }
}

def disconnectTelnet() {
    telnetClose()
	updateAttr("networkStatus", "offline")
}

def sendMsg(message, manual=true) {
	if(manual) syncState(message)
    sendHubCommand(new hubitat.device.HubAction("""$message\r""", hubitat.device.Protocol.TELNET))
}

def syncState(message){
    msgCmd = message.substring(1,2)
	msgParam = message.substring(3,message.length())
	switch (msgCmd) {
		case "i":
            updateAttr("input", "${iVals[(Integer)msgParam.toInteger()-1]}","","Set by sendMsg")
			break
		case "m":
		    if(msgParam == "t"){
		        if(device.currentValue("mute") == "on")
                    updateAttr("mute", "off","","Set by sendMsg")
                else        
                    updateAttr("mute", "on","","Set by sendMsg")
			} else if(msgParam == 1)
                updateAttr("mute", "on","","Set by sendMsg")			
			else
                updateAttr("mute", "off","","Set by sendMsg")			
			break
		case "p":
		    if(msgParam == "t"){
			    if(device.currentValue("switch") == "on")
                    updateAttr("switch", "off","","Set by sendMsg")
                else 
                    updateAttr("switch", "on","","Set by sendMsg")
			} else if(msgParam==1)
				updateAttr("switch", "on", "", "Set by sendMsg")
			else
				updateAttr("switch", "off", "", "Set by sendMsg")
			break
		case "v":
		    if (msgParam == "u")
			    updateAttr("lastVolume", device.currentValue("lastVolume").toInteger() + 1,"","Set by sendMsg")
		    else if (msgParam == "d")
			    updateAttr("lastVolume", device.currentValue("lastVolume").toInteger() - 1,"","Set by sendMsg")
			else 
			    updateAttr("lastVolume", msgParam, "", "Set by sendMsg")
			break
		 default:
            updateAttr("lastMessage","Invalid Cmd or Param - $message:$msgCmd|$msgParam") 
			break
	}

}

def on(){
    connectTelnet()
    pauseExecution(100)
    sendMsg("-p.1",false)
    updateAttr("switch", "on")
    setVolume(volume)
    updateAttr("mute","off")
    updateAttr("networkStatus", "online")
    if(startInput > 0){     
        pauseExecution(100)
        setInput(startInput)
    } else {
        pauseExecution(100)
        setInput(iVals.findIndexOf{it == device.currentValue("input", true)} + 1)        
    }
    if(keepAlive){
        pauseExecution(100)
        runIn(120, "sendReset")
    }
}

def off(){
    sendMsg("-p.0",false)
    pauseExecution(100)
    unschedule()
    sendMsg("-r.~",false)
    pauseExecution(100)
    disconnectTelnet()
    updateAttr("switch", "off")
    updateAttr("networkStatus", "offline")
}

def powerToggle(){
    sendMsg("-p.t",false)
    if(device.currentValue("switch") == "on")
        updateAttr("switch", "off")
    else {
        updateAttr("switch", "on")
        pauseExecution(100)
        setVolume(volume)
        updateAttr("mute","off")
    }
}

def muteOn(){
    sendMsg("-m.1",false)
    updateAttr("mute", "on")
}

def muteOff(){
    sendMsg("-m.0",false)
    updateAttr("mute", "off")
}

def muteToggle(){
    sendMsg("-m.t",false)
    if(device.currentValue("mute") == "on")
        updateAttr("mute", "off")
    else        
        updateAttr("mute", "on")
}

def volUp() {
    sendMsg("-v.u",false)
    updateAttr("lastVolume", device.currentValue("lastVolume").toInteger() + 1)
}

def volDown() {
    sendMsg("-v.d",false)
    updateAttr("lastVolume", device.currentValue("lastVolume").toInteger() - 1)
}

def setVolume(level){
    level = level.toInteger()
    if(level < 0 || level > 100) level = 50
    sendMsg("-v.$level",false)
    updateAttr("lastVolume",level)
}

def setInput(inputNum){
    inputNum = inputNum.toInteger()
    if(inputNum < 1 || inputNum> 9) inputNum = 1
    updateAttr("input", "${iVals[(Integer)inputNum-1]}")
    sendMsg("-i.$inputNum",false)
    if(inputNum == 1) {
	pauseExecution(100)
	setVolume(85)
    }      
}

def sendReset(){
    sendMsg("-r.3",false)
    runIn(120,"sendReset")
}

def parse(message) {
    updateAttr("lastParseMessage", message)
}

def telnetStatus(message){
    updateAttr("lastStatusMessage", message)
    if(message.contains("receive error: Stream is closed")){
        updateAttr("lastMessage","Stream closed, Reconnecting...")
        connectTelnet()
        sendMsg(device.currentValue("lastParseMessage",true) ,false)
    }
}