Android Automotive

https://source.android.com/docs/automotive
Admin
Android Automotive is a specialized version of the Android operating system designed for in-vehicle...
Tokens:356,885
Snippets:4,348
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Service Bundle Configuration Sample

Source: https://source.android.com/docs/automotive/sdv/core-areas/orchestrator

Example configuration for starting service bundle instances based on TURN and FOG custom modes.

```textproto
service_bundle_config {
package_name: "oem.package"
service_bundle_name: "OemApplication"
instance: "flasher_light"
// Service bundle is allowed to set values for the TURN mode
custom_mode: "TURN"
// Service bundle is allowed to set values for the FOG mode
custom_mode: "FOG"

state {
    condition {
        custom_state {
            mode: "TURN"
            state: "LEFT"
        }
    }
    instances_states {
        started: "flasher_light"
    }
}

state {
    condition {
        custom_state {
            mode: "FOG"
            state: "ON"
        }
    }
    // Group assumed to be defined containing all FOG lights instances.
    groups_states {
        started: "fog_lights"
    }
}

}
```

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

### Build Configuration Usage Example

Source: https://source.android.com/docs/automotive/sdv/core-areas/vsidl/language-specification

Example configuration for build settings.

```text
build_cfg {
  target_name: "my_custom_target_name"
  skip_codegen: false
}
```

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

### Example Publisher Configuration

Source: https://source.android.com/docs/automotive/sdv/core-areas/vsidl/language-specification

Basic configuration example for a Publisher instance.

```text
publisher {
  message: "SeatHeating"
  topic: "driver-heating"
  capacity: 10
}
```

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

### Install Node.js and NPM

Source: https://source.android.com/docs/automotive/start/avd/cloud_emulator

Install the Node.js runtime and Node Package Manager.

```bash
sudo apt install nodejs npm
```

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

### Configure Authorization Policy Example

Source: https://source.android.com/docs/automotive/sdv/workstreams/core/comms-authorization/authz-policy

Example configuration for publisher, subscriber, server, and client permissions.

```textproto
# Allows this SB to register publication of TireStatus type with "left_tire" topic only.
publisher {
  message: "com.sdv.TireStatus"
  topic: "left_tire"
}

# Allows this SB to subscribe to publication of TireStatus type with "left_tire" topic only.
subscriber {
  message: "com.sdv.TireStatus"
  topic: "left_tire"
}

# Allows this SB to implement and serve UserPreferencesManager service on any channel.
server {
  service: "com.sdv.UserPreferencesManager"
  allow_all_channels: true
}

# Allows this SB to discover and call UserPreferencesManager service on any channel.
client {
  service: "com.sdv.UserPreferencesManager"
  allow_all_channels: true
}
```

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

### RPC Client Usage Example

Source: https://source.android.com/docs/automotive/sdv/core-areas/vsidl/language-specification

Example configuration for an RPC client.

```text
client {
  service: "SetTemperature"
  channel: "temp-setter"
}
```

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

### ParameterFrameworkConfiguration XML Example

Source: https://source.android.com/docs/automotive/audio/configurable-audio-policy-engine

Example of a configuration file with tuning enabled.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ParameterFrameworkConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    SystemClassName="Policy" TuningAllowed="true" ServerPort="unix:///dev/socket/audioserver/policy_debug">
    <SubsystemPlugins>
        <Location Folder="">
            <Plugin Name="libpolicy-subsystem.so"/>
        </Location>
    </SubsystemPlugins>
    <StructureDescriptionFileLocation Path="Structure/Policy/CapClass.xml"/>
</ParameterFrameworkConfiguration>
```

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

### Complete metrics configuration example

Source: https://source.android.com/docs/automotive/sdv/workstreams/telemetry/write-metrics-configurations

A full configuration example demonstrating data sources, aggregators, triggers, and report configurations.

```json
{
  "existing_uuid": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", // Unique identifier for the configuration
  "vs_version": "example_version", // Version of the VSIDL catalog to use
  "data_sources": [
    {
      "name": "SpeedSource",
      "source_identifier": "mcg.test.subpkg.speed_msg",
      "connection_type": "SUBSCRIPTION",
      "sub_sampling_interval_ms": 1000
    }
  ],
  "aggregators": [
    {
      "name": "SpeedAggregator",
      "trigger_names": ["OnNewSpeed"],
      "reset_on_get": true,
      "message_builder": {
        "field_assignments": [
          {
            "field_name": "average_speed",
            "aggregation": {
              "@type": "avg",
              "expression": "SpeedSource.speed"
            }
          },
          {
            "field_name": "speed_reading_count",
            "aggregation": { "@type": "count" }
          },
          {
            "field_name": "speed_history_last5",
            "aggregation": {
              "@type": "vector",
              "expression": "SpeedSource.speed",
              "max_length": 5
            }
          }
        ]
      }
    }
  ],
  "triggers": [
    {
      "name": "OnNewSpeed",
      "data": { "source_name": "SpeedSource" }
    },
    {
      "name": "EveryMinute",
      "periodic": { "period_ms": 60000 }
    }
  ],
  "report_configs": [
    {
      "name": "MinuteReport",
      "trigger_names": ["EveryMinute"],
      "message_builder": {
        "field_assignments": [
          {
            "field_name": "average_speed",
            "aggregation": {
              "@type": "none",
              "expression": "SpeedAggregator.average_speed"
            }
          },
          {
            "field_name": "reading_count",
            "aggregation": {
              "@type": "none",
              "expression": "SpeedAggregator.speed_reading_count"
            }
          }
        ]
      }
    }
  ]
}
```

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

### Install Python and Environment

Source: https://source.android.com/docs/automotive/start/avd/cloud_emulator

Install Python 3 and the virtual environment package on the VM.

```bash
sudo apt update
sudo apt install python3
sudo apt-get install python3-venv
```

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

### Install KVM

Source: https://source.android.com/docs/automotive/start/avd/cloud_emulator

Install the Kernel Virtual Machine and associated virtualization tools.

```bash
sudo apt-get install qemu-kvm libvirt-daemon-system libvirt-clients bridge-utils
```

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

### Install and configure coturn

Source: https://source.android.com/docs/automotive/start/avd/cloud_emulator

Commands to install the coturn server and enable it in the default configuration.

```bash
sudo apt install coturn
systemctl stop coturn
echo "TURNSERVER_ENABLED=1"|sudo tee -a /etc/default/coturn
```

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

### Example RPC Server Configuration

Source: https://source.android.com/docs/automotive/sdv/core-areas/vsidl/language-specification

A concrete example of an RPC server configuration block.

```text
server {
  service: "SetTemperature"
  channel: "temp-setter"
}
```

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

### Verify KVM Installation

Source: https://source.android.com/docs/automotive/start/avd/cloud_emulator

Install cpu-checker and run kvm-ok to verify KVM functionality.

```bash
sudo apt install cpu-checker
kvm-ok
```

```text
INFO: /dev/kvm exists
KVM acceleration can be used
```

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

### INITIAL_USER_INFO Request Example

Source: https://source.android.com/docs/automotive/users_accounts/user_hal

Represents a flattened InitialUserInfoRequest for a first boot scenario.

```text
VehiclePropValue { // flattened from InitialUserInfoRequest
prop: 299896583 // INITIAL_USER_INFO
prop.values.int32Values:
 [0] = 1 // Request ID
 [1] = 1 // InitialUserInfoRequestType.FIRST_BOOT
 [2] = 0 // user id of current user
 [3] = 1 // flags of current user (SYSTEM)
 [4] = 1 // number of existing users
 [5] = 0 // existingUser[0].id
 [6] = 1 // existingUser[0].flags
}
```

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

### Camera Configuration Example

Source: https://source.android.com/docs/automotive/hmi/dashcam

Example XML configuration for defining camera IDs, preroll lengths, and resolution settings.

```xml
<CameraConfig>
  <Camera
      ID="EVS:1"
      prerollLengthMs="10000"
      width="1920"
      height="1080" />
  <Camera
      ID="Camera2:1"
      prerollLengthMs="10000" />
</CameraConfig>
```

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

### Example Feature Configuration Output

Source: https://source.android.com/docs/automotive/displays/multi-display-comms-api

Sample output showing the list of enabled features from the configuration.

```text
mDefaultEnabledFeaturesFromConfig:[car_evs_service, car_navigation_service, car_occupant_connection_service, car_remote_device_service, car_telemetry_service, cluster_home_service, com.android.car.user.CarUserNoticeService, diagnostic, storage_monitoring, vehicle_map_service]
```

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

### Configure and Start Camera Stream

Source: https://source.android.com/docs/automotive/sdv/display-safety/har-camera-view?hl=it

Initializes the camera stream configuration and starts the data stream using the platform camera service handle.

```cpp
// selectStreamConfiguration examines this camera's stream configurations
    // and returns the one closest to the selected configuration.
    CameraStreamConfiguration config = selectStreamConfiguration(configuration);

    // mDevice refers to the camera handle for the platform camera service. We
    // may need to translate CameraStreamConfiguration for the platform service.
    mDevice->configure(
        configuration.mWidth, configuration.mHeight, configuration.mFormat);

    // Start a data stream with a callback object.
    if (!mDevice->startStream(mCallback)) {
        // We failed to start a data stream.
        return CAMERA_EIO;
    }

    return CAMERA_OK;
}
```

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

### Start Cuttlefish Instance

Source: https://source.android.com/docs/automotive/sdv/core-areas/vsidl/create-apex

Command to initialize a Cuttlefish instance for testing.

```bash
sdv-cf create --instance_name=instance1
```

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

### Emulator build and image placeholders

Source: https://source.android.com/docs/automotive/start/avd/cloud_emulator

Example filenames for emulator builds and system images.

```text
sdk-repo-linux-emulator-7154743.zip
```

```text
emu-docker create <emulator-zip> <system-image-zip>
```

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

### Start the SOME/IP stack agent

Source: https://source.android.com/docs/automotive/sdv/some-ip-integration/some-ip-stack

Use this init.rc configuration to start the SOME/IP stack agent when the device boot is complete and the vsock CID is set to 3.

```rc
on property:dev.bootcomplete=1 && property:ro.sdv.vsock_local_cid=3
    start sdv_someip_stack_agent
```

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

### INITIAL_USER_INFO Response Example

Source: https://source.android.com/docs/automotive/users_accounts/user_hal

Represents a flattened InitialUserInfoResponse for creating an Admin user.

```text
VehiclePropValue { // flattened from InitialUserInfoResponse
prop: 299896583 // INITIAL_USER_INFO
prop.values.int32Values:
  [0] = 1      // Request ID (must match request)
  [1] = 2      // InitialUserInfoResponseAction.CREATE
  [2] = -10000 // user id (not used on CREATE)
  [3] = 8      // user flags (ADMIN)
prop.values.stringValue: "en-US||Car Owner" // User locale and user name
}
```

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

### Set up SDV environment

Source: https://source.android.com/docs/automotive/sdv/testing/sdv-test-framework

Initialize the build environment and launch the target.

```bash
. build/envsetup.sh
lunch <TARGET>
```

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

### Set up build environment

Source: https://source.android.com/docs/automotive/sdv/workstreams/core/service-bundle-development

Initialize the build environment and build the vsidlc generator.

```bash
source build/envsetup.sh
lunch sdv_core_cf-aosp_current-userdebug
m vsidlc
```

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

### Example VehicleProperty Metadata

Source: https://source.android.com/docs/automotive/start/avd/extend-vhal-properties

A basic example of defining a VehicleProperty in the metadata JSON.

```json
[
  {
      "name": "VehicleProperty",
      "values": [
          {
              "name": "CURRENT_GEAR",
              "value": 289408001
          }
      ]
  }
]
```

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

### Clone and configure emulator scripts

Source: https://source.android.com/docs/automotive/start/avd/cloud_emulator

Initial setup steps to clone the repository and configure the environment.

```bash
git clone https://github.com/google/android-emulator-container-scripts.git
```

```bash
cd android-emulator-container-script
source ./configure.sh
```

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

### Service Bundle Usage Example

Source: https://source.android.com/docs/automotive/sdv/core-areas/vsidl/language-specification

Example configuration for a SeatController service bundle.

```text
service_bundle {
    name: "SeatController"

    publisher {
      message: "SeatHeating"
      topic: "driver-seat"
      capacity: 10
    }
}
```

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

### Create web container and start service

Source: https://source.android.com/docs/automotive/start/avd/cloud_emulator

Commands to create the web container and launch the emulator service using docker-compose.

```bash
./create_web_container.sh -p user1,passwd1
```

```bash
docker-compose -f js/docker/docker-compose-build.yaml -f js/docker/development.yaml up
```

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

### Install Cuttlefish Common

Source: https://source.android.com/docs/automotive/sdv/getting-started/build

Install the cuttlefish-common package if the crosvm VM manager is not supported.

```bash
sudo apt install cuttlefish-common
```

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

### Example Boot Image Profile Content

Source: https://source.android.com/docs/automotive/system_performance_tools/boot-image-profile

A sample of the text format used in boot image profiles to specify classes for optimization.

```text
Landroid/accounts/AccountManager;
Landroid/app/ActivityManager;
Landroid/app/ActivityTaskManager;
Landroid/app/ActivityThread;
Landroid/app/AlarmManager;
Landroid/app/AlertDialog;
Landroid/car/Car;
Landroid/car/input/CarInputManager;
Landroid/car/media/CarAudioManager;
```

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

### Build instructions for libgui_vendor

Source: https://source.android.com/docs/automotive/camera/evs/camera-hal

Commands to set up the build environment and compile the libgui_vendor library.

```bash
$ cd <your_android_source_tree_top>
$ . ./build/envsetup.
$ lunch <**product_name**>-<**build_variant**>
============================================
PLATFORM_VERSION_CODENAME=REL
PLATFORM_VERSION=10
TARGET_PRODUCT=<**product_name**>
TARGET_BUILD_VARIANT=<**build_variant**>
TARGET_BUILD_TYPE=release
TARGET_ARCH=arm64
TARGET_ARCH_VARIANT=armv8-a
TARGET_CPU_VARIANT=generic
TARGET_2ND_ARCH=arm
TARGET_2ND_ARCH_VARIANT=armv7-a-neon
TARGET_2ND_CPU_VARIANT=cortex-a9
HOST_ARCH=x86_64
HOST_2ND_ARCH=x86
HOST_OS=linux
HOST_OS_EXTRA=<**host_linux_version**>
HOST_CROSS_OS=windows
HOST_CROSS_ARCH=x86
HOST_CROSS_2ND_ARCH=x86_64
HOST_BUILD_TYPE=release
BUILD_ID=QT
OUT_DIR=out
============================================
  

$ m -j libgui_vendor
…
$ find $ANDROID_PRODUCT_OUT/system -name "libgui_vendor*"
.../out/target/product/hawk/system/lib64/libgui_vendor.so
.../out/target/product/hawk/system/lib/libgui_vendor.so
```

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

### Display emulator help

Source: https://source.android.com/docs/automotive/start/avd/cloud_emulator

View help information for the emu-docker executable.

```bash
emu-docker -h
```

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

### Usage Example for Subscriber

Source: https://source.android.com/docs/automotive/sdv/core-areas/vsidl/language-specification

Example configuration for a Subscriber instance targeting a specific message and topic.

```text
subscriber {
  message: "SeatHeating"
  topic: "driver-seat"
}
```

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

### Select a build target

Source: https://source.android.com/docs/automotive/sdv/getting-started/build

Use the lunch command to specify the product, release configuration, and variant for the build.

```bash
lunch sdv_core_cf-aosp_current-userdebug
```

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

### Install RRO via ADB

Source: https://source.android.com/docs/automotive/hmi/car_ui/appendix

Install an RRO APK directly to the device for faster iteration.

```bash
$ adb install <path-to-overlay.apk-file>
```

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

### Run AVD Image

Source: https://source.android.com/docs/automotive/start/avd/android_virtual_device

Launches the emulator instance.

```bash
emulator &
```

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

### Example Watchdog termination log

Source: https://source.android.com/docs/automotive/watchdog/wd_system_health

An example of the log output generated when the Watchdog terminates an unresponsive process.

```text
05-01 09:50:19.683   578  5777 W CarServiceHelper: carwatchdog killed com.google.android.car.kitchensink (pid: 5574)
```

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

### Telemetry Expression Examples

Source: https://source.android.com/docs/automotive/sdv/workstreams/telemetry/write-metrics-configurations

Examples demonstrating field retrieval and conditional logic for telemetry data sources.

```text
SpeedSource.speed
```

```text
SpeedSource.speed > 27.7
```

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

### Start VM with Custom Partitions

Source: https://source.android.com/docs/automotive/sdv/workstreams/core/oem-ab-partition-updates

Command to launch a Cuttlefish VM instance with the required custom partition images.

```bash
cvd create --custom_partition_path="$OUT/oem_ab.img;$OUT/oem_ab.img;$OUT/oem_ab_metadata.img"
```

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

### ProgramSelector URI Examples

Source: https://source.android.com/docs/automotive/radio/radio-control-implementation

Examples of serialized ProgramSelector URIs for various radio technologies and identifier types.

```text
broadcastradio://program/RDS_PI/1234?AMFM_FREQUENCY=88500&AMFM_FREQUENCY=103300
broadcastradio://program/AMFM_FREQUENCY/102100
broadcastradio://program/DAB_SID_EXT/14895264?RDS_PI=1234
```

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

### Install Android SDK

Source: https://source.android.com/docs/automotive/start/avd/cloud_emulator

Install the Android SDK package to ensure ADB is available on the system path.

```bash
sudo apt install android-sdk
```

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

### Build and Install CarDialerAppForTesting

Source: https://source.android.com/docs/automotive/hmi/dialer/testing

Commands to build the test variant of the Dialer app and install it on the target device.

```bash
cd %rRepoRoot%/packages/apps/Car/Dialer

m CarDialerAppForTesting

adb install %rRepoRoot%/out/target/product/%buildTarget%/system/priv-app/CarDialerAppForTesting/CarDialerAppForTesting.apk
```

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

### Event Trigger Configuration Examples

Source: https://source.android.com/docs/automotive/hmi/dashcam

Examples of defining event triggers based on VHAL sensor values and thresholds.

```xml
<EventTriggers>
  <EventTrigger
      name="AEB"
      cameras="EVS:1, EVS:2"
      sensorPropertyID="VHAL:289411073"
      description="Automatic Emergency Braking"
      recordingLengthMs="20000"
      sensorValueType="INT"
      thresholdType="EQUALS"
      thresholdValue="2"
      triggerCooldown="5000"/>
</EventTriggers>
```

```xml
<EventTrigger
            name="SPEED"
            cameras="Camera2:0, Camera2:1,  Camera2:2,  Camera2:3"
            sensorPropertyID="VHAL:291504648"
            description="Over speed"
            recordingLengthMs="10000"
            sensorValueType="FLOAT"
            thresholdType="AVERAGE"
            thresholdValue="20.0"
            thresholdExtra="10"
            triggerCooldown="2000"/>
```

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

### Create native client instance

Source: https://source.android.com/docs/automotive/sdv/sdv-gateway-on-ivi

Initialize a new SDV Gateway client instance.

```cpp
ASDVGateway_Client* client;
ASDVGateway_StatusCode_t statusCode = ASDVGateway_Client_new(
     &client, /*outStatus*/nullptr);
```

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

### Orchestrator dumpsys output example

Source: https://source.android.com/docs/automotive/sdv/core-areas/orchestrator

Example output showing the internal state, active modes, and requested service states.

```text
AGENT NAME: SDV Agent dump - Orchestrator
AGENT FQIN: instance1:com.android.sdv.orchestrator.OrchestratorServiceBundle/default
AGENT STATE: See orchestrator state below.
----------------
----------------
INTERNAL STATE REPORTERS:

*NAME: Configuration state
*REPORT:
Active modes:
MODE                          VALUE                         TIMESTAMP (scs, ns)
Power                         POWER_OFF_EXIT                -
Vehicle                       VEHICLE_ON                    -
Custom("CHARGING")            ON                            1750757590 (scs) 466507459 (ns)
Custom("TIRE_PRESSURE")       front-left                    1750757570 (scs) 554522995 (ns)

Modes allowed to publish by bundle (FQIN: modes):
com.android.sdv.sample.orchestration/CustomModeControlBundle: CHARGING, TIRE_PRESSURE

Requested state for instances:
STATE          FQIN
Started        com.android.sdv.sample.orchestration/CustomModeControlBundle/always-started-instance
Started        com.android.sdv.sample.orchestration/OrchestratedServiceBundle/my-instance
Started        com.sdv.oem.sample.diagnostics/DiagnosticsSampleWithDataItem/instance
Started        com.sdv.oem.sample.diagnostics/DiagnosticsSampleWithEvent/instance
Started        com.sdv.oem.user_preferences/UserPreferencesServiceBundle/default
----------------
*NAME: Engine state
*REPORT:
Last mode enforced was Custom("CHARGING") with value "ON"

Next modes to process: []
----------------
```

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

### Define Parameter Framework Domain Configuration

Source: https://source.android.com/docs/automotive/audio/configurable-audio-policy-engine

Example of a parameter framework file defining device selection rules for product strategies.

```text
supDomain: DeviceForProductStrategies
  supDomain: Music
    domain: SelectedDevice
      conf: BluetoothA2dp
        ForceUseForMedia IsNot NO_BT_A2DP
        ForceUseForCommunication IsNot BT_SCO
        AvailableOutputDevices Includes BLUETOOTH_A2DP
        component:/Policy/policy/product_strategies/vx_1000/selected_output_devices/mask
          bluetooth_a2dp = 1
          bus = 0
      conf: Bus
        AvailableOutputDevices Includes Bus
        AvailableOutputDevicesAddresses Includes BUS00_MEDIA
        component: /Policy/policy/product_strategies/vx_1000/selected_output_devices/mask
          bluetooth_a2dp = 0
          bus = 1
      conf: Default
        component: /Policy/policy/product_strategies/vx_1000/selected_output_devices/mask
          bluetooth_a2dp = 0
          bus = 0
```

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

### IEvsCamera::startVideoStream

Source: https://source.android.com/docs/automotive/camera/evs/camera-hal

Starts video streams for a client. Clients may independently start and stop video streams on the same underlying camera.

```APIDOC
## IEvsCamera::startVideoStream

### Description
Starts video streams. Clients may independently start and stop video streams on the same underlying camera. The underlying camera starts when the first client starts.

### Signature
startVideoStream(IEvsCameraStream receiver) generates (EvsResult result);
```

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

### Configure init.target.rc for Service Startup

Source: https://source.android.com/docs/automotive/security/macsec

Ensure the Ethernet interface is ready before starting the MACsec service to avoid race conditions.

```text
# init.target.rc
on late-fs
    …
    wait /sys/class/net/eth0
    start wpa_supplicant_macsec
    …
```

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

### Launch Dumpstate Server with Configuration

Source: https://source.android.com/docs/automotive/virtualization/architecture

Pass the path of the configuration file to the dumpstate server during launch.

```bash
--config_file my_config.xml
```

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

### Start a video stream via IEvsCamera

Source: https://source.android.com/docs/automotive/camera/evs/camera-hal

Initiates a video stream. The underlying hardware camera starts only when the first client requests a stream.

```HIDL
startVideoStream(IEvsCameraStream receiver) generates (EvsResult result);
```

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

### Configure Package Installation for User Types (Android 11)

Source: https://source.android.com/docs/automotive/users_accounts/disable_packages

Define which packages are installed for FULL and SYSTEM users using XML configuration in the sysconfig directory.

```xml
<!- this package will be installed for both FULL and SYSTEM user -->
    <install-in-user-type package="com.android.bluetooth"->
        <install-in user-type="FULL" />
        <install-in user-type="SYSTEM" />
    </install-in-user-type->

<!- this package will only be installed for both FULL user -->
    <install-in-user-type package="com.android.car.calendar"->
        <install-in user-type="FULL" >
    </install-in-user-type->
```

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

### Prepare DriverUI Prebuilt Files

Source: https://source.android.com/docs/automotive/sdv/display-safety/get-started

Commands to create the Android.bp file and copy the built DriverUI APK into the AOSP repository.

```bash
# Create a blueprint file, contents of this file are shown in the next step
touch /path/to/aosp_repo_root/packages/apps/Car/DriverUIPrebuilt/Android.bp
# Copy DriverUI.apk built
cp /path/to/ub-automotive-master/out/aaos-apps-gradle-build/driver-ui/outputs/apk/default/debug/driver-ui-default-debug.apk /path/to/aosp_repo_root/packages/apps/Car/DriverUIPrebuilt/DriverUI.apk
```

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

### Configure third-party app installation location

Source: https://source.android.com/docs/automotive/flash-wear

Use this resource overlay setting to restrict third-party app installation to external storage, reducing write wear on internal flash memory.

```xml
<bool name="config_allow3rdPartyAppOnInternal">false</bool>
```

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

### GET /health

Source: https://source.android.com/docs/automotive/sdv/workstreams/telemetry/metrics-configuration-generator/api

Check the service's health.

```APIDOC
## GET /health

### Description
Check the service's health.

### Method
GET

### Endpoint
/health
```

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

### GET /health

Source: https://source.android.com/docs/automotive/sdv/workstreams/telemetry/metrics-configuration-generator/api

Checks the health status of the service.

```APIDOC
## GET /health

### Description
Returns the current health status of the service.

### Method
GET

### Endpoint
/health
```

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

### GET /api/v1/vs/

Source: https://source.android.com/docs/automotive/sdv/workstreams/telemetry/metrics-configuration-generator/api

Retrieves vehicle signal catalogs.

```APIDOC
## GET /api/v1/vs/

### Description
Retrieves a list of vehicle signal catalogs.

### Method
GET

### Endpoint
/api/v1/vs/
```

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

### Define Orchestrator state configuration

Source: https://source.android.com/docs/automotive/sdv/core-areas/orchestrator

Example configuration defining power states and instance startup requirements.

```text
state {
    condition {
        power_state: "SUSPEND_TO_RAM_ENTER"
    }
    instances_states {
        started: "instance-1"
        started: "instance-2"
        started: "instance-3"
    }
}
```

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

### Download Android Source

Source: https://source.android.com/docs/automotive/start/avd/android_virtual_device

Initializes the repository and syncs the source code for the specified Android branch.

```bash
ANDROID_BRANCH="android12L-release"  

REPO_URL="https://android.googlesource.com/platform/manifest"  

mkdir $ANDROID_BRANCH && cd $ANDROID_BRANCH && repo init -u $REPO_URL -b
$ANDROID_BRANCH --partial-clone &&  repo sync -c -j8
```

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

### getDisplayState()

Source: https://source.android.com/docs/automotive/camera/evs/camera-hal

Gets the current state of the EVS display.

```APIDOC
## getDisplayState()

### Description
Returns the actual current state of the display as reported by the HAL implementation.

### Response
- **state** (DisplayState) - The current state of the display.
```

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

### CameraDevice::start

Source: https://source.android.com/docs/automotive/sdv/display-safety/har-camera-view

Starts a data stream for a camera device.

```APIDOC
## CameraError CameraDevice::start(std::shared_ptr<CameraStreamConfiguration>& configuration, std::shared_ptr<CameraStreamListener>& listener, std::shared_ptr<CameraStreamConfiguration>* effective)

### Description
Initiates a data stream based on the provided configuration and listener. If configuration is null, the default configuration is used.

### Parameters
- **configuration** (std::shared_ptr<CameraStreamConfiguration>&) - Required - The desired stream configuration.
- **listener** (std::shared_ptr<CameraStreamListener>&) - Required - The listener to receive stream events.
- **effective** (std::shared_ptr<CameraStreamConfiguration>*) - Required - Pointer to store the actual configuration used.
```

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

### GET /health

Source: https://source.android.com/docs/automotive/sdv/workstreams/telemetry/metrics-configuration-generator/api

Check the service's health status.

```APIDOC
## GET /health

### Description
Check the service's health.

### Method
GET

### Endpoint
/health

### Response
#### Success Response (200)
- The service returns a 200 OK status code if healthy.

### Request Example
curl "$SERVICE_URL/health"
```
Tokens:
Raw