LgTvWebOSSwift

LgTvWebOSSwift is a Swift library that allows you to simply and easily send commands from an iOS device to an LG Smart TV running WebOS.

THIS LIBRARY IS NOT MAINTAINED, BUT YOU ARE WELCOME TO USE THE SOURCE CODE HOWEVER YOU LIKE

🏋️‍♂️ Motivation

I'm a co-founder at 🧿 Magico. We're building an app that allows users to control their TV with simple hand gestures via the Apple Watch. So this is pretty straight forwared - I needed a way to send commands to an LG Smart TV via an iPhone.

🤔 How to Use

❗ Note:

In order for this package to work the iOS device running it and the LG TV must be connected to the same WiFi network.

This package requires you to manually input the LG TV’s IP.

If you want to discover devices on the network I recommend using the SSDPClient package

⚙️ Setup

import LgTvWebOSSwift

class SomeClass: LgTvWebOSSwiftDelegate {
    
    // If this is the first you connect to this TV: (a popup will appear on the TV and require user authorization)
    
    let lg = LgTvWebOSSwift(url: *YOUR DEVICE URL*)
    lg.delegate = self
    
    // and use this delegate method to save the token you recieve
    
    func lgtvDidConnect(with token: String) {
        *SAVE THE TOKEN*
    }
    
    // If you already have a token you can use it so there's no popup on the TV:
    
    let lg = LgTvWebOSSwift(url: *YOUR DEVICE URL*, token: *YOUR SAVED TOKEN*)
    lg.delegate = self
    
}

Make sure you set up your class as a Delegate so you can recieve the token back from the TV (and perisist it for future use).

📱 Send Commands

After the connection has been established you can use the following commands:

lg.sendKey(.up)                              //Send an "UP" arrow button key press.
lg.sendKey(.down)                            //Send a "DOWN" arrow button key press.
lg.sendKey(.left)                            //Send a "LEFT" arrow button key press.
lg.sendKey(.right)                           //Send a "RIGHT" arrow button key press.
lg.sendKey(.home)                            //Send a "HOME" button key press.
lg.sendKey(.enter)                           //Send an "ENTER" / "SELECT" button key press.
lg.sendKey(.back)                            //Send a "BACK" / "RETURN" arrow button key press.
lg.sendKey(.volumeUp)                        //Send a "VOLUME UP" button key press.
lg.sendKey(.volumeDown)                      //Send a "VOLUME DOWN" button key press.
lg.sendKey(.mute)                            //Send a "MUTE" button key press.

🏆 Credits

In the making of LgTvWebOSSwift I've relied heavily on the following libraries:

1. PyWebOSTV (Python)
2. lgtv2 (JavaScript)

🤝 Dependencies:

1. Starscream WebSockets Client
2. SwiftyJSON

📋 To Do

• Add install instructions.
• Add more commands.
• Add support for all types of commands (non-mouse input) .
• Seperate the use of mouse input to be non default.
• Add tests.
• Add package to CocoaPods.