LGTV2

Simple Node.js module to remote control LG WebOS smart TVs.

this is a fork of LGTV.js, heavily modified and rewritten to suite my needs.

Projects using this Module

• node-red-contrib-lgtv - Node-RED Nodes to control LG webOS Smart TVs.
• lgtv2mqtt - Interface between LG WebOS Smart TVs and MQTT.
• homebridge-webos-tv - Homebridge plugin for LG WebOS TVs.
• ioBroker.lgtv - LG WebOS SmartTV adapter for ioBroker.

Installation

npm install lgtv2

Requires Node.js 20.19+, 22.12+ or 24+. The package is an ES module; import LGTV from 'lgtv2' and const LGTV = require('lgtv2') both work (see Upgrading to 2.0).

TV configuration

• The TV must be reachable on your network. Newer TVs (firmware from 2023 on) only accept secure websocket connections on port 3001 (wss://<tv>:3001); TVs from before 2018 only offer ws://<tv>:3000. Since lgtv2 1.7 you don't have to care: with just {host} the module tries wss://<tv>:3001 first, falls back to ws://<tv>:3000 and remembers what worked. Set secure/port or a full url to pin it.
• On first connection the TV shows a connection request ("LG Connect Apps" / "Mobile TV On" on older models). Accept it; the resulting client key is stored in the key file (see keyFile below) and reused on subsequent connections.
• To turn the TV on over the network you need Wake-on-LAN and the TV setting Settings → General → Mobile TV On / Turn on via Wi-Fi (2025+ models: Support → IP control settings → Wake on LAN). Then lgtv.wake() / LGTV.wake(mac) turns it on.

Usage Examples

Subscribe to volume and mute changes and output to console:

import LGTV from 'lgtv2';

const lgtv = new LGTV({host: '192.168.1.20'});

lgtv.on('error', (err) => console.log(err));
lgtv.on('prompt', () => console.log('please accept the connection request on the TV'));

lgtv.on('connect', () => {
    console.log('connected');

    lgtv.subscribe('ssap://audio/getVolume', (err, res) => {
        if (err) return console.log(err);
        if (res.changed.includes('volume')) console.log('volume changed', res.volume);
        if (res.changed.includes('muted')) console.log('mute changed', res.muted);
    });
});

Turn TV off (promise style):

import LGTV from 'lgtv2';

const lgtv = new LGTV({host: '192.168.1.20'});
lgtv.on('error', (err) => console.log(err));

lgtv.on('connect', async () => {
    await lgtv.request('ssap://system/turnOff');
    await lgtv.disconnect();
});

Old-style TV (ws://, port 3000):

const lgtv = new LGTV({host: '192.168.1.20', secure: false});
// or: new LGTV({url: 'ws://192.168.1.20:3000'})

More in examples/.

API

options

• host - hostname or IP of the TV. Used to build the URL together with secure and port.
• secure - true → wss://<host>:3001, false → ws://<host>:3000. When omitted (and no port/url is given) both are tried automatically, wss first; the port that worked is used for reconnects, and only if both fail an error (code: 'ECONNFAILED') is emitted.
• port - overrides the port chosen by secure (disables the automatic fallback).
• ports - {secure: 3001, insecure: 3000} - the ports used for wss/ws (e.g. behind port forwarding); keeps the automatic fallback.
• url - complete websocket URL (e.g. 'wss://192.168.1.20:3001'). Takes precedence over host/secure/port and disables the automatic fallback.
• urls (property) - the list of URLs that will be tried.
• rejectUnauthorized - verify the TV's TLS certificate against public CAs. Default false: the TV uses a certificate issued by LG's private CA that is not verifiable against public roots.
• verifyCert - additional certificate check for wss connections, default false:
  • 'lg' - the presented chain must contain LG's static TV certificate "LGE TV SSG" or its issuer "LGE SSG Intermediate CA" (pinned by SHA-256 fingerprint, see LGTV.LG_ISSUER_FINGERPRINTS). LG ships the same certificate and key on every webOS TV (2018–2025 models, all regions checked), so this tells you "it is an LG TV", not "it is my TV". Protects against a rogue device answering as your TV.
  • 'tofu' - trust on first use: the first certificate seen is pinned in certFile; a different one later is rejected (error with code: 'ECERT', delete the file to re-trust).
  • a SHA-256 fingerprint ('AB:CD:…' or 'sha256/abcd…') or an array of them - accepted if any certificate of the chain matches.
• certFile - where the tofu fingerprint is stored, default <keyFile>.cert.
• mac - MAC address of the TV for wake(). Usually not needed: after pairing the module learns the TV's wired and Wi-Fi MACs from connectionmanager/getinfo and caches them in macFile (default <keyFile>.mac), so wake() works without configuration from the second start on. learnMac: false disables that; an explicit mac always wins.
• timeout - request timeout in milliseconds, default: 15000.
• handshakeTimeout - abort a connection attempt whose websocket handshake does not complete within this many milliseconds (then reconnect), default: 10000. 0 disables.
• reconnect - reconnect interval in milliseconds, default: 5000. false/0 disables auto-reconnect.
• keyFile - path of the file the client key is stored in. Default: Linux ~/.lgtv2/keyfile-<host>, macOS ~/Library/Preferences/lgtv2/keyfile-<host>, Windows %APPDATA%\lgtv2\keyfile-<host>; the environment variable LGTV2_KEY_DIR overrides the directory (handy for Docker volumes). The directory is created when the key is first saved.
• saveKey - function (key, callback) to override how the key is stored.
• clientKey - supply the key directly (use together with a custom saveKey).
• keepalive (true), keepaliveInterval (10000 ms), keepaliveGracePeriod (5000 ms) - ping the TV regularly and drop the connection when a pong does not arrive in time (a TV going to standby does not always close the socket); the normal reconnect then takes over.
• wsOptions - extra options for the underlying ws client, e.g. ca, cert, headers, localAddress; merged over {rejectUnauthorized}.
• wsconfig - the 1.x option is still understood (keepalive* keys and tlsOptions are mapped), prefer the options above.

properties

• connected - true while connected and paired.
• keyFile - resolved key file path.
• clientKey - the current client key.

methods

request(uri [, payload] [, callback])

Send a request. With a callback: callback(err, payload). Without a callback a promise is returned. Error responses from the TV (type: 'error', e.g. 404 no such service or method, or returnValue: false) are delivered as an Error with code: 'ESSAP' and, if available, errorCode / errorText.

subscribe(uri [, payload], callback)

Subscribe to a topic. The callback is invoked for every update. Returns the subscription id.

For ssap://audio/getVolume the payload is normalized across firmware versions: volume, muted and changed (array with 'volume' and/or 'muted') are always present.

unsubscribe(id)

Stop a subscription. Returns true if the id was known.

getSocket(uri [, callback])

Get a specialized socket for mouse and button events. Returns a promise when no callback is given.

const sock = await lgtv.getSocket('ssap://com.webos.service.networkinput/getPointerInputSocket');
sock.send('button', {name: 'HOME'});
sock.send('click');
sock.send('move', {dx: 10, dy: 0});

Button names include LEFT RIGHT UP DOWN ENTER BACK EXIT HOME MENU INFO DASH ASTERISK CC PLAY PAUSE STOP REWIND FASTFORWARD RED GREEN YELLOW BLUE VOLUMEUP VOLUMEDOWN MUTE CHANNELUP CHANNELDOWN 0 … 9.

getPowerState([callback]) / subscribePowerState(callback)

com.webos.service.tvpower/power/getPowerState mapped to {state, raw} with state one of 'on' (Active), 'standby' (Active Standby), 'screen_off' (Screen Off), 'screen_saver' (Screen Saver), 'off' (Suspend / Power Off), 'unknown'. While powering down the TV sends a few updates with raw.processing (e.g. "Request Power Off") before state changes. A TV in deep standby does not answer at all - then connected is false and only wake() helps (measured on a webOS 6.0 OLED: websocket closes ~4 s after turnOff, port 3001 ~10 s later; after wake() the TV is reachable again within ~2 s).

wake([mac] [, options] [, callback]) / LGTV.wake(mac [, options] [, callback])

Sends Wake-on-LAN magic packets (3 by default). mac can be a string or an array; it defaults to the mac option, else to every MAC learned from the TV (wired and Wi-Fi - the TV only reacts on the interface it uses, so both are sent). lgtv.mac / lgtv.macs show what is known; without any MAC wake() rejects with no MAC address known. options: address (default '255.255.255.255', use your subnet's broadcast address if the TV does not react), port (9), count (3), interval (100 ms). Returns a promise when no callback is given.

await LGTV.wake('aa:bb:cc:dd:ee:ff', {address: '192.168.1.255'});

connect([url])

Usually not needed - the connection is established automatically on construction and re-established after close.

disconnect([callback])

Closes the connection to the TV and stops auto-reconnection. Returns a promise when no callback is given.

events

• connecting (url) - trying to connect to the TV
• prompt - the TV shows the pairing prompt; accept it on the TV
• connect - connection established and paired
• error (err) - websocket/pairing/TV errors. Subsequent equal connection errors are only emitted once (so your log isn't flooded with EHOSTUNREACH while the TV is off)
• message (text) - every raw frame received from the TV as a string, for debugging
• close ({code, reason}) - connection closed
• certificate ({fingerprint, stored}) - verifyCert: 'tofu' pinned a certificate for the first time
• mac ({wired, wifi}) - MAC addresses learned from the TV after pairing

TypeScript

Type declarations ship with the package (index.d.ts): import LGTV from 'lgtv2' (default export), plus named exports LGTV, wake, LG_ISSUER_FINGERPRINTS, POWER_STATES.

Upgrading to 2.0

2.0 is a modernization release; the API is unchanged except for the points below.

• ES module. import LGTV from 'lgtv2' is the native form. const LGTV = require('lgtv2') keeps working unchanged on Node 20.19+ / 22.12+ / 24 (require(esm)) - no .default, and calling it without new still works. Node < 20.19 is no longer supported.
• Transport is ws instead of websocket. No native add-ons any more (no bufferutil/utf-8-validate build on ARM/Docker). Consequences:
  • the message event now delivers the raw frame as a string (was the websocket message object with utf8Data);
  • the close event payload is {code, reason};
  • wsconfig is replaced by keepalive/keepaliveInterval/keepaliveGracePeriod and wsOptions (passed to ws). A 1.x wsconfig (including tlsOptions) is still mapped, so existing code keeps working; wsconfig.dropConnectionOnKeepaliveTimeout has no equivalent (always on).
• Connection behaviour is unchanged: {host} tries wss://host:3001 first and falls back to ws://host:3000; verifyCert is still opt-in; audio/getVolume payloads are still normalized to volume/muted/changed.

Commands

A selection of SSAP endpoints; payloads are passed as the second argument of request.

| uri | payload / notes | | -------------------------------------------------------- | -------------------------------------------------------------------------------- | | ssap://api/getServiceList | | | ssap://audio/getStatus | subscribe: volume, mute, sound output | | ssap://audio/getVolume | subscribe: {volume, muted, changed} (normalized) | | ssap://audio/setVolume | {volume: 10} | | ssap://audio/volumeUp / volumeDown | needed for ARC/eARC soundbars that report volume: -1 | | ssap://audio/setMute | {mute: true} | | ssap://com.webos.service.apiadapter/audio/getSoundOutput / changeSoundOutput | {output: 'external_arc'} — tv_speaker, external_arc, external_optical, bt_soundbar, headphone, lineout | | ssap://com.webos.service.tvpower/power/getPowerState | subscribe: {state: 'Active' \| 'Active Standby' \| 'Suspend' \| 'Screen Off'} | | ssap://com.webos.service.tvpower/power/turnOffScreen / turnOnScreen | | | ssap://system/turnOff | | | ssap://system/getSystemInfo | model name etc. | | ssap://com.webos.service.update/getCurrentSWInformation | firmware version | | ssap://com.webos.applicationManager/getForegroundAppInfo | subscribe: {appId} | | ssap://com.webos.applicationManager/listLaunchPoints | installed apps (id → title) | | ssap://com.webos.applicationManager/launch | {id: 'netflix'}, {id: 'youtube.leanback.v4', params: {contentTarget: 'https://www.youtube.com/watch?v=…'}} | | ssap://system.launcher/launch | {id: 'netflix', contentId: '…'} | | ssap://system.launcher/open | {target: 'https://example.org'} — opens the browser | | ssap://system.launcher/close / getAppState | {id}; getAppState answers 403 access denied on webOS 6.0 | | ssap://com.webos.media/getForegroundAppInfo | subscribe: play/pause state — not on every firmware (404 on webOS 6.0) | | ssap://media.controls/play / pause / stop / rewind / fastForward | | | ssap://media.viewer/close | | | ssap://system.notifications/createToast | {message: 'Hello World!'} (optional iconData base64, iconExtension) | | ssap://system.notifications/createAlert | {message, buttons: [{label, onclick, params}]} | | ssap://com.webos.service.ime/insertText | {text: 'abc', replace: 0} | | ssap://com.webos.service.ime/sendEnterKey / deleteCharacters | {count: 1} | | ssap://tv/getExternalInputList | inputs with id, label, connected | | ssap://tv/switchInput | {inputId: 'HDMI_2'} | | ssap://tv/getCurrentChannel | subscribe; 500 Application error while not in live TV | | ssap://tv/getChannelList / getChannelProgramInfo | warning: on TVs without tuned channels (e.g. HDMI/ARC-only setups, seen on webOS 6.0) getChannelList makes the TV close the websocket; getChannelProgramInfo answers 500 | | ssap://tv/openChannel | {channelId} or {channelNumber: '5'} | | ssap://tv/channelUp / channelDown | | | ssap://com.webos.service.tv.display/set3DOn / set3DOff | | | ssap://webapp/closeWebApp | |

Endpoints not listed here (picture settings, energy saving, …) are not exposed through the SSAP permission set of this pairing manifest.

License

MIT (c) Sebastian Raff