How do I save the authentication key for my LG TV with LGTV2?

By default, the library stores keys in system-specific paths (e.g., ~/.lgtv2/ on Linux), but you can override this with a custom saveKey function. After the initial connection, you'll need to accept the prompt on your TV to authorize the app.

LGTV2 vs LGTV.js – which one is better for controlling LG TVs?

LGTV2 is a fork of LGTV.js, heavily modified for improved integration and features. It's actively maintained and used in projects like Node-RED, so it's generally recommended for new developments, though LGTV.js might be simpler for basic use cases.

How to handle errors when the TV is turned off or unreachable?

The library emits an 'error' event for connection issues, and it prevents log flooding by emitting subsequent equal errors only once, as noted in the README. You should implement error handling in your callbacks to manage disconnections gracefully.

Can I control multiple LG TVs simultaneously with this library?

Yes, you can create multiple instances with different URLs for each TV, but each requires its own authentication key and connection management, which might increase complexity in large setups.

How to subscribe to mute status changes on an LG TV?

Use the subscribe method with the URL 'ssap://audio/getVolume', and in the callback, check the 'muted' field in the response object, as shown in the example code that logs mute changes.

Is there a way to simulate mouse clicks or button presses on the TV?

Yes, use the getSocket method with URLs like 'ssap://com.webos.service.networkinput/getPointerInputSocket' to get a dedicated socket for sending input events, such as 'click' commands, as detailed in the API section.

lgtv2 — LG WebOS TV Remote Control

What is lgtv2?

LGTV2 is a Node.js module that allows developers to control LG WebOS smart TVs programmatically. It connects to the TV via WebSocket and provides an API to send commands, subscribe to events, and automate TV functions like power, volume, app launching, and media playback.

Target Audience

Developers building home automation systems, IoT projects, or integrations that require remote control of LG WebOS TVs, such as with Node-RED, Homebridge, or MQTT-based setups.

Value Proposition

It offers a straightforward, event-driven interface specifically for LG WebOS TVs, with support for real-time subscriptions and custom authentication, making it a reliable choice for automation scenarios over proprietary apps.

Control LG WebOS TV using node.js :tv:

Use Cases

Best For

Integrating LG WebOS TVs into Node-RED automation flows
Building home automation systems with MQTT-based control
Creating custom remote controls for LG TVs via Node.js scripts
Developing Homebridge plugins for Apple HomeKit integration
Automating TV power and volume in smart home setups
Subscribing to real-time TV status changes in IoT applications

Not Ideal For

Projects requiring control of non-LG or non-WebOS smart TVs (e.g., Samsung or Sony TVs)
Applications needing a built-in GUI or mobile app frontend without additional development
Environments where network latency or WebSocket reliability is critical for instantaneous control
Systems that cannot run Node.js or prefer languages like Python or Java for TV automation

Pros & Cons

Pros

Lightweight and Simple API

Offers a straightforward Node.js interface for sending commands like turning off the TV or adjusting volume, as demonstrated in the concise usage examples with minimal boilerplate code.

Real-time Event Subscription

Enables subscribing to TV events such as volume changes via WebSocket, allowing responsive automation without polling, as shown in the subscription example for audio updates.

Extensible for Home Automation

Integrates seamlessly with popular platforms like Node-RED, MQTT, and Homebridge, as listed in the 'Projects using this Module' section, making it ideal for IoT setups.

Custom Authentication Handling

Supports custom key storage and authentication methods through options like saveKey and clientKey, providing flexibility for persistent connections in diverse environments.

Cons

LG WebOS Lock-in

Only compatible with LG WebOS TVs, limiting its use in multi-brand smart home systems where control across different TV manufacturers is needed.

Breaking Changes in Updates

The README warns that v1.4.0 changed the keyFile location, requiring re-authorization on the TV, which can disrupt existing deployments and add maintenance overhead.

Manual TV Configuration Required

Users must enable 'LG Connect Apps' on the TV beforehand, adding a non-trivial setup step that might confuse less technical users or in automated deployments.

Network Dependency Issues

Relies on WebSocket connections over the network, so control can fail if the TV is offline or experiences network instability, with error handling that may require custom logic.

Frequently Asked Questions

What is lgtv2?

Target Audience

Developers building home automation systems, IoT projects, or integrations that require remote control of LG WebOS TVs, such as with Node-RED, Homebridge, or MQTT-based setups.

Value Proposition

Use Cases

Best For

Integrating LG WebOS TVs into Node-RED automation flows
Building home automation systems with MQTT-based control
Creating custom remote controls for LG TVs via Node.js scripts
Developing Homebridge plugins for Apple HomeKit integration
Automating TV power and volume in smart home setups
Subscribing to real-time TV status changes in IoT applications

Not Ideal For

Projects requiring control of non-LG or non-WebOS smart TVs (e.g., Samsung or Sony TVs)
Applications needing a built-in GUI or mobile app frontend without additional development
Environments where network latency or WebSocket reliability is critical for instantaneous control
Systems that cannot run Node.js or prefer languages like Python or Java for TV automation

Pros & Cons

Pros

Lightweight and Simple API

Offers a straightforward Node.js interface for sending commands like turning off the TV or adjusting volume, as demonstrated in the concise usage examples with minimal boilerplate code.

Real-time Event Subscription

Enables subscribing to TV events such as volume changes via WebSocket, allowing responsive automation without polling, as shown in the subscription example for audio updates.

Extensible for Home Automation

Integrates seamlessly with popular platforms like Node-RED, MQTT, and Homebridge, as listed in the 'Projects using this Module' section, making it ideal for IoT setups.

Custom Authentication Handling

Supports custom key storage and authentication methods through options like saveKey and clientKey, providing flexibility for persistent connections in diverse environments.

Cons

LG WebOS Lock-in

Only compatible with LG WebOS TVs, limiting its use in multi-brand smart home systems where control across different TV manufacturers is needed.

Breaking Changes in Updates

The README warns that v1.4.0 changed the keyFile location, requiring re-authorization on the TV, which can disrupt existing deployments and add maintenance overhead.

Manual TV Configuration Required

Users must enable 'LG Connect Apps' on the TV beforehand, adding a non-trivial setup step that might confuse less technical users or in automated deployments.

Network Dependency Issues

Relies on WebSocket connections over the network, so control can fail if the TV is offline or experiences network instability, with error handling that may require custom logic.

Frequently Asked Questions

lgtv2

What is lgtv2?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

lgtv2

What is lgtv2?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?