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::VEHICLE_IDENTIFIER, VehiclePropertyType::ENGINE_TYPE, VehiclePropertyType::RSE_EMBEDDED_FIRETVS }

using	VehicleProperty = std::pair< VehiclePropertyType, std::string >

Static Public Member Functions
static std::shared_ptr< aace::core::config::EngineConfiguration >	createVehicleInfoConfig (const std::vector< VehicleProperty > &propertyList)

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

Detailed Description

The VehicleConfiguration class is a factory interface for creating "aace.vehicle" configuration objects.

Member Typedef Documentation

◆ VehicleProperty

using aace::vehicle::config::VehicleConfiguration::VehicleProperty = std::pair<VehiclePropertyType, std::string>

Identifies a vehicle property with a type and value pair

Member Enumeration Documentation

◆ VehiclePropertyType

enum aace::vehicle::config::VehicleConfiguration::VehiclePropertyType

strong

Specifies the vehicle properties required in configuration

Enumerator
MAKE	The make of the vehicle. Note This property is required.
MODEL	The model of the vehicle. Note This property is required.
YEAR	The model year of the vehicle. A value of this property type must be an integer in the range 1900-2100. Example value: "2019" Note This property is required.
TRIM	The trim level of the vehicle, identifying the vehicle's level of equipment or special features. Example values: "Standard", "Sport", "Limited"
GEOGRAPHY	The current location (country/region/state/etc.) of the vehicle. Example values: "US", "US-North", "WA"
VERSION	The client software version. Example value: "2.2.1X"
OPERATING_SYSTEM	The operating system used by the vehicle's infotainment system. Example value: "AndroidOreo_8.1"
HARDWARE_ARCH	The hardware architecture used by the vehicle. Example value: "x86_64"
LANGUAGE	The language or locale selected for Alexa by the vehicle owner. Example values: "en-US", "fr-CA"
MICROPHONE	The type and arrangement of microphone used by the vehicle. Example value: "7 mic array, centrally mounted"
VEHICLE_IDENTIFIER	The automaker's identifier for the vehicle.
ENGINE_TYPE	The engine type for the vehicle.
RSE_EMBEDDED_FIRETVS	The number of RSE embedded FireTVs installed in 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 "aace.vehicle" 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>",
         "vehicleIdentifier": "<VEHICLE_IDENTIFIER>",
         "engineType": "<ENGINE_TYPE>",
         "rseEmbeddedFireTvs": "<RSE_EMBEDDED_FIRETVS>"
     }
  }
}

Parameters

[in] propertyList A 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 )