@nightspark77/node-red-charlie-home-assistant 1.0.0

package/ask.html

@@ -0,0 +1,133 @@
+<script type="text/javascript">
+    RED.nodes.registerType('charlie-ask', {
+        category: 'Charlie',
+        paletteLabel: 'Ask',
+        color: '#fff',
+        defaults: {
+            name: { value: '' },
+        },
+        inputs: 1,
+        outputs: 1,
+        label: function () {
+            return this.name || 'Ask';
+        },
+    });
+</script>
+
+<script type="text/x-red" data-template-name="charlie-ask">
+    <form id="dialog-form" class="form-horizontal" autocomplete="off">
+        <div class="form-row">
+            <label for="node-input-name">Name</label>
+            <input id="node-input-name" />
+        </div>
+    </form>
+</script>
+
+<script type="text/x-red" data-help-name="charlie-ask">
+        <p>
+            The <b>Charlie Ask</b> node sends a natural‑language prompt to the Charlie
+            assistant and returns the generated response. It acts as a simple interface
+            to the Charlie LLM backend and is designed for conversational flows,
+            automation queries, and contextual reasoning.
+        </p>
+
+        <h3>Inputs</h3>
+        <p>
+            This node accepts a single input message. The input must contain a
+            <code>payload</code> object with a <code>message</code> field:
+        </p>
+
+        <pre>
+    {
+        "message": "Your question or instruction"
+    }
+        </pre>
+
+        <ul>
+            <li><b>message</b> – Required. A string representing the prompt to send to
+                the assistant.</li>
+        </ul>
+
+        <p>Examples:</p>
+
+        <pre>
+    // Ask a question
+    { "message": "Quels appareils sont éteints ?" }
+
+    // Request an explanation
+    { "message": "Explique-moi comment fonctionne l'arrosage automatique." }
+
+    // Ask for help with automation
+    { "message": "Ouvre le volet du salon à 50%." }
+        </pre>
+
+        <h3>Outputs</h3>
+        <p>
+            The node outputs a single message containing the assistant's full response
+            in <code>msg.payload</code>. The structure includes:
+        </p>
+
+        <ul>
+            <li><b>input_entries</b> – The messages sent to the assistant.</li>
+            <li><b>output_entries</b> – The assistant’s reasoning steps, tool calls,
+                and final answer.</li>
+            <li><b>conversation_id</b> – Identifier for the ongoing conversation.</li>
+            <li><b>files</b> – Optional file attachments.</li>
+        </ul>
+
+        <p>
+            The final assistant answer is always found in the last
+            <code>output_entries</code> item with <code>type: "message.output"</code>.
+        </p>
+
+        <h4>Example Output</h4>
+
+        <pre>
+    {
+      "input_entries": [
+        {
+          "role": "user",
+          "content": "Quel appareils sont eteints ?",
+          "type": "message.input"
+        }
+      ],
+      "conversation_id": "conv_019bece990a773288d23949e97df190d",
+      "output_entries": [
+        {
+          "type": "function.call",
+          "name": "fetch-devices-state",
+          "arguments": "{}"
+        },
+        {
+          "type": "function.result",
+          "result": "[ ... device state list ... ]"
+        },
+        {
+          "type": "message.output",
+          "content": "Les appareils éteints sont l'ampoule du salon et la lumière cabannon2."
+        }
+      ]
+    }
+        </pre>
+
+        <h3>Details</h3>
+        <p>
+            The Charlie assistant may call internal tools (for example,
+            <code>fetch-devices-state</code>) to gather information before generating
+            the final answer. These intermediate steps are included in
+            <code>output_entries</code> for transparency and debugging.
+        </p>
+
+        <p>
+            The last <code>message.output</code> entry contains the assistant’s final
+            natural‑language response, which is typically what you will use in your
+            flow.
+        </p>
+
+        <h3>Usage</h3>
+        <p>
+            Connect inject, function, or automation nodes to generate the
+            <code>msg.payload.message</code>. The output can be routed to debug nodes,
+            dashboards, notification systems, or other Charlie nodes.
+        </p>
+</script>

package/ask.js

@@ -0,0 +1,35 @@
+const { conf, isReady, apiUrl, mqttHost } = require('./shared');
+
+module.exports = function (RED) {
+    function MyNode(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+
+        node.on('input', async function (msg, send) {
+            await isReady();
+
+            const payload = msg.payload;
+
+            let json = undefined;
+            if (payload?.message) {
+                try {
+                    const res = await fetch(`${apiUrl()}/api/assistant/chat`, {
+                        method: 'POST',
+                        headers: {
+                            'Content-Type': 'application/json',
+                        },
+                        body: JSON.stringify({ message: payload.message }),
+                    });
+
+                    json = await res.json();
+                } catch (e) {
+                    node.warn('Error cannot ask assistant please retry later.');
+                }
+            }
+
+            node.send([{ ...msg, payload: json }]);
+        });
+    }
+
+    RED.nodes.registerType('charlie-ask', MyNode);
+};

package/device.html

@@ -0,0 +1,150 @@
+<script type="text/javascript">
+    RED.nodes.registerType('charlie-device', {
+        category: 'Charlie',
+        paletteLabel: 'Device',
+        color: '#fff',
+        defaults: {
+            name: { value: '', required: true },
+            id: { value: '', required: true },
+            deviceType: { value: 'light', required: true },
+            externalId: { value: '', required: true },
+            outputs: { value: 2 },
+        },
+        inputs: 1,
+        outputs: function () {
+            const n = Number(this.outputs);
+            return isNaN(n) ? 2 : n;
+        },
+        outputLabels: function (index) {
+            return index === 0 ? 'On' : index === 1 ? 'Off' : 'Pause';
+        },
+        icon: 'device.png',
+        label: function () {
+            return this.name || 'Device';
+        },
+        oneditsave: function () {
+            const type = $('#node-input-deviceType').val();
+            this.outputs = type === 'shutter' ? 3 : 2;
+        },
+    });
+</script>
+
+<script type="text/x-red" data-template-name="charlie-device">
+    <form id="dialog-form" class="form-horizontal" autocomplete="off">
+        <div class="form-row">
+            <label for="node-input-id">Id</label>
+            <input id="node-input-id" />
+        </div>
+
+        <div class="form-row">
+            <label for="node-input-name">Name</label>
+            <input id="node-input-name" />
+        </div>
+
+        <div class="form-row">
+            <label for="node-input-externalId">External id</label>
+            <input id="node-input-externalId" />
+        </div>
+
+        <div class="form-row">
+            <label for="node-input-deviceType">Type</label>
+            <select id="node-input-deviceType">
+                <option value="light">Lum</option>
+                <option value="switch">Interupteur</option>
+                <option value="shutter">Volet</option>
+                <option value="sprinkler">Arrosage</option>
+            </select>
+        </div>
+    </form>
+</script>
+
+<script type="text/x-red" data-help-name="charlie-device">
+        <p>
+            The <b>Charlie Device</b> node represents a controllable device managed by the
+            Charlie provider. It reacts to incoming messages and triggers the appropriate
+            action on the Charlie backend based on the content of <code>msg.payload</code>.
+        </p>
+
+        <h3>Inputs</h3>
+        <p>
+            This node accepts a single input message. The input must contain a
+            <code>payload</code> object describing the desired action:
+        </p>
+
+        <pre>
+    {
+        "state": "on" | "off" | "pause",
+        "level": &lt;number&gt;   // optional
+    }
+        </pre>
+
+        <ul>
+            <li><b>state</b> – Required. Defines the action to perform.</li>
+            <li><b>level</b> – Optional. A numeric value used for devices that support
+                intensity or position (e.g., dimmable lights, shutters).</li>
+        </ul>
+
+        <p>
+            Examples:
+        </p>
+
+        <pre>
+    // Turn on a light
+    { "state": "on" }
+
+    // Turn off a device
+    { "state": "off" }
+
+    // Set a shutter to 50%
+    { "state": "on", "level": 50 }
+
+    // Pause a shutter
+    { "state": "pause" }
+        </pre>
+
+        <h3>Outputs</h3>
+        <ul>
+            <li><b>Light / Switch / Sprinkler</b>: 2 outputs (On / Off)</li>
+            <li><b>Shutter</b>: 3 outputs (On / Off / Pause)</li>
+        </ul>
+
+        <p>
+            The number of outputs is automatically adjusted based on the selected
+            device type. Output labels are:
+        </p>
+
+        <ul>
+            <li><b>Output 1</b>: On</li>
+            <li><b>Output 2</b>: Off</li>
+            <li><b>Output 3</b> (shutter only): Pause</li>
+        </ul>
+
+        <h3>Properties</h3>
+        <ul>
+            <li><b>ID</b> – Unique identifier for this device within Charlie.</li>
+            <li><b>Name</b> – Display name shown in the Node‑RED editor.</li>
+            <li><b>External ID</b> – Identifier used by the Charlie backend.</li>
+            <li><b>Type</b> – Device category:
+                <ul>
+                    <li><b>Lum</b> – Light</li>
+                    <li><b>Interrupteur</b> – Switch</li>
+                    <li><b>Volet</b> – Shutter</li>
+                    <li><b>Arrosage</b> – Sprinkler</li>
+                </ul>
+            </li>
+        </ul>
+
+        <h3>Details</h3>
+        <p>
+            When a valid payload is received, the node forwards the corresponding
+            command to the Charlie backend. For shutters, the optional
+            <code>level</code> attribute can be used to set a specific position.
+        </p>
+
+        <h3>Usage</h3>
+        <p>
+            Connect inject, function, or automation logic nodes to generate the
+            appropriate <code>msg.payload</code>. Route the outputs to the rest of
+            your flow depending on the action you want to perform.
+        </p>
+</script>

package/device.js

@@ -0,0 +1,94 @@
+const { conf, isReady, apiUrl, mqttHost } = require('./shared');
+const mqtt = require('mqtt');
+
+module.exports = function (RED) {
+    function MyNode(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+        let ready = false;
+        let client = null;
+
+        (async () => {
+            if (
+                !config.id ||
+                !config.name ||
+                !config.externalId ||
+                !config.deviceType
+            )
+                return;
+
+            await isReady();
+
+            // register device
+            await fetch(`${apiUrl()}/api/devices`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+                body: JSON.stringify({
+                    _id: config.id,
+                    name: config.name,
+                    externalId: config.externalId,
+                    provider: conf.provider.id,
+                    type: config.deviceType,
+                }),
+            });
+
+            client = mqtt.connect(mqttHost());
+
+            client.on('connect', () => {
+                client.subscribe(`device/${config.id}/state`);
+            });
+
+            client.on('message', (topic, payload) => {
+                const res = JSON.parse(payload.toString());
+                const oi =
+                    res.power === 'on'
+                        ? 0
+                        : res.power === 'off' || config.deviceType === 'shutter'
+                          ? 1
+                          : 2;
+
+                const outputs = [null, null, null];
+                outputs[oi] = {
+                    topic: config.id,
+                    payload: { state: res.power, level: res.level },
+                };
+
+                node.send(outputs);
+            });
+
+            ready = true;
+        })();
+
+        node.on('input', async function (msg, send) {
+            if (!ready) return;
+
+            const payload = msg.payload;
+
+            if (
+                payload.state === 'on' ||
+                payload.state === 'off' ||
+                payload.state === 'pause'
+            ) {
+                try {
+                    client.publish(
+                        `device/state`,
+                        JSON.stringify({
+                            id: config.id,
+                            power: payload.state,
+                            level: payload.level ?? 100,
+                        }),
+                        {
+                            qos: 0,
+                        }
+                    );
+                } catch (e) {
+                    node.warn('Error cannot send state to home assistant.');
+                }
+            }
+        });
+    }
+
+    RED.nodes.registerType('charlie-device', MyNode);
+};

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@nightspark77/node-red-charlie-home-assistant",
+  "version": "1.0.0",
+  "description": "Create and control your own device with Charlie within nodered",
+  "license": "ISC",
+  "keywords": [
+    "node-red"
+  ],
+  "author": "Quentin Vanhauteghem",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "node-red": {
+    "nodes": {
+      "provider": "provider.js",
+      "device": "device.js",
+      "ask": "ask.js"
+    }
+  },
+  "dependencies": {
+    "mqtt": "^5.14.1"
+  }
+}

package/provider.html

@@ -0,0 +1,76 @@
+<script type="text/javascript">
+    RED.nodes.registerType('charlie-provider', {
+        category: 'Charlie',
+        paletteLabel: 'Provider',
+        color: '#fff',
+        defaults: {
+            id: { value: '', required: true },
+            name: { value: '', required: true },
+            charlieHost: { value: 'localhost' },
+            apiPort: { value: 9300 },
+            mqttPort: { value: 9304 },
+        },
+        inputs: 0,
+        outputs: 0,
+        icon: 'provider.png',
+        label: function () {
+            return this.name || 'Charlie provider';
+        },
+    });
+</script>
+
+<script type="text/x-red" data-template-name="charlie-provider">
+    <form id="dialog-form" class="form-horizontal" autocomplete="off">
+        <div class="form-row">
+            <label for="node-input-id"><i class="fa fa-tag"></i> ID</label>
+            <input type="text" id="node-input-id" />
+        </div>
+
+        <div class="form-row">
+            <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+            <input type="text" id="node-input-name" />
+        </div>
+
+        <div class="form-row">
+            <label for="node-input-charlieHost"
+                ><i class="fa fa-tag"></i> Charlie host</label
+            >
+            <input type="text" id="node-input-charlieHost" placeholder="localhost" />
+        </div>
+
+        <div class="form-row">
+            <label for="node-input-apiPort"><i class="fa fa-tag"></i> API port</label>
+            <input type="number" id="node-input-apiPort" placeholder="9300" />
+        </div>
+
+        <div class="form-row">
+            <label for="node-input-mqttPort"><i class="fa fa-tag"></i> MQTT port</label>
+            <input type="number" id="node-input-mqttPort" placeholder="9304" />
+        </div>
+    </form>
+</script>
+
+<script type="text/x-red" data-help-name="charlie-provider">
+    <p>This node connects to a Charlie provider server.</p>
+
+    <h3>Inputs</h3>
+    <p>No inputs. This is a configuration node.</p>
+
+    <h3>Outputs</h3>
+    <p>No outputs.</p>
+
+    <h3>Properties</h3>
+    <ul>
+        <li><b>ID</b> – Unique identifier for this provider.</li>
+        <li><b>Name</b> – Display name.</li>
+        <li><b>Charlie host</b> – Hostname or IP of the Charlie server.</li>
+        <li><b>API port</b> – Port for the API.</li>
+        <li><b>MQTT port</b> – Port for MQTT communication.</li>
+    </ul>
+
+    <h3>Details</h3>
+    <p>
+        This node registers a provider with the Charlie backend and makes it
+        available to other Charlie nodes in the flow.
+    </p>
+</script>

package/provider.js

@@ -0,0 +1,39 @@
+const { conf, apiUrl } = require('./shared');
+
+module.exports = function (RED) {
+    function MyNode(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+
+        conf.provider.charlieHost = config.charlieHost;
+        conf.provider.apiPort = config.apiPort;
+        conf.provider.mqttPort = config.mqttPort;
+
+        (async () => {
+            if (!conf?.provider?.charlieHost) return;
+            try {
+                const res = await fetch(`${apiUrl()}/api/providers`, {
+                    method: 'POST',
+                    headers: {
+                        'Content-Type': 'application/json',
+                    },
+                    body: JSON.stringify({
+                        _id: config.id,
+                        name: config.name,
+                        codesource: 'default_custom',
+                    }),
+                });
+
+                const json = await res.json();
+
+                conf.provider.id = json.uuid;
+
+                conf.ready = true;
+            } catch (e) {
+                node.warn('Charlie provider server host not configured');
+            }
+        })();
+    }
+
+    RED.nodes.registerType('charlie-provider', MyNode);
+};

package/shared.js

@@ -0,0 +1,25 @@
+const conf = {
+    provider: {
+        id: undefined,
+        host: undefined,
+    },
+    ready: false,
+};
+
+module.exports = {
+    conf,
+    apiUrl: () =>
+        `http://${conf.provider.charlieHost ?? 'localhost'}:${conf.provider.apiPort ?? '9300'}`,
+    mqttHost: () =>
+        `mqtt://${conf.provider.charlieHost}:${conf.provider.mqttHost ?? '9304'}`,
+    isReady: () => {
+        return new Promise((res) => {
+            const inter = setInterval(() => {
+                if (conf.ready) {
+                    res();
+                }
+                clearInterval(inter);
+            }, 500);
+        });
+    },
+};