node-red-contrib-alice 2.2.5 → 2.3.2

package/src/alice.ts

@@ -1,92 +1,67 @@
-import {NodeAPI, Node, NodeDef, NodeCredentials, NodeCredential } from "node-red";
+import { NodeAPI } from "node-red";
 import axios from "axios";
 import mqtt from "mqtt";
-
-interface NodeAliceConfig
-    extends NodeDef {
-    name:string;
-};
-
-interface NodeAliceCredentials
-  extends NodeCredential {
-    email:string;
-    id:string;
-    password:string;
-    token:string;
-  };
-
-interface AliceNode
-  extends Node {
-    credentials: NodeAliceCredentials;
-    isOnline:boolean;
-    getToken():string;
-    send2gate(topic:string,data:any,retain:boolean):void;
-    // on(event: 'hello', listener: (name: string) => void): this;
-    on(event: string, listener: Function): this;
-  };
-
-export = (RED: NodeAPI):void =>{
-  function AliceService(this:AliceNode, config:NodeAliceConfig):void {
-      RED.nodes.createNode(this,config);
-      this.debug("Starting Alice service... ID: "+this.id);
-
-      const email = this.credentials.email;
-      const login = this.credentials.id;
-      const password = this.credentials.password;
-      const token = this.credentials.token;
-
-      //вызов для удаления всех устройств 
-      const suburl = Buffer.from(email).toString('base64');
-      RED.httpAdmin.get("/noderedhome/"+suburl+"/clearalldevice",(req,res)=>{
-        const option = {
-          method: 'POST',
-          url: 'https://api.nodered-home.ru/gtw/device/clearallconfigs',
-          headers: {
-            'content-type': 'application/json',
-            'Authorization': "Bearer "+this.getToken()
-          },
-          data: {}
-        };
-        axios.request(option)
-        .then(result=>{
-          this.trace("All devices configs deleted on gateway successfully");
-          // console.log(result)
-          res.sendStatus(200);
-        })
-        .catch(error=>{
-          this.debug("Error when delete All devices configs deleted on gateway: "+error.message);
-          res.sendStatus(500);
-        });
+import { AliceServiceConfig, AliceServiceNode } from "./types.js";
+
+export = (RED: NodeAPI): void => {
+  function AliceService(this: AliceServiceNode, config: AliceServiceConfig): void {
+    RED.nodes.createNode(this, config);
+    this.debug("Starting Alice service... ID: " + this.id);
+
+    const email = this.credentials.email;
+    const login = this.credentials.id;
+    const password = this.credentials.password;
+    const token = this.credentials.token;
+
+    //вызов для удаления всех устройств
+    const suburl = Buffer.from(email).toString('base64');
+    RED.httpAdmin.get("/noderedhome/" + suburl + "/clearalldevice", (_req, res) => {
+      axios.request({
+        method: 'POST',
+        url: 'https://api.nodered-home.ru/gtw/device/clearallconfigs',
+        headers: {
+          'content-type': 'application/json',
+          'Authorization': "Bearer " + this.getToken()
+        },
+        data: {}
+      })
+      .then(() => {
+        this.trace("All devices configs deleted on gateway successfully");
+        res.sendStatus(200);
+      })
+      .catch(error => {
+        this.debug("Error when delete All devices configs deleted on gateway: " + error.message);
+        res.sendStatus(500);
       });
+    });
 
-      RED.httpAdmin.get("/noderedhome/"+this.id+"/getfullconfig",(req,res)=>{
-        const option = {
-          method: 'GET',
-          url: 'https://api.iot.yandex.net/v1.0/user/info',
-          headers: {
-            'content-type': 'application/json',
-            'Authorization': "Bearer "+this.getToken()
-          }
-        };
-        axios.request(option)
-        .then(result=>{
-          this.trace("Full Alice SmartHome config successfully retrieved");
-          // console.log(result)
-          res.json(result.data);
-        })
-        .catch(error=>{
-          this.debug("Error when retrieve Alice SmartHome config: "+error.message);
-          res.sendStatus(500);
-        });
+    RED.httpAdmin.get("/noderedhome/" + this.id + "/getfullconfig", (_req, res) => {
+      axios.request({
+        method: 'GET',
+        url: 'https://api.iot.yandex.net/v1.0/user/info',
+        headers: {
+          'content-type': 'application/json',
+          'Authorization': "Bearer " + this.getToken()
+        }
+      })
+      .then(result => {
+        this.trace("Full Alice SmartHome config successfully retrieved");
+        res.json(result.data);
+      })
+      .catch(error => {
+        this.debug("Error when retrieve Alice SmartHome config: " + error.message);
+        res.sendStatus(500);
       });
+    });
 
     this.isOnline = false;
-    //// проверяем а есть ли токен 
-    if (!token){
+
+    if (!token) {
       this.error("Authentication is required!!!");
       return;
-    };
-    const mqttClient = mqtt.connect("mqtts://mqtt.cloud.yandex.net",{
+    }
+
+    const mqttClient = mqtt.connect("mqtts://mqtt.cloud.yandex.net", {
       port: 8883,
       clientId: login,
       rejectUnauthorized: false,
@@ -95,202 +70,77 @@ export = (RED: NodeAPI):void =>{
       reconnectPeriod: 10000
     });
 
-    mqttClient.on("message",(topic:string, payload:string)=>{
+    mqttClient.on("message", (topic: string, payload: Buffer) => {
       const arrTopic = topic.split('/');
-      const data = JSON.parse(payload);
-      this.trace("Incoming:" + topic +" timestamp:"+new Date().getTime());
-      if (payload.length && typeof data === 'object'){
-        if (arrTopic[3]=='message'){
+      const data = JSON.parse(payload.toString());
+      this.trace("Incoming:" + topic + " timestamp:" + new Date().getTime());
+      if (payload.length && typeof data === 'object') {
+        if (arrTopic[3] == 'message') {
           this.warn(data.text);
-        }else{
-          this.emit(arrTopic[3],data);
-        };
+        } else {
+          this.emit(arrTopic[3], data);
+        }
       }
     });
-    mqttClient.on("connect",()=>{
+
+    mqttClient.on("connect", () => {
       this.debug("Yandex IOT client connected. ");
       this.emit('online');
-      // Подписываемся на получение комманд 
-      mqttClient.subscribe("$me/device/commands/+",_=>{
+      mqttClient.subscribe("$me/device/commands/+", () => {
         this.debug("Yandex IOT client subscribed to the command");
       });
     });
-    mqttClient.on("offline",()=>{
+
+    mqttClient.on("offline", () => {
       this.debug("Yandex IOT client offline. ");
       this.emit('offline');
     });
-    mqttClient.on("disconnect",()=>{
+
+    mqttClient.on("disconnect", () => {
       this.debug("Yandex IOT client disconnect.");
       this.emit('offline');
     });
-    mqttClient.on("reconnect",()=>{
+
+    mqttClient.on("reconnect", () => {
       this.debug("Yandex IOT client reconnecting ...");
     });
-    mqttClient.on("error",(err)=>{
-      this.error("Yandex IOT client Error: "+ err.message);
+
+    mqttClient.on("error", (err) => {
+      this.error("Yandex IOT client Error: " + err.message);
       this.emit('offline');
     });
 
-    this.on('offline', ()=>{
+    this.on('offline', () => {
       this.isOnline = false;
     });
 
-    this.on('online', ()=>{
+    this.on('online', () => {
       this.isOnline = true;
     });
 
-    this.on('close',(done:Object)=>{
+    this.on('close', (done: () => void) => {
       this.emit('offline');
-      setTimeout(()=>{
-        mqttClient.end(false,done);
-      },500)
+      setTimeout(() => {
+        mqttClient.end(false, {}, done);
+      }, 500);
     });
 
-    this.send2gate = (path:string,data:any,retain:boolean)=>{
-      // this.debug(path);
-      // this.debug(data);
-      this.trace("Outgoing: "+path);
-      mqttClient.publish(path, data ,{ qos: 0, retain: retain });
-    }
-
+    this.send2gate = (path: string, data: string, retain: boolean) => {
+      this.trace("Outgoing: " + path);
+      mqttClient.publish(path, data, { qos: 0, retain: retain });
+    };
 
-    this.getToken = ()=>{
-      return JSON.parse(token).access_token; 
+    this.getToken = () => {
+      return JSON.parse(token).access_token;
+    };
+  }
+
+  RED.nodes.registerType("alice-service", AliceService, {
+    credentials: {
+      email: { type: "text" },
+      password: { type: "password" },
+      token: { type: "password" },
+      id: { type: "text" }
     }
-  };
-
-  RED.nodes.registerType("alice-service",AliceService,{
-        credentials: {
-          email: {type: "text"},
-          password: {type: "password"},
-          token: {type: "password"},
-          id:{type:"text"}
-        }
-      });
-}
-
-// const mqtt = require('mqtt');
-// const axios = require('axios');
-
-// module.exports = function(RED) {
-//   //Sevice node, Alice-Service (credential)
-//   function AliceService(config) {
-//     RED.nodes.createNode(this,config);
-//     this.debug("Starting Alice service...");
-
-//     const email = this.credentials.email;
-//     const login = this.credentials.id;
-//     const password = this.credentials.password;
-//     const token = this.credentials.token;
-
-//     const suburl = Buffer.from(email).toString('base64');
-//     RED.httpAdmin.get("/noderedhome/"+suburl+"/clearalldevice",(req,res)=>{
-//       const option = {
-//         method: 'POST',
-//         url: 'https://api.nodered-home.ru/gtw/device/clearallconfigs',
-//         headers: {
-//           'content-type': 'application/json',
-//           'Authorization': "Bearer "+this.getToken()
-//         },
-//         data: {}
-//       };
-//       axios.request(option)
-//       .then(result=>{
-//         this.trace("All devices configs deleted on gateway successfully");
-//         // console.log(result)
-//         res.sendStatus(200);
-//       })
-//       .catch(error=>{
-//         this.debug("Error when delete All devices configs deleted on gateway: "+error.message);
-//         res.sendStatus(500);
-//       });
-//     });
-
-//     this.isOnline = false;
-//     if (!token){
-//       this.error("Authentication is required!!!");
-//       return;
-//     };
-    // const mqttClient = mqtt.connect("mqtts://mqtt.cloud.yandex.net",{
-    //   port: 8883,
-    //   clientId: login,
-    //   rejectUnauthorized: false,
-    //   username: login,
-    //   password: password,
-    //   reconnectPeriod: 10000
-    // });
-    // mqttClient.on("message",(topic, payload)=>{
-    //   const arrTopic = topic.split('/');
-    //   const data = JSON.parse(payload);
-    //   this.trace("Incoming:" + topic +" timestamp:"+new Date().getTime());
-    //   if (payload.length && typeof data === 'object'){
-    //     if (arrTopic[3]=='message'){
-    //       this.warn(data.text);
-    //     }else{
-    //       this.emit(arrTopic[3],data);
-    //     };
-    //   }
-    // });
-    // mqttClient.on("connect",()=>{
-    //   this.debug("Yandex IOT client connected. ");
-    //   this.emit('online');
-    //   // Подписываемся на получение комманд 
-    //   mqttClient.subscribe("$me/device/commands/+",_=>{
-    //     this.debug("Yandex IOT client subscribed to the command");
-    //   });
-    // });
-    // mqttClient.on("offline",()=>{
-    //   this.debug("Yandex IOT client offline. ");
-    //   this.emit('offline');
-    // });
-    // mqttClient.on("disconnect",()=>{
-    //   this.debug("Yandex IOT client disconnect.");
-    //   this.emit('offline');
-    // });
-    // mqttClient.on("reconnect",(err)=>{
-    //   this.debug("Yandex IOT client reconnecting ...");
-    // });
-    // mqttClient.on("error",(err)=>{
-    //   this.error("Yandex IOT client Error: "+ err.message);
-    //   this.emit('offline');
-    // });
-
-    // this.on('offline', ()=>{
-    //   this.isOnline = false;
-    // })
-
-    // this.on('online', ()=>{
-    //   this.isOnline = true;
-    // })
-
-    // this.on('close',(done)=>{
-    //   this.emit('offline');
-    //   setTimeout(()=>{
-    //     mqttClient.end(false,done);
-    //   },500)
-    // });
-
-    // this.send2gate= (path,data,retain)=>{
-    //   // this.debug(path);
-    //   // this.debug(data);
-    //   this.trace("Outgoing: "+path);
-    //   mqttClient.publish(path, data ,{ qos: 0, retain: retain });
-    // }
-
-    // this.getToken = ()=>{
-    //   return JSON.parse(token).access_token; 
-    // }
-
-//   };
-//   RED.nodes.registerType("alice-service",AliceService,{
-//     credentials: {
-//       email: {type: "text"},
-//       password: {type: "password"},
-//       token: {type: "password"},
-//       id:{type:"text"}
-//     }
-//   });
-// };
-
-
-
+  });
+};

package/src/types.ts

@@ -0,0 +1,157 @@
+import { Node, NodeDef } from "node-red";
+
+// ==================== Конфигурации нод ====================
+
+export interface AliceServiceConfig extends NodeDef {
+  name: string;
+}
+
+export interface AliceDeviceConfig extends NodeDef {
+  service: string;
+  name: string;
+  description: string;
+  room: string;
+  dtype: string;
+}
+
+export interface AliceCapabilityConfig extends NodeDef {
+  device: string;
+  name: string;
+  response?: boolean;
+  instance?: string;
+}
+
+export interface AliceOnOffConfig extends AliceCapabilityConfig {
+  split?: boolean;
+}
+
+export interface AliceRangeConfig extends AliceCapabilityConfig {
+  retrievable: boolean;
+  unit: string;
+  min: string;
+  max: string;
+  precision: string;
+}
+
+export interface AliceColorConfig extends AliceCapabilityConfig {
+  color_support?: boolean;
+  scheme: string;
+  temperature_k?: boolean;
+  temperature_min: string;
+  temperature_max: string;
+  color_scene?: string[];
+}
+
+export interface AliceModeConfig extends AliceCapabilityConfig {
+  modes: string[];
+}
+
+export interface AliceSensorConfig extends NodeDef {
+  device: string;
+  name: string;
+  stype: string;
+  instance: string;
+  unit: string;
+}
+
+export interface AliceEventConfig extends NodeDef {
+  device: string;
+  name: string;
+  instance: string;
+  events: string[];
+}
+
+export interface AliceVideoConfig extends NodeDef {
+  device: string;
+  name: string;
+  stream_url: string;
+  protocol: string;
+}
+
+// ==================== Типы состояний ====================
+
+export interface CapabilityState {
+  id?: string;
+  type: string;
+  state: {
+    instance: string;
+    value: any;
+    relative?: boolean;
+  };
+}
+
+export interface SensorState {
+  id?: string;
+  type: string;
+  state: {
+    instance: string;
+    value: any;
+  };
+}
+
+// ==================== Конфигурация умения/сенсора для регистрации ====================
+
+export interface CapabilityRegistration {
+  id?: string;
+  type: string;
+  retrievable: boolean;
+  reportable: boolean;
+  parameters: Record<string, any>;
+}
+
+export interface SensorRegistration {
+  id?: string;
+  type: string;
+  retrievable: boolean;
+  reportable: boolean;
+  parameters: Record<string, any>;
+}
+
+// ==================== Интерфейсы нод ====================
+
+export interface AliceServiceNode extends Node {
+  credentials: {
+    email: string;
+    id: string;
+    password: string;
+    token: string;
+  };
+  isOnline: boolean;
+  getToken(): string;
+  send2gate(topic: string, data: string, retain: boolean): void;
+  on(event: string, listener: (...args: any[]) => void): this;
+}
+
+export interface AliceDeviceNode extends Node {
+  initState: boolean;
+  setCapability(capId: string, capab: CapabilityRegistration): Promise<boolean>;
+  setSensor(sensId: string, sensor: SensorRegistration): Promise<boolean>;
+  updateCapabState(capId: string, state: CapabilityState): Promise<boolean>;
+  updateSensorState(sensId: string, state: SensorState): Promise<boolean>;
+  delCapability(capId: string): Promise<boolean>;
+  delSensor(sensId: string): Promise<boolean>;
+  on(event: string, listener: (...args: any[]) => void): this;
+}
+
+// ==================== Конфигурация устройства для шлюза ====================
+
+export interface DeviceConfig {
+  id: string;
+  name: string;
+  description: string;
+  room: string;
+  type: string;
+  device_info: {
+    manufacturer: string;
+    model: string;
+    sw_version: string;
+  };
+  capabilities: CapabilityRegistration[];
+  properties: SensorRegistration[];
+}
+
+export interface DeviceStates {
+  id: string;
+  capabilities: CapabilityState[];
+  properties: SensorState[];
+}