Merge branch 'master' of github.com:pimatic/pimatic-shell-execute

Author: sweetpi

README.md

@@ -107,6 +107,28 @@ If you're running pimatic on a RaspberryPi, you can use the following sensors fo
       "interval": 60000
     }
 
+
+### ShellButtons Device
+
+You can define a button device with buttons that trigger individual shell commands, eliminating the need for individual rules:
+
+    { 
+      "id": "tv-remote",
+      "name": "TV Remote",
+      "class": "ShellButtons",
+      "buttons": [
+        {
+          "id": "tv-power",
+          "text": "PWR",
+          "onPress": "irsend SEND_ONCE tvset KEY_POWER",
+          "confirm": true
+        }
+      ]
+    }
+    
+The given example shows the possibility to create an infrared remote in the pimatic frontend using lirc.
+The `onPress` command can be any bash command or file you may want to execute.
+
 ### ShellPresenceSensor Device
 
 You can define a presence sensor whose state gets updated with the output of shell command. In some

device-config-schema.coffee

@@ -33,6 +33,36 @@ module.exports = {
         type: "boolean"
         default: false
   }
+  ShellButtons: {
+    title: "ShellButtons config options"
+    type: "object"
+    extensions: ["xLink"]
+    properties:
+      buttons:
+        description: "Buttons and their actions once they are pressed"
+        type: "array"
+        default: []
+        format: "table"
+        items:
+          type: "object"
+          properties:
+            id:
+              description: "ID for the button"
+              type: "string"
+            text:
+              description: "Label for the button"
+              type: "string"
+            onPress:
+              description: "
+                Shell command to be executed, when the button is
+                pressed
+              "
+              type: "string"
+            confirm:
+              description: "Ask the user to confirm the button press"
+              type: "boolean"
+              default: false
+  }
   ShellSensor: {
     title: "ShellSensor config options"
     type: "object"
@@ -96,7 +126,10 @@ module.exports = {
         type: "boolean"
         default: false
       resetTime:
-        description: "Time in milliseconds after that the presence value is reset to absent."
+        description: "
+          Time in milliseconds after that the presence value is
+          reset to absent.
+        "
         type: "integer"
         default: 10000
   }

shell-execute-config-schema.coffee

@@ -4,13 +4,16 @@ module.exports = {
   properties:
     sequential:
       description: "
-        Run all shell commands sequential (not in parallel). Enable this if you have commands 
-        that should not be execute in parallel
+        Run all shell commands sequential (not in parallel). Enable
+        this if you have commands that should not be execute in parallel
       "
       type: "boolean"
       default: false
     shell:
-      description: "Shell to execute a command with. Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows"
+      description: "
+        Shell to execute a command with. Default:
+        '/bin/sh' on UNIX, 'cmd.exe' on Windows
+      "
       type: "string"
       required: false
     cwd:

shell-execute.coffee

@@ -16,7 +16,7 @@ module.exports = (env) ->
     )
   settled = (promise) -> Promise.settle([promise])
 
-  transformError = (error) =>
+  transformError = (error) ->
     if error.code? and error.cause?
       cause = String(error.cause).replace(/(\r\n|\n|\r)/gm," ").trim()
       error = new Error "Command execution failed with exit code #{error.code} (#{cause})"
@@ -35,6 +35,12 @@ module.exports = (env) ->
         createCallback: (config, lastState) => return new ShellSwitch(config, lastState)
       })
 
+      @framework.deviceManager.registerDeviceClass("ShellButtons", {
+        configDef: deviceConfigDef.ShellButtons,
+        createCallback: (config, lastState) ->
+          return new ShellButtons(config, lastState)
+      })
+
       @framework.deviceManager.registerDeviceClass("ShellSensor", {
         configDef: deviceConfigDef.ShellSensor, 
         createCallback: (config, lastState) => return new ShellSensor(config, lastState)
@@ -120,7 +126,34 @@ module.exports = (env) ->
       ).catch( (error) =>
         @base.rejectWithErrorString Promise.reject, transformError(error)
       )
-  
+
+  class ShellButtons extends env.devices.ButtonsDevice
+
+    constructor: (@config, lastState) ->
+      @name = @config.name
+      @id = @config.id
+      @base = commons.base @, @config.class
+
+      # pass config to parent constructor
+      super(@config)
+
+    destroy: () ->
+      super()
+
+    getButton: -> Promise.resolve(@_lastPressedButton)
+
+    buttonPressed: (buttonId) ->
+      for b in @config.buttons
+        if b.id is buttonId
+          command = b.onPress
+          return exec(command, plugin.execOptions).then( ({stdout, stderr}) =>
+            @base.error "stderr output from on/offCommand for
+              #{@name}: #{stderr}" if stderr.length isnt 0
+          ).catch( (error) =>
+            @base.rejectWithErrorString Promise.reject, transformError(error)
+          )
+      throw new Error("No button with the id #{buttonId} found")
+
   class ShellSensor extends env.devices.Sensor
 
     constructor: (@config, lastState) ->