node-red-contrib-alice 2.2.5 → 2.3.2

package/src/alice-event.html

@@ -0,0 +1,148 @@
+<script type="text/javascript">
+    RED.nodes.registerType('Event',{
+        category: 'alice',
+        defaults:{
+            device: {value:"", type:"alice-device"},
+            name: {value:"Event"},
+            stype: {value:'devices.properties.event'},
+            instance: {value:undefined, validate: (v)=>{
+                if (v){
+                    return true;
+                }else{
+                    return false;
+                }
+            }},
+            events:{value:[]}
+        },
+        inputs:1,
+        outputs:0,
+        icon: "alice.png",
+        color: "#D8BFD8",
+        label: function(){
+            return this.name;
+        },
+        oneditprepare: function(){
+            $("#node-input-instance").typedInput({
+                types: [
+                    {
+                        options: [
+                            { value: "vibration", label: "Vibration"},
+                            { value: "open", label: "Open"},
+                            { value: "button", label: "Button"},
+                            { value: "motion", label: "Motion"},
+                            { value: "smoke", label: "Smoke"},
+                            { value: "gas", label: "Gas"},
+                            { value: "battery_level", label: "Battery level"},
+                            { value: "water_level", label: "Water level"},
+                            { value: "water_leak", label: "Water leak"}
+                        ]
+                    }
+                ]
+            });
+            $('#node-input-instance').on('change',()=>{
+                let val= $("#node-input-instance").val();
+                $("#node-input-eventslist").editableList('empty');
+
+                switch (val) {
+                    case "vibration":
+                        $("#node-input-eventslist").editableList('addItems',["tilt","fall","vibration"]);
+                        break;
+                    case "open":
+                        $("#node-input-eventslist").editableList('addItems',["opened","closed"]);
+                        break;
+                    case "button":
+                        $("#node-input-eventslist").editableList('addItems',["click","double_click","long_press"]);
+                        break;
+                    case "motion":
+                        $("#node-input-eventslist").editableList('addItems',["detected","not_detected"]);
+                        break;
+                    case "smoke":
+                        $("#node-input-eventslist").editableList('addItems',["detected","not_detected","high"]);
+                        break;
+                    case "gas":
+                        $("#node-input-eventslist").editableList('addItems',["detected","not_detected","high"]);
+                        break;
+                    case "battery_level":
+                        $("#node-input-eventslist").editableList('addItems',["low","normal"]);
+                        break;
+                    case "water_level":
+                        $("#node-input-eventslist").editableList('addItems',["low","normal"]);
+                        break;
+                    case "water_leak":
+                        $("#node-input-eventslist").editableList('addItems',["dry","leak"]);
+                        break;
+                    default:
+                        break;
+                }
+            });
+            $("#node-input-eventslist").editableList({
+                addButton: false,
+                height: 150,
+                addItem: function(container,i,opt){
+                    var row = $('<div style="padding-left: 3px; class="event_name">'+opt+'</div>').appendTo(container);
+                }
+            });
+        },
+        oneditsave: function(){
+            deivcename = $('#node-input-device option:selected').text();
+            instance = $("#node-input-instance").val();
+            $('#node-input-name').val(deivcename+":"+instance);
+            let events = $("#node-input-eventslist").editableList('items');
+            let node = this;
+            node.events= [];
+            events.each(function(i) {
+                let name = $(this).text(); 
+                node.events.push(name);
+            })
+        }
+    })
+</script>
+
+<script type="text/x-red" data-template-name="Event">
+    <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">Event Type</label>
+        <input type="text" id="node-input-instance">
+    </div>
+    <div class="form-row node-input-rule-container-row">
+        <label for="node-input-modes" style="width:auto">Supported events</label>
+        <ol id="node-input-eventslist"></ol>
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="Event">
+    <p>Transmits event 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>Event Type
+            <span class="property-type">Select</span>
+        </dt>
+        <dd>a type of event that helps to better understand the area of its use and the data it collects</dd>
+        <dt>Supported events
+            <span class="property-type">Read only</span>
+        </dt>
+        <dd>list of events that the sensor can send</dd>
+    </dl>
+
+    <h3>Inputs</h3>
+        <dl class="message-properties">
+            <dt>payload
+                <span class="property-type">string</span>
+            </dt>
+            <dd>events can only be from the allowed list</dd>
+        </dl>
+    
+    <h3>References</h3>
+        <ul>
+            <li><a href="https://yandex.ru/dev/dialogs/smart-home/doc/concepts/event.html"> - Yandex documentation</a></li>
+        </ul>
+    </script>

package/src/alice-event.ts

@@ -0,0 +1,112 @@
+import { NodeAPI, Node } from "node-red";
+import { AliceEventConfig, AliceDeviceNode, SensorState } from "./types.js";
+
+export = (RED: NodeAPI): void => {
+  function AliceEvent(this: Node, config: AliceEventConfig): 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 = 'devices.properties.event';
+    const instance = config.instance;
+    const events = config.events;
+    let initState = false;
+
+    const curentState: SensorState = {
+      type: stype,
+      state: {
+        instance: instance,
+        value: ''
+      }
+    };
+
+    this.status({ fill: "red", shape: "dot", text: "offline" });
+
+    const init = (): void => {
+      this.debug("Starting sensor initilization ...");
+      const objEvents = events.map(v => ({ value: v }));
+      const sensor = {
+        type: stype,
+        reportable: true,
+        retrievable: false,
+        parameters: {
+          instance: instance,
+          events: objEvents
+        }
+      };
+
+      device.setSensor(id, sensor)
+        .then(() => {
+          this.debug("Sensor initilization - success!");
+          this.status({ fill: "green", shape: "dot", text: "online" });
+          initState = true;
+        })
+        .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", () => {
+      if (!initState) {
+        init();
+      } else {
+        this.status({ fill: "green", shape: "dot", text: curentState.state.value });
+      }
+    });
+
+    device.on("offline", () => {
+      this.status({ fill: "red", shape: "dot", text: "offline" });
+    });
+
+    this.on('input', (msg, _send, done) => {
+      if (!events.includes(msg.payload as string)) {
+        this.error("Wrong type! msg.payload must be from the list of allowed events.");
+        if (done) { done(); }
+        return;
+      }
+      if (curentState.state.value == msg.payload) {
+        this.debug("Value not changed. Cancel update");
+        if (done) { done(); }
+        return;
+      } else {
+        curentState.state.value = msg.payload;
+      }
+      // для кнопок обнуляем значение через 1 сек
+      if (instance == 'button') {
+        setTimeout(() => {
+          curentState.state.value = null;
+          this.status({ fill: "green", shape: "dot", text: "" });
+        }, 1000);
+      }
+      device.updateSensorState(id, curentState)
+        .then(() => {
+          this.status({ fill: "green", shape: "dot", text: curentState.state.value });
+          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 {
+        done();
+      }
+    });
+  }
+
+  RED.nodes.registerType("Event", AliceEvent);
+};

package/src/alice-get.ts

@@ -1,18 +1,15 @@
-import {NodeAPI, Node, NodeDef } from "node-red";
-import axios from "axios";
+import { NodeAPI, Node, NodeDef } from "node-red";
 
+interface NodeAliceGetConfig extends NodeDef {
+  service: string;
+  name: string;
+}
 
-interface NodeAliceGetConfig
-    extends NodeDef {
-    service: string;
-    name:string;
-};
-
-export = (RED: NodeAPI):void =>{
-    function AliceGet(this:Node, config:NodeAliceGetConfig):void {
-        RED.nodes.createNode(this,config);
-        const service = RED.nodes.getNode(config.service);
-    };
+export = (RED: NodeAPI): void => {
+  function AliceGet(this: Node, config: NodeAliceGetConfig): void {
+    RED.nodes.createNode(this, config);
+    const _service = RED.nodes.getNode(config.service);
+  }
 
-    RED.nodes.registerType("Alice-Get",AliceGet);
-}
+  RED.nodes.registerType("Alice-Get", AliceGet);
+};

package/src/alice-mode.html

@@ -0,0 +1,296 @@
+<script type="text/javascript">
+    RED.nodes.registerType('Mode',{
+        category: 'alice',
+        defaults:{
+            device: {value:"", type:"alice-device"},
+            name: {value:""},
+            instance: { value:null, validate: (v)=>{
+                if (v){
+                    return true;
+                }else{
+                    return false;
+                }
+            }},
+            modes:{value:[], validate:(ms)=>{
+                return ms.length > 0
+            }},
+            response:{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);
+            currentInstance = $('#node-input-instance').val();
+            if (currentInstance=='multicooker_mode'){
+                $('#node-input-instance option[value=program]').prop('selected', true);
+            };
+            this.modes = getCurrentModes();
+        },
+        oneditprepare: function(){
+            var firstRun = true;            
+            $('#node-input-instance').on('change',()=>{
+                var val = $('#node-input-instance').find(":selected").val();
+                if (firstRun){
+                    firstRun=false;
+                    return;
+                };
+                switch (val) {
+                    case 'cleanup_mode':
+                        this.modes = ['auto','eco','express','normal','quiet']
+                        break;
+                    case 'coffee_mode':
+                        this.modes = ['americano','cappuccino','double_espresso','espresso','latte']
+                        break;
+                    case 'multicooker_mode':
+                        this.modes = ['vacuum','boiling','baking','dessert','baby_food','fowl','frying','yogurt','cereals','macaroni','milk_porridge','multicooker','steam','pasta','pizza','pilaf','sauce','soup','stewing','slow_cook','deep_fryer','bread','aspic','cheesecake','preheat']
+                        break;
+                    case 'fan_speed':
+                        this.modes = ['auto','high','low','medium','turbo']
+                        break;
+                    case 'heat':
+                        this.modes = ['auto','max','min','normal','turbo']
+                        break;
+                    case 'input_source':
+                        this.modes = ['one','two','three','four','five','six','seven','eight','nine','ten']
+                        break;
+                    case 'program':
+                        this.modes = ['auto','express','one','two','three','four','five','six','seven','eight','nine','ten']
+                        break;
+                    case 'swing':
+                        this.modes = ['auto','horizontal','stationary','vertical']
+                        break;
+                    case 'thermostat':
+                        this.modes = ['auto','cool','dry','fan_only','heat','preheat']
+                        break;
+                    case 'work_speed':
+                        this.modes = ['auto','fast','max','medium','min','slow','turbo']
+                        break;
+                    case 'tea_mode':
+                        this.modes = ['black_tea','flower_tea','green_tea','herbal_tea','oolong_tea','puerh_tea','red_tea','white_tea']
+                        break;
+                    default:
+                        this.modes = [];
+                        break;
+                };
+                updateAllModes(this.modes);  
+            });
+            updateAllModes(this.modes);
+        }
+    });
+    function updateAllModes(modes){
+        deleteAllMode();
+        modes.forEach((m,i)=>{
+            addMode2List(m,i);
+        });
+        if (modes.length<1){
+            $('#node-input-modes-container').parent().css('border-color', "rgb(214, 97, 95)")
+        }else{
+            $('#node-input-modes-container').parent().css('border-color', "")
+        }
+    };
+    function addMode2List(mode,index){
+        $('#node-input-modes-container').append('<li rel="'+mode+'" 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>'+mode+'</span></div><a href="#" onclick="delMode('+index+')" class="red-ui-editableList-item-remove red-ui-button red-ui-button-small"><i class="fa fa-remove"></i></a></li>')        
+    };
+    function deleteAllMode() {
+        $('#node-input-modes-container').empty();
+    };
+    function delMode(index) {
+        var modes = getCurrentModes();
+        modes.splice(index, 1);
+        updateAllModes(modes);
+    };
+    function addMode() {
+        var mode = $('#select-custom-mode').find(":selected").val();
+        var modes = getCurrentModes();
+        if (modes.indexOf(mode)>-1){
+            return;
+        }else{
+            modes.push(mode);
+            updateAllModes(modes);
+        }
+    };
+    function getCurrentModes() {
+        var modes = [];
+        $('#node-input-modes-container li').each(function(){ 
+            modes.push($(this).attr('rel')); 
+        });
+        return modes;
+    }
+</script>
+
+<script type="text/x-red" data-template-name="Mode">
+    <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">Mode Type</label>
+        <select id="node-input-instance" style="width: 70%;">
+            <option value="cleanup_mode">Cleanup mode</option>
+            <option value="coffee_mode">Coffee mode</option>
+            <option value="multicooker_mode">Multicooker Mode</option>
+            <option value="tea_mode">Tea Mode</option>
+            <option value="fan_speed">Fan speed</option>
+            <option value="heat">Heat Mode</option>
+            <option value="input_source">Input source</option>
+            <option value="program">Program</option>
+            <option value="swing">Swing Mode</option>
+            <option value="thermostat">Thermostat</option>
+            <option value="work_speed">Work speed</option>
+        </select>
+    </div>
+    <div class="form-row node-input-rule-container-row">
+        <label for="node-input-modes" style="width:auto">Supported commands</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-modes-container" class="red-ui-editableList-list" style="min-height: 0px; min-width: 450px; height: auto;">
+                    <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-mode">
+                    <option value="auto">auto</option>
+                    <option value="eco">eco</option>
+                    <option value="turbo">turbo</option>
+                    <option value="cool">cool</option>
+                    <option value="dry">dry</option>
+                    <option value="fan_only">fan_only</option>
+                    <option value="heat">heat</option>
+                    <option value="preheat">preheat</option>
+                    <option value="high">high</option>
+                    <option value="low">low</option>
+                    <option value="medium">medium</option>
+                    <option value="max">max</option>
+                    <option value="min">min</option>
+                    <option value="fast">fast</option>
+                    <option value="slow">slow</option>
+                    <option value="express">express</option>
+                    <option value="normal">normal</option>
+                    <option value="quiet">quiet</option>
+                    <option value="horizontal">horizontal</option>
+                    <option value="stationary">stationary</option>
+                    <option value="vertical">vertical</option>
+                    <option value="americano">americano</option>
+                    <option value="cappuccino">cappuccino</option>
+                    <option value="double_espresso">double_espresso</option>
+                    <option value="espresso">espresso</option>
+                    <option value="latte">latte</option>
+                    <option value="one">one</option>
+                    <option value="two">two</option>
+                    <option value="three">three</option>
+                    <option value="four">four</option>
+                    <option value="five">five</option>
+                    <option value="six">six</option>
+                    <option value="seven">seven</option>
+                    <option value="eight">eight</option>
+                    <option value="nine">nine</option>
+                    <option value="ten">ten</option>
+                    <option value="vacuum">vacuum</option>
+                    <option value="boiling">boiling</option>
+                    <option value="baking">baking</option>
+                    <option value="dessert">dessert</option>
+                    <option value="baby_food">baby_food</option>
+                    <option value="fowl">fowl</option>
+                    <option value="frying">frying</option>
+                    <option value="yogurt">yogurt</option>
+                    <option value="cereals">cereals</option>
+                    <option value="macaroni">macaroni</option>
+                    <option value="milk_porridge">milk_porridge</option>
+                    <option value="multicooker">multicooker</option>
+                    <option value="steam">steam</option>
+                    <option value="pasta">pasta</option>
+                    <option value="pizza">pizza</option>
+                    <option value="pilaf">pilaf</option>
+                    <option value="sauce">sauce</option>
+                    <option value="soup">soup</option>
+                    <option value="stewing">stewing</option>
+                    <option value="slow_cook">slow_cook</option>
+                    <option value="deep_fryer">deep_fryer</option>
+                    <option value="bread">bread</option>
+                    <option value="aspic">aspic</option>
+                    <option value="cheesecake">cheesecake</option>
+                    <option value="preheat">preheat</option>
+                    <option value="black_tea">black_tea</option>
+                    <option value="flower_tea">flower_tea</option>
+                    <option value="green_tea">green_tea</option>
+                    <option value="herbal_tea">herbal_tea</option>
+                    <option value="oolong_tea">oolong_tea</option>
+                    <option value="puerh_tea">puerh_tea</option>
+                    <option value="red_tea">red_tea</option>
+                    <option value="white_tea">white_tea</option>
+                </select>
+                <a id="button-addMode" href="#" class="red-ui-button" onclick="addMode()" 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="Mode">
+    <p>Controlling the operating modes of the device, for example, switching between the temperature operating modes of the air conditioner: "Cooling", "Heating" or "Auto".</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>Mode Type
+            <span class="property-type">Select</span>
+        </dt>
+        <dd> Selection of the type of modes (cleanup, coffee, input source, work speed, etc.) </dd>
+        <dt>Supported commands
+            <span class="property-type">List</span>
+        </dt>
+        <dd> List of commands that are supported by this mode. You can add other commands yourself. </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">String</span>
+            </dt>
+            <dd> command from the supported list of commands </dd>
+        </dl>
+    
+     <h3>Outputs</h3>
+        <dl class="message-properties">
+            <dt>payload
+                <span class="property-type">Strin</span>
+            </dt>
+            <dd> command from the supported list of commands </dd>
+        </dl>
+    <h3>References</h3>
+        <ul>
+            <li><a href="https://yandex.ru/dev/dialogs/alice/doc/smart-home/concepts/mode-instance-modes-docpage/"> Yandex documentation</a></li>
+        </ul>
+</script>