node-red-contrib-alice 2.2.5 → 2.3.1

package/src/alice-mode.ts

@@ -0,0 +1,139 @@
+import { NodeAPI, Node } from "node-red";
+import { AliceModeConfig, AliceDeviceNode, CapabilityState } from "./types.js";
+
+export = (RED: NodeAPI): void => {
+  function AliceMode(this: Node, config: AliceModeConfig): void {
+    RED.nodes.createNode(this, config);
+    const device = RED.nodes.getNode(config.device) as AliceDeviceNode;
+
+    const ctype = 'devices.capabilities.mode';
+    const instance = config.instance || '';
+    const modes = config.modes;
+    let response = config.response;
+    let value: string | undefined;
+
+    if (config.response === undefined) {
+      response = true;
+    }
+
+    const init = (): void => {
+      if (modes.length < 1) {
+        this.status({ fill: "red", shape: "dot", text: "error" });
+        this.error("In the list of supported commands, there must be at least one command");
+        return;
+      }
+      if (!instance) {
+        this.status({ fill: "red", shape: "dot", text: "error" });
+        this.error("Mode type not selected");
+        return;
+      }
+
+      const cfgModes = modes.map(v => ({ value: v }));
+      const capab = {
+        type: ctype,
+        retrievable: true,
+        reportable: true,
+        parameters: {
+          instance: instance,
+          modes: cfgModes
+        }
+      };
+
+      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: string) => {
+      this.send({ payload: val });
+      const state: CapabilityState = {
+        type: ctype,
+        state: {
+          instance: instance,
+          value: val
+        }
+      };
+      if (response) {
+        device.updateCapabState(this.id, state)
+          .then(() => {
+            value = 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) => {
+      const newValue = msg.payload;
+      if (typeof newValue != 'string') {
+        this.error("Wrong type! msg.payload must be String.");
+        this.status({ fill: "red", shape: "dot", text: "Error" });
+        if (done) { done(); }
+        return;
+      }
+      if (modes.indexOf(newValue) < 0) {
+        this.error("Error! Unsupported command.");
+        this.status({ fill: "red", shape: "dot", text: "Error" });
+        if (done) { done(); }
+        return;
+      }
+      if (newValue === value) {
+        this.debug("Value not changed. Cancel update");
+        if (done) { done(); }
+        return;
+      }
+
+      const state: CapabilityState = {
+        type: ctype,
+        state: {
+          instance: instance,
+          value: newValue
+        }
+      };
+      device.updateCapabState(this.id, state)
+        .then(() => {
+          value = newValue;
+          this.status({ fill: "green", shape: "dot", text: newValue });
+          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("Mode", AliceMode);
+};

package/src/alice-onoff.html

@@ -0,0 +1,93 @@
+<script type="text/javascript">
+    RED.nodes.registerType('On_Off',{
+        category: 'alice',
+        defaults:{
+            device: {value:"", type:"alice-device"},
+            name: {value:""},
+            // retrievable: {value:true},
+            response:{value:true},
+            split: {value:false}
+        },
+        inputs:1,
+        outputs:1,
+        icon: "alice.png",
+        color: "#D8BFD8",
+        label: function(){
+            return this.name + ":On/Off";
+        },
+        oneditprepare: function(){
+            if (this.response === undefined){
+                $( "#node-input-response").prop('checked', true);
+            };
+            if (this.retrievable === false){
+                $( "#node-input-split").prop('checked', true);
+            }
+        },
+        oneditsave: function(){
+            deivcename = $('#node-input-device option:selected').text();
+            $('#node-input-name').val(deivcename);
+        }
+    })
+</script>
+
+<script type="text/x-red" data-template-name="On_Off">
+    <input type="hidden" id="node-input-name">
+    <div class="form-row">
+        <label for="node-input-device">Device</label>
+        <input id="node-input-device">
+    </div>
+    <div class="form-row">
+        <label for="node-input-split"><i class="fa fa-power-off"></i> <span >Split button</span></label>
+        <label for="node-input-split" style="width:70%">
+        <input type="checkbox" id="node-input-split" style="display:inline-block; width:22px; vertical-align:baseline;" autocomplete="off"><span>Split On/Off button</span>
+        </label>
+    </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="On_Off">
+    <p>Allows the device to turn on and off</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>Main button
+            <span class="property-type">checkbox</span>
+        </dt>
+        <dd>The main button blocks access to other controls if the device is turned off.
+            When unchecking this, the controls will be available, but you will not be able to find out whether the device is on or off</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">boolean</span>
+            </dt>
+            <dd> true or false </dd>
+        </dl>
+    
+     <h3>Outputs</h3>
+         <dl class="message-properties">
+            <dt>payload
+                <span class="property-type">boolean</span>
+            </dt>
+            <dd> true or false </dd>
+        </dl>
+    <h3>References</h3>
+        <ul>
+            <li><a href="https://yandex.ru/dev/dialogs/alice/doc/smart-home/concepts/capability-types-docpage/"> - Yandex documentation</a></li>
+        </ul>
+    </script>

package/src/alice-onoff.ts

@@ -0,0 +1,132 @@
+import { NodeAPI, Node } from "node-red";
+import { AliceOnOffConfig, AliceDeviceNode, CapabilityState } from "./types.js";
+
+export = (RED: NodeAPI): void => {
+  function AliceOnOff(this: Node, config: AliceOnOffConfig): void {
+    RED.nodes.createNode(this, config);
+    const device = RED.nodes.getNode(config.device) as AliceDeviceNode;
+    device.setMaxListeners(device.getMaxListeners() + 1);
+
+    const id = JSON.parse(JSON.stringify(this.id));
+    const ctype = 'devices.capabilities.on_off';
+    const instance = 'on';
+    let response = config.response;
+    let split = config.split;
+    let initState = false;
+
+    const curentState: CapabilityState = {
+      type: ctype,
+      state: {
+        instance: instance,
+        value: false
+      }
+    };
+
+    if (config.response === undefined) {
+      response = true;
+    }
+    if (config.split === undefined) {
+      split = false;
+    }
+
+    this.status({ fill: "red", shape: "dot", text: "offline" });
+
+    const init = (): void => {
+      this.debug("Starting capability initilization ...");
+      const capab = {
+        type: ctype,
+        retrievable: true,
+        reportable: true,
+        parameters: {
+          instance: instance,
+          split: split
+        }
+      };
+
+      device.setCapability(id, capab)
+        .then(() => {
+          this.debug("Capability initilization - success!");
+          initState = true;
+          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" });
+        });
+
+      device.updateCapabState(id, curentState)
+        .then(() => {
+          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" });
+        });
+    };
+
+    if (device.initState) init();
+
+    device.on("online", () => {
+      init();
+    });
+
+    device.on("offline", () => {
+      this.status({ fill: "red", shape: "dot", text: "offline" });
+    });
+
+    device.on(id, (val: boolean) => {
+      this.send({ payload: val });
+      if (response) {
+        curentState.state.value = val;
+        device.updateCapabState(id, curentState)
+          .then(() => {
+            this.status({ fill: "green", shape: "dot", text: val.toString() });
+          })
+          .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) => {
+      if (typeof msg.payload != 'boolean') {
+        this.error("Wrong type! msg.payload must be boolean.");
+        if (done) { done(); }
+        return;
+      }
+      if (msg.payload === curentState.state.value) {
+        this.debug("Value not changed. Cancel update");
+        if (done) { done(); }
+        return;
+      }
+      curentState.state.value = msg.payload;
+      device.updateCapabState(id, curentState)
+        .then(() => {
+          this.status({ fill: "green", shape: "dot", text: String(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) => {
+      device.setMaxListeners(device.getMaxListeners() - 1);
+      if (removed) {
+        device.delCapability(id)
+          .then(() => { done(); })
+          .catch(err => {
+            this.error("Error on delete capability: " + err.message);
+            done();
+          });
+      } else {
+        done();
+      }
+    });
+  }
+
+  RED.nodes.registerType("On_Off", AliceOnOff);
+};

package/src/alice-range.html

@@ -0,0 +1,293 @@
+<script type="text/javascript">
+    RED.nodes.registerType('Range',{
+        category: 'alice',
+        defaults:{
+            device: {value:"", type:"alice-device"},
+            name: {value:""},
+            instance: {value:undefined, validate: (v)=>{
+                if (v){
+                    return true;
+                }else{
+                    return false;
+                }
+            }},
+            unit: {value:""},
+            min:{value:1, validate: (v)=>{
+                if (v){
+                    return true;
+                }else{
+                    return false;
+                }
+            }},
+            max:{value:100, validate: (v)=>{
+                if (v){
+                    return true;
+                }else{
+                    return false;
+                }
+            }},
+            precision:{value: 1, validate: (v)=>{
+                if (v){
+                    return true;
+                }else{
+                    return false;
+                }
+            }},
+            response:{value:true},
+            retrievable: {value: true}
+        },
+        inputs:1,
+        outputs:1,
+        icon: "alice.png",
+        color: "#D8BFD8",
+        label: function(){
+            return this.name + ":"+this.instance;
+        },
+        oneditsave: function(){
+            deivcename = $('#node-input-device option:selected').text();
+            $('#node-input-name').val(deivcename);
+        },
+        oneditprepare: function(){
+            var firstRun = true;
+            function instanceChange(inst){
+                var unit, min, max, precision;
+                // проверяем первый ли это запуск редактирования или он уже был настроен
+                if (firstRun && typeof inst !== "undefined"){
+                    unit = $('#node-input-unit').find(":selected").val();
+                    min = $('#node-input-min').val();
+                    max = $('#node-input-max').val();
+                    precision = $('#node-input-precision').val();
+                };
+                switch (inst) {
+                    case 'brightness':
+                        min = (typeof min !== "undefined") ? min : 0;
+                        max = (typeof max !== "undefined") ? max : 100;
+                        precision = (typeof precision !== "undefined") ? precision : 10;
+                        $('#node-input-unit').replaceWith('<select id="node-input-unit" style="width: 70%;"></select>');
+                        $('#node-input-unit').append('<option value="unit.percent">%</option>');
+                        $('#node-input-unit select').val("unit.percent");
+                        $('#node-input-unit').prop( "disabled", true );
+                        $('#node-input-min').val(min);
+                        $('#node-input-min').prop( "disabled", true );
+                        $('#node-input-max').val(max);
+                        $('#node-input-max').prop( "disabled", true );
+                        $('#node-input-precision').val(precision);
+                        $('#node-input-precision').prop( "disabled", false );
+                    break;
+                    case 'channel':
+                        min = (typeof min !== "undefined") ? min : 1;
+                        max = (typeof max !== "undefined") ? max : 1000;
+                        precision = (typeof precision !== "undefined") ? precision : 1;
+                        $('#node-input-unit').replaceWith('<select id="node-input-unit" style="width: 70%;"></select>');
+                        $('#node-input-unit').append('<option value="unit.number">Number</option>');
+                        $('#node-input-unit select').val("unit.number");
+                        $('#node-input-unit').prop( "disabled", true );
+                        $('#node-input-min').val(min);
+                        $('#node-input-min').prop( "disabled", false );
+                        $('#node-input-max').val(max);
+                        $('#node-input-max').prop( "disabled", false );
+                        $('#node-input-precision').val(precision);
+                        $('#node-input-precision').prop( "disabled", false );
+                    break;
+                    case 'humidity':
+                        min = (typeof min !== "undefined") ? min : 0;
+                        max = (typeof max !== "undefined") ? max : 100;
+                        precision = (typeof precision !== "undefined") ? precision : 10;
+
+                        $('#node-input-unit').replaceWith('<select id="node-input-unit" style="width: 70%;"></select>');
+                        $('#node-input-unit').append('<option value="unit.percent">%</option>');
+                        $('#node-input-unit select').val("unit.percent");
+                        $('#node-input-unit').prop( "disabled", true );
+                        $('#node-input-min').val(min);
+                        $('#node-input-min').prop( "disabled", true );
+                        $('#node-input-max').val(max);
+                        $('#node-input-max').prop( "disabled", true );
+                        $('#node-input-precision').val(precision);
+                        $('#node-input-precision').prop( "disabled", false );
+                    break;
+                    case 'open':
+                        min = (typeof min !== "undefined") ? min : 0;
+                        max = (typeof max !== "undefined") ? max : 100;
+                        precision = (typeof precision !== "undefined") ? precision : 10;
+
+                        $('#node-input-unit').replaceWith('<select id="node-input-unit" style="width: 70%;"></select>');
+                        $('#node-input-unit').append('<option value="unit.percent">%</option>');
+                        $('#node-input-unit select').val("unit.percent");
+                        $('#node-input-unit').prop( "disabled", true );
+                        $('#node-input-min').val(min);
+                        $('#node-input-min').prop( "disabled", true );
+                        $('#node-input-max').val(max);
+                        $('#node-input-max').prop( "disabled", true );
+                        $('#node-input-precision').val(precision);
+                        $('#node-input-precision').prop( "disabled", false );
+                    break;
+                    case 'temperature':
+                        unit = (typeof unit !== "unit") ? unit : "unit.temperature.celsius";
+                        min = (typeof min !== "undefined") ? min : 0;
+                        max = (typeof max !== "undefined") ? max : 100;
+                        precision = (typeof precision !== "undefined") ? precision : 2;
+
+                        $('#node-input-unit').replaceWith('<select id="node-input-unit" style="width: 70%;"></select>');
+                        $('#node-input-unit').append('<option value="unit.temperature.celsius">Celsius (C)</option>');
+                        $('#node-input-unit').append('<option value="unit.temperature.kelvin">Kelvin (K)</option>');
+                        $('#node-input-unit select').val(unit);
+                        $('#node-input-unit').prop( "disabled", false );
+                        $('#node-input-min').val(min);
+                        $('#node-input-min').prop( "disabled", false );
+                        $('#node-input-max').val(max);
+                        $('#node-input-max').prop( "disabled", false );
+                        $('#node-input-precision').val(precision);
+                        $('#node-input-precision').prop( "disabled", false );
+                    break;
+                    case 'volume':
+                        min = (typeof min !== "undefined") ? min : 0;
+                        max = (typeof max !== "undefined") ? max : 100;
+                        precision = (typeof precision !== "undefined") ? precision : 10;
+
+                        $('#node-input-unit').replaceWith('<select id="node-input-unit" style="width: 70%;"></select>');
+                        $('#node-input-unit').append('<option value="unit.number">Number</option>');
+                        $('#node-input-unit select').val("unit.number");
+                        $('#node-input-unit').prop( "disabled", true );
+                        $('#node-input-min').val(min);
+                        $('#node-input-min').prop( "disabled", false );
+                        $('#node-input-max').val(max);
+                        $('#node-input-max').prop( "disabled", false );
+                        $('#node-input-precision').val(precision);
+                        $('#node-input-precision').prop( "disabled", false );
+                    break;
+                    default:
+                        $('#node-input-unit').prop( "disabled", true );
+                        $('#node-input-min').prop( "disabled", true );
+                        $('#node-input-max').prop( "disabled", true );
+                        $('#node-input-precision').prop( "disabled", true );
+                }
+                firstRun = false;
+            };
+            $('#node-input-instance').on('change',()=>{
+                var val = $('#node-input-instance').find(":selected").val();
+                instanceChange(val);
+            });
+            if (this.retrievable === undefined){
+                $( "#node-input-retrievable").prop('checked', true);
+            }
+            if (this.response === undefined){
+                $( "#node-input-response").prop('checked', true);
+            }
+        }
+    })
+</script>
+
+<script type="text/x-red" data-template-name="Range">
+    <input type="hidden" id="node-input-name">
+    <div class="form-row">
+        <label for="node-input-device">Device</label>
+        <input id="node-input-device">
+    </div>
+    <div class="form-row">
+        <label for="node-input-instance">Range Type</label>
+        <select id="node-input-instance" style="width: 70%;">
+            <option value="brightness">Brightness</option>
+            <option value="channel">Channel</option>
+            <option value="humidity">Humidity</option>
+            <option value="open">Open</option>
+            <option value="temperature">Temperature</option>
+            <option value="volume">Volume</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-unit">Unit</label>
+        <select id="node-input-unit" style="width: 70%;">
+            <option value="unit.temperature.celsius">Celsius</option>
+            <option value="unit.temperature.kelvin">Kelvin</option>
+            <option value="unit.percent">Percent</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-min">Min</label>
+        <input type="number" id="node-input-min">
+    </div>
+    <div class="form-row">
+        <label for="node-input-max">Max</label>
+        <input type="number" id="node-input-max">
+    </div>
+    <div class="form-row">
+        <label for="node-input-precision">Step</label>
+        <input type="number" id="node-input-precision">
+    </div>
+    <div class="form-row">
+        <label for="node-input-retrievable"><i class="fa fa-sign-out"></i> <span >Output</span></label>
+        <label for="node-input-retrievable" style="width:70%">
+        <input type="checkbox" id="node-input-retrievable" style="display:inline-block; width:22px; vertical-align:baseline;" autocomplete="off"><span>full value/changes only</span>
+        </label>
+    </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="Range">
+    <p>Manage device settings that have a range. For example, lamp brightness, sound volume, heater temperature, etc.</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>Range Type
+            <span class="property-type">Select</span>
+        </dt>
+        <dd> Selection of the type of ranges (brightness, sound, channel, temperature, etc.) </dd>
+        <dt>Unit
+            <span class="property-type">Select</span>
+        </dt>
+        <dd> Unit of measure for the range </dd>
+        <dt>Min
+            <span class="property-type">Float</span>
+        </dt>
+        <dd> Minimum value </dd>
+        <dt>Max
+            <span class="property-type">Float</span>
+        </dt>
+        <dd> Maximum value </dd>
+        <dt>precision
+            <span class="property-type">Float</span>
+        </dt>
+        <dd> The minimum step of changing values within the range </dd>
+        <dt>Output
+            <span class="property-type">checkbox</span>
+        </dt>
+        <dd> Determines what kind of value will be output. The full value that the device should set or the delta of the value change. 
+            When the checkbox is unchecked, the current device values are not stored in Yandex.. </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>
+    </dl>
+
+    <h3>Inputs</h3>
+        <dl class="message-properties">
+            <dt>payload
+                <span class="property-type">Float</span>
+            </dt>
+            <dd> Value </dd>
+        </dl>
+    
+     <h3>Outputs</h3>
+        <dl class="message-properties">
+            <dt>payload
+                <span class="property-type">Float</span>
+            </dt>
+            <dd> Value </dd>
+        </dl>
+    <h3>References</h3>
+        <ul>
+            <li><a href="https://yandex.ru/dev/dialogs/alice/doc/smart-home/concepts/range-docpage/"> Yandex documentation</a></li>
+        </ul>
+</script>