![]() |
Alexa Auto SDK
2.3.1
|
Classes | |
class | Action |
class | Zone |
Static Public Member Functions | |
static CarControlConfiguration | create () |
The CarControlConfiguration
class programmatically generates the "aace.carControl" com.amazon.aace.core.config.EngineConfiguration
. "aace.carControl" configuration specifies additional endpoints that are connected and controllable through the root endpoint that maintains the connection to the Alexa service. Each connected endpoint represents a controllable component of the vehicle and should be configured with any of the supported capabilities (i.e. PowerController and primitives ModeController, ToggleController, RangeController ) to model how the endpoint can be controlled with voice.
Using the methods on an instance of this class produces configuration data in the format of the following example:
note
This class acts as a configuration builder, so the method calls must be ordered to produce the intended configuration.
|
static |
Create a CarControlConfiguration
instance.
final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.createEndpoint | ( | String | endpointId | ) |
Begin an endpoint definition using the specified endpoint ID. This creates a single entry in the "endpoints" array of 'aace.carControl'.
endpointId | The unique identifier for the endpoint. |
CarControlConfiguration
to allow chaining. final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.createControl | ( | String | controlId, |
String | zoneId | ||
) |
addMembers()
on a zone definition if you create endpoints with createControl()
. addMembers()
is only compatible with createEndpoint()
.createControl()
and createEndpoint()
in your implementation.Begin an endpoint definition using the specified endpoint ID. This creates a single entry in the "endpoints" array of 'aace.carControl'.
controlId | The unique identifier for the endpoint. |
zoneId | The unique identifier of the zone the endpoint is located in. Default is "zone.all" . |
CarControlConfiguration
to allow chaining. final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addAssetId | ( | String | assetId | ) |
Add an asset ID to the enclosing element. This can be called to add an asset ID to the friendly names list for the following elements:
CarControlAssets.java
for a full list of the asset IDs supported by default.assetId | The identifier of the asset. |
CarControlConfiguration
to allow chaining. final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addPowerController | ( | boolean | retrievable | ) |
Add a PowerController capability to the enclosing endpoint. Only one instance is allowed per endpoint.
retrievable | Whether the state of this instance may be retrieved by the Alexa service. Only false is supported. |
CarControlConfiguration
to allow chaining. final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addToggleController | ( | String | instanceId, |
boolean | retrievable | ||
) |
Add a ToggleController capability to the enclosing endpoint. Multiple instances are allowed per endpoint. Call addAsset()
to add friendly names to the 'capabilityResources' of this instance.
instanceId | The identifier of this ToggleController instance. Must be unique with respect to the enclosing endpoint. |
retrievable | Whether the state of this instance may be retrieved by the Alexa service. Only false is supported. |
CarControlConfiguration
to allow chaining. final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addActionTurnOn | ( | String [] | actions | ) |
Maps the specified action IDs to the TurnOn directive for the enclosing ToggleController. This adds a 'semantics.actionMappings' entry to its definition. com.amazon.aace.carControl.CarControl.turnToggleControllerOn()
is invoked when the user says the additional utterances enabled by the specified action ID(s).
com.amazon.aace.carControl.CarControlConfiguration.Action
are supported.actions | The action IDs to map to the TurnOn directive. |
final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addActionTurnOff | ( | String [] | actions | ) |
Maps the specified action IDs to the TurnOff directive for the enclosing ToggleController. This adds a 'semantics.actionMappings' entry to its definition. com.amazon.aace.carControl.CarControl.turnToggleControllerOn()
is invoked when the user says the additional utterances enabled by the specified action ID(s).
com.amazon.aace.carControl.CarControlConfiguration.Action
are supported.actions | The action IDs to map to the TurnOff directive. |
final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addRangeController | ( | String | instanceId, |
boolean | retrievable, | ||
double | minimum, | ||
double | maximum, | ||
double | precision, | ||
String | unit | ||
) |
Add a RangeController capability to the enclosing endpoint. Multiple instances are allowed per endpoint. Call addAsset()
to add friendly names to the 'capabilityResources' of this instance.
instanceId | The identifier of this RangeController instance. Must be unique with respect to the enclosing endpoint. |
retrievable | Whether the state of this instance may be retrieved by the Alexa service. Only false is supported. |
minimum | The minimum value of the range supported by this instance. |
minimum | The maximum value of the range supported by this instance. |
precision | The amount by which the set value changes when iterating through the range. |
unit | The unit of the measure. |
CarControlConfiguration
to allow chaining. final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addPreset | ( | double | value | ) |
Add a 'preset' to the enclosing RangeController instance. A preset describes a value that can be invoked by name. Call addAsset()
to add friendly names to 'presetResources' of this preset.
value | The value within the range that has an associated named preset. |
CarControlConfiguration
to allow chaining. final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addActionSetRange | ( | String [] | actions, |
double | value | ||
) |
Maps the specified action IDs to the SetRangeValue directive for the enclosing RangeController. This adds a 'semantics.actionMappings' entry to its definition. com.amazon.aace.carControl.CarControl.setRangeControllerValue()
is invoked when the user says the additional utterances enabled by the specified action ID(s).
com.amazon.aace.carControl.CarControlConfiguration.Action
are supported.actions | The action IDs to map to the SetRangeValue directive. |
value | The value argument of setRangeControllerValue() . The value must be within the configured range of this RangeController instance. |
final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addActionAdjustRange | ( | String [] | actions, |
double | delta | ||
) |
Maps the specified action IDs to AdjustRangeValue directive for the enclosing RangeController. This adds a 'semantics.actionMappings' entry to its definition. com.amazon.aace.carControl.CarControl/adjustRangeControllerValue
() is invoked when the user says the additional utterances enabled by the specified action ID(s).
com.amazon.aace.carControl.CarControlConfiguration.Action
are supported.actions | The action IDs to map to the AdjustRangeValue directive. |
delta | The delta argument of adjustRangeControllerValue() . The absolute value must be <= (max - min) configured for this RangeController instance. |
final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addModeController | ( | String | instanceId, |
boolean | retrievable, | ||
boolean | ordered | ||
) |
Add a ModeController capability to the enclosing endpoint. Multiple instances are allowed per endpoint. Call addAsset()
to add friendly names to the 'capabilityResources' of this instance.
instanceId | The identifier of this ModeController instance. Must be unique with respect to the enclosing endpoint. |
retrievable | Whether the state of this instance may be retrieved by the Alexa service. Only false is supported. |
ordered | Whether the modes are ordered, enabling iteration through them using the AdjustMode directive. |
CarControlConfiguration
to allow chaining. final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addValue | ( | String | value | ) |
Add a supported mode 'value' to the enclosing ModeController instance. If ordered is true, the order in which modes are created with calls to this method determines the ordering for iteration by voice. Call addAsset()
to add friendly names to 'modeResources' of this mode.
value | The identifier of the mode. |
CarControlConfiguration
to allow chaining. final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addActionSetMode | ( | String [] | actions, |
String | value | ||
) |
Maps the specified action IDs to the SetMode directive for the enclosing ModeController. This adds a 'semantics.actionMappings' entry to its definition. com.amazon.aace.carControl.CarControl.setModeControllerValue()
is invoked when the user says the additional utterances enabled by the specified action ID(s).
com.amazon.aace.carControl.CarControlConfiguration.Action
are supported.actions | The action IDs to map to the SetMode directive. |
value | The value argument of setModeControllerValue() specifying the mode to set. The value must be one configured for this ModeController instance. |
final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addActionAdjustMode | ( | String [] | actions, |
int | delta | ||
) |
Maps the specified action IDs to the AdjustMode directive for the enclosing ModeController. This adds a 'semantics.actionMappings' entry to its definition. com.amazon.aace.carControl.CarControl.adjustModeControllerValue()
is invoked when the user says the additional utterances enabled by the specified action ID(s).
true
for this ModeController instance.com.amazon.aace.carControl.CarControlConfiguration.Action
are supported.actions | The action IDs to map to the AdjustMode directive. |
delta | The delta argument of adjustModeControllerValue() specifying the number of modes to advance from the current mode setting. |
final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.createZone | ( | String | zoneId | ) |
Begin a zone definition using the specified zone ID. This creates a single entry in the "zones" array of 'aace.carControl'. Call addMembers()
to add endpoint IDs as members of this zone.
zoneId | The unique identifier for the zone. |
CarControlConfiguration
to allow chaining. final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addMembers | ( | String [] | endpointIds | ) |
Add the specified endpoint IDs to the definition of the enclosing zone.
createControl()
to create endpoints if using this method.endpointIds | The IDs of the endpoints belonging to this zone. Endpoint IDs used must correspond to endpoints created with createEndpoint() . |
CarControlConfiguration
to allow chaining. final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.setDefaultZone | ( | String | zoneId | ) |
Set the default zone to the specified zone ID. This allows the endpoints in the specified default zone to take precedence over endpoints not in the default zone when the user does not specify any zone in the utterance.
zoneId | The ID of the default zone. |
CarControlConfiguration
to allow chaining. final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addDefaultAssetsPath | ( | String | path | ) |
Specify the path to a file that defines the default assets. This creates an "assets.defaultAssetsPath" entry in 'aace.carControl'.
CarControlAssets.h
. This method can override the internal asset definitions in online-only use cases (without the LVC extension).path | The path to the file defining the default assets. |
final CarControlConfiguration com.amazon.aace.carControl.CarControlConfiguration.addCustomAssetsPath | ( | String | path | ) |
Specify the path to a file that defines additional assets. This creates an "assets.customAssetsPath" entry in 'aace.carControl'. Specify a path to additional assets if you have endpoints that cannot be modeled using the default asset IDs present in CarControlAssets.java
.
path | The path to the file defining additional assets. |
Alexa Auto SDK 2.3.1 - Copyright 2017-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0