Release Notes

The webOS TV SDK provides tools for web application development including a Command Line Interface and emulator. With the SDK, you can create, debug, package, and test webOS TV applications.

 

 

Open All


webOS TV SDK v4.0.2 (August 2018)

New Features

webOS TV CLI

newicon.png  Added a new hosted web app template to make hosted web apps easily in the ares-generate command.

newicon.png  Added the new ares-device-info command that retrieves system information of a target device.


webOS TV SDK v4.0.1 (July 2018)

Bug Fixes are listed below.

Bug Fixes

Installation

  • Fixed an issue where the permission of all folders/files within the home folder is unintentionally changed to 777 after webOS TV SDK 4.0 is installed in MacOS 10.13 (High Sierra).

  • Fixed an issue where an error occurs with a message that says “Installer cannot be executed as some required files are missing” while webOS TV SDK 4.0 is installed in MacOS 10.13.5 (High Sierra).


webOS TV SDK v4.0.0 (May 2018)

New/Changed Features, Bug Fixes and Known Issues for each webOS TV SDK component are listed below.

New/Changed Features

Supported OS

  • MacOS X (64-bit)

    • 10.12 Sierra

    • 10.13 High Sierra (supported but not fully tested)

    • 10.11 El Capitan (supported but not fully tested)

  • Microsoft® Windows

    • Windows 10 (32-bit and 64-bit)

    • Windows 7 (32-bit and 64-bit)

  • Ubuntu 12.04 (32-bit and 64-bit) or later (tested with Ubuntu 14.04)

Common

  • Improved SDK installation and emulator stability on MacOS.

  • Added UDC (User Data Collection) to the emulator and the IDE.

    The UDC (Usage Data Collection) feature does not collect any information that can uniquely identify you as an individual. 
    The data collected is only about how the SDK performed and will be used solely for enhancing the SDK quality. 
    You can send us a request to have this feature turned off on the forum or via email at developer@lge.com.

APIs

changedicon.png  Camera API is deprecated from webOS TV 4.0. 

webOS TV Installer

changedicon.png  Provides brand new installer UI/UX

  • Includes the minimum installer that installs only the CLI.

  • Includes a full-package installer that includes CLI, Eclipse IDE, Sublime Plugin and Emulator for SDK 4.0.0.

  • Includes a Component Manager that must be used to add/remove/update SDK components. 

webOS TV CLI

changedicon.png  Templates are updated.

changedicon.png  All enyo templates are removed.

webOS TV Emulator

newicon.png  Added the webOS TV emulator 4.0.0 that emulates the webOS TV 4.0.

changedicon.png  Changed new RCU UI/UX.

changedicon.png  Replaced Enyo pre-built-in apps into Enact pre-built-in apps (enact-hello, enact-sampler).

webOS TV IDE

changedicon.png  Templates are updated.

changedicon.png  All enyo templates are removed.

webOS TV Plugin for Sublime Text

changedicon.png  Templates are updated.

changedicon.png  All enyo templates are removed.

Bug Fixes

  • None

Known Issues

webOS TV Installer

  • On Windows 32-bit, a pathname longer than 250 characters cannot be selected as the installation directory.

  • VirtualBox 5.1.0 version is having an issue on Sierra (https://www.virtualbox.org/ticket/15832).

  • In MacOS Sierra, a single click of a mouse is sometimes not working in installation. 

  • In MacOS High Sierra, the shortcut icon often is not displayed correctly.

  • In win7, when you select medium(125%) or Larger(150%) in "Control Panel">"Appearance and Personalization">"Display">"Make it easier to read what's on your screen," some text of installer UI may cut down. At that time, please select "smaller(100%) (default)" then you can see the full text.

  • In Linux, when you select more than 1 in "System Settings">"All Settings">"Displays">"Scale for menu and title bars," some text of installer UI may cut down. At that time, please select 1(default) or less than 1 value then you can see the full text.

  • The download icon for the Virtual Box is shown on the Component Manager while the Virtual Box is in the waiting stage.

webOS TV CLI

  • The Web and Node Inspectors work on WebKit-based browsers (Chrome and Safari) but not on non-WebKit browsers (IE, FireFox).

  • The emulator should be running prior to using the ares-install or ares-launch commands.

  • The ares-server and ares-inspect commands are not terminated on their own, and can only be terminated manually by pressing Ctrl+C.

  • The ares-package shows an error message if an app file name contains non-ASCII characters. (App file names should contain Latin letters ONLY.)

webOS TV Emulator

  • VirtualBox 5.1.0 version is having an issue on Sierra (https://www.virtualbox.org/ticket/15832).

  • The App Manager, a tool of RCU, may have some visual artifacts in operation.

  • Apps continue to be installed even though the App Manager window is closed.

  • In MacOS,  the scroll bar is displayed after resizing the emulator screen.

  • The emulator supports only basic HTML5 media playback such as MP4.

  • The emulator doesn't support HTML5 MSE/EME.

  • Instead of the background image, a blank screen is shown on the emulator after an app was terminated.

webOS TV IDE

  • No known Issues

webOS TV Plugin for Sublime Text

  • If you install the plugin when Sublime Text is running, the plugin menu is not shown in the menu bar until rebooting Sublime Text.

  • Sublime Text 3 is not supported.

webOS TV SDK v3.0.0 (January 2017)

New/Changed Features, Bug Fixes and Known Issues for each webOS TV SDK component are listed below.

New/Changed Features

Supported OS

  • Microsoft® Windows 7 (32-bit and 64-bit)

  • Mac OS X 10.8 Mountain Lion, 10.9 Mavericks and 10.10 Yosemite (64-bit)

  • Ubuntu 10.04, 12.04 / Ubuntu Mint 13 (Maya) (32-bit and 64-bit)

webOS TV CLI

changedicon.png  The ares-generate command is updated as below:

  • The names of the basic web app and JavaScript service templates are modified to 'basic' and 'js_service'.
  • Enyo Template list has been changed.  The template title shows the supported webOS TV platform version (model year).
  • webOS library (webOS.js) included in templates has been updated to support new functions such as webOS.platformBack()
  • The git command is required for creating apps from templates.
  • The --init option has been added to initialize Enyo libraries

changedicon.png  Now, the ares-package command minifies not only Enyo apps but also basic web apps (partial minification - whitespace trimming).

changedicon.png  The ares-setup-device command is updated as below:

  • The --search option has been added to discover webOS devices within the same network.
  • '$' and '%' characters cannot be included in the device name.

webOS TV IDE

changedicon.png Template list is updated for new templates.

newicon.png  Added git perspective in webOS TV IDE.

changedicon.png  Changed an error message in "Preview on browser" menu.

webOS TV Plugin for Sublime Text

changedicon.png Template list is updated for new templates.

Bug Fixes

webOS TV CLI

  • Packaging apps are failed if the file named as 'services.json' exists in sub-directory.

webOS TV IDE

  • App debugging is not working if the target URL is set as "undefined:9998".

  • App creation is not working if the project name contains white spaces. 

Known Issues

webOS TV CLI

  • Non-WebKit browsers (e.g. IE, FireFox) do not support Web Inspector and Node Inspector.

  • Before using ares-install and ares-launch commands, the emulator should have been running.

  • The ares-server and ares-inspect commands are not terminated on their own, but can only be terminated manually by pressing Ctrl+C.

  • The ares-package shows an error message if the app file name contains non-ASCII letters (App file names should contain Latin letters ONLY.).

webOS TV Emulator

  • If you remove the Screenshot folder while the emulator is running, the image will not be saved by Take Screenshot. Once the emulator is restarted, the Screenshot folder is regenerated and the image will then be saved normally.

  • The BD LPCM audio format is not supported.

  • The MOV format is not supported.

  • Media (audio/video) playback is supported, but the progress bar does not move while playing.

webOS TV IDE

  • No known Issues

webOS TV Plugin for Sublime Text

  • If you install the plugin when Sublime Text is running, the plugin menu is not shown in the menu bar until rebooting Sublime Text.


webOS TV SDK v3.0.0 (January 2016)

New/Changed Features, Bug Fixes and Known Issues for each webOS TV SDK component are listed below.

New/Changed Features

APIs

Luna Service API

newicon.png Security Manager API

  • Added deviceid/getIDs methods to generate a unique device ID for apps.

changedicon.png Application Manager API

  • Removed launch/open methods that launch a specified app.

changedicon.png Push API

  • Removed 5 methods including register App and createToken that are used for sending messages from Push Center to the user or push requester.

 

Enyo API

changedicon.png Supports Enyo 2.6

Installation/Uninstallation

newicon.png Supports updating existing SDK components to v3.0.0 with ‘Update components’ feature.

changedicon.png Supports installing all three webOS TV emulators v1.2.0, v2.0.0, and v3.0.0 with network installer.

Supported OS

  • Microsoft® Windows 7 (32-bit and 64-bit)

  • Mac OS X 10.8 Mountain Lion, 10.9 Mavericks and 10.10 Yosemite (64-bit)

  • Ubuntu 10.04, 12.04 / Ubuntu Mint 13 (Maya) (32-bit and 64-bit)

webOS TV CLI

changedicon.png Templates are updated for Enyo 2.6.

webOS TV Emulator

newicon.png Added webOS TV Emulator 3.0.0. It emulates the webOS TV platform 3.0.

webOS TV IDE

changedicon.png Templates are updated for Enyo 2.6.

newicon.png Added the webOS service project function to create the webOS service (node.js) project.

newicon.png Added the Convert to webOS Project and Convert to webOS Service Project functions to convert the Eclipse-based project to a webOS/webOS Service project.

newicon.png In New Target Connection, added the LG Smart TV option under the Device Type field for testing on real TVs.

webOS TV Plugin for Sublime Text

changedicon.png Templates are updated for Enyo 2.6.

newicon.png Supports webOS TV 3.0 and webOS TV Emulator 3.0.0.

Bug Fixes

Installation

  • Fixed an issue where selecting ‘Add Components’ feature causes an error or the installer to freeze if webOS TV SDK v1.2.0 is already installed on your computer when installing a newer version of SDK.

Known Issues

Installation/Uninstallation

  • After uninstalling the SDK, SDK home and Uninstall folders are not deleted.

  • If OpenJDK is installed on your computer, the installer does not start.

  • [Win32] Unable to specify an installation directory which exceeds the maximum number of characters (250).

  • [Mac OS] The popup window for VirtualBox installation appears after a delay.

  • [Linux] A warning message may sometimes be shown in the console only while installing with GUI installer.

webOS TV CLI

  • Non-WebKit browsers (e.g. IE, FireFox) do not support Web Inspector and Node Inspector.

  • Before using ares-install and ares-launch commands, the emulator should have been running.

  • The ares-server and ares-inspect commands are not terminated on their own, but can only be terminated manually by pressing Ctrl+C.

  • The ares-package shows an error message if the app file name contains non-ASCII letters (App file names should contain Latin letters ONLY.).

webOS TV Emulator

  • If you remove the Screenshot folder while the emulator is running, the image will not be saved by Take Screenshot. Once the emulator is restarted, the Screenshot folder is regenerated and the image will then be saved normally.

  • The BD LPCM audio format is not supported.

  • The MOV format is not supported.

  • Media (audio/video) playback is supported, but the progress bar does not move while playing.

webOS TV IDE

  • No known Issues.

webOS TV Plugin for Sublime Text

  • If you install the plugin when Sublime Text is running, the plugin menu is not shown in the menu bar until rebooting Sublime Text.


webOS TV SDK v2.0.0 (January 2015)

New/Changed Features, Bug Fixes and Known Issues for each webOS TV SDK component are listed below.

New/Changed Features

APIs

Luna Service API

newicon.png Magic Remote API

  • Provides the enableDualPairing method to enable or disable the Dual Pairing mode. Dual Pairing mode can be used for game play.
  • Provides the sensor/getSensorData and sensor/resetQuaternion methods to get sensor data from Magic remote.

newicon.png In-App Purchase API

  • Provides the conveyRequestPub and open method for In-app-purchasing. These methods allow you to check item information, retrieve paid item list, and make an item purchase.

newicon.png TV Device Information API

  • Provides the getSystemInfo method to get device information such as a model name, firmware version, and hardware version.

newicon.png Settings Service API

  • Provides the getSystemSetting method to get setting values from setting service. This method allows you to get locale information and country setting value.

 

Standard Web API

changedicon.png HTML5 Audio & Video Element

  • Provides the file type for the src attribute of HTMLVideoElement, HTMLAudioElement and HTMLSourceElement interfaces. It is used to embed audio or video content. However, the emulator does not support this type.
  • The defaultMuted attribute of HTMLMediaElement interface is not supported.

changedicon.png HTML5 User Interaction API

  • Provides the replaceState method to update the state. However, the emulator does not support this method.

 

Enyo API

changedicon.png In addition to Enyo 2.3, Enyo 2.5 is newly supported.

Installation

newicon.png Supports update of existing SDK components to v2.0.0.

newicon.png Supports selecting SDK version and its components to install in the Advanced option of network installer.

newicon.png Supports installing both webOS TV emulator v1.2.0 and v2.0.0 with network installer.

changedicon.png Supports installing missing components with ‘Add components’ feature. This feature used to be provided in webOS TV SDK v1.2.0. The name of the feature, however, has been changed.

webOS TV CLI

newicon.png Added webOS.js file into bootplate-web template (non-enyo app template). webOS.js is a library to call Luna Service API from a web app.

newicon.png CLI command returns a proper exit code.

newicon.png Supports packaging app with symbolic link files.

changedicon.png Updated bootplate-moonstone template to Enyo 2.5 version.

changedicon.png Reduced app generation time of ares-generate.

webOS TV Emulator

newicon.png Emulates the webOS TV platform 2.0.

newicon.png All functions in Emulator v1.2.0 work same in Emulator V2.0.0 except for changedicon.png.

newicon.png Added selecting the skin of remote control unit emulator between a traditional remote and a magic remote.

changedicon.png Only user-installed apps are shown in Installed Apps in App Manager.

webOS TV IDE

newicon.png Supports adding and importing a custom template which is created by users.

newicon.png Supports exporting IPK file on a location where the user sets.

newicon.png Provides shortcut keys for menus.

newicon.png Provides information on applications which are installed and running on a target device. Also, those applications can be controlled; run, debug, uninstall or close.

changedicon.png Supports Target Configuration for an Emulator/TV on which application can be installed, launched and debugged. TV connection is only supported for Contract Partners.

changedicon.png Supports importing code samples by using drag and drop feature.

changedicon.png Supports three steps of packaging, installing and launching through one step.

changedicon.png Supports running HTML files on integrated chromium browser in IDE.

webOS TV Plugin for Sublime Text

newicon.png Provides shortcut keys for menus.

newicon.png Provides the simplified menus for a package, install, and launch.

newicon.png Provides the completion popup for a keyword.

newicon.png Provides the snippets for JavaScript file.

changedicon.png Supports an uninstaller program for a plugin.

Bug Fixes

Installation

  • Fixed the error "Emulator Script Failed" caused by localization on Windows.

webOS TV CLI

  • Fixed app packaging problem in Mac OS, that was occurred by UID.
  • Excludes .DS_Store file from app directory when packaging in Mac OS.
  • Clears connection with the target when the execution of CLI command completes.

webOS TV Emulator

  • Fixed the problem of playing HLS video.
    Note: If you have an emulator released in 2014, this issue may occur.

  • Fixed the problem of receiving the webOSLaunch event in the emulator.
    Note: If you have an emulator released in 2014, this issue may occur.

webOS TV IDE

  • Fixed the problem of ‘bootplate-moonstone-MediaBrowser’ template in a preview.

Known Issues

Installation/Uninstallation

  • In case the webOS TV SDK v1.2.0 is installed on your computer, you cannot use 'Add Components' feature because the installer may stop or an error occurs.

  • During fresh installation, if you choose 'SDK package v2.0.0' and then switch to 'Network Installer', 'Emulator v1.2.0' will not appear in the components list.

  • If VirtualBox is not installed on your computer and you select the component ‘Emulator v1.2.0’ in the installer, without selecting ‘Emulator v2.0.0’, the installer does not ask for installing VirtualBox and an error occurs. In this case, you need to install VirtualBox first.

  • After uninstallation, SDK home and Uninstall folders are not removed.
  • If OpenJDK is installed on your computer, the installer does not work.
  • The disk space required to install with network installer is incorrect.
  • [Win32] Do not select installation directory which has more than 250 characters in its pathname.
  • [Mac OS] The progress bar may display the incorrect percentage of installation when using the network installer.
  • [Mac OS] The popup window for VirtualBox installation appears after a delay.
  • [Linux] A warning message may be shown in the console to install with GUI installer.

webOS TV CLI

  • Web Inspector and Node Inspector work on WebKit-based browsers (Chrome and Safari) but not on non-WebKit browsers (IE, FireFox).

  • To use ares-install and ares-launch commands, the emulator should be running before.

  • The ares-server and ares-inspect commands are not terminated on their own, but can only be terminated manually by Ctrl+C.

  • The ares-package shows the error message if app file name contains non-ASCII letters. (App file names should be in English.)

webOS TV Emulator

  • If you remove the Screenshot folder when the emulator is executed, the image will not be saved by Take Screenshot. Once the emulator is restarted, the Screenshot folder is regenerated and the image will be saved normally.
  • The BD LPCM audio format is not supported.
  • The MOV format is not supported.

webOS TV Plugin for Sublime Text

  • If you install the plugin when Sublime Text is running, the plugin menu is not shown in the menu bar until rebooting Sublime Text.


webOS TV SDK v1.2.0 (June 2014)

Main Features and Known Issues for each webOS TV SDK component are listed below.

Main Features

Supported OS

  • Microsoft® Windows 7 (32-bit and 64-bit)
  • Mac OS X Lion or later (64-bit)
  • Ubuntu 10.04, 12.04 / Ubuntu Mint 13 (Maya) (32-bit and 64-bit)

webOS TV CLI

  • Provides scripts to use in a command line to create/package a project for an app and to install/run the app on the emulator.

  • Supports project creation

    • Provides standard project templates for webOS TV web apps
    • Provides a list of available templates
    • Generates a project for an app and sets up basic information of an app
  • Supports web app packaging
    • Packages the source code and generates a package file (.ipk) to run on the emulator
    • Provides a feature to exclude sample and test code directories from a project
    • Provides an option to reduce the code size for Enyo app
    • Generates app installation files for debugging
  • Supports target device managing
    • Provides a list of target devices.
    • Adds, modifies, and removes target devices.
  • Supports web app installation
    • Provides a list of emulators
    • Installs apps on the emulator
    • Provides a list of apps installed on the emulator
    • Removes selected apps from the emulator
  • Supports web app launching/closing
    • Runs selected apps
    • Closes apps that are running
    • Provides the list of apps running on the emulator
  • Supports debugging web apps
    • Provides Web Inspector for debugging
    • Provides Node Inspector for debugging
    • Provides web app information
    • Provides JavaScript service information

webOS TV Emulator

  • Provides a VirtualBox based emulator

    • Emulates webOS TV on Windows 7 32/ 64-bit, Mac OS 64-bit, and Linux 32 / 64-bit systems
  • Provides a TV emulation function
    • Provides a remote control unit emulator
    • Provides the same resolution (1920x1080 Full HD) as webOS TV
    • Provides the same action as webOS TV by choosing the same UX and HID keyboard/mouse input
  • Supports Web app development
    • Provides App Manager for installing, running, and removing apps
    • Provides Command Line Interface for installing, running, and debugging apps
    • Provides partial support for standard web API, Cordova standard API, and Luna Service API.
  • Supports Connect app (2nd screen app) development
    • Provides the environment for testing connect apps

webOS TV IDE

  • Provides a subset functions of CLI in Eclipse-based IDE for web app development

  • Supports project creation
    • Provides web app templates
    • Generates an Enyo file
    • Creates an appinfo.json file
  • Supports web app packaging
  • Supports target device managing
    • Provides a list of target devices
  • Supports web app launching
  • Supports debugging web apps
    • Provides Web Inspector for debugging

webOS TV Plugin for Sublime Text

  • Provides a subset functions of CLI in the plugin for Sublime Text 2 for web app development

  • Supports project creation
    • Provides web app templates
    • Creates an appinfo.json file
  • Supports JS service creation
    • Provides JS service templates
  • Supports web app packaging
  • Supports target device managing
    • Provides a list of target devices
  • Supports web app installation
    • Installs an app on the emulator
    • Provides a list of installed apps on the emulator
  • Supports web app launching
  • Supports debugging web apps
    • Provides Web Inspector for debugging

APIs

Known Issues

Installation/Uninstallation

  • After uninstallation, SDK home and Uninstall folders are not removed.
  • If OpenJDK is installed on your computer, the installer does not work.
  • The disk space required to install with network installer is incorrect.
  • [Win32] Do not select installation directory which has more than 250 characters in its pathname.
  • [Mac OS] The progress bar may display the incorrect percentage of installation when using the network installer.
  • [Mac OS] The popup window for VirtualBox installation appears after a delay.
  • [Linux] A warning message may be shown in the console to install with GUI installer.

webOS TV CLI

  • Web Inspector and Node Inspector work on WebKit-based browsers (Chrome and Safari) but not on non-WebKit browsers (IE, FireFox).

  • To use ares-install and ares-launch commands, the emulator should be running before.

  • The ares-server and ares-inspect commands are not terminated on their own, but can only be terminated manually by Ctrl+C.

webOS TV Emulator

  • The BD LPCM audio format is not supported.
  • The MOV format is not supported.
  • In emulator released in 2014, HLS video is not played normally.
    Note: If you install emulator v1.2.0 released in 2015, this issue does not occur.

  • In emulator released in 2014, the webOSLaunch event cannot be received.
    Note: If you install emulator v1.2.0 released in 2015, this issue does not occur.

webOS TV IDE

  • When a user deletes, renames or copies the target in IDE (under Remote Systems tab of IDE), though the view reflects the updates, it does not get applied in the system.

     

    < Workaround for the above >

    a. The devices can be deleted using the CLI ‘ares-setup-device –remove DEVICE NAME’.

    b. As rename is not supported, users have to delete the old one (using CLI) and regenerate new one (using IDE).

     

  • The ‘bootplate-moonstone-MediaBrowser’ template does not work properly in preview

webOS TV Plugin for Sublime Text

  • If you install the plugin when Sublime Text is running, the plugin menu is not shown in menu bar until rebooting Sublime Text.



Navigation