Alexa Auto SDK  2.3.1
Public Member Functions | List of all members
com.amazon.aace.carControl.CarControl Class Referenceabstract

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
 

Detailed Description

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:

Constructor & Destructor Documentation

◆ CarControl()

com.amazon.aace.carControl.CarControl.CarControl ( )

CarControl constructor.

Member Function Documentation

◆ turnPowerControllerOn()

void com.amazon.aace.carControl.CarControl.turnPowerControllerOn ( String  endpointId) throws Exception

Notifies the platform implementation to power on the controller identified by endpointId.

Parameters
endpointIdThe unique identifier of the endpoint.
Exceptions
ExceptionThe controller cannot be powered on.

◆ turnPowerControllerOff()

void com.amazon.aace.carControl.CarControl.turnPowerControllerOff ( String  endpointId) throws Exception

Notifies the platform implementation to power off the controller identified by endpointId.

Parameters
endpointIdThe unique identifier of the endpoint.
Exceptions
ExceptionThe controller cannot be powered off.

◆ isPowerControllerOn()

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.

Parameters
endpointIdThe unique identifier of the endpoint.
Exceptions
ExceptionThe power state of the controller identified by endpointId cannot be retrieved.
Returns
true if the power controller is on.

◆ turnToggleControllerOn()

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.

Parameters
endpointIdThe unique identifier of the endpoint.
controllerIdThe unique identifier of the controller.
Exceptions
ExceptionThe controller cannot be powered on.

◆ turnToggleControllerOff()

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.

Parameters
endpointIdThe unique identifier of the endpoint.
controllerIdThe unique identifier of the controller.
Exceptions
ExceptionThe controller cannot be powered off.

◆ isToggleControllerOn()

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.

Parameters
endpointIdThe unique identifier of the endpoint.
controllerIdThe unique identifier of the controller.
Exceptions
ExceptionThe power state of the controller identified by endpointId and controllerId cannot be retrieved.
Returns
true if the controller is on.

◆ setRangeControllerValue()

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.

Parameters
endpointIdThe unique identifier of the endpoint.
controllerIdThe unique identifier of the controller.
valueThe new range setting.
Exceptions
ExceptionThe range setting of the controller cannot be set.

◆ adjustRangeControllerValue()

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.

Parameters
endpointIdThe unique identifier of the endpoint.
controllerIdThe unique identifier of the controller.
deltaThe delta by which to adjust the range setting.
Exceptions
ExceptionThe range setting of the controller cannot be adjusted.

◆ getRangeControllerValue()

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.

Parameters
endpointIdThe unique identifier of the endpoint.
controllerIdThe unique identifier of the controller.
Exceptions
ExceptionThe range setting of the controller identified by endpointId and controllerId cannot be retrieved.
Returns
The range setting of the controller.

◆ setModeControllerValue()

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.

Parameters
endpointIdThe unique identifier of the endpoint.
controllerIdThe unique identifier of the controller.
valueThe new mode to set.
Exceptions
ExceptionThe mode of the controller cannot be set.

◆ adjustModeControllerValue()

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.

Parameters
endpointIdThe unique identifier of the endpoint.
controllerIdThe unique identifier of the controller.
deltaThe delta by which to adjust the mode.
Exceptions
ExceptionThe mode of the controller cannot be adjusted.

◆ getModeControllerValue()

String com.amazon.aace.carControl.CarControl.getModeControllerValue ( String  endpointId,
String  controllerId 
) throws Exception

Retrieves the mode of the controller identified by endpointId and controllerId.

Parameters
endpointIdThe unique identifier of the endpoint.
controllerIdThe unique identifier of the controller.
Exceptions
ExceptionThe mode of the controller identified by endpointId and controllerId cannot be retrieved.
Returns
The mode of the controller.

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