platform_vehiclefunctions_api_common_androidcar/com.tomtom.ivi.platform.vehiclefunctions.api.common.androidcar

Package-level declarations

This package provides helper classes to interact with android.car.

The package provides tools usable in different contexts:

VhalPropertyDelegate. Maps an Android Vehicle Hardware Abstraction Layer property to an IVI service property.
VhalWrapper. Implements basic handling of car properties from Vehicle Hardware Abstraction Layer. Intended to be used in vehicle function service implementations.
CarFlow. Flow to safely and simply access the Car service.
CarClient. Client to safely access the Car service for complex use cases.

Note: All of the tools are meant to operate under Android Automotive OS since version R (API 30), and will gracefully fail when running non-Automotive Android or with API levels below 30.

Types

CarClient

class CarClient(context: Context, coroutineScope: CoroutineScope)

Safe client for the Car service.

CarConnectionState

@IviExperimental(reasons = [])

sealed class CarConnectionState

Represents the state of a connection to the Car service.

CarFlow

@IviExperimental(reasons = [])

object CarFlow

Safe client for the Car service, in form of a Flow.

FlowVhal

@IviExperimental(reasons = [])

class FlowVhal(context: Context)

Experimental API for obtaining Android Car properties as Flows.

VhalPropertyDelegate

class VhalPropertyDelegate<ValueType>

Maps an Android Vehicle Hardware Abstraction Layer property to a ValueType.

VhalWrapper

class VhalWrapper

VhalWrapper implements basic handling of car properties from Android's Vehicle Hardware Abstraction Layer. Intended to be used in vehicle function service implementations.

Properties

seatAreaMap

val seatAreaMap: Map<Int, SeatArea>

Converts the VehicleAreaSeat to a dedicated SeatArea.

windowAreaMap

val windowAreaMap: Map<Int, WindowArea>

Converts the VehicleAreaWindow to a dedicated WindowArea.

Functions

withDrivingStateManager

@IviExperimental(reasons = [])

suspend fun Car.withDrivingStateManager(block: suspend CarDrivingStateManager.() -> Unit)

Run block with a valid CarDrivingStateManager.

withDrivingStateManagerIfAvailable

@IviExperimental(reasons = [])

suspend fun Car?.withDrivingStateManagerIfAvailable(block: suspend CarDrivingStateManager.() -> Unit)

Run block with a valid CarDrivingStateManager.

withPowerManager

@IviExperimental(reasons = [])

suspend fun Car.withPowerManager(block: suspend CarPowerManager.() -> Unit)

Run block with a valid CarPowerManager.

withPowerManagerIfAvailable

@IviExperimental(reasons = [])

suspend fun Car?.withPowerManagerIfAvailable(block: suspend CarPowerManager.() -> Unit)

Run block with a valid CarPowerManager.

withPropertyManager

@IviExperimental(reasons = [])

suspend fun Car.withPropertyManager(block: suspend CarPropertyManager.() -> Unit)

Run block with a valid CarPropertyManager.

withPropertyManagerIfAvailable

@IviExperimental(reasons = [])

suspend fun Car?.withPropertyManagerIfAvailable(block: suspend CarPropertyManager.() -> Unit)

Run block with a valid CarPropertyManager.