LG TV IP Control

This is a JS library that implements TCP network control for LG TVs manufactured since 2018. It utilizes encryption rules based on a guide found on the internet.

This is not provided by LG, and it is not a complete implementation for every TV model.

Requirements

• LG TV (tested on model OLED65B9PUA)
• Node 12+ (at least ES2017)

Installing

# Using NPM
npm install lgtv-ip-control

# Using Yarn
yarn add lgtv-ip-control

Setting Up the TV

Before anything, you need to enable Network IP Control, which is very easy:

1. Open the "All Settings" menu on the TV
2. Using the remote arrows, navigate to "Connection". For some TVs, this may say "Network" instead.
3. Quickly, press 82888 using the remote numeric buttons
4. Note the MAC IP addresses for reference and library configuration
5. Turn "Network IP Control" on
6. Click "Generate Keycode", and take note of the 8 characters code displayed on the message for reference and library configuration. You can generate a new code at any time
7. If you want to be able to turn the TV on, turn "Wake On LAN" on

Library Usage

Here's a very basic example of how to control the TV:

const tv = new LGTV('192.168.1.100', '1a:2b:3c:4d:5e:6f', 'KEY1C0DE');

tv.connect()
  .then(async () => {
    console.log('Unmutting...');
    await tv.setVolumeMute(false);
    console.log('Setting volume to 15...');
    await tv.setVolume(50);
    console.log('Done!');
  })
  .catch(console.error);

new LGTV()

Returns a new instance to control a TV.

const lgtv = new LGTV(
  /**
   * TV IP Address
   */
  '192.168.1.100',

  /**
   * TV MAC Address for being able to turn the TV on remotely, `null` otherwise
   */
  '1a:2b:3c:4d:5e:6f',

  /**
   * Encryption Keycode, as generated during "Setting Up the TV" above
   */
  'KEY1C0DE',

  /**
   * Additional options (optional)
   *
   * See src/constants/DefaultSettings.ts file.
   */
  {
    ...DefaultSettings,
  }
);

.connect()

Connects to the TV using HTTP. Returns a promise.

Required before sending any commands.

await lgtv.connect();

.disconnect()

Disconnects from the TV. Returns a promise.

await lgtv.disconnect();

.getCurrentApp()

Gets the current app. Returns a promise.

const currentApp = await lgtv.getCurrentApp();

.getCurrentVolume()

Gets the current volume. Returns a promise.

const currentVolume = await lgtv.getCurrentVolume();

.getIpControlState()

Gets the ip control state. Returns a promise.

const ipControlState = await lgtv.getIpControlState();

.getMacAddress(type: 'wired' | 'wifi')

Gets the mac address by type. Returns a promise.

const macAddress = await lgtv.getMacAddress('wired');

.getMuteState()

Gets the mute state. Returns a promise.

const muteState = await lgtv.getMuteState();

.powerOff()

Powers the TV off. Returns a promise.

await lgtv.powerOff();

.powerOn()

Powers the TV on, using Wake On Lan. Requires MAC address to be set when creating the LGTV instance.

Returns nothing.

lgtv.powerOn();

.sendKey(key: Keys)

Sends a key, as if it was pressed on the TV remote control. Returns a promise.

await lgtv.sendKey(Keys.menu);

See Keys for available keys.

.setEnergySaving(level: EnergySavingLevels)

Sets the current energy saving level. Returns a promise.

await lgtv.setEnergySaving(EnergySavingLevels.maximum);

See EnergySavingLevels for available levels.

.setInput(input: Inputs)

Sets the current TV input. Returns a promise.

await lgtv.setInput(Inputs.hdmi1);

See Inputs for available inputs.

.setVolume(volume: number)

Sets the volume level, from 0 to 100. Returns a promise.

await lgtv.setVolume(15);

.setVolumeMute(isMuted: boolean)

Sets the volume mute state. Returns a promise.

await lgtv.setVolumeMute(false);

Available Lists

EnergySavingLevels

Inputs

Keys

License

MIT, https://wes.dev/LICENSE.txt