node-red-contrib-alice 2.2.4 → 2.3.2

package/src/alice-color.html

@@ -0,0 +1,255 @@
+<script type="text/javascript">
+    RED.nodes.registerType('Color',{
+        category: 'alice',
+        defaults:{
+            device: {value:"", type:"alice-device"},
+            name: {value:""},
+            color_support:{value:true},
+            scheme: {value:"rgb_normal"},
+            response:{value:true},
+            temperature_k: {value:false},
+            temperature_min: {value:2000, validate:function(v){
+                let value = parseInt(v);
+                return value>=2000;
+            }},
+            temperature_max: {value:9000, validate:function(v){
+                let value = parseInt(v);
+                return value<=9000;
+            }},
+            color_scene: {value:[]}
+        },
+        inputs:1,
+        outputs:3,
+        outputLabels: ["color","temperature_k","color_scene"],
+        icon: "alice.png",
+        color: "#D8BFD8",
+        label: function(){
+            return this.name + ":Color";
+        },
+        oneditprepare: function(){
+            if (this.response === undefined){
+                $( "#node-input-response").prop('checked', true);
+            };
+            if (this.color_support === undefined){
+                $( "#node-input-color_support").prop('checked', true);
+            };
+            if (this.temperature_min === undefined){
+                $('#node-input-temperature_min').val(2000);
+            };
+            if (this.temperature_max === undefined){
+                $('#node-input-temperature_max').val(9000);
+            };
+            $('#node-input-color_support').on('change',()=>{
+                if ($('#node-input-color_support').is(":checked")){
+                    $('#node-input-scheme').prop('disabled', false);
+                }else{
+                    $('#node-input-scheme').prop('disabled', true);
+                };
+            });
+            $('#node-input-temperature_k').on('change',()=>{
+                if ($('#node-input-temperature_k').is(":checked")){
+                    $('#node-input-temperature_min').prop('disabled', false);
+                    $('#node-input-temperature_max').prop('disabled', false);
+                }else{
+                    $('#node-input-temperature_min').prop('disabled', true);
+                    $('#node-input-temperature_max').prop('disabled', true);
+                };
+            });
+            updateAllScenes(this.color_scene);
+        },
+        oneditsave: function(){
+            deivcename = $('#node-input-device option:selected').text();
+            $('#node-input-name').val(deivcename);
+            this.color_scene = getCurrentScenes();
+        }
+    })
+    function updateAllScenes(scenes){
+        deleteAllScenes();
+        scenes.forEach((s,i)=>{
+            addScene2List(s,i);
+        });
+    };
+    function deleteAllScenes() {
+        $('#node-input-color_scene-container').empty();
+    };
+    function addScene2List(scene,index){
+        $('#node-input-color_scene-container').append('<li rel="'+scene+'" class="red-ui-editableList-item-sortable red-ui-editableList-item-removable"><div class="red-ui-editableList-item-content" style="overflow: hidden; white-space: nowrap;"><span>'+scene+'</span></div><a href="#" onclick="delScene('+index+')" class="red-ui-editableList-item-remove red-ui-button red-ui-button-small"><i class="fa fa-remove"></i></a></li>')        
+    };
+    function getCurrentScenes() {
+        let scenes = [];
+        $('#node-input-color_scene-container li').each(function(){ 
+            scenes.push($(this).attr('rel')); 
+        });
+        return scenes;
+    };
+    function addScene() {
+        let scene = $('#select-custom-scene').find(":selected").val();
+        let scenes = getCurrentScenes();
+        if (scenes.indexOf(scene)>-1){
+            return;
+        }else{
+            scenes.push(scene);
+            updateAllScenes(scenes);
+        }
+    };
+    function delScene(index) {
+        let scenes = getCurrentScenes();
+        scenes.splice(index, 1);
+        updateAllScenes(scenes);
+    };
+</script>
+
+<script type="text/x-red" data-template-name="Color">
+    <input type="hidden" id="node-input-name">
+    <div class="form-row" style="border-bottom: 1px solid #ddd; padding-bottom: 12px;">
+        <label for="node-input-device">Device</label>
+        <input id="node-input-device">
+    </div>
+    <div class="form-row" style="border-bottom: 1px solid #ddd; padding-bottom: 12px;">
+        <label for="node-input-color_support"><span >Color</span></label>
+        <label for="node-input-color_support" style="width:70%">
+        <input type="checkbox" id="node-input-color_support" style="display:inline-block; width:22px; vertical-align:baseline;" autocomplete="off"><span> supports color change</span>
+        </label>
+        <label for="node-input-scheme">Scheme</label>
+        <select id="node-input-scheme" style="width: 70%;">
+            <option value="rgb_normal">RGB</option>
+            <!-- <option value="rgb">RGB (24bit)</option> -->
+            <option value="hsv">HSV</option>
+        </select>
+    </div>
+    <div class="form-row" style="border-bottom: 1px solid #ddd; padding-bottom: 12px;">
+        <label for="node-input-temperature_k"><span>Wite Temp</span></label>
+        <label for="node-input-temperature_k" style="width:70%">
+            <input type="checkbox" id="node-input-temperature_k" style="display:inline-block; width:22px; vertical-align:baseline;" autocomplete="off">
+            <span> white temperature support</span>
+        </label>
+        <div>
+            <label for="node-input-temperature_x"><span>Temp Range</span></label>
+            <span style="padding-left: 4px;"> Min</span>
+            <input id="node-input-temperature_min" type="number" style="width: 70px;">
+            <span> K</span>
+            <span style="padding-left: 10px;"> Max</span>
+            <input id="node-input-temperature_max" type="number" style="width: 70px;">
+            <span> K</span>
+        </div>
+    </div>
+
+    <div class="form-row node-input-rule-container-row" style="border-bottom: 1px solid #ddd; padding-bottom: 12px;">
+        <label for="node-input-color_scene" style="width:auto">Supported color scenes</label>
+        <div class="red-ui-editableList">
+            <div class="red-ui-editableList-border red-ui-editableList-container" style="min-height: 150px; max-height: none; overflow-y: scroll; height: 308.4px;">
+                <ol id="node-input-color_scene-container" class="red-ui-editableList-list" style="min-height: 100px; min-width: 150px; ">
+                    <li class="red-ui-editableList-item-sortable red-ui-editableList-item-removable">
+                        <div class="red-ui-editableList-item-content" style="overflow: hidden; white-space: nowrap;">
+                            <span>Tets</span>
+                        </div>
+                        <i class="red-ui-editableList-item-handle fa fa-bullhorn" style="cursor:auto"></i><a href="#" class="red-ui-editableList-item-remove red-ui-button red-ui-button-small"><i class="fa fa-remove"></i></a>
+                    </li>
+                    <li class="red-ui-editableList-item-sortable red-ui-editableList-item-removable">
+                        <div class="red-ui-editableList-item-content" style="overflow: hidden; white-space: nowrap;">
+                            <span>Tets2</span>
+                        </div>
+                    <i class="red-ui-editableList-item-handle fa fa-bullhorn" style="cursor:auto"></i><a href="#" class="red-ui-editableList-item-remove red-ui-button red-ui-button-small"><i class="fa fa-remove"></i></a>
+                    </li>
+                </ol>
+            </div>
+            <div style="margin-top:4px">
+                <select id="select-custom-scene">
+                    <option value="alarm">alarm</option>
+                    <option value="alice">alice</option>
+                    <option value="candle">candle</option>
+                    <option value="dinner">dinner</option>
+                    <option value="fantasy">fantasy</option>
+                    <option value="garland">garland</option>
+                    <option value="jungle">jungle</option>
+                    <option value="movie">movie</option>
+                    <option value="neon">neon</option>
+                    <option value="night">night</option>
+                    <option value="ocean">ocean</option>
+                    <option value="party">party</option>
+                    <option value="reading">reading</option>
+                    <option value="rest">rest</option>
+                    <option value="romance">romance</option>
+                    <option value="siren">siren</option>
+                    <option value="sunrise">sunrise</option>
+                    <option value="sunset">sunset</option>
+                </select>
+                <a id="button-addScene" href="#" class="red-ui-button" onclick="addScene()" style="margin-top: 4px;"><i class="fa fa-plus"></i></a>
+            </div>
+        </div>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-response"><i class="fa fa-refresh"></i> <span >Response</span></label>
+        <label for="node-input-response" style="width:70%">
+        <input type="checkbox" id="node-input-response" style="display:inline-block; width:22px; vertical-align:baseline;" autocomplete="off"><span>Always answer Alice with success</span>
+        </label>
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="Color">
+    <p>Change the color of their luminous elements to any one from the HSV model or from the RGB model;</p>
+    
+    <h3>Property</h3>
+    <dl class="message-properties">
+        <dt>Device
+            <span class="property-type">Select</span>
+        </dt>
+        <dd> The device to which this feature is connected </dd>
+        <dt>Color Scheme
+            <span class="property-type">Select</span>
+        </dt>
+        <dd> Color scheme selection (RGB or HSV) </dd>
+        <dt>White temperature support
+            <span class="property-type">Integer</span>
+        </dt>
+        <dd>White temperature support, min and max value in Kelvin</dd>
+        <dd>Min value must be above 2000 kelvin</dd>
+        <dd>Max value must be below 9000 kelvin</dd>
+        <dt>Supported color scenes
+            <span class="property-type">array of strings</span>
+        </dt>
+        <dd>List of supported color scenes</dd>
+        <dt>Response
+            <span class="property-type">checkbox</span>
+        </dt>
+        <dd> In order for the device to respond to Alice that the command was successful, the corresponding value should arrive at the input within 2.5 seconds.
+            If your device takes longer or doesn’t return a confirmation at all, just check this box. </dd>
+    </dl>
+
+    <h3>Inputs</h3>
+        <dl class="message-properties">
+            <dt>payload
+                <span class="property-type">Object || Integer || String</span>
+            </dt>
+            <dd> If you want to set the color, msg.payload must be RGB or HSV Object </br><i>{r,g,b} or {h,s,v}</i></dd>
+            <dd> If you want white temperature, msg.payload must be Integer >=MIN and <=MAX</dd>
+            <dd> If you want to set the color scene, the msg.payload must be String set in the settings</dd>
+        </dl>
+    
+    <h3>Outputs 1</h3>
+        <dl class="message-properties">
+            <dt>payload
+                <span class="property-type">Object</span>
+            </dt>
+            <dd> RGB or HSV Object </br><i>{r,g,b} or {h,s,v}</i></dd>
+        </dl>
+    <h3>Outputs 2</h3>
+        <dl class="message-properties">
+            <dt>payload
+                <span class="property-type">Integer</span>
+            </dt>
+            <dd> White temperature in Kelvin</dd>
+        </dl>
+    <h3>Outputs 3</h3>
+        <dl class="message-properties">
+            <dt>payload
+                <span class="property-type">String</span>
+            </dt>
+            <dd> Color scene text name</dd>
+        </dl>
+    <h3>References</h3>
+        <ul>
+            <li><a href="https://yandex.ru/dev/dialogs/alice/doc/smart-home/concepts/color_setting-docpage/"> Yandex documentation</a></li>
+        </ul>
+</script>

package/src/alice-color.ts

@@ -0,0 +1,227 @@
+import { NodeAPI, Node } from "node-red";
+import { AliceColorConfig, AliceDeviceNode, CapabilityState, CapabilityRegistration } from "./types.js";
+
+interface RGBColor {
+  r: number;
+  g: number;
+  b: number;
+}
+
+interface HSVColor {
+  h: number;
+  s: number;
+  v: number;
+}
+
+export = (RED: NodeAPI): void => {
+  function AliceColor(this: Node, config: AliceColorConfig): void {
+    RED.nodes.createNode(this, config);
+    const device = RED.nodes.getNode(config.device) as AliceDeviceNode;
+    device.setMaxListeners(device.getMaxListeners() + 1);
+
+    const ctype = 'devices.capabilities.color_setting';
+    let scheme = config.scheme;
+    const temperature_k = config.temperature_k;
+    const temperature_min = parseInt(config.temperature_min);
+    const temperature_max = parseInt(config.temperature_max);
+    const color_scene = config.color_scene || [];
+    let needConvert = false;
+    let response = config.response;
+    let color_support = config.color_support;
+    let lastValue: string | undefined;
+
+    if (scheme == "rgb_normal") {
+      scheme = "rgb";
+      needConvert = true;
+    }
+    if (config.response === undefined) {
+      response = true;
+    }
+    if (config.color_support === undefined) {
+      color_support = true;
+    }
+
+    const init = (): void => {
+      const parameters: Record<string, any> = {};
+      const capab: CapabilityRegistration = {
+        type: ctype,
+        retrievable: true,
+        reportable: true,
+        parameters: parameters
+      };
+
+      if (!color_support && !temperature_k && color_scene.length < 1) {
+        this.error("Error on create capability: At least one parameter must be enabled");
+        this.status({ fill: "red", shape: "dot", text: "error" });
+        return;
+      }
+
+      if (color_scene.length > 0) {
+        const scenes = color_scene.map(s => ({ id: s }));
+        parameters.color_scene = { scenes: scenes };
+      }
+
+      if (color_support) {
+        parameters.color_model = scheme;
+      }
+
+      if (temperature_k) {
+        parameters.temperature_k = {
+          min: temperature_min,
+          max: temperature_max
+        };
+      }
+
+      device.setCapability(this.id, capab)
+        .then(() => {
+          this.status({ fill: "green", shape: "dot", text: "online" });
+        })
+        .catch(err => {
+          this.error("Error on create capability: " + err.message);
+          this.status({ fill: "red", shape: "dot", text: "error" });
+        });
+    };
+
+    if (device.initState) init();
+
+    device.on("online", () => {
+      init();
+    });
+
+    device.on("offline", () => {
+      this.status({ fill: "red", shape: "dot", text: "offline" });
+    });
+
+    device.on(this.id, (val: any, newstate: { instance: string }) => {
+      // отправляем данные на выход
+      const outmsgs: Array<{ payload: any } | null> = [null, null, null];
+      switch (newstate.instance) {
+        case 'rgb': {
+          const value: RGBColor = {
+            r: val >> 16,
+            g: val >> 8 & 0xFF,
+            b: val & 0xFF
+          };
+          outmsgs[0] = { payload: value };
+          break;
+        }
+        case 'hsv':
+          outmsgs[0] = { payload: val };
+          break;
+        case 'temperature_k':
+          outmsgs[1] = { payload: val };
+          break;
+        case 'scene':
+          outmsgs[2] = { payload: val };
+          break;
+      }
+      this.send(outmsgs);
+
+      // возвращаем подтверждение в базу
+      const state: CapabilityState = {
+        type: ctype,
+        state: {
+          instance: newstate.instance,
+          value: val
+        }
+      };
+      if (response) {
+        device.updateCapabState(this.id, state)
+          .then(() => {
+            lastValue = JSON.stringify(val);
+            this.status({ fill: "green", shape: "dot", text: "online" });
+          })
+          .catch(err => {
+            this.error("Error on update capability state: " + err.message);
+            this.status({ fill: "red", shape: "dot", text: "Error" });
+          });
+      }
+    });
+
+    this.on('input', (msg, _send, done) => {
+      let value: any = msg.payload;
+      const state: { value?: any; instance?: string } = {};
+
+      switch (typeof value) {
+        case 'object': {
+          const obj = value as RGBColor | HSVColor;
+          if (('r' in obj && 'g' in obj && 'b' in obj) || ('h' in obj && 's' in obj && 'v' in obj)) {
+            if (scheme == 'rgb' && 'r' in obj) {
+              value = (obj as RGBColor).r << 16 | (obj as RGBColor).g << 8 | (obj as RGBColor).b;
+            }
+            state.value = value;
+            state.instance = scheme;
+          } else {
+            this.error("Wrong type! For Color, msg.payload must be RGB or HSV Object.");
+            if (done) { done(); }
+            return;
+          }
+          break;
+        }
+        case 'number': {
+          value = Math.round(value as number);
+          if (value >= temperature_min && value <= temperature_max) {
+            state.value = value;
+            state.instance = 'temperature_k';
+          } else {
+            this.error("Wrong type! For Temperature_k, msg.payload must be >=MIN and <=MAX.");
+            if (done) { done(); }
+            return;
+          }
+          break;
+        }
+        case 'string':
+          if (color_scene.includes(value as string)) {
+            state.value = value;
+            state.instance = 'scene';
+          } else {
+            this.error("Wrong type! For the Scene, the msg.payload must be set in the settings");
+            if (done) { done(); }
+            return;
+          }
+          break;
+        default:
+          this.error("Wrong type! Unsupported msg.payload type");
+          if (done) { done(); }
+          return;
+      }
+
+      if (JSON.stringify(value) === lastValue) {
+        this.debug("Value not changed. Cancel update");
+        if (done) { done(); }
+        return;
+      }
+
+      const upState: CapabilityState = {
+        type: ctype,
+        state: state as CapabilityState['state']
+      };
+      device.updateCapabState(this.id, upState)
+        .then(() => {
+          lastValue = JSON.stringify(value);
+          this.status({ fill: "green", shape: "dot", text: JSON.stringify(msg.payload) });
+          if (done) { done(); }
+        })
+        .catch(err => {
+          this.error("Error on update capability state: " + err.message);
+          this.status({ fill: "red", shape: "dot", text: "Error" });
+          if (done) { done(); }
+        });
+    });
+
+    this.on('close', (removed: boolean, done: () => void) => {
+      if (removed) {
+        device.delCapability(this.id)
+          .then(() => { done(); })
+          .catch(err => {
+            this.error("Error on delete capability: " + err.message);
+            done();
+          });
+      } else {
+        done();
+      }
+    });
+  }
+
+  RED.nodes.registerType("Color", AliceColor);
+};

package/src/alice-device.html

@@ -0,0 +1,94 @@
+<script type="text/javascript">
+    RED.nodes.registerType('alice-device',{
+        category: 'config',
+        defaults:{
+            service: {value:"", type:"alice-service"},
+            name: {value:null, required: true},
+            description: {value:null},
+            room: {value:"Комната"},
+            dtype: {value:"devices.types.light", required: true}
+        },
+        label: function(){
+            return this.room+":"+this.name || "Alice-Device";
+        },
+        oneditprepare: ()=>{
+            $("#node-config-input-dtype").typedInput({
+                types: [
+                    {
+                        options: [
+                            { value: "devices.types.light", label: "Light" },
+                            { value: "devices.types.light.ceiling", label: "Light Сeiling" },
+                            { value: "devices.types.light.strip", label: "Light Strip" },
+                            { value: "devices.types.socket", label: "Socket" },
+                            { value: "devices.types.switch", label: "Switch" },
+                            { value: "devices.types.thermostat", label: "Thermostat"  },
+                            { value: "devices.types.thermostat.ac", label: "Air conditioning"  },
+                            { value: "devices.types.media_device", label: "Multimedia"  },
+                            { value: "devices.types.media_device.tv", label: "TV"  },
+                            { value: "devices.types.media_device.tv_box", label: "TV Box" },
+                            { value: "devices.types.media_device.receiver", label: "AV Receiver" },
+                            { value: "devices.types.camera", label: "Camera" },
+                            { value: "devices.types.cooking", label: "Kitchen appliances" },
+                            { value: "devices.types.cooking.coffee_maker", label: "Coffee machine" },
+                            { value: "devices.types.cooking.kettle", label: "Smart kettle" },
+                            { value: "devices.types.cooking.multicooker", label: "Multicooker" },
+                            { value: "devices.types.openable", label: "Door, gate, window, shutters" },
+                            { value: "devices.types.openable.curtain", label: "Curtains, blinds" },
+                            { value: "devices.types.openable.valve", label: "Valve (ball valve)" },
+                            { value: "devices.types.humidifier", label: "Humidifier" },
+                            { value: "devices.types.purifier", label: "Air purifier" },
+                            { value: "devices.types.ventilation", label: "Ventilation" },
+                            { value: "devices.types.ventilation.fan", label: "Fan" },
+                            { value: "devices.types.vacuum_cleaner", label: "Vacuum cleaner robot" },
+                            { value: "devices.types.washing_machine", label: "Washing machine" },
+                            { value: "devices.types.dishwasher", label: "Dishwasher" },
+                            { value: "devices.types.iron", label: "Iron, steam generator" },
+                            { value: "devices.types.sensor", label: "Sensor" },
+                            { value: "devices.types.sensor.motion", label: "Sensor motion" },
+                            { value: "devices.types.sensor.vibration", label: "Sensor vibration" },
+                            { value: "devices.types.sensor.illumination", label: "Sensor illumination" },
+                            { value: "devices.types.sensor.open", label: "Sensor open" },
+                            { value: "devices.types.sensor.climate", label: "Sensor climate" },
+                            { value: "devices.types.sensor.water_leak", label: "Sensor water_leak" },
+                            { value: "devices.types.sensor.button", label: "Sensor button" },
+                            { value: "devices.types.sensor.gas", label: "Sensor gas" },
+                            { value: "devices.types.sensor.smoke", label: "Sensor smoke" },
+                            { value: "devices.types.smart_meter", label: "Counter" },
+                            { value: "devices.types.smart_meter.cold_water", label: "Cold Water counter" },
+                            { value: "devices.types.smart_meter.hot_water", label: "Hot Water counter" },
+                            { value: "devices.types.smart_meter.electricity", label: "Electricity counter" },
+                            { value: "devices.types.smart_meter.gas", label: "Gas counter" },
+                            { value: "devices.types.smart_meter.heat", label: "Heat Water counter" },
+                            { value: "devices.types.pet_drinking_fountain", label: "Pet drinking fountain" },
+                            { value: "devices.types.pet_feeder", label: "Pet feeder" },
+                            { value: "devices.types.other", label: "Other" },
+                        ]
+                    }
+                ]
+            });
+        }
+    })
+</script>
+
+<script type="text/x-red" data-template-name="alice-device">
+    <div class="form-row">
+        <label for="node-config-input-service">Credentials</label>
+        <input id="node-config-input-service">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-name">Name</label>
+        <input type="text" id="node-config-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-description">Description</label>
+        <input type="text" id="node-config-input-description" placeholder="">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-room">Room</label>
+        <input type="text" id="node-config-input-room" placeholder="Room">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-dtype">Type</label>
+        <input type="text" id="node-config-input-dtype">
+    </div>
+</script>