webOS Open Source Edition

https://www.webosose.org/docs/
Admin
webOS Open Source Edition is an open-source operating system platform for smart devices that enables...
Tokens:992,878
Snippets:8,844
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Application Example

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-appinstallservice

This example demonstrates how to install an application using its ID and IPK URL. It also shows how to subscribe for installation status updates.

```shell
# luna-send -i -f luna://com.webos.appInstallService/install '{  
"id":"com.test.app.hello",  
"ipkUrl":"/media/internal/downloads/com.test.app.hello_0.0.1_all.ipk",  
"subscribe":true   
}'
```

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

### Activity Start Event Subscription Example

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-activitymanager

Example JSON object for subscribing to activity events, specifically the 'start' event. This shows the structure of a subscription response when an activity begins.

```json
{
"activityId": 10813,
"event": "start",
"returnValue": true
}
```

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

### Initialize Build Environment

Source: https://www.webosose.org/docs/iot/setup/building-webos-iot

Source the environment setup script to initialize the build environment before starting the BitBake process.

```bash
$ source oe-init-build-env
```

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

### Get Application Info Example

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-applicationmanager

Use this command to retrieve information about a specific application. Ensure the 'id' parameter is correctly specified.

```bash
# luna-send -n 1 -f luna://com.webos.service.applicationmanager/getAppInfo '{  
"id":"com.webos.app.test"
}'
```

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

### Application Launching Event

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-applicationmanager

This is an example of the output received when an application, such as 'barenativeqt', starts launching. It includes details like app ID, status, and type.

```json
{
"reason":"",
"appId":"barenativeqt",
"status":"launching",
"type":"native"
}
```

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

### Get Foreground App Info

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-surfacemanager

Retrieves information about the application currently in the foreground. This example shows the output for a multiview setup.

```bash
# luna-send -n 1 luna://com.webos.surfacemanager/getForegroundAppInfo '{}' 
{
"foregroundAppInfo": [
{
"appId": "com.webos.app.livetv",
"displayId": 0,
"multiview": true,
"params": {
},
"pip": false,
"primary": true,
"processId": "2419",
"viewType": "mvsxs",
"windowGroup": true,
"windowGroupOwner": true,
"windowGroupOwnerId": "",
"windowType": "_WEBOS_WINDOW_TYPE_CARD"
},
{
"appId": "com.webos.app.browser",
"displayId": 0,
"multiview": true,
"params": {
},
"pip": false,
"primary": false,
"processId": "22382",
"viewType": "mvsxs",
"windowGroup": false,
"windowType": "_WEBOS_WINDOW_TYPE_CARD"
}
],
"mode": "multiview",
"returnValue": true
}
```

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

### Main Application Entry Point

Source: https://www.webosose.org/docs/tutorials/native-apps/developing-built-in-native-apps

Sets up the Qt application, initializes the window, registers services, and configures window properties for display affinity.

```cpp
#include "MyOpenGLWindow.h"
#include "ServiceRequest.h"
#include <QGuiApplication>
#include <QWindow>
#include <QScreen>
#include <qpa/qplatformnativeinterface.h>

int main(int argc, char **argv)
{
    QGuiApplication app(argc, argv);
    PmLogInfo(getPmLogContext(), "MAIN_ARGV1", 1, PMLOGKFV("argv", "%s", argv[1]),  " ");

    QString displayId = (getenv("DISPLAY_ID") ? getenv("DISPLAY_ID"): "0");
    PmLogInfo(getPmLogContext(), "DISPLAY", 1, PMLOGKFV("Id", "%s", displayId.toStdString().c_str()),  " ");

    QScreen *screen = QGuiApplication::primaryScreen();
    QRect screenGeometry = screen->geometry();
    MyOpenGLWindow window(screenGeometry);
    window.resize(screenGeometry.width(), screenGeometry.height());
    window.show();

    ServiceRequest s_request("com.example.app.nativeqt", window);
    s_request.registerApp();

    QGuiApplication::platformNativeInterface()->setWindowProperty(window.handle(), "appId", "com.example.app.nativeqt");
    QGuiApplication::platformNativeInterface()->setWindowProperty(window.handle(), "displayAffinity", displayId);

    return app.exec();
}
```

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

### A2DP Get Status Example

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-bluetooth2

This example shows how to get the A2DP connection status for a remote device. You can specify the device address to get its status, or omit it to get the status of the device whose connection or playing status has most recently changed. Subscribing to notifications is optional.

```bash
# luna-send -i -f luna://com.webos.service.bluetooth2/a2dp/getStatus '{  
"address":"b8:ad:3e:bd:93:c2",  
"subscribe":true  
}'
```

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

### Quick Summary of Build Steps

Source: https://www.webosose.org/docs/guides/setup/building-webos-ose

A concise overview for experienced users, covering cloning, prerequisites, configuration, and building.

```bash
# Download source codes
$ git clone https://github.com/webosose/build-webos.git
$ cd build-webos

# Install and configure the build
$ sudo scripts/prerequisites.sh
$ ./mcf -p <half the num of CPUs> -b <half the num of CPUs> <image type>

# Start to build
$ source oe-init-build-env
$ bitbake webos-image

```

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

### Start Virtual Machine

Source: https://www.webosose.org/docs/tools/sdk/emulator/virtualbox-emulator/emulator-user-guide

Launch the configured webOS emulator virtual machine from the command line.

```bash
vboxmanage startvm webos-image
```

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

### Example: Await Media Meta Data Request with Subscription

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-bluetooth2

This example demonstrates how to subscribe to await media meta data requests. It shows the command to send and the expected response, including subscription status and adapter information.

```bash
# luna-send -f -i luna://com.webos.service.bluetooth2/avrcp/awaitMediaMetaDataRequest '{"subscribe":true}'
```

```json
{
"subscribed":true,
"adapterAddress":"00:00:c5:99:f5:87",
"returnValue":true
}
```

```json
Subscription response:
{
"requestId":"001",
"adapterAddress":"00:00:c5:99:f5:87",
"subscribed":true,
"address":"34:4d:f7:f9:52:f7",
"returnValue":true
}
```

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

### getAppBasePath

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-applicationmanager

Gets the path of the application. This API is useful to get the base directory path of an installed application.

```APIDOC
## getAppBasePath

### Description
Gets the path of the application.
**Note:** This API is useful to get base directory path of installed application.

### Parameters
#### Query Parameters
- **appId** (String) - Required - Indicates the appId.

### Call Returns
#### Success Response
- **returnValue** (Boolean) - Indicates the status of operation. Possible values are: true, false.
- **appId** (String) - Optional - Indicates the appId.
- **basePath** (String) - Optional - Indicates the application path.
- **errorText** (String) - Optional - Indicates the reason for the failure of the operation.
- **errorCode** (Number) - Optional - The error code for the failed operation.

### Error Codes Reference
- **None** - Not allowed. Allow only for the info of calling app itself.
- **None** - Error parsing request:Missing required key.
- **None** - Error parsing request:Not string.

### Request Example
```bash
luna-send -n 1 -a "bareapp" -f luna://com.webos.service.applicationmanager/getAppBasePath '{
"appId":"bareapp"
}'
```
```

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

### Initiate a Download

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-downloadmanager

Use this command to start a new download. Specify the target URL and optionally other parameters like destination path.

```bash
# luna-send -f -i luna://com.webos.service.downloadmanager/download '{"target" : "http://www.google.co.kr"}'
```

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

### Remove Application Example

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-appinstallservice

This example shows how to remove an installed application from the device using its ID. Subscription for removal status is optional.

```shell
# luna-send -i -f luna://com.webos.appInstallService/remove '{  
"id":"com.test.app.hello",  
"subscribe":true   
}'
```

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

### Create Scheduled Activity

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-activitymanager

Example of creating a scheduled activity with a specific start time. The activity will be created and optionally started immediately, with subscription for events.

```APIDOC
## POST luna://com.webos.service.activitymanager/create

### Description
Creates a new activity, which can be scheduled to start at a specific time or triggered by certain conditions. This example demonstrates creating a scheduled activity.

### Method
POST

### Endpoint
luna://com.webos.service.activitymanager/create

### Parameters
#### Request Body
- **activity** (object) - Required - Defines the properties of the activity.
  - **name** (string) - Required - The name of the activity.
  - **description** (string) - Optional - A description for the activity.
  - **type** (object) - Optional - Specifies the type of activity.
    - **foreground** (boolean) - Optional - Indicates if the activity is in the foreground.
  - **schedule** (object) - Optional - Defines the schedule for the activity.
    - **start** (string) - Required - The start time for the scheduled activity (e.g., "YYYY-MM-DD HH:MM:SS").
  - **callback** (object) - Optional - A callback to be executed when the activity starts or meets certain conditions.
    - **method** (string) - Required - The Luna service method to call for the callback.
    - **params** (object) - Optional - Parameters for the callback method.
- **start** (boolean) - Optional - If true, the activity will be started immediately upon creation.
- **subscribe** (boolean) - Optional - If true, the client will receive subscription notifications for activity events.

### Request Example
```json
{
  "activity": {
    "name": "ScheduledActivity",
    "description": "Test create of scheduled activity",
    "type": { "foreground": true },
    "schedule": { "start": "2015-02-15 13:22:00" }
  },
  "start": true,
  "subscribe": true
}
```

### Response
#### Success Response (200)
- **activityId** (integer) - The unique identifier for the created activity.
- **returnValue** (boolean) - True if the operation was successful.
- **subscribed** (boolean) - True if the client is subscribed to activity events.

#### Response Example
```json
{
  "activityId": 102,
  "returnValue": true,
  "subscribed": true
}
```

#### Subscription Response Example
```json
{
  "event": "start",
  "activityId": 102,
  "returnValue": true,
  "subscribed": true
}
```
```

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

### Flashing Command Example

Source: https://www.webosose.org/docs/iot/setup/flashing-webos-iot

An example demonstrating the unmount and dd commands to flash a specific webOS IoT image to a microSD card identified as /dev/sdb.

```bash
$ sudo umount /dev/sdb1
$ sudo dd bs=4M if=./webos-iot-image-raspberrypi4.rootfs.wic of=/dev/sdb
$ sudo umount /dev/sdb1
```

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

### Install Prerequisites

Source: https://www.webosose.org/docs/iot/setup/building-webos-iot

Install the necessary tools and libraries for the build process using the provided script. Failure to do so may result in BitBake sanity check failures.

```bash
$ sudo scripts/prerequisites.sh
```

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

### Get App Status (Fail Example)

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-applicationmanager

This example demonstrates the response when a call to getAppStatus fails due to invalid parameters. Check 'errorCode' and 'errorText' for details.

```bash
# luna-send -n 1 -f luna://com.webos.service.applicationmanager/getAppStatus '{  
"id":"com.webos.app.browser"
}'
```

```json
{
"errorCode":2,
"returnValue":false,
"errorText":"invalid parameters"
}
```

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

### Start Preview (With Window ID)

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-camera2

Turns on camera streaming and displays a preview on a specified surface using a window ID. Requires a handle and the window ID.

```bash
# luna-send -n 1 -f luna://com.webos.service.camera2/startPreview '{  
"handle": 189,  
"windowId": "_Window_Id_1"  
}'
```

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

### Install Perf Service Error

Source: https://www.webosose.org/docs/tools/sdk/beanviser/beanviser-user-guide

This is an example of an error message that may appear during the installation of the perf service. It indicates that the 'dev mode' is not enabled on the target device.

```text
Error Installing the perf service ...
luna-send command failed (Unknown method "install" for category "/dev/")
```

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

### Example services.json Configuration

Source: https://www.webosose.org/docs/guides/development/configuration-files/services-json

This is a sample services.json file that defines a service with its ID, description, engine type, executable, and a list of its own services.

```json
{
    "id": "com.test.testacct.test.service",
    "description": "Test Service",
    "engine": "native",
    "executable": "test_service",
    "services": [
        {
            "name": "com.test.testacct.test.service",
            "description": "Test Contact"
        }
    ]
}
```

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

### getGpsStatus

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-location

Gets the current status of the GPS engine. This is used to notify users when the GPS engine starts or stops. The engine starts when a method requiring it is called and stops when all requests are handled or canceled.

```APIDOC
## getGpsStatus

### Description
Gets the current status of the GPS engine. Used for notifying device users that the GPS engine has started or stopped. The GPS engine is started when a method that needs the engine to work is called, and it is turned off when all received requests have been handled or canceled.

**Prerequisite:** The GPS feature of the device must be powered ON for this method to work.

### Method
GET

### Endpoint
luna://com.webos.service.location/getGpsStatus

### Parameters
#### Query Parameters
- **subscribe** (Boolean) - Optional - Subscribe for notifications. `true` to receive notifications, `false` otherwise. Defaults to `true`.

### Response
#### Success Response (200)
- **state** (Boolean) - Indicates the status of the GPS engine. `true` if the engine has started, `false` if it has stopped.
- **returnValue** (Boolean) - Indicates the status of the operation. `true` for success, `false` for failure.
- **errorCode** (Number) - The error code for the failed operation.
- **errorText** (String) - Optional - Indicates the reason for the failure of the operation.

#### Subscription Returns
- **state** (Boolean) - Indicates the status of the GPS engine. `true` if the engine has started, `false` if it has stopped.
- **returnValue** (Boolean) - Indicates the status of the operation. `true` for success, `false` for failure.
- **errorCode** (Number) - The error code for the failed operation.
- **errorText** (String) - Optional - Indicates the reason for the failure of the operation.

### Response Example
**Example code**
```bash
luna-send -f -n 1 luna://com.webos.service.location/getGpsStatus '{}'
```
**Response**
```json
{
  "state": false,
  "errorCode": 0,
  "returnValue": true
}
```
**Subscription response**
```json
{
  "state": false,
  "errorCode": 0,
  "returnValue": true
}
```
```

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

### Get Delay Reporting Time Example

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-bluetooth2

This example demonstrates how to retrieve the delay reporting time for a Bluetooth A2DP connection. It requires specifying the adapter and device addresses and can optionally subscribe to notifications.

```bash
# luna-send -i -f luna://com.webos.service.bluetooth2/a2dp/getDelayReportingTime '{  
"adapterAddress":"0a:ad:3e:bd:93:c2",  
"address":"b8:ad:3e:bd:93:c2",  
"subscribe":true  
}'
```

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

### start

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-pipeline-camera

Starts the camera preview with specified video and memory configurations.

```APIDOC
## start

### Description
Starts the preview.

### Method
N/A (This is a service method, not an HTTP endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **appId** (String) - Required - Indicates the application ID.
- **windowId** (String) - Required - Window ID.
- **videoDisplayMode** (String) - Required - Indicates the display mode of the pipeline.
- **width** (Number) - Required - The width of the video.
- **height** (Number) - Required - The height of the video.
- **format** (String) - Required - Indicates the video format.
- **frameRate** (Number) - Required - Indicates the video frame rate.
- **memType** (String) - Required - Indicates the memory type.
- **memSrc** (String) - Required - Indicates the memory source.
- **primary** (Boolean) - Required - Indicates the priority.
- **cameraId** (String) - Required - Camera ID.

### Request Example
```bash
luna-send -n 1 -f luna://com.webos.pipeline.camera._ZuqSwL30000AlU/start '{
"appId": "com.webos.app.mediaevents-test",
"windowId": "_Window_Id_1",
"videoDisplayMode": "Textured",
"width": 1280,
"height": 720,
"format": "JPEG",
"frameRate": 30,
"memType": "shmem",
"memSrc": "7010",
"primary": true,
"cameraId": "camera1"
}'
```
(_ZuqSwL30000AlU : A random ID to identify the pipeline)

### Response
#### Success Response (200)
- **pid** (Number) - Process ID.
- **returnValue** (Boolean) - Indicates method execution status. Possible values are: true: Successful., false: Not successful. For details, see the 'Error Codes' table.

#### Response Example
```json
{
  "returnValue": true,
  "pid": 2322
}
```
```

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

### Install Application Response

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-appinstallservice

This is a sample response for the application installation request, indicating the subscription status and the success of the operation.

```json
{
  "subscribed": true,
  "returnValue": true
}
```

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

### Start Google Assistant Service

Source: https://www.webosose.org/docs/iot/development/use-cases/using-google-assistant

Use this command to start the Google Assistant service in continuous mode with keyword detection enabled. Ensure you have completed the Google Assistant setup and connected a microphone.

```shell
root@raspberrypi4:/sysroot/home/root# luna-send -n 1 -f luna://com.webos.service.ai.voice/start '{"mode": "continuous", "keywordDetect": true}'
{
    "returnValue": true
}

```

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

### Get App Property (Success)

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-preferences

Example of a successful call to retrieve a specific application property by its key.

```bash
# luna-send -n 1 -f luna://com.webos.service.preferences/appProperties/getAppProperty '{"appId": "com.webos.rdxd", "key": "reportIdNum"}'
{
"returnValue": true,
"reportIdNum": [
"7"
]
}
```

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

### Start App Mirroring

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-surfacemanager

Starts mirroring an application from one display to another. Ensure the 'from' and 'to' display IDs are valid.

```bash
# luna-send -n 1 -f luna://com.webos.surfacemanager/setAppMirroring '{ 
"mirror":true,
"from":0,
"to":1 
}'
Response:
{
"returnValue":true
}
```

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

### Get App Keys (Success)

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-preferences

Example of a successful call to retrieve all property keys for a specific application.

```bash
# luna-send -n 1 -f luna://com.webos.service.preferences/appProperties/getAppKeys '{"appId": "com.webos.rdxd"}'
[
"reportIdNum"
]
```

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

### Start Native Service

Source: https://www.webosose.org/docs/tutorials/native-services/developing-built-in-native-services

Use this command to start your native service. Ensure the service name matches your project.

```bash
systemctl start com.example.service.native
```

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

### Get Current Settings Example

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-settings

Retrieve settings for the current foreground application. This method supports subscribing to changes.

```bash
# luna-send -n 1 luna://com.webos.service.settings/getCurrentSettings '{
"category": "lock",
"keys": [
"applockPerApp"
]
}'
```

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

### Package App and Service

Source: https://www.webosose.org/docs/tutorials/js-services

Packages the dummy app and service together into an .ipk file for installation.

```bash
# Command format
# ares-package <APP DIRECTORY> <SERVICE DIRECTORY>
ares-package sampleApp sampleService

```

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

### Initialize and Log with pmloglib in C/C++

Source: https://www.webosose.org/docs/guides/development/logging/formatting-logs/using-pmloglib-in-c-cpp

Demonstrates how to initialize a log context and log an informational message with key-value pairs. Ensure a valid context name and log level are provided.

```cpp
PmLogContext my_context;
PmLogGetContext("context_name", &my_context);
PmLogInfo(my_context, "APPDEL", 3, PMLOGKS("APP_NAME","Solitaire"), PMLOGKFV("APP_ID","%d",app_id), PMLOGKS("APP_STATUS","deleted"), " ");
```

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

### Successful Get Details Response

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-activitymanager

Example of a successful response from the getDetails method, containing detailed activity information.

```json
{
  "activity": {
    "type": {
      "bus": "private",
      "foreground": true,
      "power": true,
      "persist": true
    },
    "name": "myactivity",
    "adopters": [],
    "callback": {
      "method": "luna://com.webos.service.test/callback"
    },
    "focused": true,
    "subscribers": [],
    "creator": {
      "serviceId": "com.webos.service.test"
    },
    "state": "waiting",
    "schedule": {
      "interval": "1d",
      "local": true,
      "lastFinished": "2015-03-20 00:37:38"
    },
    "description": "my test activity",
    "activityId": 36
  },
  "returnValue": true
}
```

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

### Resume Download Examples

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-downloadmanager

Examples show how to resume a download using a ticket and the expected response for a successful operation or when the ticket is not found.

```shell
/ # luna-send -f -i luna://com.webos.service.downloadmanager/resumeDownload '{"ticket" : 135}'


{


"subscribed": false,


"returnValue": true


}




Example response for a failed call : ticket is not found.  


/ # luna-send -f -i luna://com.webos.service.downloadmanager/resumeDownload '{"ticket" : 999}'


{


"subscribed": false,


"errorCode": "-1",


"errorText": "Ticket provided does not correspond to an interrupted transfer in history",


"returnValue": false

}
```

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

### getStatus

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-sdkagent

Gets the current status of the Telegraf service, indicating whether it is active or inactive, and whether it is configured to start on boot.

```APIDOC
## getStatus

### Description
Gets the status of the Telegraf service.

### Method
POST

### Endpoint
luna://com.webos.service.sdkagent/collector/getStatus

### Parameters
None

### Request Example
```json
{{}}
```

### Response
#### Success Response (200)
- **returnValue** (Boolean) - Indicates the status of the operation. `true` for success, `false` for failure.
- **status** (String) - The status of the Telegraf service. Possible values: `active`, `inactive`.
- **startOnBoot** (Boolean) - Optional - Indicates if the service is configured to start on device boot. `true` if configured, `false` otherwise.
```

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

### Get App Property (Failure - No Such Key)

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-preferences

Example of a failed call to retrieve an application property when the specified key does not exist.

```bash
# luna-send -n 1 -f luna://com.webos.service.preferences/appProperties/getAppProperty '{"appId": "com.webos.rdxd", "key": "reportIdNum"}'
{
"returnValue": false,
"errorText": "no such key"
}
```

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

### Install Prerequisites

Source: https://www.webosose.org/docs/tutorials/js-services/developing-built-in-js-services

Install the necessary prerequisites for building the webOS OSE platform.

```bash
sudo scripts/prerequisites.sh
```

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

### Install Prerequisites for Platform Build

Source: https://www.webosose.org/docs/tutorials/qml-apps/developing-built-in-qml-apps

Install the necessary prerequisites for building the webOS OSE platform.

```bash
sudo scripts/prerequisites.sh

```

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

### Get App Keys Object (Success)

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-preferences

Example of a successful call to retrieve all property keys for an application as a JSON object.

```bash
# luna-send -n 1 -f luna://com.webos.service.preferences/appProperties/getAppKeysObj '{"appId": "com.webos.rdxd"}'
{
"returnValue": true,
"values": [
"reportIdNum"
]
}
```

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

### Failed Get Details Response

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-activitymanager

Example of a failed response from the getDetails method, indicating an error such as an unknown activity ID.

```json
{
  "errorCode": 2,
  "returnValue": false,
  "errorText": "activityId not found"
}
```

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

### Flashing Command Example for Linux

Source: https://www.webosose.org/docs/guides/setup/flashing-webos-ose

A concrete example of flashing a webOS OSE image to a microSD card on Linux, demonstrating the use of `umount` and `dd` commands.

```bash
$ sudo umount /dev/sdb1
$ sudo dd bs=4M if=./webos-image-raspberrypi4.rootfs.wic of=/dev/sdb
$ sudo umount /dev/sdb1
```

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

### scan

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-configurator

Notifies the Configurator service about new resource files and requests processing for them. This is typically used when an application is installed or first started.

```APIDOC
## scan

### Description
Within the API call, application can notify Configurator about new resource files and ask Configurator to process those resource files. Example of use case: application installed and runs at first. Application at first startup can ask configurator to register kind for itself. For Path of resource files, see Runtime Configurator Directory in Overview section of this doc

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **id** (String) - Required - Application Id
- **type** (String) - Required - Either 'app' or 'service'
- **location** (String) - Required - Indicates if it is a system app or a third party app.

### Request Example
```json
[
  {
    "id": "com.webos.app.settings",
    "type": "app",
    "location": "system"
  }
]
```

### Response
#### Success Response (200)
- **returnValue** (Boolean) - Indicates the status of operation. Possible values are: true: Successful, false: Not successful.
- **configured** (Number) - The number of resources which were successfully processed.

#### Response Example
```json
{
  "configured": 0,
  "returnValue": true
}
```
```

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

### Initialize Build Environment and Build Image

Source: https://www.webosose.org/docs/guides/setup/bring-up-guide/bringing-up-jetson-nano

Source the build environment script and initiate the webOS OSE image build process using bitbake.

```bash
(build-webos)$ source ./oe-init-build-env
(build-webos)$ bitbake webos-image
```

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

### Get App Keys (Failure)

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-preferences

Example of a failed call to retrieve application property keys due to a missing appId parameter.

```bash
# luna-send -n 1 -f luna://com.webos.service.preferences/appProperties/getAppKeys '{}'
{
"returnValue": false,
"errorText": "no appId parameter found"
}
```

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

### Build QML App with Bitbake

Source: https://www.webosose.org/docs/tutorials/qml-apps/developing-built-in-qml-apps

Navigate to the build directory, source the environment setup script, and then use bitbake to build your QML application package.

```bash
cd build-webos
source oe-init-build-env
bitbake com.example.app.qml
```

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

### QML App Project Configuration (com.example.app.qml.pro)

Source: https://www.webosose.org/docs/tutorials/qml-apps/developing-built-in-qml-apps

Defines the build and installation procedures for a QML application. It specifies installation paths for application files, including QML, appinfo, and icons. Ensure WEBOS_INSTALL_WEBOS_APPLICATIONSDIR is correctly set.

```pro
TEMPLATE = aux
!load(webos-variables):error("Cannot load webos-variables.prf")

# install
defined(WEBOS_INSTALL_WEBOS_APPLICATIONSDIR, var) {
    INSTALL_APPDIR = $$WEBOS_INSTALL_WEBOS_APPLICATIONSDIR/com.example.app.qml
    target.path = $$INSTALL_APPDIR

    appinfo.path = $$INSTALL_APPDIR
    appinfo.files = appinfo.json

    base.path = $$INSTALL_APPDIR
    base.files = main.qml

    icon.path = $$INSTALL_APPDIR
    icon.files = icon.png

    INSTALLS += target appinfo base icon
}
```

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

### Remove App Example

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-appinstallservice

This example demonstrates how to initiate the removal of an application using the luna-send command. It includes a subscription to receive status updates during the removal process.

```bash
# luna-send -i -f luna://com.webos.appInstallService/remove '{"id":"com.test.app.hello", "subscribe":true}'
Response: For successful call
{
"subscribed": true,
"returnValue": true
}
```

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

### Get Application Base Path (getAppBasePath)

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-applicationmanager

Retrieves the base directory path for a specified installed application. Useful for accessing application-specific resources.

```shell
# luna-send -n 1 -a "bareapp" -f luna://com.webos.service.applicationmanager/getAppBasePath '{  
"appId":"bareapp"
}'
```

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

### Get Manager Info

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-applicationmanager

Retrieves information about the application manager, including details about installed applications, launch points, and currently running applications.

```APIDOC
## managerInfo

### Description
Retrieves comprehensive information about the application manager, including lists of installed applications, defined launch points, and currently running application instances.

### Method
Call

### Endpoint
luna://com.webos.applicationManager/dev/managerInfo

### Parameters
#### Request Body
- **{}** (string) - Required - An empty JSON object is expected.

### Request Example
```json
{
  "service": "com.webos.applicationManager",
  "method": "dev/managerInfo",
  "payload": {}
}
```

### Response
#### Success Response (200)
- **returnValue** (boolean) - Indicates if the call was successful.
- **launchPoints** (array) - An array of objects, each representing a launch point for an application.
- **running** (array) - An array of objects, each representing a currently running application instance.
- **apps** (array) - An array of objects, each representing an installed application.

#### Response Example
```json
{
  "launchPoints": [
    {
      "checkUpdateOnLaunch": true,
      "title": "Bare App",
      "icon": "/usr/palm/applications/bareapp/icon.png",
      "tileSize": "normal",
      "inAppSetting": false,
      "miniicon": "icon.png",
      "folderPath": "/usr/palm/applications/bareapp",
      "lptype": "default",
      "transparent": false,
      "icons": [],
      "version": "1.0.1",
      "hasPromotion": false,
      "lockable": true,
      "trustLevel": "default",
      "bgImage": "",
      "systemApp": true,
      "launchPointId": "bareapp_default",
      "main": "index.html",
      "visible": true,
      "largeIcon": "/usr/palm/applications/bareapp/icon.png",
      "privilegedJail": false,
      "inspectable": false,
      "imageForRecents": "",
      "defaultWindowType": "card",
      "vendor": "LG Electronics, Inc.",
      "accessibility": {
        "supportsAudioGuidance": false
      },
      "deeplinkingParams": "",
      "type": "web",
      "spinnerOnLaunch": true,
      "id": "bareapp",
      "disableBackHistoryAPI": false,
      "favicon": "",
      "handlesRelaunch": false,
      "noSplashOnLaunch": false,
      "removable": false,
      "unmovable": false,
      "uiRevision": "2"
    }
  ],
  "returnValue": true,
  "lunaTasks": [
    {
      "caller": "com.webos.lunasend-1851",
      "kind": "/dev/managerInfo"
    }
  ],
  "running": [
    {
      "appType": "web",
      "displayId": 0,
      "instanceId": "03419c62-edad-4031-8ffb-c2494170befc0",
      "launchPointId": "com.webos.app.volume_default",
      "webprocessid": "1161",
      "id": "com.webos.app.volume",
      "processid": "-1",
      "defaultWindowType": "system_ui"
    }
  ],
  "apps": [
    {
      "checkUpdateOnLaunch": true,
      "title": "Bare App",
      "icon": "icon.png",
      "tileSize": "normal",
      "inAppSetting": false,
      "miniicon": "icon.png",
      "folderPath": "/usr/palm/applications/bareapp",
      "transparent": false,
      "version": "1.0.1",
      "icons": [],
      "hasPromotion": false,
      "lockable": true,
      "trustLevel": "default",
      "systemApp": true,
      "largeIcon": "icon.png",
      "main": "index.html",
      "visible": true,
      "privilegedJail": false,
      "inspectable": false,
      "defaultWindowType": "card",
      "vendor": "LG Electronics, Inc.",
      "deeplinkingParams": "",
      "type": "web",
      "accessibility": {
        "supportsAudioGuidance": false
      },
      "spinnerOnLaunch": true,
      "id": "bareapp",
      "disableBackHistoryAPI": false,
      "handlesRelaunch": false,
      "noSplashOnLaunch": false,
      "removable": false,
      "unmovable": false,
      "uiRevision": "2"
    }
  ]
}
```
```

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

### Install Prerequisites

Source: https://www.webosose.org/docs/guides/setup/building-webos-ose

Force the installation of all missing software required for the build process. This script installs necessary tools and libraries.

```bash
$ sudo scripts/prerequisites.sh

```

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

### Get Multiple Preferences Example

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-systemservice

Retrieves values for multiple preference keys, such as 'locale'. This method supports subscribing to changes for dynamic updates.

```bash
# luna-send -n 1 -f luna://com.webos.service.systemservice/getPreferences '{"keys": ["locale"]}'
```

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

### Wallpaper Example

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-systemservice

This example shows the structure for defining wallpaper properties, including the wallpaper name and file paths for the wallpaper and its thumbnail.

```json
"wallpaper": {
"wallpaperName": "flowers.png",
"wallpaperFile": "/media/internal/.wallpapers/flowers.png",
"wallpaperThumbFile": "/media/internal/.wallpapers/thumbs/flowers.png"
}
```

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

### Set Up NDK Environment

Source: https://www.webosose.org/docs/guides/setup/setting-up-native-development-kit

Source the environment setup file to configure your current shell session with the NDK paths and variables. This makes the NDK tools available for use.

```bash
$ source /usr/local/webos-sdk-x86_64/environment-setup-cortexa72-webos-linux
```

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

### Filter Luna Services by Pattern

Source: https://www.webosose.org/docs/tools/commands/ls-monitor

Use grep with a pattern to filter services. This example searches for services whose names start with 'com.webos.service'.

```bash
$ ls-monitor -l | grep 'com.webos.service*'
988             com.webos.service.ime           /usr/sbin/MaliitServer                  static                  4bVcR4sI
988             com.webos.service.ime.globalplugin      /usr/sbin/MaliitServer                  static                  CLWsVoGP
378             com.webos.service.pdm           /usr/sbin/physical-device-manager       static                  EiUUeTcR
780             com.webos.service.downloadmanager       /usr/bin/LunaDownloadMgr                static                  0vamvcPe
1038            com.webos.service.contextintentmgr      /usr/bin/node                           static                  UMMQl4Zt
...


```

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

### Failed Get Current Settings Response

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-settings

Example of a failed response when retrieving current settings, indicating an error such as no matched result from the database.

```json
{
"errorText": "There is no matched result from DB",
"app_id": "com.webos.app.live",
"category": "lock",
"method": "getSystemSettings",
"returnValue": false
}
```

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

### Build and Deploy webOS Application

Source: https://www.webosose.org/docs/tutorials/web-apps/developing-built-in-web-apps

Navigate to the build directory, initialize the build environment, and then use 'bitbake' to build your application. This is the standard workflow for creating webOS applications.

```bash
cd build-webos
source oe-init-build-env
bitbake com.example.app.web
```

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

### Get Foreground App Info (Picture-in-Picture)

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-surfacemanager

Retrieves foreground application information, specifically for a picture-in-picture (PiP) scenario within a multiview setup.

```bash
# luna-send -n 1 luna://com.webos.surfacemanager/getForegroundAppInfo '{}' 
{
"foregroundAppInfo": [
{
"appId": "com.webos.app.livetv",
"displayId": 0,
"multiview": true,
"params": {
},
"pip": false,
"primary": true,
"processId": "2419",
"viewType": "mvpip",
"windowGroup": true,
"windowGroupOwner": true,
"windowGroupOwnerId": "",
"windowType": "_WEBOS_WINDOW_TYPE_CARD"
},
{
"appId": "com.webos.app.browser",
"displayId": 0,
"multiview": true,
"params": {
},
"pip": true,
"primary": false,
"processId": "22382",
"viewType": "mvpip",
"windowGroup": false,
"windowType": "_WEBOS_WINDOW_TYPE_CARD"
}
],
"mode": "multiview",
"returnValue": true
}
```

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

### Get Bluetooth Mesh Configuration (GATT Proxy)

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-bluetooth2

Retrieves specific configuration parameters for a Bluetooth mesh node. This example shows how to get the GATT proxy state for a given destination address and netKeyIndex. Ensure 'subscribe' is set to true to receive notifications.

```bash
# luna-send -i -f luna://com.webos.service.bluetooth2/mesh/model/config/get '{  
"destAddress":173,  
"config":"GATT_PROXY",  
"netKeyIndex": 0,  
"subscribe":true  
}'
```

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

### Get List of Media Indexer Plugins

Source: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-mediaindexer

Fetches a list of all available media indexer plugins. This is useful for discovering which plugins are installed and ready to be used.

```bash
# luna-send -n 1 -f luna://com.webos.service.mediaindexer/getPluginList '{}'
```
Tokens:
Raw