Installation

[For existing SDK users]

  • This installation process is applicable from webOS TV SDK v4.0 and is different from earlier SDK versions. Read the v4.0 release notes for more information.

  • The changes in the installation process do not affect the compatibility with older SDK versions.

  • If you have an older SDK installed on your system, and want to add a component or upgrade existing components, see Add/Upgrade/Remove webOS TV SDK Components.

 

The SDK installation allows you to install the required SDK components. It provides two executable files: minimal installer and full package installer, using which the SDK must be installed. Once installed, any further changes to the installation (adding, updating, or removing SDK components) must be done by using the Component Manager that is provided in the SDK installation directory.


Minimal Installer

  • Installs only the CLI. 

  • To install Emulator and other SDK components, use the Component Manager after installation.

  • Quick download and installation including the previous versions of Emulator and SDK components.

  • No network connection required to perform the installation.

Full Package Installer (v4.0)

  • Installs the latest version of SDK including all components (CLI, IDE, Sublime, and Emulator).

  • Download and installation can take some time.

  • If installing VirtualBox (required for Emulator), then network connection is required.

System Requirements

Before you install the SDK, the system must have the following:

Operating System
  • Microsoft® Windows 
    • Windows 10 (32-bit and 64-bit)
    • Windows 7 (32-bit and 64-bit)
  • Linux 
    • Ubuntu 12.04 (32-bit and 64-bit) or later (tested with Ubuntu 14.04)
  • Mac OS X (64-bit)
    • 10.12 Sierra
    • 10.13 High Sierra (supported but not fully tested)
    • 10.11 El Capitan (supported but not fully tested)
Processor

Intel® Pentium® 4 2.0 GHz or faster

Memory

3 GB or more of RAM

Display

1920 x 1080 or greater of screen resolution

Graphics Card

256 MB or more of video memory

Oracle® Java

The required JRE version is packaged along with the installer. No extra action required.

Note: Do not remove any packaged file from downloaded installer.

Oracle® VirtualBox

Oracle® VirtualBox (recommended VirtualBox 5.0.x)

 

Supported versions for each OS:

  • Windows: VirtualBox 4.2 or later (if not available, the installer automatically installs VirtualBox 5.2.16)
     

    Note: On Windows, the installer prompts you to install VirtualBox. Click Yes to proceed. Once VirtualBox is installed, continue with installing the SDK. If you click No, the installer will proceed with installing the SDK components, excluding the emulator.

 

  • Linux: VirtualBox 4.2 or later (manual installation required)

  • Mac: VirtualBox 5.0.26 or later, except 5.2.x versions
    VirtualBox 5.1.0 version has issue on Sierra (https://www.virtualbox.org/ticket/15832)

 

Note: In order to work with an emulator, VT-x must be enabled. In most cases, this option is already enabled on the PC. However, if the emulator does not start, make sure that this option is enabled in the BIOS on your PC by referring to here.

System Permissions

Administrator permission is required to run the installer.


Install webOS TV SDK

To install the SDK using the Minimal or Full Package installer:

  1. Unzip the downloaded installer package.

  2. Navigate to the unzipped directory and execute the installer executable file.
    Note: On Linux and Mac operating systems, use the sudo ./<executable filename> command.

  3. Perform the following:

    • Screen 1: Accept the license agreement.

    • Screen 2: Select the installation directory, view the components that will be installed, and click INSTALL.

      webOS_TV_40_Installer.png
      Screenshot of Full Package installer. In a Minimal installer, only the CLI would be shown as selected.

      If you have not changed the target directory during installation, you will find the SDK in the following locations:

      • Linux: /usr/local/share/webOS_TV_SDK
      • Mac OS: /opt/webOS_TV_SDK 
      • Windows: C:\webOS_TV_SDK

    • Screen 3: On completing the installation, read the information on the screen, and click DONE.

  4. Restart the system to ensure that the installation works properly.


Add/Upgrade/Remove webOS TV SDK Components
If you have an older SDK version installed (before webOS TV SDK v4.0), the Component Manager is not available on the system. You must re-install the SDK using the minimal installer, and then run the Component Manager.

On installing the webOS TV SDK, a Component Manager utility is automatically installed on the system. This utility lists all SDK components that are installed and that are available for installation. You must use it to add, upgrade, or remove components from the installation.

To use the Component Manager:

  1. Navigate to the <SDK-HOME>/ComponentManager/ directory.

  2. Run the component manager executable file (internet connection is required).

  3. Perform the desired operations. 

    • The Version column indicates the version that is installed on the system.
    • The Update column allows you to update the component if an updated version is available.
    • The Action column shows the operations (install or uninstall) that you can perform on the component.

webOS_TV_40_Component_Manager.png


Uninstall webOS TV SDK

You can choose to uninstall the entire SDK or individual components.

To uninstall components individually, you can choose to use the Component Manager.

To uninstall:

  1. Navigate to the <SDK-HOME>/Uninstall/ directory.

  2. Run the uninstaller executable file. 

  3. Select the component(s) to be uninstalled and click UNINSTALL.

webOS_TV_40_Uninstaller.png

 


FAQs

 

► I have an SDK version that is prior to v4.0. Will I experience any compatibility issues after upgrading?

Not at all. For users who have older versions, we recommend updating using the minimal installer. Using this, only the CLI component is mandatorily updated. The other components can be installed or upgraded later by using the Component Manager.

Even if you update the other SDK components, there is no effect. Check this table:

Component

Update Required?

Remarks

CLI

Yes

Compatible across versions

IDE

No

Compatible across versions

Sublime Plugin

No

Compatible across versions

Emulator

No

You can install the emulator of any version that you want by using the Component Manager.

 

► From v4.0, since the installer uses the JRE packaged within the SDK, do I need JRE also installed on the system?

No. For the purposes of the webOS TV SDK, the JRE is not required. Only the packaged JRE is used.

 

► On a Linux 64-bit system, I sometimes notice an unexpected icon for the SDK installer, while it is running. Why does it occur and does it affect the installation process?

Well, normally the SDK icon of the 'Beanbird' is displayed. However, on some versions of Linux 64-bit, this issue is linked to the name of the directory from which the installer is running. This is because, in Linux, if some reserved keywords are used for directory names, then the corresponding icon is automatically associated with it.

For example:

  • If the directory name includes the term "back" followed by a space (for example "back two") => A "back arrow" icon is displayed.

  • If the directory name includes the term "terminal" followed by a space (for example "terminal abc") => A "terminal" icon is displayed.

However, besides the issue with the icon, there is no effect on the installation process.

 

► On a Linux or Mac system, I am unable to launch the Component Manager. How can I resolve this issue?

To resolve this issue, give recursive permission to the installed directory as follows:

sudo chmod  -R 777 /<path-to-sdk-directory>/webOS_TV_SDK

 

► On a Windows or Mac system, VirtualBox is not getting installed when installing the emulator. How can I resolve this issue?

In a Windows or Mac system, when installing the emulator, the VirtualBox is installed automatically if it is not available. However, when installing the emulator through the Component Manager, sometimes the VirtualBox installation might not happen.

To resolve this issue, re-launch the Component Manager.

 

► On a Mac system, I am unable to launch the Emulator. How can I resolve this issue?

To resolve this issue, open the terminal program and execute as follows:

/opt/webOS_TV_SDK/Emulator/v4.0.0/run_webos_emulator.sh


 

Navigation