node-red-contrib-alice 2.2.4 → 2.3.2

package/src/alice-sensor.html

@@ -0,0 +1,307 @@
+<script type="text/javascript">
+    RED.nodes.registerType('Sensor',{
+        category: 'alice',
+        defaults:{
+            device: {value:"", type:"alice-device"},
+            name: {value:"Sensor"},
+            stype: {value:'devices.properties.float'},
+            instance: {value:undefined, validate: (v)=>{
+                if (v){
+                    return true;
+                }else{
+                    return false;
+                }
+            }},
+            unit:{value:undefined}
+        },
+        inputs:1,
+        outputs:0,
+        icon: "alice.png",
+        color: "#D8BFD8",
+        label: function(){
+            return this.name;
+        },
+        oneditprepare: function(){
+            $('#node-input-instance').on('change',()=>{
+                var val = $('#node-input-instance').find(":selected").val();
+                switch (val) {
+                    case 'amperage':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.ampere">Ampere (A)</option>')
+                        .val('unit.ampere')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'battery_level':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.percent">Percent (%)</option>')
+                        .val('unit.percent')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'co2_level':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.ppm">Parts per million (ppm)</option>')
+                        .val('unit.ppm')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'food_level':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.percent">Percent (%)</option>')
+                        .val('unit.percent')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'humidity':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.percent">Percent (%)</option>')
+                        .val('unit.percent')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'power':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.watt">Watt (W)</option>')
+                        .val('unit.watt')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'temperature':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.temperature.celsius">Celsius</option>')
+                        .append('<option value="unit.temperature.kelvin">Kelvin</option>')
+                        .prop('disabled', false);
+                    if (this.unit && this.unit.includes("unit.temperature")){
+                        $('#node-input-unit').val(this.unit);
+                    }else{
+                        $('#node-input-unit').val('unit.temperature.celsius');
+                    }
+                    break;
+                    case 'voltage':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.volt">Volt (V)</option>')
+                        .val('unit.volt')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'water_level':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.percent">Percent (%)</option>')
+                        .val('unit.percent')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'illumination':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.illumination.lux">Lux (lx)</option>')
+                        .val('unit.illumination.lux')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'pressure':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.pressure.atm">Atmosphere (atm)</option>')
+                        .append('<option value="unit.pressure.pascal">Pascal (pascal)</option>')
+                        .append('<option value="unit.pressure.bar">Bar (bar)</option>')
+                        .append('<option value="unit.pressure.mmhg">Millimeters of mercury (mmhg)</option>')
+                        // .val('unit.pressure.bar')
+                        .prop('disabled', false);
+                    if (this.unit && this.unit.includes("unit.pressure")){
+                        $('#node-input-unit').val(this.unit);
+                    }else{
+                        $('#node-input-unit').val('unit.pressure.bar');
+                    }
+                    break;
+                    case 'pm1_density':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.density.mcg_m3">μg/m3</option>')
+                        .val('unit.density.mcg_m3')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'pm2.5_density':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.density.mcg_m3">μg/m3</option>')
+                        .val('unit.density.mcg_m3')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'pm10_density':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.density.mcg_m3">μg/m3</option>')
+                        .val('unit.density.mcg_m3')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'tvoc':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.density.mcg_m3">μg/m3</option>')
+                        .val('unit.density.mcg_m3')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'electricity_meter':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.kilowatt_hour">kW⋅h</option>')
+                        .val('unit.kilowatt_hour')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'gas_meter':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.cubic_meter">m3</option>')
+                        .val('unit.cubic_meter')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'heat_meter':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.gigacalorie">Gcal</option>')
+                        .val('unit.gigacalorie')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'water_meter':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .append('<option value="unit.cubic_meter">m3</option>')
+                        .val('unit.cubic_meter')
+                        .prop('disabled', 'disabled');
+                    break;
+                    case 'meter':
+                    $('#node-input-unit')
+                        .find('option')
+                        .remove()
+                        .end()
+                        .prop('disabled', 'disabled');
+                    break;
+                    default:
+                    $('#node-input-unit').prop('disabled', 'disabled');
+                        break;
+                };
+            });
+        },
+        oneditsave: function(){
+            deivcename = $('#node-input-device option:selected').text();
+            instance = $('#node-input-instance option:selected').text();
+            $('#node-input-name').val(deivcename+":"+instance);
+        }
+    })
+</script>
+
+<script type="text/x-red" data-template-name="Sensor">
+    <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">Sensor Type</label>
+        <select id="node-input-instance" style="width: 70%;">
+            <option value="amperage">Amperage</option>
+            <option value="battery_level">Battery level</option>
+            <option value="co2_level">CO2 level</option>
+            <option value="food_level">Food level</option>
+            <option value="humidity">Humidity</option>
+            <option value="illumination">Illumination</option>
+            <option value="pm1_density">PM 1 density</option>
+            <option value="pm2.5_density">PM 2.5_density</option>
+            <option value="pm10_density">PM 10 density</option>
+            <option value="power">Power</option>
+            <option value="pressure">Pressure</option>
+            <option value="temperature">Temperature</option>
+            <option value="tvoc">TVOC</option>
+            <option value="voltage">Voltage</option>
+            <option value="water_level">Water level</option>
+            <option value="electricity_meter">Electricity counter</option>
+            <option value="gas_meter">Gas counter</option>
+            <option value="water_meter">Water counter</option>
+            <option value="meter">Universal counter</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.percent">Percent (%)</option>
+            <option value="unit.ppm">Parts per million (ppm)</option>
+            <option value="unit.temperature.celsius">Celsius</option>
+            <option value="unit.temperature.kelvin">Kelvin</option>
+            <option value="unit.ampere">Ampere (A)</option>
+            <option value="unit.volt">Volt (V)</option>
+            <option value="unit.watt">Watt (W)</option>
+            <option value="unit.illumination.lux">Lux (lx)</option>
+            <option value="unit.density.mcg_m3">μg/m3</option>
+        </select>
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="Sensor">
+    <p>Transmits data from sensors built into the device.</p>
+    
+    <h3>Property</h3>
+    <dl class="message-properties">
+        <dt>Device
+            <span class="property-type">Select</span>
+        </dt>
+        <dd> The device to which this sensor is connected </dd>
+        <dt>Sensor Type
+            <span class="property-type">Select</span>
+        </dt>
+        <dd>a type of sensor that helps to better understand the area of its use and the data it collects</dd>
+    </dl>
+
+    <h3>Inputs</h3>
+        <dl class="message-properties">
+            <dt>payload
+                <span class="property-type">boolean/float</span>
+            </dt>
+            <dd>bollean or float</dd>
+        </dl>
+    
+    <h3>References</h3>
+        <ul>
+            <li><a href="https://yandex.ru/dev/dialogs/alice/doc/smart-home/concepts/properties-types.html"> - Yandex documentation</a></li>
+        </ul>
+    </script>

package/src/alice-sensor.ts

@@ -0,0 +1,103 @@
+import { NodeAPI, Node } from "node-red";
+import { AliceSensorConfig, AliceDeviceNode, SensorState } from "./types.js";
+
+export = (RED: NodeAPI): void => {
+  function AliceSensor(this: Node, config: AliceSensorConfig): 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 stype = config.stype;
+    const unit = config.unit;
+    const instance = config.instance;
+
+    const curentState: SensorState = {
+      type: stype,
+      state: {
+        instance: instance,
+        value: 0
+      }
+    };
+
+    this.status({ fill: "red", shape: "dot", text: "offline" });
+
+    const init = (): void => {
+      this.debug("Starting sensor initilization ...");
+      const sensor = {
+        type: stype,
+        reportable: true,
+        retrievable: true,
+        parameters: {
+          instance: instance,
+          unit: unit
+        }
+      };
+
+      device.setSensor(id, sensor)
+        .then(() => {
+          this.debug("Sensor initilization - success!");
+          this.status({ fill: "green", shape: "dot", text: "online" });
+        })
+        .catch(err => {
+          this.error("Error on create sensor: " + 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" });
+    });
+
+    this.on('input', (msg, _send, done) => {
+      if (typeof msg.payload != 'number') {
+        this.error("Wrong type! msg.payload must be number.");
+        if (done) { done(); }
+        return;
+      }
+      if (unit == 'unit.temperature.celsius' || unit == 'unit.ampere') {
+        msg.payload = +msg.payload.toFixed(1);
+      } else {
+        msg.payload = +msg.payload.toFixed(0);
+      }
+      if (curentState.state.value == msg.payload) {
+        this.debug("Value not changed. Cancel update");
+        if (done) { done(); }
+        return;
+      }
+      curentState.state.value = msg.payload;
+      device.updateSensorState(id, curentState)
+        .then(() => {
+          this.status({ fill: "green", shape: "dot", text: String(msg.payload) });
+          if (done) { done(); }
+        })
+        .catch(err => {
+          this.error("Error on update sensor state: " + err.message);
+          this.status({ fill: "red", shape: "dot", text: "Error" });
+          if (done) { done(); }
+        });
+    });
+
+    this.on('close', (removed: boolean, done: () => void) => {
+      if (removed) {
+        device.delSensor(id)
+          .then(() => { done(); })
+          .catch(err => {
+            this.error("Error on delete property: " + err.message);
+            done();
+          });
+      } else {
+        device.setMaxListeners(device.getMaxListeners() - 1);
+        done();
+      }
+    });
+  }
+
+  RED.nodes.registerType("Sensor", AliceSensor);
+};

package/src/alice-togle.html

@@ -0,0 +1,96 @@
+<script type="text/javascript">
+    RED.nodes.registerType('Toggle',{
+        category: 'alice',
+        defaults:{
+            device: {value:"", type:"alice-device"},
+            name: {value:""},
+            instance: {value:"backlight"},
+            response: {value:true}
+        },
+        inputs:1,
+        outputs:1,
+        icon: "alice.png",
+        color: "#D8BFD8",
+        label: function(){
+            return this.name + ":"+this.instance;
+        },
+        oneditprepare: function(){
+            if (this.response === undefined){
+                $( "#node-input-response").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="Toggle">
+    <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">Instance</label>
+        <select id="node-input-instance" style="width: 70%;">
+            <option value="backlight">Backlight</option>
+            <option value="controls_locked">Locking</option>
+            <option value="ionization" >Ionization</option>
+            <option value="keep_warm">Keep warm</option>
+            <option value="mute">Mute</option>
+            <option value="oscillation">Oscillation</option>
+            <option value="pause">Pause</option>
+        </select>
+    </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="Toggle">
+    <p>Manage device settings that can only be in one of two states.</p>
+    <p>The toggle skill has features. Functions are characterized by certain parameters and 
+        voice scripts that allow you to describe the corresponding skills of the device.</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>Instance
+            <span class="property-type">Select</span>
+        </dt>
+        <dd> The name of the function for this skill. Affects which voice command is called </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/toggle-instance-docpage/"> - Yandex documentation</a></li>
+        </ul>
+    </script>

package/src/alice-togle.ts

@@ -0,0 +1,122 @@
+import { NodeAPI, Node } from "node-red";
+import { AliceCapabilityConfig, AliceDeviceNode, CapabilityState } from "./types.js";
+
+export = (RED: NodeAPI): void => {
+  function AliceToggle(this: Node, config: AliceCapabilityConfig): void {
+    RED.nodes.createNode(this, config);
+    const device = RED.nodes.getNode(config.device) as AliceDeviceNode;
+    device.setMaxListeners(device.getMaxListeners() + 1);
+
+    const ctype = 'devices.capabilities.toggle';
+    const instance = config.instance || '';
+    let response = config.response;
+    let value = false;
+
+    if (config.response === undefined) {
+      response = true;
+    }
+
+    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,
+        }
+      };
+      device.setCapability(this.id, capab)
+        .then(() => {
+          this.debug("Capability initilization - success!");
+          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: boolean) => {
+      this.debug("Received a new value from Yandex...");
+      this.send({ payload: val });
+      const state: CapabilityState = {
+        type: ctype,
+        state: {
+          instance: instance,
+          value: val
+        }
+      };
+      if (response) {
+        this.debug("Automatic confirmation is true, sending confirmation to Yandex ...");
+        device.updateCapabState(this.id, state)
+          .then(() => {
+            value = val;
+            this.status({ fill: "green", shape: "dot", text: String(val) });
+          })
+          .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 === value) {
+        this.debug("Value not changed. Cancel update");
+        if (done) { done(); }
+        return;
+      }
+      const state: CapabilityState = {
+        type: ctype,
+        state: {
+          instance: instance,
+          value: msg.payload
+        }
+      };
+      device.updateCapabState(this.id, state)
+        .then(() => {
+          value = msg.payload as boolean;
+          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) => {
+      if (removed) {
+        device.delCapability(this.id)
+          .then(() => { done(); })
+          .catch(err => {
+            this.error("Error on delete capability: " + err.message);
+            done();
+          });
+      } else {
+        done();
+      }
+    });
+  }
+
+  RED.nodes.registerType("Toggle", AliceToggle);
+};