Skip to main content

Introduction

Vehicle SDK Overview​

Vehicle SDK provides APIs for retrieving and controlling vehicle information. Third-party apps connect to the Vehicle Service in Pleos Connect through Vehicle SDK. Vehicle Service runs on Android Automotive OS and processes requests from third-party apps to retrieve and control vehicle information through Vehicle SDK APIs.

SDK version

This guide is based on Vehicle SDK v2.3.2 and Vehicle Service v2.3.21.

Entry point and domain structure​

Vehicle SDK APIs are provided as domain-specific interfaces, including Brake, CarInfo, Display, Door, DrivingMode, EvBattery, Fuel, HVAC, and Light. Domain objects such as Door and Brake are not instantiated directly. Instead, obtain them through getXxx() methods such as getDoor() and getBrake() on the Vehicle instance, which is the entry point to Vehicle SDK. Use the domain objects to call capability, get, set, and callback APIs. Capability APIs (checkXXXCapabilities) check feature support and the available value range, get APIs retrieve current values, set APIs update values, and callback APIs subscribe to state changes by registering listeners.

Connect to Vehicle Service by calling initialize(), and call release() when you are finished. Vehicle communication uses IPC, so capability, get, and set results are delivered asynchronously through onComplete and onFailed lambdas instead of being returned immediately. Do not call release() before an asynchronous callback completes.

DomainDescription
BrakeRetrieves brake pedal and parking brake states
CarInfoRetrieves basic vehicle information, such as exterior dimensions, manufacturer, and model year
DisplayRetrieves and sets display-related settings, such as the temperature unit
DoorControls door opening and closing, locking and unlocking, and retrieves door states
DrivingModeRetrieves drive mode and cruise control information
EvBatteryRetrieves EV battery charging state and energy efficiency
FuelRetrieves fuel-related information, such as fuel economy
HVACControls and retrieves heating, ventilation, and air conditioning information, including temperature, fan speed, and humidity
LightRetrieves light states and controls ambient lighting features
OdometerRetrieves total mileage, trip distance and duration, and distance units
SafetyRetrieves vehicle warning information
SeatControls and retrieves seat positions, angles, and features
SideMirrorRetrieves and sets side-mirror heating states
SteeringwheelRetrieves and controls steering-wheel states and heating
TireRetrieves tire states
TollRetrieves and sets ETCS toll-system voice-guidance volume and other settings
TurnSignalRetrieves turn-signal states
WindowControls windows and retrieves window states
WiperControls wipers and retrieves wiper states

Emulator setup​

Develop and validate Vehicle SDK applications in the Pleos Connect Emulator environment. Prepare your development environment as follows.

  1. Check software development environment requirements
  2. Install the Pleos Connect Emulator
  3. Create and run an AVD
  4. Set up Pleos Connect Virtual Console
  5. Configure microphone access
  6. Configure cold boot

Next steps​

  1. Obtaining domain objects: How to obtain domain objects and call get, set, callback, and capability APIs
  2. Permission: Domain-specific permissions
  3. Error code: Error codes and onFailed handling
  4. API Reference: Vehicle SDK API specification
  5. Vehicle SDK sample app guide