![]() |
Alexa Auto SDK
2.3.1
|
Public Member Functions | |
CarControl () | |
void | turnPowerControllerOn (String endpointId) throws Exception |
void | turnPowerControllerOff (String endpointId) throws Exception |
boolean | isPowerControllerOn (String endpointId) throws Exception |
void | turnToggleControllerOn (String endpointId, String controllerId) throws Exception |
void | turnToggleControllerOff (String endpointId, String controllerId) throws Exception |
boolean | isToggleControllerOn (String endpointId, String controllerId) throws Exception |
void | setRangeControllerValue (String endpointId, String controllerId, double value) throws Exception |
void | adjustRangeControllerValue (String endpointId, String controllerId, double delta) throws Exception |
double | getRangeControllerValue (String endpointId, String controllerId) throws Exception |
void | setModeControllerValue (String endpointId, String controllerId, String value) throws Exception |
void | adjustModeControllerValue (String endpointId, String controllerId, int delta) throws Exception |
String | getModeControllerValue (String endpointId, String controllerId) throws Exception |
CarControl should be extended to interface the elements that can be controlled in the vehicle. Each controllable element is an 'endpoint' with a unique endpointId
. CarControl
provides interfaces for four types of controllers. A custom combination of these controllers describes controls of the entire vehicle:
endpointId
. endpointId
and controllerId
. endpointId
and controllerId
. endpointId
and controllerId
. com.amazon.aace.carControl.CarControl.CarControl | ( | ) |
CarControl constructor.
void com.amazon.aace.carControl.CarControl.turnPowerControllerOn | ( | String | endpointId | ) | throws Exception |
Notifies the platform implementation to power on the controller identified by endpointId
.
endpointId | The unique identifier of the endpoint. |
Exception | The controller cannot be powered on. |
void com.amazon.aace.carControl.CarControl.turnPowerControllerOff | ( | String | endpointId | ) | throws Exception |
Notifies the platform implementation to power off the controller identified by endpointId
.
endpointId | The unique identifier of the endpoint. |
Exception | The controller cannot be powered off. |
boolean com.amazon.aace.carControl.CarControl.isPowerControllerOn | ( | String | endpointId | ) | throws Exception |
Retrieves the power state of the controller identified by endpointId
from the platform implementation.
endpointId | The unique identifier of the endpoint. |
Exception | The power state of the controller identified by endpointId cannot be retrieved. |
true
if the power controller is on. void com.amazon.aace.carControl.CarControl.turnToggleControllerOn | ( | String | endpointId, |
String | controllerId | ||
) | throws Exception |
Notifies the platform implementation to turn on the controller identified by endpointId
and controllerId
.
endpointId | The unique identifier of the endpoint. |
controllerId | The unique identifier of the controller. |
Exception | The controller cannot be powered on. |
void com.amazon.aace.carControl.CarControl.turnToggleControllerOff | ( | String | endpointId, |
String | controllerId | ||
) | throws Exception |
Notifies the platform implementation to turn off the controller identified by endpointId
and controllerId
.
endpointId | The unique identifier of the endpoint. |
controllerId | The unique identifier of the controller. |
Exception | The controller cannot be powered off. |
boolean com.amazon.aace.carControl.CarControl.isToggleControllerOn | ( | String | endpointId, |
String | controllerId | ||
) | throws Exception |
Retrieves the power state of the controller identified by endpointId
and controllerId
from the platform implementation.
endpointId | The unique identifier of the endpoint. |
controllerId | The unique identifier of the controller. |
Exception | The power state of the controller identified by endpointId and controllerId cannot be retrieved. |
true
if the controller is on. void com.amazon.aace.carControl.CarControl.setRangeControllerValue | ( | String | endpointId, |
String | controllerId, | ||
double | value | ||
) | throws Exception |
Notifies the platform implementation to set the range setting of the controller identified by endpointId
and controllerId
.
endpointId | The unique identifier of the endpoint. |
controllerId | The unique identifier of the controller. |
value | The new range setting. |
Exception | The range setting of the controller cannot be set. |
void com.amazon.aace.carControl.CarControl.adjustRangeControllerValue | ( | String | endpointId, |
String | controllerId, | ||
double | delta | ||
) | throws Exception |
Notifies the platform implementation to adjust the range setting of the controller identified by endpointId
and controllerId
.
endpointId | The unique identifier of the endpoint. |
controllerId | The unique identifier of the controller. |
delta | The delta by which to adjust the range setting. |
Exception | The range setting of the controller cannot be adjusted. |
double com.amazon.aace.carControl.CarControl.getRangeControllerValue | ( | String | endpointId, |
String | controllerId | ||
) | throws Exception |
Retrieves the range value of the controller identified by endpointId
and controllerId
.
endpointId | The unique identifier of the endpoint. |
controllerId | The unique identifier of the controller. |
Exception | The range setting of the controller identified by endpointId and controllerId cannot be retrieved. |
void com.amazon.aace.carControl.CarControl.setModeControllerValue | ( | String | endpointId, |
String | controllerId, | ||
String | value | ||
) | throws Exception |
Notifies the platform implementation to set the mode of the controller identified by endpointId
and controllerId
.
endpointId | The unique identifier of the endpoint. |
controllerId | The unique identifier of the controller. |
value | The new mode to set. |
Exception | The mode of the controller cannot be set. |
void com.amazon.aace.carControl.CarControl.adjustModeControllerValue | ( | String | endpointId, |
String | controllerId, | ||
int | delta | ||
) | throws Exception |
Notifies the platform implementation to adjust the mode of the controller identified by endpointId
and controllerId
.
endpointId | The unique identifier of the endpoint. |
controllerId | The unique identifier of the controller. |
delta | The delta by which to adjust the mode. |
Exception | The mode of the controller cannot be adjusted. |
String com.amazon.aace.carControl.CarControl.getModeControllerValue | ( | String | endpointId, |
String | controllerId | ||
) | throws Exception |
Retrieves the mode of the controller identified by endpointId
and controllerId
.
endpointId | The unique identifier of the endpoint. |
controllerId | The unique identifier of the controller. |
Exception | The mode of the controller identified by endpointId and controllerId cannot be retrieved. |
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