ask_sdk_model.services.gadget_controller package¶
Submodules¶
Note
Canonical imports have been added in the __init__.py
of the package.
This helps in importing the class directly from the package, than
through the module.
For eg: if package a
has module b
with
class C
, you can do from a import C
instead of
from a.b import C
.
ask_sdk_model.services.gadget_controller.animation_step module¶
-
class
ask_sdk_model.services.gadget_controller.animation_step.
AnimationStep
(duration_ms=None, color=None, blend=None)¶ Bases:
object
Parameters: - duration_ms ((optional) int) – The duration in milliseconds to render this step.
- color ((optional) str) – The color to render specified in RGB hexadecimal values. There are a number of Node.js libraries available for working with color.
- blend ((optional) bool) – A boolean that indicates whether to interpolate from the previous color into this one over the course of this directive's durationMs.
-
attribute_map
= {'blend': 'blend', 'color': 'color', 'duration_ms': 'durationMs'}¶
-
deserialized_types
= {'blend': 'bool', 'color': 'str', 'duration_ms': 'int'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_sdk_model.services.gadget_controller.light_animation module¶
-
class
ask_sdk_model.services.gadget_controller.light_animation.
LightAnimation
(repeat=None, target_lights=None, sequence=None)¶ Bases:
object
Parameters: - repeat ((optional) int) – The number of times to play this animation.
- target_lights ((optional) list[str]) – An array of strings that represent the light addresses on the target gadgets that this animation will be applied to. Because the Echo Button has one light only, use ["1"] to signify that this animation should be sent to light one.
- sequence ((optional) list[ask_sdk_model.services.gadget_controller.animation_step.AnimationStep]) – The animation steps to render in order. The maximum number of steps that you can define is 38. The minimum is 0. Each step must have the following fields, all of which are required.
-
attribute_map
= {'repeat': 'repeat', 'sequence': 'sequence', 'target_lights': 'targetLights'}¶
-
deserialized_types
= {'repeat': 'int', 'sequence': 'list[ask_sdk_model.services.gadget_controller.animation_step.AnimationStep]', 'target_lights': 'list[str]'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_sdk_model.services.gadget_controller.set_light_parameters module¶
-
class
ask_sdk_model.services.gadget_controller.set_light_parameters.
SetLightParameters
(trigger_event=None, trigger_event_time_ms=None, animations=None)¶ Bases:
object
Arguments that pertain to animating the buttons.
Parameters: - trigger_event ((optional) ask_sdk_model.services.gadget_controller.trigger_event_type.TriggerEventType) –
- trigger_event_time_ms ((optional) int) –
- animations ((optional) list[ask_sdk_model.services.gadget_controller.light_animation.LightAnimation]) –
-
attribute_map
= {'animations': 'animations', 'trigger_event': 'triggerEvent', 'trigger_event_time_ms': 'triggerEventTimeMs'}¶
-
deserialized_types
= {'animations': 'list[ask_sdk_model.services.gadget_controller.light_animation.LightAnimation]', 'trigger_event': 'ask_sdk_model.services.gadget_controller.trigger_event_type.TriggerEventType', 'trigger_event_time_ms': 'int'}¶
-
supports_multiple_types
= False¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
ask_sdk_model.services.gadget_controller.trigger_event_type module¶
-
class
ask_sdk_model.services.gadget_controller.trigger_event_type.
TriggerEventType
¶ Bases:
enum.Enum
The action that triggers the animation. Possible values are as follows * `buttonDown` - Play the animation when the button is pressed. * `buttonUp` - Play the animation when the button is released. * `none` - Play the animation as soon as it arrives.
Allowed enum values: [buttonDown, buttonUp, none]
-
none
= 'none'¶
-
to_dict
()¶ Returns the model properties as a dict
-
to_str
()¶ Returns the string representation of the model
-