Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hobbyquaker/lgtv2mqtt
Interface between LG WebOS Smart TVs and MQTT :tv:
https://github.com/hobbyquaker/lgtv2mqtt
lg mqtt smart-tv smarthome tv webos
Last synced: 6 days ago
JSON representation
Interface between LG WebOS Smart TVs and MQTT :tv:
- Host: GitHub
- URL: https://github.com/hobbyquaker/lgtv2mqtt
- Owner: hobbyquaker
- License: mit
- Created: 2015-12-06T20:08:07.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-17T17:59:20.000Z (almost 2 years ago)
- Last Synced: 2024-12-11T08:22:13.698Z (15 days ago)
- Topics: lg, mqtt, smart-tv, smarthome, tv, webos
- Language: JavaScript
- Homepage:
- Size: 16.6 KB
- Stars: 106
- Watchers: 15
- Forks: 34
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lgtv2mqtt
[![mqtt-smarthome](https://img.shields.io/badge/mqtt-smarthome-blue.svg)](https://github.com/mqtt-smarthome/mqtt-smarthome)
[![NPM version](https://badge.fury.io/js/lgtv2mqtt.svg)](http://badge.fury.io/js/lgtv2mqtt)
[![Dependencies Status](https://david-dm.org/hobbyquaker/lgtv2mqtt/status.svg)](https://david-dm.org/hobbyquaker/lgtv2mqtt)
[![Build Status](https://travis-ci.org/hobbyquaker/lgtv2mqtt.svg?branch=master)](https://travis-ci.org/hobbyquaker/lgtv2mqtt)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
[![License][mit-badge]][mit-url]> Interface between LG WebOS Smart TVs and MQTT 📺
### Getting started
* TV configuration
You need to allow "LG Connect Apps" on your TV - see http://www.lg.com/uk/support/product-help/CT00008334-1437131798537-others
* Install
```npm install -g lgtv2mqtt```
* Start
```lgtv2mqtt --help```
### Topics subscribed by lgtv2mqtt
Topics and Payloads follow [mqtt-smarthome Architecture](https://github.com/mqtt-smarthome/mqtt-smarthome).
#### lgtv/set/mute
Enable or disable mute. Payload should be one off '0', '1', 'false' and 'true'.
#### lgtv/set/volume
Set volume. Expects value between 0 and 100.
#### lgtv/set/toast
Show a Popup Message. Send Message as plain payload string.
#### lgtv/set/launch
Lauch an app. Send AppId as plain payload string.
#### lgtv/set/media.controls/play
#### lgtv/set/media.controls/pause
#### lgtv/set/media.controls/stop
#### lgtv/set/media.controls/rewind
#### lgtv/set/media.controls/fastForward
#### lgtv/set/system/turnOff
#### lgtv/set/com.webos.service.tv.display/set3DOn
#### lgtv/set/com.webos.service.tv.display/set3DOff
#### lgtv/set/move lgtv/set/drag
Send coordinates as JSON with attributes dx and dy of type number
Example payload: ```{dx: 100, dy: 0}```
#### lgtv/set/scroll
Send coordinates as JSON with attributes dx and dy of type number
#### lgtv/set/click
#### lgtv/set/button
Send button as plain string payload
Buttons that are known to work:
MUTE, RED, GREEN, YELLOW, BLUE, HOME, MENU, VOLUMEUP, VOLUMEDOWN, CC, BACK, UP, DOWN, LEFT, ENTER, DASH, 0-9, EXIT,
channelup, channeldown, record
#### lgtv/set/youtubeYoutube video ID as payload. Runs youtube app and opens video.
### topics published by lgtv2mqtt
#### lgtv/status/volume
Reports volume changes. Payload is the plain value.
#### lgtv/status/mute
Reports mute changes. Payload is '0' (not muted) or '1' (muted).
#### lgtv/status/foregroundApp
Reports which App is currently in foreground. (example Payloads: 'netflix', 'com.webos.app.livetv', 'com.webos.app.hdmi2')
#### lgtv/status/currentChannel
Reports current channel if foregroundApp is 'com.webos.app.livetv'. Payload is a JSON String, property val contains the
channelNumber, underneath 'lgtv' you will find more properties with detailed information.## License
MIT © [Sebastian Raff](https://github.com/hobbyquaker)
[mit-badge]: https://img.shields.io/badge/License-MIT-blue.svg?style=flat
[mit-url]: LICENSE