Interfaces and Commands

Visual Studio (VS) Code, which you probably are already familiar with, provides most features of the webOS TV CLI. With the commands and menus provided in the webOS TV extension, you can have the same result as the webOS TV CLI. If you want to check available features in the extension, see Supported Features of the webOS TV extension.

The following sections provide:

webOS TV Commands on Command Palette

Open the Command Palette (Ctrl+Shift+P). To see all available webOS TV commands, open the Command Palette and type 'webOS TV.'

The command palette of the Visual Studio Code

Developing Apps

To develop apps, use the following commands.

  • webOS TV: Generate Project - Create a web app from templates.

  • webOS TV: Preview Application - Runs a web server for testing app files in local PC.

  • webOS TV: Package Application - Package your app files into the package file (.ipk) stored in a specified directory.

Connecting Devices

To connecting the target devices and your PC to test your app excepting the emulator, use the following commands.

  • webOS TV: Set Up Device - Add, modify, or remove devices from the device list.

  • webOS TV: Set Up SSH Key - Get a private key from webOS TV device. After getting the private key, you can install and launch apps or run other commands on webOS TV.

Testing Apps on Devices

To test apps on the target devices, use the following commands.

  • webOS TV: Install Application - Install your app on the target device with the selected app package file (.IPK).

  • webOS TV: Launch Application - Run your app installed on the device.

  • webOS TV: Inspect Application - Run Web Inspector and open the browser. Web Inspector displays the running information about your app.

  • webOS TV: Inspect JS Service - Run Node Inspector in the target device and create a launch configuration file to run Node Inspector Client in VS Code. You should package the JS service with your app by CLI and install it on the target device.

  • webOS TV: Run without Installation - Run your web app on the device without packaging and installing the app whenever you change the code.

Batch Commands

To execute multiple commands at a time, use the following commands.

  • webOS TV: Run Application - Package, install, and launch your app sequentially.

  • webOS TV: Debug Application - Package, install, and inspect your app sequentially.

webOS TV Features on User Interface

You can use various features of the webOS TV extension from the inline and context menus on VS Code.

Explorer

In The Explorer, you can browse, open, and manage all of the files and folders in your webOS TV project.

Explorer Context Menu

When you right-click the IPK file of your app in the Explorer, you can install, run, and debug your app.

The Explorer context menu by clicking the IPK file of the Visual Studio Code

  • webOS TV: Install Application - Install the selected app.

  • webOS TV: Run Application - Install and launch the selected app.

  • webOS TV: Debug Application - Install and inspect the selected app on the target device.

When you right-click the directory of your app files in the Explorer, you can also package, preview, and run without installing your app.

The Explorer context menu by clicking the directory of the Visual Studio Code

  • webOS TV: Package Application - Package the selected app directory into the package file (.ipk) stored in a specified directory.

  • webOS TV: Preview Application - Run a web server for testing the selected app directory.

  • webOS TV: Run without Installation - Run the selected app directory on the device without packaging and installing the app whenever you change the code.

Editor

You can run some commands directly by right-clicking in the editor without launching the Command Palette.

Editor Context Menu

The editor context menu of the Visual Studio Code

  • webOS TV: Generate Project

  • webOS TV: Package Application 

  • webOS TV: Run Application

  • webOS TV: Debug Application 

Activity Bar

You can run some commands about target devices and your apps from webOS TV devices in the Activity Bar. To activate the extension, click the Refresh icon at first.

Device Inline Menu

The device inline menu of the Visual Studio Code

  • Refresh - Refresh the list of devices.

  • Add Device - Add a device to the list.

  • Modify Device - Modify the selected device.

  • Remove Device - Remove the selected device.

Device Context Menu

The device context menu of the Visual Studio Code

  • Refresh - Refresh the installed and running app lists of the selected device.

  • Install Application - Install your app to the selected device.

  • Set Up SSH Key - Get a privacy key from the selected device.

  • Extend DevMode Session - Extends the Developer Mode session time of the selected device. Note that this command only works when the following conditions are satisfied.

    • The Developer Mode is on.

    • The session time remains longer than 0 minutes.

  • Show Information - Retrieves the following system information of the selected device. Note that if some system information cannot be retrieved depending on TV models, only the retrieved information is displayed.

    • Model Name

    • SDK Version

    • Firmware Version

    • Board Type

    • OTA (Over The Air) ID

Application Context Menu

The application context menu of the Visual Studio Code

Note that you can refresh the installed and running app lists only when the device is connected.

  • Run - Run the selected app to the device. It is the same as webOS TV: Launch Application command in the Command Palette.

  • Debug - Run Web Inspector and open the browser. Web Inspector displays the running information about your app. It is the same as webOS TV: Inspect Application command in the Command Palette.

  • Uninstall - Uninstall the selected app from the device. This command works only for installed apps.

  • Close - Close the selected app on the devices. This command works only for running apps.

 

 

 

Navigation