https://github.com/klattimer/LGWebOSRemote

Command line webOS remote for LGTVs
https://github.com/klattimer/LGWebOSRemote

lg python python3 smart-tv smarthome webos websockets

Last synced: 20 days ago
JSON representation

Command line webOS remote for LGTVs

• Host: GitHub
• URL: https://github.com/klattimer/LGWebOSRemote
• Owner: klattimer
• License: mit
• Created: 2017-05-14T07:50:14.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-08T20:16:27.000Z (5 months ago)
• Last Synced: 2024-08-06T12:23:34.142Z (4 months ago)
• Topics: lg, python, python3, smart-tv, smarthome, webos, websockets
• Language: Python
• Size: 187 KB
• Stars: 500
• Watchers: 31
• Forks: 97
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome - klattimer/LGWebOSRemote - Command line webOS remote for LGTVs (Python)

README

        
# LGWebOSRemote

Command line webOS remote for LGTVs. This tool uses a connection via websockets to port 3000 on newer LG TVs, there are other tools which use a restful connection to port 8080 however that port is closed on newer firmware versions.

## A note from the developer

My LG TV is now so out of date that largely what is developed here is tested, improved and debugged by the community. As it goes my TV works fine and I'm not the kind of person to create more unnecessary electrical waste than I need to so as long as my current TV works, it's largely down to you guys.

A big thanks for the contributions over the years too, lots of people have made lots of changes to this project over time, and it would only be as useful as it is with their help.

## Supported models

### Tested with

  * 43LM6300PSB

  * 43UN73003LC

  * 43UJ630V-ZA

  * 60UJ6300-UA

  * HU80KG.AEU (CineBeam 4K)

  * OLED48A2

  * OLED55B7

  * OLED55C9

  * OLED55CX5LB

  * OLED55CXAUA

  * OLED65B9PUA

  * OLED77CX9LA

  * OLED77GX

  * OLED48C1 (ssl)

  * OLED42C2 (ssl)

  * OLED48C2 (ssl)

  * SK8500PLA

  * SM9010PLA

  * UF776V

  * UF830V

  * UH650V

  * UU668V

  * UJ6309

  * UJ635V

  * UJ6570

  * UJ701V

  * [please add more!]

Tested with python 3.9 on Debian Unstable.

Tested with python 3.10 on Windows 10/11

Tested with 3.10 on WSL (Ubuntu 20.04)

Tested with python 3.12 on macOS

### Likely supports

All devices with firmware major version 4, product name "webOSTV 2.0"

## Available Commands

	lgtv scan

	lgtv --ssl auth  MyTV

	lgtv setDefault MyTV

	lgtv --name MyTV --ssl audioStatus

	lgtv --name MyTV --ssl audioVolume

	lgtv --name MyTV --ssl closeAlert 

	lgtv --name MyTV --ssl closeApp 

	lgtv --name MyTV --ssl createAlert  

	lgtv --name MyTV --ssl execute 

	lgtv --name MyTV --ssl getCursorSocket

	lgtv --name MyTV --ssl getForegroundAppInfo

	lgtv --name MyTV --ssl getPictureSettings

	lgtv --name MyTV --ssl getPowerState

	lgtv --name MyTV --ssl getSoundOutput

	lgtv --name MyTV --ssl getSystemInfo

	lgtv --name MyTV --ssl getTVChannel

	lgtv --name MyTV --ssl input3DOff

	lgtv --name MyTV --ssl input3DOn

	lgtv --name MyTV --ssl inputChannelDown

	lgtv --name MyTV --ssl inputChannelUp

	lgtv --name MyTV --ssl inputMediaFastForward

	lgtv --name MyTV --ssl inputMediaPause

	lgtv --name MyTV --ssl inputMediaPlay

	lgtv --name MyTV --ssl inputMediaRewind

	lgtv --name MyTV --ssl inputMediaStop

	lgtv --name MyTV --ssl listApps

	lgtv --name MyTV --ssl listLaunchPoints

	lgtv --name MyTV --ssl listChannels

	lgtv --name MyTV --ssl listInputs

	lgtv --name MyTV --ssl listServices

	lgtv --name MyTV --ssl mute 

	lgtv --name MyTV --ssl notification 

	lgtv --name MyTV --ssl notificationWithIcon  

	lgtv --name MyTV --ssl off

	lgtv --name MyTV --ssl on

	lgtv --name MyTV --ssl openAppWithPayload 

	lgtv --name MyTV --ssl openBrowserAt 

	lgtv --name MyTV --ssl openYoutubeId 

	lgtv --name MyTV --ssl openYoutubeURL 

	lgtv --name MyTV --ssl openYoutubeLegacyId 

	lgtv --name MyTV --ssl openYoutubeLegacyURL 

	lgtv --name MyTV --ssl sendButton 

	lgtv --name MyTV --ssl serialise

	lgtv --name MyTV --ssl setInput 

	lgtv --name MyTV --ssl setSoundOutput 

	lgtv --name MyTV --ssl screenOff

	lgtv --name MyTV --ssl screenOn

	lgtv --name MyTV --ssl setTVChannel 

	lgtv --name MyTV --ssl setVolume 

	lgtv --name MyTV --ssl startApp 

	lgtv --name MyTV --ssl swInfo

	lgtv --name MyTV --ssl volumeDown

	lgtv --name MyTV --ssl volumeUp

## Install

Requires wakeonlan, websocket for python (python3-websocket for python3), and getmac.

python-pip (python3-pip for python3) and git are required for the installation process.

    python -m venv lgtv-venv

    source lgtv-venv/bin/activate

    pip install git+https://github.com/klattimer/LGWebOSRemote

To install it system wide:

	sudo mkdir -p /opt

	sudo python -m venv /opt/lgtv-venv

	source /opt/lgtv-venv/bin/activate

	sudo pip install git+https://github.com/klattimer/LGWebOSRemote

or with [pipx](https://pipx.pypa.io/stable/):

	pipx install git+https://github.com/klattimer/LGWebOSRemote.git

## Example usage

    # Scan/Authenticate

    $ lgtv scan

    {

        "count": 1,

        "list": [

            {

                "address": "192.168.1.31",

                "model": "UF830V",

                "uuid": "10f34f86-0664-f223-4b8f-d16a772d9baf"

            }

        ],

        "result": "ok"

    }

    $ lgtv --ssl auth 192.168.1.31 MyTV

    # At this point the TV will request pairing, follow the instructions on screen

    # Commands are basically

    $ lgtv --name TVNAME --ssl COMMAND COMMAND_ARGS

    $ lgtv --name MyTV --ssl on

    $ lgtv --name MyTV --ssl off

    # If you have the youtube plugin

    $ lgtv --name MyTV --ssl openYoutubeURL https://www.youtube.com/watch?v=dQw4w9WgXcQ

    # Otherwise, this works reasonably well

    $ lgtv --name MyTV --ssl openBrowserAt https://www.youtube.com/tv#/watch?v=dQw4w9WgXcQ

    # You can set the default TV so the `--name` argument can be skipped

    $ lgtv setDefault MyTV

## SSL

Starting 25th of January 2023 LG has deprecated insecure ws connections, ssl is now required. Because of this, should you wish to use it on newer firmware devices you can append the argument "ssl" at the back. It connects to 3001 with wss. 

### Example

```

$ lgtv auth 192.168.1.31 MyTV

$ lgtv --name MyTV --ssl off

$ lgtv --name MyTV --ssl screenOff

```

sendButton args:

['asterisk', 'back', 'blue', 'channel_down', 'channel_up', 'click', 'down', 'enter', 'exit', 'fast_forward', 'green', 'home', 'left', 'pause', 'play', 'red', 'rewind', 'right', 'stop', 'up', 'volume_down', 'volume_up', 'yellow']

## Caveats

You need to auth with the TV before being able to use the on command as it requires the mac address.

## TODO

Implement the following features:

	closeToast

	getSystemSettings

## Bugs

I couldn't test youtube because it seems the app isn't installed and not available to download right now

maybe they're updating it?