added experimental scene selector device, issue #9

Author: mwittig

README.md

@@ -148,7 +148,7 @@ depend on the AVR model.
 
     {
           "id": "avr-5",
-          "name": "AVR Inout Selector",
+          "name": "AVR Input Selector",
           "class": "YamahaAvrInputSelector"
           "buttons": [
                {
@@ -171,6 +171,29 @@ The following action is provided to switch the input source as part of rules
 
 * `avr input <device> to "<id>"`, for example: `avr input yamaha-avr to "tv"`
 
+### YamahaAvrSceneSelector (Experimental)
+
+Similar to the input selector, the YamahaAvrSceneSelector can be used switch the the input by selecting a scene if the
+AVR supports that feature. Allowed values for scene selection depend on the AVR model.
+
+    {
+          "id": "avr-5",
+          "name": "AVR Scene Selector",
+          "class": "YamahaAvrSceneSelector"
+          "buttons": [
+               {
+                 "id": "TV"
+               }
+          ]
+    }
+
+The device has the following configuration properties:
+
+| Property          | Default  | Type    | Description                                 |
+|:------------------|:---------|:--------|:--------------------------------------------|
+| interval          | 20       | Number  | The time interval in seconds (minimum 10) at which the power state of the AVR will be read |
+| buttons           | see example | Array   | The buttons to display for selection. See device configuration schema for details |
+
 ## History
 
 See [Release History](https://github.com/mwittig/pimatic-yamaha-avr/blob/master/HISTORY.md).

device-config-schema.coffee

@@ -103,4 +103,39 @@ module.exports = {
               type: "boolean"
               default: false
   }
+  YamahaAvrSceneSelector: {
+    title: "Yamaha AVR Scene Selector"
+    description: "Yamaha AVR Scene Selector"
+    type: "object"
+    extensions: ["xLink", "xOnLabel", "xOffLabel"]
+    properties:
+      interval:
+        description: "The time interval in seconds (minimum 10) at which the mutr state of the AVR will be read"
+        type: "number"
+        default: 30
+        minimum: 10
+      buttons:
+        description: "The scenes to select from"
+        type: "array"
+        default: [
+          {
+            id: "TV"
+          }
+        ]
+        format: "table"
+        items:
+          type: "object"
+          properties:
+            id:
+              type: "string"
+              description: "The scene ids switchable by the AVR"
+            text:
+              type: "string"
+              description: "The button text to be displayed. The id will be displayed if not set"
+              required: false
+            confirm:
+              description: "Ask the user to confirm the scene select"
+              type: "boolean"
+              default: false
+  }
 }

devices/yamaha-avr-scene-selector.coffee

@@ -0,0 +1,57 @@
+module.exports = (env) ->
+
+  Promise = env.require 'bluebird'
+  _ = env.require 'lodash'
+  commons = require('pimatic-plugin-commons')(env)
+  commands = require '../yamaha-avr-commands'
+  cmd = commands.cmd
+
+  # Device class representing a scene button of the Yamaha AVR
+  class YamahaAvrSceneSelector extends env.devices.ButtonsDevice
+
+    # Create a new YamahaAvrSceneSelector device
+    # @param [Object] config    device configuration
+    # @param [YamahaAvrPlugin] plugin   plugin instance
+    # @param [Object] lastState state information stored in database
+    constructor: (@config, @plugin, lastState) ->
+      @base = commons.base @, @config.class
+      @id = @config.id
+      @name = @config.name
+      @interval = @base.normalize @config.interval, 10
+      @debug = @plugin.debug || false
+      for b in @config.buttons
+        b.text = b.id unless b.text?
+      @statusUpdateHandler = @_createStatusUpdateHandler()
+      @plugin.on 'statusUpdate', @statusUpdateHandler
+      super(@config)
+      process.nextTick () =>
+        @plugin.startStatusUpdates @interval * 1000
+
+    destroy: () ->
+      @plugin.removeListener 'statusUpdate', @statusUpdateHandler
+      super()
+
+    _createStatusUpdateHandler: () ->
+      return (status) =>
+        @base.debug "Status Update", status
+        if status.Input?.Select?
+          @_lastPressedButton = status.Input.Select
+          @emit 'button', status.Input.Select
+
+    buttonPressed: (buttonId) ->
+      return new Promise (resolve, reject) =>
+        matched = @config.buttons.some (element, iterator) =>
+          element.id is buttonId
+
+        if matched
+          @plugin.sendRequest(cmd.command cmd.put, cmd.mainZone cmd.scene cmd.sceneSelect buttonId).then (data) =>
+            @_lastPressedButton = buttonId
+            @emit 'button', buttonId
+            @plugin.emit "statusUpdate",
+              Scene:
+                Select: buttonId
+            resolve()
+            .catch (errorResult) =>
+            @base.rejectWithErrorString reject, if errorResult instanceof Error then errorResult else errorResult.error
+        else
+          @base.rejectWithErrorString new Error("No button with the id #{buttonId} found")

yamaha-avr-commands.coffee

@@ -13,7 +13,9 @@ module.exports = {
     val: (command) -> "<Val>#{command}</Val><Exp>1</Exp><Unit>dB</Unit>"
     mute: (state) -> "<Mute>#{if state then "On" else "Off"}</Mute>"
     input: (command) -> "<Input>#{command}</Input>"
-    inputSelect: (command) -> "<Input_Sel>#{command}</Input_Sel>"
+    scene: (command) -> "<Scene>#{command}</Scene>"
+    inputSelect: (parameter) -> "<Input_Sel>#{parameter}</Input_Sel>"
+    sceneSelect: (parameter) -> "<Scene_Sel>#{parameter}</Scene_Sel>"
 
   query:
     resultCode: (object) -> parseInt object.YAMAHA_AV.$.RC

yamaha-avr.coffee

@@ -29,6 +29,10 @@ module.exports = (env) ->
       "name": "Yamaha AVR Input Selector",
       "class": "YamahaAvrInputSelector",
     }
+    {
+      "name": "Yamaha AVR Scene Selector",
+      "class": "YamahaAvrSceneSelector",
+    }
   ]
 
   actionProviders = [
@@ -80,6 +84,7 @@ module.exports = (env) ->
       @base.cancelUpdate()
       @base.debug "Requesting status update"
       @sendRequest(cmd.command cmd.get, cmd.mainZone cmd.basicStatus cmd.getParam).then (data) =>
+        @base.debug JSON.stringify(data)
         status =
           Power: query.powerState query.powerControl query.basicStatus query.mainZone query.command data
           Mute: query.mute query.volume query.basicStatus query.mainZone query.command data