LG webOS Smart TV


The webostv platform allows you to control a LG webOS Smart TV.

There is currently support for the following device types within Home Assistant:

To begin with enable LG Connect Apps feature in Network settings of the TV.

Configuration

Adding LG webOS Smart TV to your Home Assistant instance can be done via the user interface, by using this My button:

LG webOS Smart TV can be auto-discovered by Home Assistant. If an instance was found, it will be shown as “Discovered”, which you can select to set it up right away.

Manual configuration steps

Turn on action

Home Assistant is able to turn on an LG webOS Smart TV if you specify an action, provided by an integration like HDMI-CEC or WakeOnLan.

Common for webOS 3.0 and higher would be to use WakeOnLan feature. To use this feature your TV should be connected to your network via Ethernet rather than Wireless and you should enable the LG Connect Apps feature in Network settings of the TV (or Mobile App in General settings for older models) (*may vary by version).

On newer models (2017+), WakeOnLan may need to be enabled in the TV settings by going to Settings > General > Mobile TV On > Turn On Via WiFi instructions.

This usually only works if the TV is connected to the same network. Routing the WakeOnLan packet to a different subnet requires special configuration on your router or may not be possible.

You can create an automation from the user interface, from the device create a new automation and select the Device is requested to turn on automation. Automations can also be created using an automation action:

# Example configuration.yaml entry
wake_on_lan: # enables `wake_on_lan` integration

automation:
  - alias: "Turn On Living Room TV with WakeOnLan"
    trigger:
      - platform: webostv.turn_on
        entity_id: media_player.lg_webos_smart_tv
    action:
      - service: wake_on_lan.send_magic_packet
        data:
          mac: aa:bb:cc:dd:ee:ff

Any other actions to power on the device can be configured.

Sources

It is possible to select which sources will be available to the media player. When the TV is powered on press the CONFIGURE button in the integration card and select the sources to enable. If you don’t select any source the media player will offer all of the sources of the TV.

Change channel through play_media service

The play_media service can be used in a script to switch to the specified TV channel. It selects the best matching channel according to the media_content_id parameter:

  1. Channel number (i.e., ‘1’ or ‘6’)
  2. Exact channel name (i.e., ‘France 2’ or ‘CNN’)
  3. Substring in channel name (i.e., ‘BFM’ in ‘BFM TV’)
# Example action entry in script to switch to channel number 1
service: media_player.play_media
target:
  entity_id: media_player.lg_webos_smart_tv
data:
  media_content_id: 1
  media_content_type: "channel"

# Example action entry in script to switch to channel including 'TF1' in its name
service: media_player.play_media
target:
  entity_id: media_player.lg_webos_smart_tv
data:
  media_content_id: "TF1"
  media_content_type: "channel"

Next/Previous buttons

The behavior of the next and previous buttons is different depending on the active source:

  • if the source is ‘LiveTV’ (television): next/previous buttons act as channel up/down
  • otherwise: next/previous buttons act as next/previous track

Sound output

The current sound output of the TV can be found under the state attributes. To change the sound output, the following service is available:

Service webostv.select_sound_output

Service data attribute Optional Description
entity_id no Target a specific webostv media player.
sound_output no Name of the sound output to switch to.

Generic commands and buttons

Available services: button, command

Service webostv.button

Service data attribute Optional Description
entity_id no Target a specific webostv media player.
button no Name of the button. Known possible values are LEFT, RIGHT, DOWN, UP, HOME, MENU, BACK, ENTER, DASH, INFO, ASTERISK, CC, EXIT, MUTE, RED, GREEN, BLUE, VOLUMEUP, VOLUMEDOWN, CHANNELUP, CHANNELDOWN, PLAY, PAUSE, NETFLIX, GUIDE, AMAZON, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9

Service webostv.command

Service data attribute Optional Description
entity_id no Target a specific webostv media player.
command no Endpoint for the command, e.g., system.launcher/open. The full list of known endpoints is available at https://github.com/bendavid/aiopylgtv/blob/master/aiopylgtv/endpoints.py
payload yes An optional payload to provide to the endpoint in the format of key value pair(s).

Example

script:
  home_button:
    sequence:
      - service: webostv.button
        target:
          entity_id:  media_player.lg_webos_smart_tv
        data:
          button: "HOME"

  open_google_command:
    sequence:
      - service: webostv.command
        target:
          entity_id:  media_player.lg_webos_smart_tv
        data:
          command: "system.launcher/open"
          payload:
            target: https://www.google.com

Notifications

The webostv notify platform allows you to send notifications to a LG webOS Smart TV.

The icon can be overridden for individual notifications by providing a path to an alternative icon image to use:

automation:
  - alias: "Front door motion"
    trigger:
      platform: state
      entity_id: binary_sensor.front_door_motion
      to: "on"
    action:
      service: notify.livingroom_tv
      data:
        message: "Movement detected: Front Door"
        data:
          icon: "/home/homeassistant/images/doorbell.png"

Notes

If Home Assistant and your TV are not on the same network, you need to create a firewall rule, which allows a connection on port 3000 with the TCP protocol from Home Assistant to your TV.