# lgtv-ip-control > IP Control module for 2018+ LG TVs Latest version **4.4.0** (published 2025-12-27) · MIT license · 0 weekly downloads ## Install ```sh npm install lgtv-ip-control pnpm add lgtv-ip-control yarn add lgtv-ip-control bun add lgtv-ip-control ``` ## Health **Score 60/100 (C)** — status: stable. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 4.4.0 | | Published | 2025-12-27 | | First published | 2020-01-26 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 1 | | Unpacked size | 116.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 125 | | Author | Wes Souza | | Maintainers | wessouza | ## Links - npm: https://www.npmjs.com/package/lgtv-ip-control - Repository: https://github.com/WesSouza/lgtv-ip-control - npm.io page: https://npm.io/package/lgtv-ip-control ## Dependencies (1) - [tslib](https://npm.io/package/tslib.md) ^2.7.0 ## Recent versions - 4.4.0 (latest) — 2025-12-27 - 1.4.0-beta.1 (beta) — 2022-07-29 - 4.3.0 — 2024-09-20 - 4.2.0 — 2024-01-03 - 4.1.1 — 2023-12-31 - 4.1.0 — 2023-12-30 - 4.0.2 — 2023-12-23 - 4.0.1 — 2023-12-23 - 4.0.0 — 2023-12-22 - 3.1.0 — 2023-12-16 - 3.0.1 — 2023-12-16 - 3.0.0 — 2023-02-27 - 2.0.2 — 2022-11-07 - 2.0.1 — 2022-11-05 - 2.0.0 — 2022-08-18 - … 11 more at https://npm.io/package/lgtv-ip-control/versions ## README # LG TV IP Control Lint, Type Check, Test, Build npm version badge 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. A non-encrypted mode is provided for older models, but hasn't been tested. This library is not provided by LG, and it is not a complete implementation for every TV model. Check compatibility and TV setup instructions on the [root's README.md](../../README.md). ### Requirements - Node 16+ (at least ES2017) - NPM or Yarn Classic ### Installation ```sh # Using NPM npm install lgtv-ip-control # Using Yarn yarn add lgtv-ip-control ``` ### Usage Here's a very basic example of how to control the TV: ```js import { Inputs, LGTV } from 'lgtv-ip-control'; const lgtv = new LGTV('192.168.1.100', '1a:2b:3c:4d:5e:6f', 'KEY1C0DE'); lgtv .connect() .then(async () => { console.log('Disconnect now'); await new Promise((resolve) => setTimeout(resolve, 5000)); console.log('Unmutting...'); await lgtv.setVolumeMute(false); console.log('Select HDMI1 input...'); await lgtv.setInput(Inputs.hdmi1); console.log('Done!'); }) // Log any errors .catch(console.error) // Tries disconnecting once done .finally(() => lgtv.disconnect()); ``` To use `import`, you need to make sure to save the file as `.mjs` or to specify `"type": "module"` on your `package.json`. [Learn more about Node.js' support for ESM.](https://nodejs.org/api/esm.html) Otherwise replace the first line with: ```js const { Inputs, LGTV } = require('lgtv-ip-control'); ``` ### `new LGTV()` Returns a new instance to control a TV. ```js 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. * If not provided, uses clear text, but is required by most models. */ 'KEY1C0DE', /** * Additional options (optional) * * See src/constants/DefaultSettings.ts file. */ { ...DefaultSettings, }, ); ``` ### `.connect(): Promise` Connects to the TV using TCP. Required before sending any commands. ```js await lgtv.connect(); ``` ### `.disconnect(): void` Disconnects from the TV. ```js lgtv.disconnect(); ``` ### `.getCurrentApp(): Promise` Gets the current app. May be one of the `Apps` enum or an arbitrary string if the app type is unknown. Might return `null` if the TV is powered off but still responding. ```js const currentApp = await lgtv.getCurrentApp(); ``` ### `.getCurrentAppDetails(): Promise` Gets the current app details as an object. Might include the current app, HDCP status, HDCP version, etc. Please note that `signal` seems to always be `true`, even if no device is connected. Might return `null` if the TV is powered off but still responding. ```js const currentAppDetails = await lgtv.getCurrentAppDetails(); ``` ### `.getCurrentVolume(): Promise` Gets the current volume as an integer from `0` to `100`. ```js const currentVolume = await lgtv.getCurrentVolume(); ``` ### `.getIpControlState(): Promise` Gets the ip control state. ```js const ipControlState = await lgtv.getIpControlState(); ``` ### `.getMacAddress(type: 'wired' | 'wifi'): Promise` Gets the MAC address by network interface. ```js const macAddress = await lgtv.getMacAddress('wired'); ``` ### `.getMuteState(): Promise` Gets the mute state. ```js const muteState = await lgtv.getMuteState(); ``` ### `.getPowerState(): Promise` Gets the current TV power state. Because the TV might be offline, you should call this function before calling `.connect()`, otherwise you can get a `TimeoutError`. ```js const powerState = await lgtv.getPowerState(); ``` See [`PowerStates`](#PowerStates) for available states. ### `.powerOff(): Promise` Powers the TV off. ```js await lgtv.powerOff(); ``` ### `.powerOn(): void` Powers the TV on, using Wake On Lan. Requires MAC address to be set when creating the `LGTV` instance. ```js lgtv.powerOn(); ``` ### `.powerOnAndConnect(): Promise` Powers the TV on, using Wake On Lan, and connects to it. Requires MAC address to be set when creating the `LGTV` instance. Returns a promise that resolves once the connection is established, or rejects after a number of retries. ```js await lgtv.powerOnAndConnect(); ``` ### `.sendKey(key: Keys): Promise` Sends a `key`, as if it was pressed on the TV remote control. ```js await lgtv.sendKey(Keys.menu); ``` See [`Keys`](#Keys) for available keys. ### `.setEnergySaving(level: EnergySavingLevels): Promise` Sets the current energy saving level. Note that `screenOff` is known not to work for some models. ```js await lgtv.setEnergySaving(EnergySavingLevels.maximum); ``` See [`EnergySavingLevels`](#EnergySavingLevels) for available levels. ### `.setInput(input: Inputs): Promise` Sets the current TV input. ```js await lgtv.setInput(Inputs.hdmi1); ``` See [`Inputs`](#Inputs) for available inputs. ### `.setVolume(volume: number): Promise` Sets the volume level as an integer from `0` to `100`. ```js await lgtv.setVolume(15); ``` ### `.setVolumeMute(isMuted: boolean): Promise` Sets the volume mute state. ```js await lgtv.setVolumeMute(false); ``` ### `.setScreenMute(mode: ScreenMuteModes): Promise` Sets the current screen mute mode. This can be used to either completely blank the screen or just blank the video feed while leaving the OSD visible. Returns a promise. ```js await lgtv.setScreenMute(ScreenMuteModes.screenmuteon); ``` See [`ScreenMuteModes`](#ScreenMuteModes) for available modes. ## Available Lists ### EnergySavingLevels | Key | Brightness Level | | --------- | ---------------- | | auto | Automatic | | screenOff | Screen Off | | maximum | Low | | medium | Medium | | minimum | High | | off | Maximum | ### Inputs | Key | Input | | --------- | ---------------- | | dtv | Digital TV | | atv | Analog TV | | cadtv | Cable Digital TV | | catv | Cable TV | | av | AV Composite | | component | Component | | hdmi1 | HDMI 1 | | hdmi2 | HDMI 2 | | hdmi3 | HDMI 3 | | hdmi4 | HDMI 4 | ### Keys | Key | Remote Button | | --------------- | -------------------- | | arrowDown | Arrow Down | | arrowLeft | Arrow Left | | arrowRight | Arrow Right | | arrowUp | Arrow Up | | aspectRatio | Aspect Ratio Toggle | | audioMode | Audio Mode Toggle | | back | Back | | blueButton | Blue Button | | captionSubtitle | – | | channelDown | Channel Down | | channelList | Channel List | | channelUp | Channel Up | | deviceInput | Device Input Toggle | | energySaving | Energy Saving Toggle | | fastForward | – | | greenButton | Green Button | | home | Home | | info | Info | | liveTV | Live TV | | menu | Open Menu | | number0 | Number 0 | | number1 | Number 1 | | number2 | Number 2 | | number3 | Number 3 | | number4 | Number 4 | | number5 | Number 5 | | number6 | Number 6 | | number7 | Number 7 | | number8 | Number 8 | | number9 | Number 9 | | ok | Ok | | play | – | | previousChannel | Previous Channel | | programGuide | Show Program Guide | | record | – | | redButton | Red Button | | rewind | – | | sleepTimer | Sleep Timer Toggle | | userGuide | Open User Guide | | videoMode | Video Mode Toggle | | volumeDown | Volume Down | | volumeMute | Mute Toggle | | volumeUp | Volume Up | | yellowButton | Yellow Button | ### PowerStates | Key | State | | ------- | -------------------------------------------- | | on | The TV is on and responding to connections | | off | The TV is off or powering off | | unknown | The state of the TV is unknown, possibly off | ### ScreenMuteModes | Key | Effect | | ------------ | ------------------------ | | screenMuteOn | Blank screen | | videoMuteOn | Blank video, OSD visible | | allMuteOff | Normal Operation | --- _Source: https://npm.io/package/lgtv-ip-control · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._