![]() |
Alexa Auto SDK
2.3.0
|
Public Member Functions | |
| CarControl ()=default | |
| virtual | ~CarControl () |
| virtual bool | turnPowerControllerOn (const std::string &endpointId) |
| virtual bool | turnPowerControllerOff (const std::string &endpointId) |
| virtual bool | isPowerControllerOn (const std::string &endpointId, bool &isOn) |
| virtual bool | turnToggleControllerOn (const std::string &endpointId, const std::string &controllerId) |
| virtual bool | turnToggleControllerOff (const std::string &endpointId, const std::string &controllerId) |
| virtual bool | isToggleControllerOn (const std::string &endpointId, const std::string &controllerId, bool &isOn) |
| virtual bool | setRangeControllerValue (const std::string &endpointId, const std::string &controllerId, double value) |
| virtual bool | adjustRangeControllerValue (const std::string &endpointId, const std::string &controllerId, double delta) |
| virtual bool | getRangeControllerValue (const std::string &endpointId, const std::string &controllerId, double &value) |
| virtual bool | setModeControllerValue (const std::string &endpointId, const std::string &controllerId, const std::string &value) |
| virtual bool | adjustModeControllerValue (const std::string &endpointId, const std::string &controllerId, int delta) |
| virtual bool | getModeControllerValue (const std::string &endpointId, const std::string &controllerId, std::string &value) |
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.
|
default |
CarControl constructor.
|
virtualdefault |
CarControl destructor.
|
virtual |
Notifies the platform implementation to power on the controller identified by endpointId.
| [in] | endpointId | The unique identifier of the endpoint. |
true if successful.PowerController
|
virtual |
Notifies the platform implementation to power off the controller identified by endpointId.
| [in] | endpointId | The unique identifier of the endpoint. |
true if successful.
|
virtual |
Retrieves the power state of the controller identified by endpointId from the platform implementation.
| [in] | endpointId | The unique identifier of the endpoint. |
| [out] | isOn | To be set to true by the implementation if the controller is powered on. |
true if isOn was successfully updated, false if the power state of the controller cannot be retrieved.
|
virtual |
Notifies the platform implementation to turn on the controller identified by endpointId and controllerId.
| [in] | endpointId | The unique identifier of the endpoint. |
| [in] | controllerId | The unique identifier of the controller. |
true if successful.ToggleController
|
virtual |
Notifies the platform implementation to turn off the controller identified by endpointId and controllerId.
| [in] | endpointId | The unique identifier of the endpoint. |
| [in] | controllerId | The unique identifier of the controller. |
true if successful.
|
virtual |
Retrieves the power state of the controller identified by endpointId and controllerId from the platform implementation.
| [in] | endpointId | The unique identifier of the endpoint. |
| [in] | controllerId | The unique identifier of the controller. |
| [out] | isOn | To be set to true by the implementation if the controller is turned on. |
true if isOn was successfully updated, false if the power state of the controller cannot be retrieved.
|
virtual |
Notifies the platform implementation to set the range setting of the controller identified by endpointId and controllerId.
| [in] | endpointId | The unique identifier of the endpoint. |
| [in] | controllerId | The unique identifier of the controller. |
| [in] | value | The new range setting. |
true if successful.RangeController
|
virtual |
Notifies the platform implementation to adjust the range setting of the controller identified by endpointId and controllerId.
| [in] | endpointId | The unique identifier of the endpoint. |
| [in] | controllerId | The unique identifier of the controller. |
| [in] | delta | The delta by which to adjust the range setting. |
true if successful.
|
virtual |
Retrieves the range setting of the controller identified by endpointId and controllerId.
| [in] | endpointId | The unique identifier of the endpoint. |
| [in] | controllerId | The unique identifier of the controller. |
| [out] | value | To be set to the current range setting by the implementation. |
true if value was successfully updated, false if the range setting of the controller cannot be retrieved.
|
virtual |
Notifies the platform implementation to set the mode of the controller identified by endpointId and controllerId.
| [in] | endpointId | The unique identifier of the endpoint. |
| [in] | controllerId | The unique identifier of the controller. |
| [in] | value | The new mode to set. |
true if successful.ModeController
|
virtual |
Notifies the platform implementation to adjust the mode of the controller identified by endpointId and controllerId.
| [in] | endpointId | The unique identifier of the endpoint. |
| [in] | controllerId | The unique identifier of the controller. |
| [in] | delta | The delta by which to adjust the mode. |
true if successful.
|
virtual |
Retrieves the mode of the controller identified by endpointId and controllerId.
| [in] | endpointId | The unique identifier of the endpoint. |
| [in] | controllerId | The unique identifier of the controller. |
| [out] | value | To be set to the current mode by the implementation. |
true if value was successfully updated, false if the mode of the controller cannot be retrieved. Alexa Auto SDK 2.3.0 - Copyright 2017-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0