feat(device): Add support for fan; close #26

Author: csuermann

device-types.js

@@ -26,6 +26,14 @@ const percentage = (val) => {
   return { key: 'percentage', value: val }
 }
 
+const speed = (val) => {
+  const isValid = Number.isInteger(val) && val >= 0 && val <= 10
+  if (!isValid) {
+    return false
+  }
+  return { key: 'speed', value: val }
+}
+
 const colorTemperatureInKelvin = (val) => {
   const isValid = Number.isInteger(val) && val >= 1000 && val <= 10000
   if (!isValid) {
@@ -278,6 +286,8 @@ const diffDecoratorFactory = (anotherDecorator) => {
     Lock: ['lockState'],
     Unlock: ['lockState'],
     SetMode: ['mode', 'instance'],
+    AdjustRangeValue: ['speed'],
+    SetRangeValue: ['speed'],
     Activate: ['isActivated'],
     Deactivate: ['isActivated'],
     SetTargetTemperature: ['targetTemperature', 'targetScale'],
@@ -427,6 +437,17 @@ const types = {
     },
     decorator: defaultDecorator,
   },
+  FAN: {
+    defaultState: {
+      powerState: 'OFF',
+      speed: 0,
+    },
+    validators: {
+      powerState,
+      speed,
+    },
+    decorator: defaultDecorator,
+  },
   GARAGE_DOOR_OPENER: {
     defaultState: {
       mode: 'Position.Up',

examples/fan.json

@@ -0,0 +1,147 @@
+[
+  {
+    "id": "1deb9367.51a3fd",
+    "type": "inject",
+    "z": "7ecdfb0b.fa7794",
+    "name": "on",
+    "props": [{ "p": "payload" }],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "{\"powerState\":\"ON\"}",
+    "payloadType": "json",
+    "x": 930,
+    "y": 520,
+    "wires": [["1de955b6.491d3a"]]
+  },
+  {
+    "id": "dab12600.fd0d08",
+    "type": "inject",
+    "z": "7ecdfb0b.fa7794",
+    "name": "off",
+    "props": [{ "p": "payload" }],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "{\"powerState\":\"OFF\"}",
+    "payloadType": "json",
+    "x": 930,
+    "y": 560,
+    "wires": [["1de955b6.491d3a"]]
+  },
+  {
+    "id": "1de955b6.491d3a",
+    "type": "vsh-virtual-device",
+    "z": "7ecdfb0b.fa7794",
+    "name": "bedroom fan",
+    "topic": "bedroom/fan",
+    "connection": "",
+    "template": "FAN",
+    "passthrough": true,
+    "diff": false,
+    "x": 1230,
+    "y": 520,
+    "wires": [["c402af75.7847"]]
+  },
+  {
+    "id": "6375e148.f86cc",
+    "type": "comment",
+    "z": "7ecdfb0b.fa7794",
+    "name": "FAN",
+    "info": "",
+    "x": 910,
+    "y": 340,
+    "wires": []
+  },
+  {
+    "id": "c402af75.7847",
+    "type": "debug",
+    "z": "7ecdfb0b.fa7794",
+    "name": "",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "false",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 1510,
+    "y": 520,
+    "wires": []
+  },
+  {
+    "id": "2bb6a27f.f9fd7e",
+    "type": "inject",
+    "z": "7ecdfb0b.fa7794",
+    "name": "speed: 1",
+    "props": [{ "p": "payload" }],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "{\"speed\":1}",
+    "payloadType": "json",
+    "x": 940,
+    "y": 600,
+    "wires": [["1de955b6.491d3a"]]
+  },
+  {
+    "id": "a2e1af48.ab3c2",
+    "type": "comment",
+    "z": "7ecdfb0b.fa7794",
+    "name": "Alexa, set the bedroom fan speed to 7.",
+    "info": "",
+    "x": 1050,
+    "y": 380,
+    "wires": []
+  },
+  {
+    "id": "394a1805.f60018",
+    "type": "comment",
+    "z": "7ecdfb0b.fa7794",
+    "name": "Alexa, set the fan speed on the bedroom fan to maximum.",
+    "info": "",
+    "x": 1110,
+    "y": 420,
+    "wires": []
+  },
+  {
+    "id": "33cd6994.775376",
+    "type": "inject",
+    "z": "7ecdfb0b.fa7794",
+    "name": "speed: 5",
+    "props": [{ "p": "payload" }],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "{\"speed\":5}",
+    "payloadType": "json",
+    "x": 940,
+    "y": 640,
+    "wires": [["1de955b6.491d3a"]]
+  },
+  {
+    "id": "8c250365.04683",
+    "type": "inject",
+    "z": "7ecdfb0b.fa7794",
+    "name": "speed: 10",
+    "props": [{ "p": "payload" }],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "{\"speed\":10}",
+    "payloadType": "json",
+    "x": 940,
+    "y": 680,
+    "wires": [["1de955b6.491d3a"]]
+  }
+]

readme.md

@@ -24,6 +24,7 @@ The _virtual smart home_ skill is available in the Amazon skill stores in the fo
   - Color Changing Light Bulb
   - Dimmable Light Bulb
   - Dimmer Switch
+  - Fan
   - Garage Door Opener
   - Plug
   - Switch

virtual-device.html

@@ -84,6 +84,7 @@
       <option value="COLOR_CHANGING_LIGHT_BULB">Color Changing Light Bulb</option>
       <option value="DIMMABLE_LIGHT_BULB">Dimmable Light Bulb</option>
       <option value="DIMMER_SWITCH">Dimmer Switch</option>
+      <option value="FAN">Fan</option>
       <option value="GARAGE_DOOR_OPENER">Garage Door Opener</option>
       <option value="PLUG">Plug</option>
       <option value="SCENE">Scene</option>
@@ -383,6 +384,20 @@ <h4>Dimmer Switch</h4>
     <dd>Brightness in % (0...100)</dd>
   </dl>
 
+  <h4>Fan</h4>
+  <dl class="message-properties">
+    <dt>
+      payload.powerState
+      <span class="property-type">string</span>
+    </dt>
+    <dd>'ON' or 'OFF'</dd>
+    <dt>
+      payload.speed
+      <span class="property-type">int</span>
+    </dt>
+    <dd>Fan speed (0...10)</dd>
+  </dl>
+
   <h4>Garage Door Opener</h4>
   <dl class="message-properties">
     <dt>