Alexa Auto SDK  2.0.0
Public Types | Static Public Member Functions | List of all members
aace::vehicle::config::VehicleConfiguration Class Reference

Public Types

enum  VehiclePropertyType {
  VehiclePropertyType::MAKE,
  VehiclePropertyType::MODEL,
  VehiclePropertyType::YEAR,
  VehiclePropertyType::TRIM,
  VehiclePropertyType::GEOGRAPHY,
  VehiclePropertyType::VERSION,
  VehiclePropertyType::OPERATING_SYSTEM,
  VehiclePropertyType::HARDWARE_ARCH,
  VehiclePropertyType::LANGUAGE,
  VehiclePropertyType::MICROPHONE,
  VehiclePropertyType::COUNTRY_LIST,
  VehiclePropertyType::VEHICLE_IDENTIFIER
}
 
using VehicleProperty = std::pair< VehiclePropertyType, std::string >
 

Static Public Member Functions

static std::shared_ptr< aace::core::config::EngineConfigurationcreateVehicleInfoConfig (const std::vector< VehicleProperty > &propertyList)
 
static std::shared_ptr< aace::core::config::EngineConfigurationcreateOperatingCountryConfig (const std::string &operatingCountry)
 

Detailed Description

The VehicleConfiguration class is a factory interface for creating Vehicle service configuration objects.

Member Typedef Documentation

◆ VehicleProperty

Identifies a vehicle property with a type and value pair

Member Enumeration Documentation

◆ VehiclePropertyType

Specifies configurable vehicle properties

Enumerator
MAKE 

Vehicle's make

MODEL 

Vehicle's model

YEAR 

Vehicle model year, example: 2018, 2019, 2020

TRIM 

Variations of a model with different set of features, example: Standard, Sport, Limited

GEOGRAPHY 

Current location (country/region/state) of the vehicle, example: US, US-North, WA

VERSION 

OEM client software version

OPERATING_SYSTEM 

Operating system for vehicle's infotainment system, example: Android 8.1 Oreo API Level 26

HARDWARE_ARCH 

Supporting hardware architecture, example: x86_64

LANGUAGE 

Language or locale selected for Alexa by the vehicle owner, example: en-UA, fr-CA

MICROPHONE 

Type and arrangement of microphone in the car, example: 7 mic array, centrally mounted

COUNTRY_LIST 

Comma-separated list countries (ISO country codes)

VEHICLE_IDENTIFIER 

Automaker's internal identifier for the vehicle

Member Function Documentation

◆ createVehicleInfoConfig()

static std::shared_ptr<aace::core::config::EngineConfiguration> aace::vehicle::config::VehicleConfiguration::createVehicleInfoConfig ( const std::vector< VehicleProperty > &  propertyList)
static

Factory method used to programmatically generate vehicle info configuration data. The data generated by this method is equivalent to providing the following JSON values in a configuration file:

{
"aace.vehicle":
{
"info": {
"make": "<MAKE>",
"model": "<MODEL>",
"year": "<YEAR>",
"trim": "<TRIM>",
"geography": "<GEOGRAPHY>",
"version": "<SOFTWARE_VERSION>",
"os": "<OPERATING_SYSTEM>",
"arch": "<HARDWARE_ARCH>",
"language": "<LANGUAGE>",
"microphone": "<MICROPHONE>",
"countries": "<COUNTRY_LIST>",
"vehicleIdentifier": "<VEHICLE_IDENTIFIER>"
}
}
}
Parameters
[in]propertyListA list of VehicleProperty type and value pairs

◆ createOperatingCountryConfig()

static std::shared_ptr<aace::core::config::EngineConfiguration> aace::vehicle::config::VehicleConfiguration::createOperatingCountryConfig ( const std::string &  operatingCountry)
static

Factory method used to programmatically generate vehicle operating country configuration data. The data generated by this method is equivalent to providing the following JSON values in a configuration file:

{
"aace.vehicle": {
"operatingCountry": "<COUNTRY>"
}
}
Parameters
[in]operatingCountryA 2-letter ISO country code

Alexa Auto SDK 2.0.0 - Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0