/homebridge-webos3

Homebridge plugin for LG webOS3+ TVs

Primary LanguageJavaScriptMIT LicenseMIT

homebridge-webos3

homebridge-webos3 is a plugin for HomeBridge which allows you to control your webOS TV! It should work with all TVs that support webOS2 and never. The idea is that the TV should be controlled completely from the native HomeKit iOS app and Siri, that is why volume appears as a light bulb or external input as a switch.

IMPORTANT

This is a work in progress. Please contribute!_

Features

  • Power status
  • Turn on / off
  • Mute Status (currently as light bulb)
  • Mute / Unmute (currently as light bulb)
  • Volume control (currently as light bulb)
  • Open apps (switch between apps of your choice and live tv)

Installation

If you are new to Homebridge, please first read the Homebridge documentation. If you are running on a Raspberry, you will find a tutorial in the homebridge-punt Wiki.

Install homebridge:

sudo npm install -g homebridge

Install homebridge-webos3:

sudo npm install -g homebridge-webos3

Configuration

Add the accessory in config.json in your home directory inside .homebridge.

{
  "accessories": [
    {
      "accessory": "webos3",
      "name": "My webOS tv",
      "ip": "192.168.0.40",
      "mac": "ab:cd:ef:fe:dc:ba",
      "keyFile": "/home/pi/.homebridge/lgtvKeyFile",
      "pollingEnabled": true,
      "appSwitch":[
         "com.webos.app.tvguide",
         "youtube.leanback.v4",
         "com.webos.app.hdmi2",
         "com.webos.app.externalinput.component"
      ]

    }
  ]  
}

You also need to enable mobile tv on on your tv for the turn on feature to work correctly.

On newer TVs LG Connect Apps under the network settings needs to be enabled.

Configuration fields

  • accessory [required] Should always be "webos3"
  • name [required] Name of your accessory
  • ip [required] ip address of your tv
  • mac [required] Mac address of your tv
  • keyFile [optional] To prevent the tv from asking for permission when you reboot homebridge, specify a file path to store the permission token. If the file doesn't exist it'll be created. Don't specify a directory or you'll get an EISDIR error.
  • pollingEnabled [optional] Wheter the TV state background polling is enabled. Useful for more accurate TV state awareness and HomeKit automation. Default: false
  • pollingInterval [optional] The TV state background polling interval in seconds. Default: 5
  • volumeControl [optional] Wheter the volume service is enabled. Default: true
  • appSwitch [optional] Wheter the app switch service is enabled. This allows to switch live tv with apps of your choice. To get the app ID simply open an app on your TV and check the homebridge console. The app ID of the opened app will be printed. Default: "" (disabled)
    • For a single switch set the desired app ID as the value
    • For multiple switches set an array of app IDs as the value
    • External sources are also apps and can be used as app switches, available sources: com.webos.app.hdmi1, com.webos.app.hdmi2, com.webos.app.hdmi3, com.webos.app.externalinput.component, com.webos.app.externalinput.av1
    • Apps can also be started when the TV is off, in that case an attempt to power on the TV and switch to the chosen app will be made

Special thanks

lgtv2 - the Node.js remote control module for LG WebOS smart TVs.

homebridge-lgtv2 & homebridge-webos2 - the basic idea for the plugin.