webOS TV Developer

https://webostv.developer.lge.com/develop/
Admin
A comprehensive developer portal providing resources, guides, tools, and a platform for creating,...
Tokens:338,690
Snippets:2,561
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install app on emulator

Source: https://webostv.developer.lge.com/develop/tools/webos-tv-cli-dev-guide

Installs the app package com.example.sampleapp_0.0.1_all.ipk on the emulator device.

```bash
ares-install --device emulator com.example.sampleapp_0.0.1_all.ipk
```

--------------------------------

### Get service event for client/connect

Source: https://webostv.developer.lge.com/develop/references/ble-gatt

Get service event example. Shows the discovered services with their characteristics, properties, and instance IDs.

```json
{
  "event": "onServicesDiscovered",
  "returnValue": true,
  "values": {
    "address": "4f:8f:d7:c4:e3:e1",
    "services": [
      {
        "includes": [],
        "characteristics": [
          {
            "properties": {
              "authenticatedSignedWrites": false,
              "extendedProperties": false,
              "write": false,
              "read": false,
              "notify": false,
              "broadcast": false,
              "writeWithoutResponse": false,
              "indicate": true
            },
            "characteristic": "00002a05-0000-1000-8000-00805f9b34fb",
            "instanceId": "003",
            "permissions": {},
            "value": {
              "bytes": []
            },
            "descriptors": []
          },
          {
            "properties": {
              "authenticatedSignedWrites": false,
              "extendedProperties": false,
              "write": false,
              "read": true,
              "notify": false,
              "broadcast": false,
              "writeWithoutResponse": false,
              "indicate": false
            },
            "characteristic": "00002b3a-0000-1000-8000-00805f9b34fb",
            "instanceId": "005",
            "permissions": {},
            "value": {
              "bytes": []
            },
            "descriptors": []
          },
          {
            "properties": {
              "authenticatedSignedWrites": false,
              "extendedProperties": false,
              "write": true,
              "read": true,
              "notify": false,
              "broadcast": false,
              "writeWithoutResponse": false,
              "indicate": false
            },
            "characteristic": "00002b29-0000-1000-8000-00805f9b34fb",
            "instanceId": "007",
            "permissions": {},
            "value": {
              "bytes": []
            },
            "descriptors": []
          },
          {
            "properties": {
              "authenticatedSignedWrites": false,
              "extendedProperties": false,
              "write": false,
              "read": true,
              "notify": false,
              "broadcast": false,
              "writeWithoutResponse": false,
              "indicate": false
            },
            "characteristic": "00002b2a-0000-1000-8000-00805f9b34fb",
            "instanceId": "009",
            "permissions": {},
            "value": {
              "bytes": []
            },
            "descriptors": []
          }
        ],
        "service": "00001801-0000-1000-8000-00805f9b34fb",
        "type": "primary"
      }
    ]
  }
}
```

--------------------------------

### Sample output of ares-setup-device --list

Source: https://webostv.developer.lge.com/develop/tools/cli-dev-guide

Sample output of the ares-setup-device --list command. Shows the emulator and a TV device with their connection details.

```text
name        deviceinfo                 connection    profile
---------   ------------------------   ------------  --------
emulator    developer@127.0.0.1:6622   ssh           tv
tv          prisoner@10.123.45.67      ssh           tv
```

--------------------------------

### Create package file from sampleApp

Source: https://webostv.developer.lge.com/develop/tools/webos-tv-cli-dev-guide

Creates a package file from the ./sampleApp directory and outputs it in the working directory.

```bash
ares-package sampleApp

```

--------------------------------

### Create basic, scheduled, and triggered activities with webOS.service.request

Source: https://webostv.developer.lge.com/develop/references/activity-manager

These examples show how to create basic, scheduled, and triggered activities using the 'luna://com.palm.activitymanager' service. The basic activity starts immediately, the scheduled activity starts at a specified time, and the triggered activity starts when a trigger condition is met and invokes a callback. Each example uses the 'create' method with 'start: true' and 'subscribe: true' parameters, and handles success and failure responses.

```javascript
// Create a basic activity
var request = webOS.service.request('luna://com.palm.activitymanager', {
  method: 'create',
  parameters: {
    activity: {
      name: 'basicactivity',
      description: 'Test create',
      type: {
        foreground: true,
      },
    },
    start: true,
    subscribe: true,
  },
  onSuccess: function (inResponse) {
    if (!inResponse.event) {
      console.log('The Activity is created');
      // To-Do something
    } else {
      console.log('Received event: ' + inResponse.event);
      // To-Do something
    }
  },
  onFailure: function (inError) {
    console.log('Failed to create the Activity');
    console.log('[' + inError.errorCode + ']: ' + inError.errorText);
    // To-Do something
    return;
  },
});
```

```javascript
// Create a scheduled activity
var request = webOS.service.request('luna://com.palm.activitymanager', {
  method: 'create',
  parameters: {
    activity: {
      name: 'ScheduledActivity',
      description: 'Test create of scheduled activity',
      type: {
        foreground: true,
      },
      schedule: {
        start: '2015-02-15 13:22:00',
      },
    },
    start: true,
    subscribe: true,
  },
  onSuccess: function (inResponse) {
    if (!inResponse.event) {
      console.log('The scheduled Activity is created');
      // To-Do something
    } else {
      console.log('Received event: ' + inResponse.event);
      // To-Do something
    }
  },
  onFailure: function (inError) {
    console.log('Failed to create the Activity');
    console.log('[' + inError.errorCode + ']: ' + inError.errorText);
    // To-Do something
    return;
  },
});
```

```javascript
// Create a scheduled activity with callback
var request = webOS.service.request('luna://com.palm.activitymanager', {
  method: 'create',
  parameters: {
    activity: {
      name: 'ScheduledActivityWithCallback',
      description: 'Test create of scheduled activity with callback',
      type: {
        foreground: true,
      },
      schedule: {
        start: '2015-02-15 00:05:00',
      },
      callback: {
        method: 'luna://com.webos.audio/setMuted',
        params: {
          muted: 'true',
        },
      },
    },
    start: true,
    subscribe: true,
  },
  onSuccess: function (inResponse) {
    if (!inResponse.event) {
      console.log('The scheduled Activity is created');
      // To-Do something
    } else {
      console.log('Received event: ' + inResponse.event);
      console.log('Audio will be muted');
      // To-Do something
    }
  },
  onFailure: function (inError) {
    console.log('Failed to create the Activity');
    console.log('[' + inError.errorCode + ']: ' + inError.errorText);
    // To-Do something
    return;
  },
});
```

```javascript
// Create a triggered activity with callback
var request = webOS.service.request('luna://com.palm.activitymanager', {
  method: 'create',
  parameters: {
    activity: {
      name: 'triggeredActivity',
      description: 'Test create Activity with Trigger',
      type: {
        background: true,
      },
      trigger: {
        method: 'luna://com.palm.connectionmanager/getStatus',
        params: { subscribe: true },
      },
      callback: {
        method: 'luna://com.webos.applicationManager/launch',
        params: {
          id: 'com.yourdomain.app.downloader',
        },
      },
    },
    start: true,
    subscribe: true,
  },
  onSuccess: function (inResponse) {
    if (!inResponse.event) {
      console.log('The scheduled Activity is created');
      // To-Do something
    } else {
      console.log('Received event: ' + inResponse.event);
      console.log('Audio will be muted');
      // To-Do something
    }
  },
  onFailure: function (inError) {
    console.log('Failed to create the Activity');
    console.log('[' + inError.errorCode + ']: ' + inError.errorText);
    // To-Do something
    return;
  },
});
```

--------------------------------

### Get response with revision set

Source: https://webostv.developer.lge.com/develop/guides/db8-usage

Example response from the get call showing the record with the stateRev property set to the current revision number.

```json
get success!, results ={
  "returnValue":true,
  "results":[
  {
    "_id":"++HEIviIqT+9MYkj",
    "_kind":"com.yourdomain.sample:1",
    "_rev":4881,
    "name":"Mabel Syrup",
    "state":"CA",
    "stateRev":4881
  }]
}
```

--------------------------------

### Example file tree for webOS TV SDK on Linux

Source: https://webostv.developer.lge.com/develop/tools/webos-tv-cli-installation

Example file tree on Linux showing the expected structure under the LG_WEBOS_TV_SDK_HOME directory, including the CLI and Simulator subdirectories.

```text
/home/user/tool/
├── webOS_TV_SDK
│   ├── CLI
│   │   ├── bin
│   │   └── ...
│   ├── Simulator
│   │   ├── webOS_TV_23_Simulator_1.3.0
│   │   │   ├── webOS_TV_23_Simulator_1.3.0.appimage
│   │   │   └── ...
```

--------------------------------

### Verify webOS TV CLI installation with ares -V

Source: https://webostv.developer.lge.com/develop/tools/webos-tv-cli-installation

Run this command to verify the webOS TV CLI installation. A successful installation displays the CLI version, for example 'webOS TV CLI Version: 1.12.4-j27'.

```bash
$ ares -V
webOS TV CLI Version: 1.12.4-j27
```

--------------------------------

### getInfo method return examples

Source: https://webostv.developer.lge.com/develop/references/camera

Example responses from the getInfo method. Shows the structure for camera and microphone devices, and a failure case with errorCode and errorText.

```json
// Camera device information
{
  'returnValue': true,
  'info': {
      'name': 'BC600 Camera',
      'type': 'camera',
      'builtin': true,
      'details': {
          'video': {
              'maxWidth': 1920,
              'maxHeight': 1080
          },
          'picture': {
              'maxWidth': 3264,
              'maxHeight': 2448
          },
          'format': 'H264ES|H264TS|SECS|MP4|'
      }
  }
}

// Microphone device information
{
  'returnValue': true,
  'info': {
      'name': 'BC600 Camera',
      'type': 'microphone',
      'builtin': true,
      'details': {
          'samplingRate': 'WB',
          'codec': 'PCM'
      }
  }
}

// Failure return
{
  'returnValue': false,
  'errorCode': '32',
  'errorText': 'Wrong param'
}
```

--------------------------------

### getAppLoadStatus: Success return example

Source: https://webostv.developer.lge.com/develop/references/application-manager

Example of a successful response from the getAppLoadStatus method. The 'exist' property indicates whether the app is installed, and 'returnValue' indicates the success of the request.

```json
// Success return
{
  "exist": true,
  "returnValue": true
}
```

--------------------------------

### Create package file with output directory

Source: https://webostv.developer.lge.com/develop/tools/webos-tv-cli-dev-guide

Creates a package file from the ./sampleApp directory and outputs it in the ./output directory.

```bash
ares-package -o output sampleApp

```

--------------------------------

### ares-novacom

Source: https://webostv.developer.lge.com/develop/tools/webos-tv-cli-dev-guide

Gets a private key from webOS TV for the Developer Mode app. After getting the private key, you can install and launch apps or run a command on webOS TV.

```APIDOC
## ares-novacom

### Description
Gets a private key from webOS TV for the Developer Mode app. After getting the private key, you can install and launch apps or run a command on webOS TV.

### Usage
```
ares-novacom [OPTION...] --forward|-f [--port|-p DEVICE_PORT1[:HOST_PORT1]][--port|-p DEVICE_PORT2]][...]
ares-novacom [OPTION...] --getkey|-k
ares-novacom [OPTION...] --run|-r DEVICE_COMMAND
ares-novacom --device|-d
ares-novacom --device-list
ares-novacom --version|-V
ares-novacom --help|-h
```

### Options
- **-d, --device** (TARGET_DEVICE) - Specifies the target device on which the command is executed.
- **-f, --forward** (List of -p, -port options) - Enables port forwarding between the host PC and the target device. You can specify a port number with additional option (`-p`,`--port` option).
- **-p, --port** (DEVICE_PORT[:HOST_PORT]) - Specifies a port for port forwarding.
- **-k, --getkey** (None) - Gets the private key from webOS TV. Before using this option, you should run the Developer Mode app on your webOS TV.
- **-r, --run** (DEVICE_COMMAND) - Executes a command on the shell of the target device.
- **-D, --device-list** (None) - Lists available target devices.
- **-v** (None) - Displays the execution log.
- **--version** (None) - Displays the version of the `ares-novacom` command.
- **-h, --help** (None) - Displays the help of the `ares-novacom` command.

### Parameters
- **DEVICE_PORT** - Specifies the target device’s port number for port forwarding between the host PC and the target device. If only `DEVICE_PORT` is specified, the host PC uses the same port number for port forwarding.
- **HOST_PORT** - Specifies the host PC’s port number for port forwarding between the host PC and the target device.
- **DEVICE_COMMAND** - Specifies the command that runs on the shell of the target device.

### Examples
- Get the private key from webOS TV named `tv` (Needed the Developer Mode app setting)
```
ares-novacom --device tv --getkey
```
- Set port forwarding between emulator (6622) and host PC (3030)
```
ares-novacom --device emulator --forward --port 6622:3030
```
- Run the `ps aux` command on webOS TV named `tv`
```
ares-novacom --device tv --run "ps aux"
```
```

--------------------------------

### Retrieve data objects with webOS service 'get' method

Source: https://webostv.developer.lge.com/develop/references/media-database

Example of using the 'get' method of the com.palm.db service to retrieve JSON data objects by ids, followed by the expected response object.

```javascript
var request = webOS.service.request('luna://com.palm.db', {
  method: 'get',
  parameters: {
    ids: ['J8rKTaBClIo'],
  },
  onSuccess: function (inResponse) {
    console.log(inResponse.results.length + ' object(s) is(are) retrieved');
    console.log('Result: ' + JSON.stringify(inResponse));
    // To-Do something
  },
  onFailure: function (inError) {
    console.log('Failed to get the obejct(s)');
    console.log('[' + inError.errorCode + ']: ' + inError.errorText);
    // To-Do something
    return;
  },
});
```

```json
{
  "returnValue": true,
  "results": [
    {
      "_rev": 21,
      "sample": "sample1",
      "test": "test1",
      "_id": "J8rKTaBClIo",
      "_kind": "com.yourdomain.test:1"
    }
  ]
}
```

--------------------------------

### List configured devices with ares-setup-device --list

Source: https://webostv.developer.lge.com/develop/getting-started/developer-mode-app

Checks the result after adding the TV as the target device.

```bash
ares-setup-device --list
```

--------------------------------

### Get revision set number using get

Source: https://webostv.developer.lge.com/develop/guides/db8-usage

Retrieves the record by id to obtain the revision set number. Note: the code uses 'id1' which is not defined in the example; the actual id from the put response is used.

```javascript
var id = '++HEIviIqT+9MYkj';
var ids = [id1];
var parameter = { ids: ids };
var request = new enyo.ServiceRequest();
request.service = 'luna://com.palm.db/get';
request.go(parameter);
```

--------------------------------

### List devices with full details using ares-setup-device --listfull

Source: https://webostv.developer.lge.com/develop/tools/cli-dev-guide

Displays detailed device information in JSON format using the -F, --listfull options. The output includes profile, name, deviceinfo, connection, and details for each device.

```bash
ares-setup-device --listfull
[
  {
    "profile": "tv",
    "name": "tv",
    "deviceinfo": {
        "ip": "10.123.45.67",
        "port": "9922",
        "user": "prisoner"
    },
    "connection": [
        "ssh"
    ],
    "details": {
        "platform": "starfish",
        "privatekey": "tv_webos",
        "passphrase": "ares-setup-device --full",
        "description": "new device"
    }
  },
  {
    "profile": "tv",
    "name": "emulator",
    "deviceinfo": {
        "ip": "127.0.0.1",
        "port": "6622",
        "user": "developer"
    },
    "connection": [
    "ssh"
    ],
    "details": {
        "platform": "starfish",
        "privatekey": "webos_emul",
        "description": "LG webOS TV Emulator"
    }
  }
]
```

--------------------------------

### fetchAppInfo example: get app root path and read appinfo.json

Source: https://webostv.developer.lge.com/develop/references/webostvjs-webos

Calls webOS.fetchAppRootPath() to get the app root path. If the path is not empty, it calls webOS.fetchAppInfo with a callback that checks the version from appinfo.json. On failure, logs an error.

```javascript
var path = webOS.fetchAppRootPath();
if (path.length !== 0) {
  // It works only in the case of packaged application
  webOS.fetchAppInfo(function (info) {
    if (info) {
      var version = info.version && info.version.split('.');
      if (Number(version[0]) > 1) {
        // different implementation
      }
    } else {
      console.error('Error occurs while getting appinfo.json.');
    }
  }, path + 'appinfo.json');
} else {
  console.error('Getting application root path failed.');
}
```

--------------------------------

### Start interactive mode with ares-setup-device

Source: https://webostv.developer.lge.com/develop/tools/cli-dev-guide

Starts the interactive mode of ares-setup-device by running it with no options. Shows the device list and prompts to add, modify, or remove a device.

```bash
ares-setup-device

name     deviceinfo                connection  profile
-------- ------------------------  ----------  --------
tv       prisoner@10.123.45.67     ssh         tv
emulator developer@127.0.0.1:6622  ssh         tv

** You can modify the device info in the above list, or add new device.
? Select
> add
  modify
  remove
```

--------------------------------

### Start local server and open browser with ares-server --open

Source: https://webostv.developer.lge.com/develop/tools/cli-dev-guide

Starts the local web server and opens the app in the default browser using the --open option of ares-server. Terminate the server with Ctrl+C.

```bash
ares-server ./sampleApp --open
```

--------------------------------

### fetchAppId example: get app ID and request DRM service

Source: https://webostv.developer.lge.com/develop/references/webostvjs-webos

Calls webOS.fetchAppId() to get the app ID. If the ID is not empty, it uses webOS.service.request to load the DRM service with the app ID and drmType 'playready'. On failure, logs an error.

```javascript
var appId = webOS.fetchAppId();
if (appId.length !== 0) {
  webOS.service.request('com.webos.service.drm', {
    method: 'load',
    parameters: {
      appId: appId,
      drmType: 'playready',
    },
    onSuccess: function (res) {
      // sendDrmMessage
    },
    onFailure: function (res) {
      // error handling
    },
  });
} else {
  console.error('Getting application ID failed.');
}
```

--------------------------------

### Retrieve JSON data objects with webOS.service.request 'get' method

Source: https://webostv.developer.lge.com/develop/references/database

Example of calling the 'get' method on the luna://com.palm.db service to retrieve JSON data objects by ids. The request uses the webOS.service.request API with an ids parameter and defines onSuccess and onFailure callbacks. The displayed response shows a successful return with returnValue true and a results array containing the retrieved object.

```javascript
var request = webOS.service.request('luna://com.palm.db', {
  method: 'get',
  parameters: {
    ids: ['J8rKTaBClIo'],
  },
  onSuccess: function (inResponse) {
    console.log(inResponse.results.length + ' object(s) is(are) retrieved');
    console.log('Result: ' + JSON.stringify(inResponse));
    // To-Do something
  },
  onFailure: function (inError) {
    console.log('Failed to get the object(s)');
    console.log('[' + inError.errorCode + ']: ' + inError.errorText);
    // To-Do something
    return;
  },
});
```

```json
{
  "returnValue": true,
  "results": [
      {
          "_rev": 21,
          "sample": "sample1",
          "test": "test1",
          "_id": "J8rKTaBClIo",
          "_kind": "com.yourdomain.test:1"
      }
  ]
}
```

--------------------------------

### alexa-setup-device DEVICE_INFO JSON example

Source: https://webostv.developer.lge.com/develop/tools/webos-tv-cli-dev-guide

Example DEVICE_INFO in JSON format, specifying host and port. This format is used with the -i/--info option to configure a target device.

```json
{"host":"127.0.0.1", "port":"6622"}
```

--------------------------------

### getState: Success return example

Source: https://webostv.developer.lge.com/develop/references/ble-gatt

Example of a successful response, showing the structure with subscribed, returnValue, version, isScan, connectedDevice, and pairedDevice arrays.

```json
{
  "subscribed": true,
  "returnValue": true,
  "version": "1.0",
  "isScan": false,
  "connectedDevice": [
    {
      "address": "45:8b:7f:e0:56:45",
      "name": "LG TV"
    },
    {
      "address": "aa:bb:cc:dd:ee:ff",
      "name": "soundbar"
    }
  ],
  "pairedDevice": [
    {
      "address": "45:8b:7f:e0:56:45",
      "name": "LG TV"
    },
    {
      "address": "aa:bb:cc:dd:ee:ff",
      "name": "soundbar"
    }
  ]
}
```

--------------------------------

### Get caption settings with webOS.service.request

Source: https://webostv.developer.lge.com/develop/references/settings-service

These examples show how to retrieve caption settings from the webOS settings service using the getSystemSettings method. Each request targets a specific caption key (captionBgOpacity, captionEdgeType, captionEdgeColor, captionWindowColor, captionWindowOpacity) and logs the response or error. The final snippet demonstrates unsubscribing with the cancel() method on a subscription handle.

```javascript
// Get captionBgOpacity information
var captionBgOpacityRequest = webOS.service.request(
  "luna://com.webos.settingsservice",
  {
    method: "getSystemSettings",
    parameters: {
      category: "caption",
      keys: ["captionBgOpacity"],
    },
    onSuccess: function (inResponse) {
      console.log("Result: " + JSON.stringify(inResponse));
      // To-Do something
    },
    onFailure: function (inError) {
      console.log("Failed to get settings' value");
      console.log("[" + inError.errorCode + "]: " + inError.errorText);
      // To-Do something
      return;
    },
  },
);
```

```javascript
// Get captionEdgeType information
var captionEdgeTypeRequest = webOS.service.request(
  "luna://com.webos.settingsservice",
  {
    method: "getSystemSettings",
    parameters: {
      category: "caption",
      keys: ["captionEdgeType"],
    },
    onSuccess: function (inResponse) {
      console.log("Result: " + JSON.stringify(inResponse));
      // To-Do something
    },
    onFailure: function (inError) {
      console.log("Failed to get settings' value");
      console.log("[" + inError.errorCode + "]: " + inError.errorText);
      // To-Do something
      return;
    },
  },
);
```

```javascript
// Get captionEdgeColor information
var captionEdgeColorRequest = webOS.service.request(
  "luna://com.webos.settingsservice",
  {
    method: "getSystemSettings",
    parameters: {
      category: "caption",
      keys: ["captionEdgeColor"],
    },
    onSuccess: function (inResponse) {
      console.log("Result: " + JSON.stringify(inResponse));
      // To-Do something
    },
    onFailure: function (inError) {
      console.log("Failed to get settings' value");
      console.log("[" + inError.errorCode + "]: " + inError.errorText);
      // To-Do something
      return;
    },
  },
);
```

```javascript
// Get captionWindowColor information
var captionWindowColorRequest = webOS.service.request(
  "luna://com.webos.settingsservice",
  {
    method: "getSystemSettings",
    parameters: {
      category: "caption",
      keys: ["captionWindowColor"],
    },
    onSuccess: function (inResponse) {
      console.log("Result: " + JSON.stringify(inResponse));
      // To-Do something
    },
    onFailure: function (inError) {
      console.log("Failed to get settings' value");
      console.log("[" + inError.errorCode + "]: " + inError.errorText);
      // To-Do something
      return;
    },
  },
);
```

```javascript
// Get captionWindowOpacity information
var captionWindowOpacityRequest = webOS.service.request(
  "luna://com.webos.settingsservice",
  {
    method: "getSystemSettings",
    parameters: {
      category: "caption",
      keys: ["captionWindowOpacity"],
    },
    onSuccess: function (inResponse) {
      console.log("Result: " + JSON.stringify(inResponse));
      // To-Do something
    },
    onFailure: function (inError) {
      console.log("Failed to get settings' value");
      console.log("[" + inError.errorCode + "]: " + inError.errorText);
      // To-Do something
      return;
    },
  },
);
```

```javascript
// If you need to unsubscribe the data, use cancel() method as below
    subscriptionHandle.cancel();
```

--------------------------------

### Run webOS TV plugin installer for Linux, macOS, or Windows

Source: https://webostv.developer.lge.com/develop/tools/sublime-configuring-webos-tv-plugin

Run the appropriate installer script for your operating system to manually install the webOS TV plugin for Sublime Text. The plugin is automatically installed if Sublime Text is already present when the SDK installer runs.

```bash
<SDK_Installed_Path>/SublimePlugin/webOS_plugin_install_linux.sh
```

```bash
<SDK_Installed_Path>/SublimePlugin/webOS_plugin_install_mac.sh
```

```batch
<SDK_Installed_Path>\SublimePlugin\webOS_plugin_install.bat
```

--------------------------------

### Create appinfo.json from template and sample output

Source: https://webostv.developer.lge.com/develop/tools/cli-dev-guide

Creates an appinfo.json file from the 'webappinfo' template into the sampleApp directory. The generated file contains sample values for app metadata such as id, version, vendor, type, main, title, icon, and largeIcon.

```bash
ares-generate -t webappinfo ./sampleApp
```

```json
{
  "id": "com.domain.app",
  "version": "0.0.1",
  "vendor": "My Company",
  "type": "web",
  "main": "index.html",
  "title": "new app",
  "icon": "icon.png",
  "largeIcon": "largeIcon.png"
}
```

--------------------------------

### Run app on emulator

Source: https://webostv.developer.lge.com/develop/tools/webos-tv-cli-dev-guide

Runs the app with ID com.example.sampleapp on the emulator.

```bash
ares-launch --device emulator com.example.sampleapp

```

--------------------------------

### start

Source: https://webostv.developer.lge.com/develop/references/activity-manager

Attempts to start the specified Activity.

```APIDOC
## start

### Description
Attempts to start the specified Activity.

### Method
POST

### Endpoint
luna://com.palm.activitymanager/start

### Parameters
No parameters documented.

### Response
No response fields documented.

```

--------------------------------

### ares-setup-device usage syntax

Source: https://webostv.developer.lge.com/develop/tools/webos-tv-cli-dev-guide

List of all valid command forms for the ares-setup-device CLI tool. Use these when setting up or managing webOS TV devices from the command line.

```bash
ares-setup-device
ares-setup-device [OPTIONS...] --add|-a [TARGET_NAME] [--info|-i [DEVICE_INFO]]
ares-setup-device [OPTIONS...] --modify|-m [TARGET_NAME] [--info|-i [DEVICE_INFO]]
ares-setup-device [OPTIONS...] --remove|-r [TARGET_NAME]
ares-setup-device [OPTIONS...] -f, --default [TARGET_NAME]
ares-setup-device --search|-s
ares-setup-device [--search|-s] --timeout|-t [TIMEOUT]
ares-setup-device --reset|-R
ares-setup-device --list|-l
ares-setup-device --listfull|-F
ares-setup-device --version|-V
ares-setup-device --help|-h
```

--------------------------------

### List installed apps with ares-install --list

Source: https://webostv.developer.lge.com/develop/tools/cli-dev-guide

Lists installed app IDs on the target device. Use this to verify that your app ID exists after installation.

```bash
ares-install --device myTV --list
```

--------------------------------

### Install web app package with ares-install

Source: https://webostv.developer.lge.com/develop/tools/cli-dev-guide

Installs the package file on the target device. Requires the target device to be running. A success message is shown if installation is successful.

```bash
ares-install --device myTV ./com.domain.app_0.0.1_all.ipk
```

--------------------------------

### DEVICE_INFO JSON example

Source: https://webostv.developer.lge.com/develop/tools/cli-dev-guide

Example DEVICE_INFO value in JSON format for the --info option. Use keys like host and port to specify device connection details.

```json
{'host':'10.123.45.67', 'port':'9922'}

```
Tokens:
Raw