Merge pull request #61 from bewee/bewee/patch-4

Add custom actions to custom things

Author: tim-hellhake

manifest.json

@@ -46,8 +46,7 @@
           "items": {
             "type": "object",
             "required": [
-              "name",
-              "properties"
+              "name"
             ],
             "properties": {
               "name": {
@@ -145,6 +144,38 @@
                     }
                   }
                 }
+              },
+              "actions": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "required": [
+                    "name",
+                    "title"
+                  ],
+                  "properties": {
+                    "name": {
+                      "description": "Machine-readable action name, e.g. \"action1\".",
+                      "type": "string"
+                    },
+                    "title": {
+                      "description": "Human-readable action name, e.g. \"My Action 1\".",
+                      "type": "string"
+                    },
+                    "description": {
+                      "description": "Human-readable description of this action.",
+                      "type": "string"
+                    },
+                    "input": {
+                      "description": "Optional JSON describing the inputs of this action (No inputs if empty)",
+                      "type": "string"
+                    },
+                    "emitEvent": {
+                      "description": "Emit an event whenever this action gets executed",
+                      "type": "boolean"
+                    }
+                  }
+                }
               }
             }
           }

package.json

@@ -23,7 +23,7 @@
   },
   "devDependencies": {
     "babel-eslint": "^10.1.0",
-    "eslint": "^7.14.0"
+    "eslint": "^7.25.0"
   },
   "files": [
     "LICENSE",

virtual-things-adapter.js

@@ -1323,6 +1323,16 @@ class VirtualThingsDevice extends Device {
 
     action.start();
 
+    if (this.id.startsWith('virtual-things-custom-')) {
+      if (this.events.has(action.name)) {
+        this.eventNotify(new Event(this,
+                                   action.name,
+                                   action.input));
+      }
+      action.finish();
+      return Promise.resolve();
+    }
+
     switch (action.name) {
       case 'basic':
         this.eventNotify(new Event(this,
@@ -1525,7 +1535,7 @@ class VirtualThingsAdapter extends Adapter {
           continue;
         }
 
-        const properties = descr.properties.map((property) => {
+        const properties = (descr.properties || []).map((property) => {
           return Object.assign({}, property);
         });
         for (const property of properties) {
@@ -1583,6 +1593,17 @@ class VirtualThingsAdapter extends Adapter {
           }
         }
 
+        const actions = (descr.actions || []).map((action) => {
+          return Object.assign({}, action);
+        });
+        for (const action of actions) {
+          try {
+            action.input = JSON.parse(action.input);
+          } catch (ex) {
+            delete action.input;
+          }
+        }
+
         const newDescr = {
           type: 'thing',
           '@context': descr['@context'] || 'https://iot.mozilla.org/schemas',
@@ -1638,6 +1659,38 @@ class VirtualThingsAdapter extends Adapter {
           newDescr.properties.push(prop);
         }
 
+        for (const action of actions) {
+          const act = {
+            name: action.name,
+            metadata: {
+              title: action.title,
+            },
+          };
+
+          if (action.description) {
+            act.metadata.description = action.description;
+          }
+
+          if (action.input) {
+            act.metadata.input = action.input;
+          }
+
+          if (action.emitEvent) {
+            const event = {
+              name: action.name,
+              metadata: {
+                title: action.title,
+              },
+            };
+            if (action.input) {
+              event.type = action.input.type;
+            }
+            newDescr.events.push(event);
+          }
+
+          newDescr.actions.push(act);
+        }
+
         new VirtualThingsDevice(this, id, newDescr);
       }