node-red-contrib-golc-alice 0.1.0

package/README.md

@@ -0,0 +1,36 @@
+# node-red-contrib-golc-alice
+
+DIY free Node-RED nodes for your personal Yandex Alice integration.
+
+## Install
+
+Inside your Node-RED user directory (usually `~/.node-red`):
+
+```bash
+npm install /opt/GOLC-HOME-lab-alise/nodered/node-red-contrib-golc-alice
+```
+
+Then restart Node-RED.
+
+## Node: `alice-device`
+
+Modes:
+
+- `register` — register/update virtual device in backend registry.
+- `state` — update state for an existing device.
+
+Required backend env:
+
+- `INTERNAL_TOKEN` (must match node config `Internal Token`)
+
+Backend endpoints used:
+
+- `POST /internal/registry/devices`
+- `POST /internal/devices/:id/state`
+
+## Message overrides
+
+- `msg.mode` — override mode (`register` or `state`)
+- `msg.device` — full device object for register mode
+- `msg.deviceId` — device id for state mode
+- `msg.state` — state object for state mode

package/examples/example-flow.json

@@ -0,0 +1,82 @@
+[
+  {
+    "id": "inject_reg",
+    "type": "inject",
+    "z": "flow1",
+    "name": "Register virtual lamp+temp",
+    "props": [],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "x": 200,
+    "y": 120,
+    "wires": [["alice_register"]]
+  },
+  {
+    "id": "alice_register",
+    "type": "alice-device",
+    "z": "flow1",
+    "name": "Register device",
+    "backendUrl": "http://localhost:3000",
+    "internalToken": "local-internal-token",
+    "mode": "register",
+    "deviceId": "virtual_lamp_1",
+    "deviceName": "Виртуальная лампа",
+    "deviceType": "devices.types.light",
+    "withOnOff": true,
+    "withTemperature": true,
+    "withHumidity": false,
+    "withOpenSensor": false,
+    "x": 460,
+    "y": 120,
+    "wires": [["debug_out"]]
+  },
+  {
+    "id": "inject_state",
+    "type": "inject",
+    "z": "flow1",
+    "name": "State update temp=27",
+    "props": [
+      { "p": "state", "v": "{\"on\":true,\"temperature\":27}", "vt": "json" }
+    ],
+    "x": 190,
+    "y": 180,
+    "wires": [["alice_state"]]
+  },
+  {
+    "id": "alice_state",
+    "type": "alice-device",
+    "z": "flow1",
+    "name": "State update",
+    "backendUrl": "http://localhost:3000",
+    "internalToken": "local-internal-token",
+    "mode": "state",
+    "deviceId": "virtual_lamp_1",
+    "deviceName": "",
+    "deviceType": "devices.types.light",
+    "withOnOff": true,
+    "withTemperature": false,
+    "withHumidity": false,
+    "withOpenSensor": false,
+    "x": 440,
+    "y": 180,
+    "wires": [["debug_out"]]
+  },
+  {
+    "id": "debug_out",
+    "type": "debug",
+    "z": "flow1",
+    "name": "result",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "targetType": "msg",
+    "x": 680,
+    "y": 150,
+    "wires": []
+  }
+]

package/nodes/alice-device.html

@@ -0,0 +1,82 @@
+<script type="text/javascript">
+  RED.nodes.registerType('alice-device', {
+    category: 'function',
+    color: '#6ab7ff',
+    defaults: {
+      name: { value: '' },
+      backendUrl: { value: 'http://localhost:3000', required: true },
+      internalToken: { value: 'local-internal-token', required: true },
+      mode: { value: 'register', required: true },
+      deviceId: { value: '' },
+      deviceName: { value: '' },
+      deviceType: { value: 'devices.types.light' },
+      withOnOff: { value: true },
+      withTemperature: { value: false },
+      withHumidity: { value: false },
+      withOpenSensor: { value: false }
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: 'bridge.svg',
+    label: function () {
+      return this.name || 'alice-device';
+    }
+  });
+</script>
+
+<script type="text/html" data-template-name="alice-device">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="alice-device" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-backendUrl">Backend URL</label>
+    <input type="text" id="node-input-backendUrl" placeholder="http://localhost:3000" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-internalToken">Internal Token</label>
+    <input type="text" id="node-input-internalToken" placeholder="local-internal-token" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-mode">Mode</label>
+    <select id="node-input-mode">
+      <option value="register">register device</option>
+      <option value="state">update state</option>
+    </select>
+  </div>
+  <hr />
+  <div class="form-row">
+    <label for="node-input-deviceId">Device ID</label>
+    <input type="text" id="node-input-deviceId" placeholder="lamp_virtual_1" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-deviceName">Device Name</label>
+    <input type="text" id="node-input-deviceName" placeholder="Лампа кухня" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-deviceType">Device Type</label>
+    <input type="text" id="node-input-deviceType" placeholder="devices.types.light" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-withOnOff">on/off</label>
+    <input type="checkbox" id="node-input-withOnOff" style="width:auto;" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-withTemperature">temperature</label>
+    <input type="checkbox" id="node-input-withTemperature" style="width:auto;" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-withHumidity">humidity</label>
+    <input type="checkbox" id="node-input-withHumidity" style="width:auto;" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-withOpenSensor">open sensor</label>
+    <input type="checkbox" id="node-input-withOpenSensor" style="width:auto;" />
+  </div>
+</script>
+
+<script type="text/html" data-help-name="alice-device">
+  <p>DIY node for GOLC Alice backend.</p>
+  <p><b>register</b>: creates/updates virtual device in backend.</p>
+  <p><b>state</b>: updates device state from <code>msg.state</code> or <code>msg.payload</code>.</p>
+</script>

package/nodes/alice-device.js

@@ -0,0 +1,179 @@
+const http = require('http');
+const https = require('https');
+
+function requestJson(method, targetUrl, headers, body) {
+  return new Promise((resolve, reject) => {
+    const parsed = new URL(targetUrl);
+    const lib = parsed.protocol === 'https:' ? https : http;
+
+    const payload = body ? JSON.stringify(body) : null;
+
+    const req = lib.request(
+      {
+        method,
+        hostname: parsed.hostname,
+        port: parsed.port || (parsed.protocol === 'https:' ? 443 : 80),
+        path: `${parsed.pathname}${parsed.search}`,
+        headers: {
+          Accept: 'application/json',
+          ...(payload ? { 'Content-Type': 'application/json' } : {}),
+          ...(payload ? { 'Content-Length': Buffer.byteLength(payload) } : {}),
+          ...(headers || {}),
+        },
+      },
+      (res) => {
+        let raw = '';
+        res.setEncoding('utf8');
+        res.on('data', (chunk) => {
+          raw += chunk;
+        });
+        res.on('end', () => {
+          try {
+            const json = raw ? JSON.parse(raw) : {};
+            resolve({ statusCode: res.statusCode, body: json });
+          } catch (error) {
+            reject(error);
+          }
+        });
+      }
+    );
+
+    req.on('error', reject);
+    if (payload) req.write(payload);
+    req.end();
+  });
+}
+
+module.exports = function (RED) {
+  function AliceDeviceNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+
+    node.backendUrl = (config.backendUrl || 'http://localhost:3000').replace(/\/$/, '');
+    node.internalToken = config.internalToken || 'local-internal-token';
+    node.mode = config.mode || 'register';
+
+    node.deviceId = config.deviceId || '';
+    node.deviceName = config.deviceName || '';
+    node.deviceType = config.deviceType || 'devices.types.light';
+
+    node.withOnOff = !!config.withOnOff;
+    node.withTemperature = !!config.withTemperature;
+    node.withHumidity = !!config.withHumidity;
+    node.withOpenSensor = !!config.withOpenSensor;
+
+    async function handleRegister(msg) {
+      const baseDevice = {
+        id: node.deviceId,
+        name: node.deviceName || node.deviceId,
+        type: node.deviceType,
+        status_info: { reportable: true },
+        capabilities: [],
+        properties: [],
+        state: {},
+      };
+
+      if (node.withOnOff) {
+        baseDevice.capabilities.push({ type: 'devices.capabilities.on_off', retrievable: true });
+        baseDevice.state.on = false;
+      }
+
+      if (node.withTemperature) {
+        baseDevice.properties.push({
+          type: 'devices.properties.float',
+          retrievable: true,
+          reportable: true,
+          parameters: { instance: 'temperature', unit: 'unit.temperature.celsius' },
+        });
+        baseDevice.state.temperature = 22;
+      }
+
+      if (node.withHumidity) {
+        baseDevice.properties.push({
+          type: 'devices.properties.float',
+          retrievable: true,
+          reportable: true,
+          parameters: { instance: 'humidity', unit: 'unit.percent' },
+        });
+        baseDevice.state.humidity = 50;
+      }
+
+      if (node.withOpenSensor) {
+        baseDevice.properties.push({
+          type: 'devices.properties.event',
+          retrievable: true,
+          reportable: true,
+          parameters: { instance: 'open', events: [{ value: 'opened' }, { value: 'closed' }] },
+        });
+        baseDevice.state.open = 'closed';
+      }
+
+      const deviceFromMsg = msg.device && typeof msg.device === 'object' ? msg.device : {};
+      const merged = {
+        ...baseDevice,
+        ...deviceFromMsg,
+        state: {
+          ...baseDevice.state,
+          ...(deviceFromMsg.state || {}),
+        },
+      };
+
+      const url = `${node.backendUrl}/internal/registry/devices`;
+      const response = await requestJson(
+        'POST',
+        url,
+        { 'X-Internal-Token': node.internalToken },
+        { devices: [merged] }
+      );
+
+      msg.payload = response.body;
+      msg.statusCode = response.statusCode;
+      return msg;
+    }
+
+    async function handleStateUpdate(msg) {
+      const id = (msg.deviceId || node.deviceId || '').trim();
+      if (!id) {
+        throw new Error('deviceId is required for state mode');
+      }
+
+      const state = (msg.state && typeof msg.state === 'object') ? msg.state : (msg.payload && typeof msg.payload === 'object' ? msg.payload : null);
+      if (!state) {
+        throw new Error('msg.state or msg.payload object is required for state mode');
+      }
+
+      const url = `${node.backendUrl}/internal/devices/${encodeURIComponent(id)}/state`;
+      const response = await requestJson(
+        'POST',
+        url,
+        { 'X-Internal-Token': node.internalToken },
+        { state }
+      );
+
+      msg.payload = response.body;
+      msg.statusCode = response.statusCode;
+      return msg;
+    }
+
+    node.on('input', async (msg, send, done) => {
+      const sender = send || node.send.bind(node);
+      try {
+        const mode = (msg.mode || node.mode || 'register').toLowerCase();
+        node.status({ fill: 'blue', shape: 'dot', text: `alice ${mode}...` });
+
+        const outMsg = mode === 'state'
+          ? await handleStateUpdate(msg)
+          : await handleRegister(msg);
+
+        node.status({ fill: 'green', shape: 'dot', text: `ok ${mode}` });
+        sender(outMsg);
+        done();
+      } catch (error) {
+        node.status({ fill: 'red', shape: 'ring', text: 'error' });
+        done(error);
+      }
+    });
+  }
+
+  RED.nodes.registerType('alice-device', AliceDeviceNode);
+};

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "node-red-contrib-golc-alice",
+  "version": "0.1.0",
+  "description": "DIY Node-RED nodes for GOLC Alice smart home backend",
+  "main": "nodes/alice-device.js",
+  "keywords": [
+    "node-red",
+    "alice",
+    "yandex",
+    "smart-home",
+    "golc"
+  ],
+  "author": "GOLC-HOME",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/detdomovski-prog/GOLC-HOME-lab-alise.git"
+  },
+  "bugs": {
+    "url": "https://github.com/detdomovski-prog/GOLC-HOME-lab-alise/issues"
+  },
+  "homepage": "https://github.com/detdomovski-prog/GOLC-HOME-lab-alise/tree/main/nodered/node-red-contrib-golc-alice",
+  "node-red": {
+    "nodes": {
+      "alice-device": "nodes/alice-device.js"
+    }
+  }
+}