lgtv2mqtt2 1.0.0

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Marcin
+
+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,43 @@
+# `lgtv2mqtt2`
+
+`lgtv2mqtt2` connects WebOS-based TVs with MQTT, exposing a couple of read-write properties to control the TV.
+
+There's [`lgtv2mqtt`](https://github.com/hobbyquaker/lgtv2mqtt) but it didn't work for me, and none of the WebOS libraries on GitHub did either, other than the one bundled with [`homebridge-webos-tv`](https://github.com/merdok/homebridge-webos-tv/) which this project re-uses.
+
+I only exposed the endpoints that I care about, and this repository is provided as-is - feel free to fork and change things and send PRs.
+
+## Installation
+
+1. `npm install lgtv2mqtt2` (optionally with `-g` if you want it to be available globally)
+2. create `~/.mqtt-config.json` containing:
+  ```
+  {
+    host: "MQTT_BROKER_ADDRESS",
+    username: "MQTT_BROKER_USERNAME",
+    password: "MQTT_BROKER_PASSWORD"
+  }
+  ```
+3. create `~/.lgtv-config.json` containing:
+  ```
+  {
+    ip: "LGTV_IP",
+    mac: "LGTV_MAC",
+    mqttBase: "MQTT_BASE_PATH",
+  }
+  ```
+  - it's best to assign static IP to your TV, and note the MAC address from the router
+  - the `mqttBase` is the path under which the properties will be stored
+
+## Usage
+
+First, run `lgtv2mqtt2`.
+
+The tool creates a couple of paths under the `mqttBase` (below). Their values are writable (which updates the TV state), and they react to TV state changes (say from a TV remote) and update the values in MQTT:
+
+- `/power` `["on" | "off"]`
+- `/screen` `["on" | "off"]`
+- `/volume` `0 - 100`
+- `/backlight` `0 - 100`
+- `/input` `com.webos.app.hdmi[N]`
+
+

package/cli.js

@@ -0,0 +1,182 @@
+#!/usr/bin/env node
+
+import mqtt from "mqtt";
+
+import LgTvController from "./vendor/LgTvController.js";
+import Events from "./vendor/Events.js";
+
+import getConfig from "./get-config.js";
+
+const MQTT_CONFIG = getConfig(".mqtt-config.json", {
+  host: "MQTT_BROKER_ADDRESS",
+  username: "MQTT_BROKER_USERNAME",
+  password: "MQTT_BROKER_PASSWORD",
+});
+
+const LGTV_CONFIG = getConfig(".lgtv-config.json", {
+  ip: "LGTV_IP",
+  mac: "LGTV_MAC",
+  mqttBase: "MQTT_BASE_PATH",
+});
+
+const client = mqtt.connect(MQTT_CONFIG);
+
+const lg = new LgTvController(LGTV_CONFIG.ip, LGTV_CONFIG.mac, "keyfile");
+lg.connect();
+
+const state = {};
+const config = {
+  power: {
+    onLgEvents: {
+      [Events.TV_TURNED_ON]: () => {
+        publishMqttMessageIfDiffers("power", "on");
+      },
+      [Events.TV_TURNED_OFF]: () => {
+        publishMqttMessageIfDiffers("power", "off");
+      },
+    },
+
+    onMqttMessage: (value) => {
+      if (value === "on") {
+        lg.turnOn();
+      }
+
+      if (value === "off") {
+        lg.turnOff();
+      }
+    },
+  },
+
+  volume: {
+    onLgEvents: {
+      [Events.AUDIO_STATUS_CHANGED]: (value) => {
+        publishMqttMessageIfDiffers("volume", `${value.volume}`);
+      },
+    },
+
+    onMqttMessage: (value) => {
+      if (!lg.isTvOn()) {
+        return;
+      }
+
+      lg.setVolumeLevel(parseInt(value));
+    },
+  },
+
+  backlight: {
+    onLgEvents: {
+      [Events.PICTURE_SETTINGS_CHANGED]: (value) => {
+        publishMqttMessageIfDiffers("backlight", `${value.backlight}`);
+      },
+    },
+
+    onMqttMessage: (value) => {
+      if (!lg.isTvOn()) {
+        return;
+      }
+
+      lg.setBacklight(parseInt(value));
+    },
+  },
+
+  screen: {
+    onLgEvents: {
+      [Events.SCREEN_STATE_CHANGED]: (value) => {
+        if (value.state === "Screen On" || value.processing === "Screen On") {
+          publishMqttMessageIfDiffers("screen", "on");
+        } else if (value.state === "Screen Off") {
+          publishMqttMessageIfDiffers("screen", "off");
+        }
+      },
+    },
+
+    onMqttMessage: (value) => {
+      if (!lg.isTvOn()) {
+        return;
+      }
+
+      if (value === "on") {
+        lg.turnOnTvScreen();
+      }
+
+      if (value === "off") {
+        lg.turnOffTvScreen();
+      }
+    },
+  },
+
+  input: {
+    onLgEvents: {
+      [Events.FOREGROUND_APP_CHANGED]: (value) => {
+        // not sure what else can come up here
+        if (value.appId.includes("hdmi")) {
+          publishMqttMessageIfDiffers("input", value.appId);
+        }
+      },
+    },
+
+    onMqttMessage: (value) => {
+      if (!lg.isTvOn()) {
+        return;
+      }
+
+      lg.launchApp(value);
+    },
+  },
+};
+
+function publishMqttMessageIfDiffers(topic, value) {
+  if (state[topic] !== value) {
+    client.publishAsync(LGTV_CONFIG.mqttBase + "/" + topic, value, {
+      retain: true,
+    });
+    state[topic] = value;
+  }
+}
+
+client.on("message", (topic, message) => {
+  topic = topic.replace(LGTV_CONFIG.mqttBase + "/", "");
+  const mqttValue = message.toString();
+
+  if (!config[topic]) {
+    console.log("no config for topic:", topic);
+    return;
+  }
+
+  console.log(
+    "got mqtt message for topic:",
+    topic,
+    "with value:",
+    mqttValue,
+    "current state value is:",
+    state[topic]
+  );
+
+  if (state[topic] !== mqttValue) {
+    config[topic].onMqttMessage(mqttValue);
+    state[topic] = mqttValue;
+  }
+});
+
+Object.values(config).forEach(({ onLgEvents = {} }) => {
+  Object.entries(onLgEvents).forEach(([event, handler]) => {
+    lg.on(event, (value) => {
+      console.log("got lg event:", event, "with value:", value);
+      handler(value);
+    });
+  });
+});
+
+client.on("connect", () => {
+  Object.keys(config).forEach((topic) => {
+    console.log("subscribing to topic:", topic);
+    client.subscribe(LGTV_CONFIG.mqttBase + "/" + topic);
+  });
+});
+
+lg.on(Events.SETUP_FINISHED, () => {
+  console.log(
+    "setup finished!\nlist of external inputs:",
+    lg.getExternalInputList()
+  );
+});

package/get-config.js

@@ -0,0 +1,43 @@
+import { homedir } from "os";
+import path from "path";
+import fs from "fs";
+
+export default function getConfig(filePath, exampleConfig) {
+  const configPath = path.join(homedir(), filePath);
+
+  if (!fs.existsSync(configPath)) {
+    console.log(`No "${configPath}" found, create one with this content:
+
+${JSON.stringify(exampleConfig, null, 2)}`);
+
+    process.exit(1);
+  }
+
+  let config;
+
+  try {
+    config = JSON.parse(fs.readFileSync(configPath, "utf-8"));
+  } catch (e) {
+    console.log(`Couldn't parse "${configPath}"
+
+${e}`);
+
+    process.exit(1);
+  }
+
+  let anyKeyMissing = false;
+  Object.keys(exampleConfig).forEach((requiredKey) => {
+    if (!config.hasOwnProperty(requiredKey)) {
+      console.log(
+        `Missing key "${requiredKey}" in config file "${configPath}"`
+      );
+      anyKeyMissing = true;
+    }
+  });
+
+  if (anyKeyMissing) {
+    process.exit(1);
+  }
+
+  return config;
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "lgtv2mqtt2",
+  "version": "1.0.0",
+  "main": "index.js",
+  "keywords": [],
+  "author": "",
+  "description": "",
+  "license": "ISC",
+  "scripts": {
+    "start": "./cli.js",
+    "vendor-libraries": "./vendor-libraries.sh"
+  },
+  "bin": {
+    "lgtv2mqtt2": "./cli.js"
+  },
+  "type": "module",
+  "dependencies": {
+    "mkdirp": "^1.0.4",
+    "mqtt": "^5.3.0",
+    "persist-path": "^1.0.2",
+    "tcp-ping": "^0.1.1",
+    "wake_on_lan": "^1.0.0",
+    "websocket": "^1.0.34"
+  },
+  "devDependencies": {}
+}

package/vendor/Events.js

@@ -0,0 +1,19 @@
+export default {
+  SETUP_FINISHED: 'tvSetupFinished',
+  PIXEL_REFRESHER_STARTED: 'tvPixelRefresherStarted',
+  TV_TURNED_OFF: 'tvTurnedOff',
+  TV_TURNED_ON: 'tvTurnedOn',
+  SCREEN_SAVER_TURNED_ON: 'screenSaverTurnedOn',
+  SCREEN_STATE_CHANGED: 'screenStateChanged',
+  POWER_STATE_CHANGED: 'powerStateChanged',
+  AUDIO_STATUS_CHANGED: 'audioStatusChanged',
+  FOREGROUND_APP_CHANGED: 'foregroundAppChanged',
+  LIVE_TV_CHANNEL_CHANGED: 'liveTvChannelChanged',
+  SOUND_OUTPUT_CHANGED: 'soundOutputChanged',
+  NEW_APP_ADDED: 'appAdded',
+  APP_REMOVED: 'appRemoved',
+  VOLUME_UP: 'volumeUp', // not directly used but the event is present
+  VOLUME_DOWN: 'volumeDown', // not directly used but the event is present
+  PICTURE_SETTINGS_CHANGED: 'pictureSettingsChanged',
+  SOUND_SETTINGS_CHANGED: 'soundSettingsChanged',
+};