Getting Started on webOS

This guide will help you integrate your THEOplayer SDK on webOS. The focus of this article is using the webOS IDE and our sample code. You may also find the Getting Started on Web to be useful.

Prerequisites

1. Make sure the webOS SDK, available for download at http://webostv.developer.lge.com/sdk/installation, is correctly installed on your system.

   • You will find the following 2 installation options:

     • At a minimum you need the CLI tool packaged in the minimal installation bundle. You will be able to install other components later on if required by using the Component Manager in your installation folder {installation folder}\webOS_TV_SDK\ComponentManager)
     • The full installation bundle will install the CLI, webOS IDE (Eclipse based), VirtualBox emulators, plugins, ...
     • The webOS IDE is a handy way to set up physical devices, but everything can also be cleanly configured using the CLI and a terminal window in the IDE of your choice (Visual Studio Code, WebStorm, ...)
     • You can create webOS projects and import compliant webOS projects into the webOS IDE by using import webos project in the webos menu of the IDE
2. Make sure to add the bin folder located at{installation folder}\webOS_TV_SDK\CLI\bin to the PATH variable of your OS to make it available everywhere from the command line.
3. Validate that the CLI is correctly set up by invoking ares at the command line of a new terminal. If the command is recognized, you are correctly set up.

Important Note If you require interactive debugging (even if you only use the CLI), you will need to install the webOS IDE. Although you might not directly use the IDE, the CLI debugging command will open up a Chromium Inspection browser that is only available when the webOS IDE is installed on the system.

Download the starter files

• Download the starter code from https://github.com/THEOplayer/samples-webos
• The folder contains all the necessary files to quickly deploy a THEOplayer solution to a webOS device

• The packager will use the app folder to build an IPK package

  • the app folder contains a crude solution with entry point index.html; the only thing left is to put your THEOplayer library files in the libs folder

• The folder example-with-UI contains a more elaborate example

  • to use it, optionally modify the code and run the following commands

    cd example-with-ui
    npm i
    npm run build  

  • next copy the js folder, the css folder and the index.html file to the app folder (overwriting the existing files)

Setting up the physical device

Prerequisites

1. Make sure you have created an LG Developer Account at http://webostv.developer.lge.com/develop/app-test. You will need this to login to the Developer Tools app on the physical device.
2. Download the Developer Tools app to the tv (use the LG Content Store), login with your LG account and follow the instructions to set the device in developer mode (a restart is required)

Make a connection

• In case you downloaded the webOS IDE, you can use the webOS IDE to link your development environment to the physical device (Target Configuration > New Connection)

• Manually set up (use the guideline provided by LG)

  1. Open terminal and enter ares-setup-device
  2. Choose add
  3. Enter device name: tv (feel free to use another name)
  4. Enter the IP address of the LG tv (open the Developer Tools app on the device to find out)
  5. Use port 9922 for physical devices (for an emulator the port is 6622)
  6. SSH user: this should be set to prisoner (important note: do not use the proposed root, this will not work)
  7. Enter an optional description
  8. Authentication: choose option password
  9. Leave the actual password blank
  10. Save
  11. Next: you need to acquire a key from the physical device to be able to securely interact
  12. Enter ares-novacom -d tv --getkey (make sure to use the device name you choose in case you changed it)
  13. You will be prompted for a key; the key will be visible in the Developer Tools app on the physical device

Emulator

Important Note: the use of an emulator is not recommended as emulators do not implement all features (e.g. DRM).

If you decide to use an emulator: start the emulator of your choice (you might need to install it using the Component Manager - see the Prerequisites section of this document)

Running the app

Note: please visit the LG webOS developer site at http://webostv.developer.lge.com/ to get more info on commands, tools and guidelines.

First make sure to cd into the root folder (this is the parent of app folder). Next run the following commands.

Packaging

ares-package  ./app --outdir ./

Installation

Default name for the created package is webos.theo1.0.0all.ipk, tv is the device name that was given when setting up the device in the previous step. This step will fail if there is no connection to the device, e.g. the device is offline, not on the same network, ... .

ares-install webos.theo_1.0.0_all.ipk  -d tv

Launch

App id is by default web.theo (you can change this in appinfo.json)

ares-launch webos.theo  -d tv

Debug

ares-inspect webos.theo -d tv --open