MSA-1818: Yamaha Receiver and Zones

Update shabbat-and-holiday-modes.groovy

devicetypes/redloro-smartthings/yamaha-zone.src/yamaha-zone.groovy

@@ -0,0 +1,282 @@
+/**
+ *  SmartThings Device Handler: Yamaha Zone
+ *
+ *  Author: redloro@gmail.com
+ *
+ *  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.
+ */
+metadata {
+  definition (name: "Yamaha Zone", namespace: "redloro-smartthings", author: "redloro@gmail.com") {
+
+    /**
+     * List our capabilties. Doing so adds predefined command(s) which
+     * belong to the capability.
+     */
+    capability "Music Player"
+    capability "Switch"
+    capability "Switch Level"
+    capability "Refresh"
+    capability "Polling"
+
+    /**
+     * Define all commands, ie, if you have a custom action not
+     * covered by a capability, you NEED to define it here or
+     * the call will not be made.
+     *
+     * To call a capability function, just prefix it with the name
+     * of the capability, for example, refresh would be "refresh.refresh"
+     */
+    command "source0"
+    command "source1"
+    command "source2"
+    command "source3"
+    command "source4"
+    command "source5"
+    command "mutedOn"
+    command "mutedOff"
+    command "partyModeOn"
+    command "partyModeOff"
+    command "zone"
+  }
+
+  /**
+   * Define the various tiles and the states that they can be in.
+   * The 2nd parameter defines an event which the tile listens to,
+   * if received, it tries to map it to a state.
+   *
+   * You can also use ${currentValue} for the value of the event
+   * or ${name} for the name of the event. Just make SURE to use
+   * single quotes, otherwise it will only be interpreted at time of
+   * launch, instead of every time the event triggers.
+   */
+  tiles(scale: 2) {
+    multiAttributeTile(name:"state", type:"lighting", width:6, height:4) {
+      tileAttribute ("device.switch", key: "PRIMARY_CONTROL") {
+        attributeState "on", label:'On', action:"switch.off", icon:"st.Electronics.electronics16", backgroundColor:"#79b821", nextState:"off"
+        attributeState "off", label:'Off', action:"switch.on", icon:"st.Electronics.electronics16", backgroundColor:"#ffffff", nextState:"on"
+      }
+      tileAttribute ("source", key: "SECONDARY_CONTROL") {
+        attributeState "source", label:'${currentValue}'
+      }
+    }
+
+    // row
+    //controlTile("volume", "device.volume", "slider", height: 1, width: 6, range:"(0..100)") {
+    controlTile("volume", "device.volume", "slider", height: 1, width: 6, range:"(-80..16)") {
+      state "volume", label: "Volume", action:"music Player.setLevel", backgroundColor:"#00a0dc"
+    }
+
+    // row
+    standardTile("0", "device.source0", decoration: "flat", width: 2, height: 2) {
+      state("off", label:"AV1", action:"source0", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-gray.png", backgroundColor:"#ffffff")
+      state("on", label:"AV1", action:"source0", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-green.png", backgroundColor:"#ffffff")
+    }
+    standardTile("1", "device.source1", decoration: "flat", width: 2, height: 2) {
+      state("off", label:"AV2", action:"source1", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-gray.png", backgroundColor:"#ffffff")
+      state("on", label:"AV2", action:"source1", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-green.png", backgroundColor:"#ffffff")
+    }
+    standardTile("2", "device.source2", decoration: "flat", width: 2, height: 2) {
+      state("off", label:"AV3", action:"source2", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-gray.png", backgroundColor:"#ffffff")
+      state("on", label:"AV3", action:"source2", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-green.png", backgroundColor:"#ffffff")
+    }
+    standardTile("3", "device.source3", decoration: "flat", width: 2, height: 2) {
+      state("off", label:"AV4", action:"source3", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-gray.png", backgroundColor:"#ffffff")
+      state("on", label:"AV4", action:"source3", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-green.png", backgroundColor:"#ffffff")
+    }
+    standardTile("4", "device.source4", decoration: "flat", width: 2, height: 2) {
+      state("off", label:"AV5", action:"source4", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-gray.png", backgroundColor:"#ffffff")
+      state("on", label:"AV5", action:"source4", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-green.png", backgroundColor:"#ffffff")
+    }
+    standardTile("5", "device.source5", decoration: "flat", width: 2, height: 2) {
+      state("off", label:"AV6", action:"source5", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-gray.png", backgroundColor:"#ffffff")
+      state("on", label:"AV6", action:"source5", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-green.png", backgroundColor:"#ffffff")
+    }
+
+    // row
+    standardTile("muted", "device.muted", decoration: "flat", width: 2, height: 2) {
+      state("off", label:'Muted', action:"mutedOn", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-gray.png", backgroundColor:"#ffffff", nextState:"on")
+      state("on", label:'Muted', action:"mutedOff", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-mute.png", backgroundColor:"#ffffff", nextState:"off")
+    }
+    standardTile("partyMode", "device.partyMode", decoration: "flat", width: 2, height: 2, inactiveLabel: false) {
+      state("off", label:'Party Mode', action:"partyModeOn", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-gray.png", backgroundColor:"#ffffff", nextState:"on")
+      state("on", label:'Party Mode', action:"partyModeOff", icon:"https://raw.githubusercontent.com/redloro/smartthings/master/images/indicator-dot-party.png", backgroundColor:"#ffffff", nextState:"off")
+    }
+    standardTile("refresh", "device.status", width: 2, height: 2, inactiveLabel: false, decoration: "flat") {
+      state "default", label:"Refresh", action:"refresh.refresh", icon:"st.secondary.refresh-icon", backgroundColor:"#ffffff"
+    }
+
+    // Defines which tile to show in the overview
+    main "state"
+
+    // Defines which tile(s) to show when user opens the detailed view
+    details([
+      "state",
+      "volume",
+      "0","1","2","3","4","5",
+      "muted", "partyMode","refresh"
+    ])
+  }
+
+  preferences {
+    input name: "source0", type: "text", title: "Source 1", defaultValue: "AV1"
+    input name: "source1", type: "text", title: "Source 2", defaultValue: "AV2"
+    input name: "source2", type: "text", title: "Source 3", defaultValue: "AV3"
+    input name: "source3", type: "text", title: "Source 4", defaultValue: "AV4"
+    input name: "source4", type: "text", title: "Source 5", defaultValue: "AV5"
+    input name: "source5", type: "text", title: "Source 6", defaultValue: "AV6"
+  }
+}
+
+/**************************************************************************
+ * The following section simply maps the actions as defined in
+ * the metadata into onAction() calls.
+ *
+ * This is preferred since some actions can be dealt with more
+ * efficiently this way. Also keeps all user interaction code in
+ * one place.
+ *
+ */
+def on() {
+  sendCommand("<YAMAHA_AV cmd=\"PUT\"><${getZone()}><Power_Control><Power>On</Power></Power_Control></${getZone()}></YAMAHA_AV>")
+  sendEvent(name: "switch", value: "on")
+}
+def off() {
+  sendCommand("<YAMAHA_AV cmd=\"PUT\"><${getZone()}><Power_Control><Power>Standby</Power></Power_Control></${getZone()}></YAMAHA_AV>")
+  sendEvent(name: "switch", value: "off")
+}
+def setLevel(value) {
+  //sendCommand("<YAMAHA_AV cmd=\"PUT\"><${getZone()}><Volume><Lvl><Val>${(Math.round(value * 9 / 5) * 5 - 800).intValue()}</Val><Exp>1</Exp><Unit>dB</Unit></Lvl></Volume></${getZone()}></YAMAHA_AV>")
+  sendCommand("<YAMAHA_AV cmd=\"PUT\"><${getZone()}><Volume><Lvl><Val>${(value * 10).intValue()}</Val><Exp>1</Exp><Unit>dB</Unit></Lvl></Volume></${getZone()}></YAMAHA_AV>")
+  sendEvent(name: "volume", value: value)
+}
+def source0() {
+  setSource(0)
+}
+def source1() {
+  setSource(1)
+}
+def source2() {
+  setSource(2)
+}
+def source3() {
+  setSource(3)
+}
+def source4() {
+  setSource(4)
+}
+def source5() {
+  setSource(5)
+}
+def mutedOn() {
+  sendCommand("<YAMAHA_AV cmd=\"PUT\"><${getZone()}><Volume><Mute>On</Mute></Volume></${getZone()}></YAMAHA_AV>")
+  sendEvent(name: "muted", value: "on")
+}
+def mutedOff() {
+  sendCommand("<YAMAHA_AV cmd=\"PUT\"><${getZone()}><Volume><Mute>Off</Mute></Volume></${getZone()}></YAMAHA_AV>")
+  sendEvent(name: "muted", value: "off")
+}
+def partyModeOn() {
+  sendCommand("<YAMAHA_AV cmd=\"PUT\"><System><Party_Mode><Mode>On</Mode></Party_Mode></System></YAMAHA_AV>")
+  sendEvent(name: "partyMode", value: "on")
+}
+def partyModeOff() {
+  sendCommand("<YAMAHA_AV cmd=\"PUT\"><System><Party_Mode><Mode>Off</Mode></Party_Mode></System></YAMAHA_AV>")
+  sendEvent(name: "partyMode", value: "off")
+}
+def refresh() {
+  sendCommand("<YAMAHA_AV cmd=\"GET\"><${getZone()}><Basic_Status>GetParam</Basic_Status></${getZone()}></YAMAHA_AV>")
+  sendCommand("<YAMAHA_AV cmd=\"GET\"><System><Party_Mode><Mode>GetParam</Mode></Party_Mode></System></YAMAHA_AV>")
+}
+/**************************************************************************/
+
+/**
+ * Called every so often (every 5 minutes actually) to refresh the
+ * tiles so the user gets the correct information.
+ */
+def poll() {
+  refresh()
+}
+
+def parse(String description) {
+  return
+}
+
+def setSource(id) {
+  //log.debug "source: "+getSourceName(id)
+  sendCommand("<YAMAHA_AV cmd=\"PUT\"><${getZone()}><Input><Input_Sel>"+getSourceName(id)+"</Input_Sel></Input></${getZone()}></YAMAHA_AV>")
+  setSourceTile(getSourceName(id))
+}
+
+def getSourceName(id) {
+  if (settings) {
+    return settings."source${id}"
+  } else {
+    return ['AV1', 'AV2', 'AV3', 'AV4', 'AV5', 'AV6'].get(id)
+  }
+}
+
+def setSourceTile(name) {
+  sendEvent(name: "source", value: "Source: ${name}")
+  for (def i = 0; i < 6; i++) {
+    if (name == getSourceName(i)) {
+      sendEvent(name: "source${i}", value: "on")
+    }
+    else {
+      sendEvent(name: "source${i}", value: "off")
+    }
+  }
+}
+
+def zone(evt) {
+  /*
+  * Zone On/Off
+  */
+  if (evt.Basic_Status.Power_Control.Power.text()) {
+    sendEvent(name: "switch", value: (evt.Basic_Status.Power_Control.Power.text() == "On") ? "on" : "off")
+  }
+
+  /*
+  * Zone Volume
+  */
+  if (evt.Basic_Status.Volume.Lvl.Val.text()) {
+    def int volLevel = evt.Basic_Status.Volume.Lvl.Val.toInteger() ?: -250
+    //sendEvent(name: "volume", value: ((volLevel + 800) / 9).intValue())
+    sendEvent(name: "volume", value: (volLevel / 10).intValue())
+  }
+
+  /*
+  * Zone Muted
+  */
+  if (evt.Basic_Status.Volume.Mute.text()) {
+    sendEvent(name: "muted", value: (evt.Basic_Status.Volume.Mute.text() == "On") ? "on" : "off")
+  }
+
+  /*
+  * Zone Source
+  */
+  if (evt.Basic_Status.Input.Input_Sel.text()) {
+    setSourceTile(evt.Basic_Status.Input.Input_Sel.text())
+  }
+
+  /*
+  * Party Mode
+  */
+  if (evt.Party_Mode.Mode.text()) {
+    sendEvent(name: "partyMode", value: (evt.Party_Mode.Mode.text() == "On") ? "on" : "off")
+  }
+}
+
+private sendCommand(body) {
+  parent.sendCommand(body)
+}
+
+private getZone() {
+  return new String(device.deviceNetworkId).tokenize('|')[2]
+}

smartapps/redloro-smartthings/yamaha-receiver.src/yamaha-receiver.groovy

@@ -0,0 +1,154 @@
+/**
+ *  SmartThings SmartApp: Yamaha Network Receiver
+ *
+ *  Author: redloro@gmail.com
+ *
+ *  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.
+ *
+ *  https://github.com/PSeitz/yamaha-nodejs
+ *  http://<RECEIVER_IP_ADDRESS>/YamahaRemoteControl/desc.xml
+ */
+import groovy.util.XmlSlurper
+
+definition(
+  name: "Yamaha Receiver",
+  namespace: "redloro-smartthings",
+  author: "redloro@gmail.com",
+  description: "Yamaha SmartApp",
+  category: "My Apps",
+  iconUrl: "https://raw.githubusercontent.com/redloro/smartthings/master/images/yamaha-receiver.png",
+  iconX2Url: "https://raw.githubusercontent.com/redloro/smartthings/master/images/yamaha-receiver.png",
+  iconX3Url: "https://raw.githubusercontent.com/redloro/smartthings/master/images/yamaha-receiver.png"
+)
+
+preferences {
+  section("SmartThings Hub") {
+    input "hostHub", "hub", title: "Select Hub", multiple: false, required: true
+  }
+  section("Yamaha Receiver") {
+    input name: "receiverName", type: "text", title: "Name", required: true, defaultValue: "Yamaha"
+    input name: "receiverIp", type: "text", title: "IP", required: true
+    input name: "receiverZones", type: "enum", title: "Zones", required: true, multiple: true, options: ["Main_Zone","Zone_B","Zone_2","Zone_3","Zone_4"]
+  }
+}
+
+def installed() {
+  subscribeToEvents()
+}
+
+def subscribeToEvents() {
+  subscribe(location, null, lanResponseHandler, [filterEvents:false])
+}
+
+def updated() {
+  addChildDevices()
+}
+
+def uninstalled() {
+  removeChildDevices()
+}
+
+def lanResponseHandler(evt) {
+  def map = stringToMap(evt.stringValue)
+
+  //verify that this message is from Yamaha Receiver IP
+  if (!map.ip || map.ip != convertIPtoHex(settings.receiverIp)) {
+    return
+  }
+
+  def headers = getHttpHeaders(map.headers);
+  def body = getHttpBody(map.body);
+  //log.trace "Headers: ${headers}"
+  //log.trace "Body: ${body}"
+
+  updateZoneDevices(body.children()[0])
+}
+
+private updateZoneDevices(evt) {
+  //log.debug "updateZoneDevices: ${evt.toString()}"
+  if (evt.name() == "System") {
+    //log.debug "Update all zones"
+    childDevices*.zone(evt)
+    return
+  }
+
+  def zonedevice = getChildDevice(getDeviceId(evt.name()))
+  if (zonedevice) {
+    zonedevice.zone(evt)
+  }
+
+  //check for Zone_B
+  zonedevice = getChildDevice(getDeviceId("Zone_B"))
+  if (zonedevice && evt.name() == "Main_Zone") {
+    zonedevice.zone(evt)
+  }
+}
+
+private addChildDevices() {
+  // add yamaha device
+  settings.receiverZones.each {
+    def deviceId = getDeviceId(it)
+    if (!getChildDevice(deviceId)) {
+      addChildDevice("redloro-smartthings", "Yamaha Zone", deviceId, hostHub.id, ["name": it, label: "${settings.receiverName}: ${it}", completedSetup: true])
+      log.debug "Added Yamaha zone: ${deviceId}"
+    }
+  }
+
+  childDevices*.refresh()
+}
+
+private removeChildDevices() {
+  getAllChildDevices().each { deleteChildDevice(it.deviceNetworkId) }
+}
+
+private sendCommand(body) {
+  //log.debug "Yamaha Network Receiver send command: ${body}"
+
+  def hubAction = new physicalgraph.device.HubAction(
+      headers: [HOST: getReceiverAddress()],
+      method: "POST",
+      path: "/YamahaRemoteControl/ctrl",
+      body: body
+  )
+  sendHubCommand(hubAction)
+}
+
+private getHttpHeaders(headers) {
+  def obj = [:]
+  new String(headers.decodeBase64()).split("\r\n").each {param ->
+    def nameAndValue = param.split(":")
+    obj[nameAndValue[0]] = (nameAndValue.length == 1) ? "" : nameAndValue[1].trim()
+  }
+  return obj
+}
+
+private getHttpBody(body) {
+  def obj = null;
+  if (body) {
+    obj = new XmlSlurper().parseText(new String(body.decodeBase64()))
+  }
+  return obj
+}
+
+private getDeviceId(zone) {
+  return "yamaha|${settings.receiverIp}|${zone}"
+}
+
+private getReceiverAddress() {
+  return settings.receiverIp + ":80"
+}
+
+private String convertIPtoHex(ipAddress) {
+  return ipAddress.tokenize( '.' ).collect {  String.format( '%02x', it.toInteger() ) }.join().toUpperCase()
+}
+
+private String convertPortToHex(port) {
+  return port.toString().format( '%04x', port.toInteger() ).toUpperCase()
+}

smartapps/shabbatholidaymode/shabbat-and-holiday-modes.src/shabbat-and-holiday-modes.groovy

@@ -30,7 +30,7 @@ preferences {
 		input "havdalahOffset", "number", title: "Minutes After Sundown", required:true
 	} 
 	section("Your ZipCode") {
-		input "zipcode", "number", title: "ZipCode", required:true
+		input "zipcode", "text", title: "ZipCode", required:true
 	}
     section( "Notifications" ) {
         input "sendPushMessage", "enum", title: "Send a push notification?", metadata:[values:["Yes","No"]], required:false
@@ -205,4 +205,4 @@ if ( sendPushMessage != "No" ) {
         log.debug( "sending text message" )
         sendSms( phone, msg )
     }
-}//END def sendMessage(msg)
+}//END def sendMessage(msg)