node-red-contrib-lgtv-notify 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 rcaldeira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,103 @@
+# node-red-contrib-lgtv-notify
+
+Send toast notifications to LG webOS Smart TVs from Node-RED.
+
+**Works with webOS 10+ (2025 TVs)** - Includes built-in SSL handling for newer TV firmware.
+
+## Features
+
+- Simple toast notifications on your LG TV
+- Works with webOS 3.0 and newer (including 2025 models)
+- Automatic SSL certificate handling (no manual configuration needed)
+- Auto-reconnection and message queuing
+- Saves pairing key for seamless future connections
+
+## Installation
+
+### From Node-RED Palette Manager
+
+1. Open Node-RED
+2. Go to Menu > Manage palette > Install
+3. Search for `node-red-contrib-lgtv-notify`
+4. Click Install
+
+### From Command Line
+
+```bash
+cd ~/.node-red
+npm install node-red-contrib-lgtv-notify
+```
+
+Then restart Node-RED.
+
+## Setup
+
+1. Drag an **LG TV notify** node onto your flow
+2. Double-click to configure
+3. Add a new TV configuration with your TV's IP address
+4. Deploy
+5. **Important:** Check your TV for a pairing prompt and accept it
+
+After accepting the pairing prompt once, the node will remember the connection key.
+
+## Usage
+
+### Basic Example
+
+```
+[inject] → [lgtv-notify]
+```
+
+Set `msg.payload` to your notification message:
+
+```javascript
+msg.payload = "Someone is at the front door!";
+return msg;
+```
+
+### Home Automation Example
+
+```
+[mqtt in] → [function] → [lgtv-notify]
+doorbell      format
+```
+
+Function node:
+```javascript
+msg.payload = "Doorbell: " + msg.payload;
+return msg;
+```
+
+## Requirements
+
+- LG webOS Smart TV (webOS 3.0 or newer)
+- TV and Node-RED on the same network
+- "LG Connect Apps" enabled on the TV
+  - Settings > General > External Device Manager > LG Connect Apps
+
+## Troubleshooting
+
+### TV not connecting
+
+1. Make sure the TV is powered on (not in standby)
+2. Check that "LG Connect Apps" is enabled
+3. Verify the IP address is correct
+4. The TV takes ~25 seconds after power-on before the API is available
+
+### Pairing prompt not appearing
+
+- Restart Node-RED and redeploy the flow
+- Try removing and re-adding the TV configuration
+
+### Notifications not showing
+
+- Notifications only appear when the TV is on and displaying content
+- Maximum message length is 60 characters
+
+## License
+
+MIT
+
+## Credits
+
+Built on [lgtv2](https://github.com/hobbyquaker/lgtv2) by Sebastian Raff.

package/nodes/lgtv-notify.html

@@ -0,0 +1,96 @@
+<!-- LG TV Configuration Node -->
+<script type="text/javascript">
+    RED.nodes.registerType('lgtv-config', {
+        category: 'config',
+        defaults: {
+            name: { value: '' },
+            host: { value: '', required: true }
+        },
+        credentials: {
+            clientKey: { type: 'text' }
+        },
+        label: function() {
+            return this.name || this.host || 'LG TV';
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="lgtv-config">
+    <div class="form-row">
+        <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-config-input-name" placeholder="Living Room TV">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-host"><i class="fa fa-globe"></i> TV IP</label>
+        <input type="text" id="node-config-input-host" placeholder="192.168.1.100">
+    </div>
+    <div class="form-tips">
+        <p><strong>First connection:</strong> Accept the pairing prompt on your TV.</p>
+        <p>The TV must be on and "LG Connect Apps" must be enabled in TV settings.</p>
+    </div>
+</script>
+
+<!-- LG TV Notify Node -->
+<script type="text/javascript">
+    RED.nodes.registerType('lgtv-notify', {
+        category: 'home automation',
+        color: '#A6BBCF',
+        defaults: {
+            name: { value: '' },
+            tv: { value: '', type: 'lgtv-config', required: true },
+            message: { value: '' }
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: 'font-awesome/fa-television',
+        label: function() {
+            return this.name || 'LG TV Notify';
+        },
+        paletteLabel: 'LG TV notify',
+        inputLabels: 'notification message',
+        outputLabels: 'result'
+    });
+</script>
+
+<script type="text/html" data-template-name="lgtv-notify">
+    <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="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-tv"><i class="fa fa-television"></i> TV</label>
+        <input type="text" id="node-input-tv">
+    </div>
+    <div class="form-row">
+        <label for="node-input-message"><i class="fa fa-comment"></i> Message</label>
+        <input type="text" id="node-input-message" placeholder="Use msg.payload or enter default">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="lgtv-notify">
+    <p>Send toast notifications to an LG webOS TV.</p>
+
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">string</span></dt>
+        <dd>The notification message to display on the TV.</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">string</span></dt>
+        <dd>The original message.</dd>
+        <dt>toastId <span class="property-type">string</span></dt>
+        <dd>The ID of the created toast notification.</dd>
+    </dl>
+
+    <h3>Details</h3>
+    <p>This node sends a toast notification to an LG webOS Smart TV.</p>
+    <p>The notification will appear in the top-right corner of the TV screen for approximately 5 seconds.</p>
+    <p><strong>First use:</strong> When you first deploy, check your TV for a pairing prompt and accept it.</p>
+
+    <h3>References</h3>
+    <ul>
+        <li><a href="https://github.com/rcaldeira/node-red-contrib-lgtv-notify">GitHub</a> - the node's repository</li>
+    </ul>
+</script>

package/nodes/lgtv-notify.js

@@ -0,0 +1,157 @@
+// Disable SSL certificate verification for LG TV's self-signed certificates
+process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
+
+module.exports = function(RED) {
+    const lgtv = require('lgtv2');
+
+    // Configuration node for TV connection
+    function LgtvConfigNode(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+
+        this.host = config.host;
+        this.name = config.name || config.host;
+        this.connection = null;
+        this.connected = false;
+        this.connecting = false;
+        this.clientKey = null;
+        this.queue = [];
+
+        // Store client key in credentials
+        if (this.credentials && this.credentials.clientKey) {
+            this.clientKey = this.credentials.clientKey;
+        }
+
+        this.connect = function() {
+            if (node.connecting || node.connected) return;
+
+            node.connecting = true;
+
+            const options = {
+                url: `wss://${node.host}:3001`,
+                reconnect: false
+            };
+
+            if (node.clientKey) {
+                options.clientKey = node.clientKey;
+            }
+
+            node.connection = lgtv(options);
+
+            node.connection.on('error', (err) => {
+                node.error(`Connection error: ${err.message}`);
+                node.connected = false;
+                node.connecting = false;
+            });
+
+            node.connection.on('close', () => {
+                node.connected = false;
+                node.connecting = false;
+            });
+
+            node.connection.on('prompt', () => {
+                node.log('Pairing prompt shown on TV - please accept');
+            });
+
+            node.connection.on('connect', () => {
+                node.connected = true;
+                node.connecting = false;
+                node.log(`Connected to ${node.host}`);
+
+                // Save client key for future connections
+                if (node.connection.clientKey && node.connection.clientKey !== node.clientKey) {
+                    node.clientKey = node.connection.clientKey;
+                    node.credentials.clientKey = node.clientKey;
+                }
+
+                // Process queued messages
+                while (node.queue.length > 0) {
+                    const msg = node.queue.shift();
+                    node.sendToast(msg.message, msg.callback);
+                }
+            });
+        };
+
+        this.disconnect = function() {
+            if (node.connection) {
+                node.connection.disconnect();
+                node.connection = null;
+            }
+            node.connected = false;
+            node.connecting = false;
+        };
+
+        this.sendToast = function(message, callback) {
+            if (!node.connected) {
+                node.queue.push({ message, callback });
+                node.connect();
+                return;
+            }
+
+            node.connection.request(
+                'ssap://system.notifications/createToast',
+                { message: message },
+                (err, res) => {
+                    if (callback) callback(err, res);
+                }
+            );
+        };
+
+        this.on('close', function(done) {
+            node.disconnect();
+            done();
+        });
+    }
+
+    RED.nodes.registerType('lgtv-config', LgtvConfigNode, {
+        credentials: {
+            clientKey: { type: 'text' }
+        }
+    });
+
+    // Notify node
+    function LgtvNotifyNode(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+
+        this.tv = RED.nodes.getNode(config.tv);
+        this.name = config.name;
+
+        if (!this.tv) {
+            node.error('No TV configured');
+            return;
+        }
+
+        node.status({ fill: 'grey', shape: 'dot', text: 'idle' });
+
+        this.on('input', function(msg, send, done) {
+            const message = msg.payload || config.message || 'Notification';
+
+            node.status({ fill: 'yellow', shape: 'dot', text: 'sending...' });
+
+            node.tv.sendToast(message, (err, res) => {
+                if (err) {
+                    node.status({ fill: 'red', shape: 'dot', text: 'error' });
+                    if (done) done(err);
+                    else node.error(err, msg);
+                } else {
+                    node.status({ fill: 'green', shape: 'dot', text: 'sent' });
+                    msg.toastId = res.toastId;
+                    send(msg);
+                    if (done) done();
+
+                    // Reset status after 3 seconds
+                    setTimeout(() => {
+                        node.status({ fill: 'grey', shape: 'dot', text: 'idle' });
+                    }, 3000);
+                }
+            });
+        });
+
+        this.on('close', function() {
+            node.status({});
+        });
+    }
+
+    RED.nodes.registerType('lgtv-notify', LgtvNotifyNode);
+};

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "node-red-contrib-lgtv-notify",
+  "version": "1.0.0",
+  "description": "Send toast notifications to LG webOS TVs from Node-RED. Works with webOS 10+ (2025 TVs).",
+  "keywords": [
+    "node-red",
+    "lgtv",
+    "lg",
+    "webos",
+    "tv",
+    "notification",
+    "toast",
+    "smart-home",
+    "home-automation"
+  ],
+  "author": "rcaldeira",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rcaldeira/node-red-contrib-lgtv-notify"
+  },
+  "node-red": {
+    "version": ">=2.0.0",
+    "nodes": {
+      "lgtv-notify": "nodes/lgtv-notify.js"
+    }
+  },
+  "dependencies": {
+    "lgtv2": "^1.4.1"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}