Animation feature

event messageolympe.messages.animation.availability(values=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Availability

Availability of the animations

Parameters:
  • values (BitfieldOf(olympe.enums.animation.type, u32)) – Bitfield of available animation types
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered when the list of available animations changes.

event messageolympe.messages.animation.state(type=None, percent=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.State

State of the animation

Parameters:
  • type (olympe.enums.animation.type) – Type of the animation. None if no animation is currently running or canceling.
  • percent (u8) – Percentage of the animation (only accurate if type is not none) (from 0 to 100).
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered when the state of the animation changes.

command messageolympe.messages.animation.cancel(_timeout=5, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Cancel

Cancel current animation.

Parameters:
  • _timeout (int) – command message timeout (defaults to 5)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: The state of the current animation (for example flip_state()) changes to canceling. Then, as soon as possible, the current animation is stopped and state() is triggered with type equals to none.

Expectations: state(_policy='wait')

command messageolympe.messages.animation.start_flip(type, _timeout=5, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_flip

Start a flip animation. Starting this animation when another animation is started (or canceling), will cancel the current one to start this one.

Parameters:
  • type (olympe.enums.animation.flip_type) – Type of the flip
  • _timeout (int) – command message timeout (defaults to 5)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, flip_state() is triggered with state equals to running and state() is triggered with type equals to flip.

Expectations: flip_state(type=self.type, state='running', _policy='wait') & state(type='flip', _policy='wait')

event messageolympe.messages.animation.flip_state(state=None, type=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Flip_state

Flip state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • type (olympe.enums.animation.flip_type) – Type of the flip (only accurate if state is not idle)
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_flip() and when the state changes.

command messageolympe.messages.animation.start_horizontal_panorama(provided_params, rotation_angle, rotation_speed, _timeout=5, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_horizontal_panorama

Start an horizontal panorama animation. Starting this animation when another animation is started (or canceling), will cancel the current one to start this one. This animation will make the drone horizontaly rotates on itself.

Parameters:
  • provided_params (BitfieldOf(olympe.enums.animation.horizontal_panorama_config_param, u8)) – Bitfield of the config parameters on which given values should be used. Setting a bit to 1 means that the corresponding parameter should be used, otherwise default value should be used.
  • rotation_angle (float) – Desired rotation angle in rad. Positive value makes a clockwise panorama, negative is anti- clockwise. Not used when rotation angle of provided_params param is 0.
  • rotation_speed (float) – The desired rotation speed of the anim in rad/s Not used when rotation speed of provided_params param is 0.
  • _timeout (int) – command message timeout (defaults to 5)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, horizontal_panorama_state() is triggered with state equals to running and state() is triggered with type equals to HorizontalPanorama.

Expectations: horizontal_panorama_state(state='running', _policy='wait') & state(type='horizontal_panorama', _policy='wait')

event messageolympe.messages.animation.horizontal_panorama_state(state=None, rotation_angle=None, rotation_speed=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Horizontal_panorama_state

Horizontal panorama state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • rotation_angle (float) – Rotation angle in rad. Positive value makes a clockwise panorama, negative is anti-clockwise. (only accurate if state is not idle)
  • rotation_speed (float) – The rotation speed of the anim in rad/s (only accurate if state is not idle)
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_horizontal_panorama() and when the state changes.

command messageolympe.messages.animation.start_dronie(provided_params, speed, distance, play_mode, _timeout=5, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_dronie

Start a dronie animation. Starting this animation when another animation is started (or canceling), will cancel the current one to start this one. This animation will make the drone flies away on a given distance with a computed angle.

Parameters:
  • provided_params (BitfieldOf(olympe.enums.animation.dronie_config_param, u8)) – Bitfield of the config parameters on which given values should be used. Setting a bit to 1 means that the corresponding parameter should be used, otherwise default value should be used.
  • speed (float) – Desired speed in m/s. Not used when speed of provided_params param is 0.
  • distance (float) – Desired dronie distance in m (length of the hypotenuse). Not used when distance of provided_params param is 0.
  • play_mode (olympe.enums.animation.play_mode) – Desired play mode. Not used when play mode of provided_params param is 0.
  • _timeout (int) – command message timeout (defaults to 5)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, dronie_state() is triggered with state equals to running and state() is triggered with type equals to Dronie.

Expectations: dronie_state(state='running', _policy='wait') & state(type='dronie', _policy='wait')

event messageolympe.messages.animation.dronie_state(state=None, speed=None, distance=None, play_mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Dronie_state

Dronie state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • speed (float) – Speed in m/s. (only accurate if state is not idle)
  • distance (float) – Dronie distance in m. (only accurate if state is not idle)
  • play_mode (olympe.enums.animation.play_mode) – Play mode. (only accurate if state is not idle)
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_dronie() and when the state changes.

command messageolympe.messages.animation.start_horizontal_reveal(provided_params, speed, distance, play_mode, _timeout=5, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_horizontal_reveal

Start an horizontal reveal animation. Starting this animation when another animation is started (or canceling), will cancel the current one to start this one. This animation will make the drone starts looking down, then moves forward while slowly looking at the horizon.

Parameters:
  • provided_params (BitfieldOf(olympe.enums.animation.horizontal_reveal_config_param, u8)) – Bitfield of the config parameters on which given values should be used. Setting a bit to 1 means that the corresponding parameter should be used, otherwise default value should be used.
  • speed (float) – Desired speed in m/s. Not used when speed of provided_params param is 0.
  • distance (float) – Desired distance in m. Not used when distance of provided_params param is 0.
  • play_mode (olympe.enums.animation.play_mode) – Desired play mode. Not used when play mode of provided_params param is 0.
  • _timeout (int) – command message timeout (defaults to 5)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, horizontal_reveal_state() is triggered with state equals to running and state() is triggered with type equals to HorizontalReveal.

Expectations: horizontal_reveal_state(state='running', _policy='wait') & state(type='horizontal_reveal', _policy='wait')

event messageolympe.messages.animation.horizontal_reveal_state(state=None, speed=None, distance=None, play_mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Horizontal_reveal_state

Horizontal reveal state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • speed (float) – Speed in m/s. (only accurate if state is not idle)
  • distance (float) – Distance in m. (only accurate if state is not idle)
  • play_mode (olympe.enums.animation.play_mode) – Play mode. (only accurate if state is not idle)
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_horizontal_reveal() and when the state changes.

command messageolympe.messages.animation.start_vertical_reveal(provided_params, speed, vertical_distance, rotation_angle, rotation_speed, play_mode, _timeout=5, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_vertical_reveal

Start a vertical reveal animation. Starting this animation when another animation is started (or canceling), will cancel the current one to start this one. This animation will make the drone starts looking down, then moves up while slowly looking at the horizon. When it reaches its target altitude, it rotates on itself to do a panorama.

Parameters:
  • provided_params (BitfieldOf(olympe.enums.animation.vertical_reveal_config_param, u8)) – Bitfield of the config parameters on which given values should be used. Setting a bit to 1 means that the corresponding parameter should be used, otherwise default value should be used.
  • speed (float) – Desired speed in m/s. Not used when speed of provided_params param is 0.
  • vertical_distance (float) – Desired vertical distance in m. Not used when vertical distance of provided_params param is 0.
  • rotation_angle (float) – Desired rotation angle in rad. Positive value makes a clockwise panorama, negative is anti- clockwise. Not used when rotation angle of provided_params param is 0.
  • rotation_speed (float) – The desired rotation speed of the anim in rad/s Not used when rotation speed of provided_params param is 0.
  • play_mode (olympe.enums.animation.play_mode) – Desired play mode. Not used when play mode of provided_params param is 0.
  • _timeout (int) – command message timeout (defaults to 5)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, vertical_reveal_state() is triggered with state equals to running and state() is triggered with type equals to VerticalReveal.

Expectations: vertical_reveal_state(state='running', _policy='wait') & state(type='vertical_reveal', _policy='wait')

event messageolympe.messages.animation.vertical_reveal_state(state=None, speed=None, vertical_distance=None, rotation_angle=None, rotation_speed=None, play_mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Vertical_reveal_state

Vertical reveal state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • speed (float) – Speed in m/s. (only accurate if state is not idle)
  • vertical_distance (float) – Vertical distance in m. (only accurate if state is not idle)
  • rotation_angle (float) – Rotation angle in rad. Positive value makes a clockwise panorama, negative is anti-clockwise. (only accurate if state is not idle)
  • rotation_speed (float) – The rotation speed of the anim in rad/s (only accurate if state is not idle)
  • play_mode (olympe.enums.animation.play_mode) – Play mode. (only accurate if state is not idle)
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_vertical_reveal() and when the state changes.

command messageolympe.messages.animation.start_spiral(provided_params, speed, radius_variation, vertical_distance, revolution_nb, play_mode, _timeout=5, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_spiral

Start a spiral animation. Starting this animation when another animation is started (or canceling), will cancel the current one to start this one. This animation will make the drone circles around its target.

Parameters:
  • provided_params (BitfieldOf(olympe.enums.animation.spiral_config_param, u8)) – Bitfield of the config parameters on which given values should be used. Setting a bit to 1 means that the corresponding parameter should be used, otherwise default value should be used.
  • speed (float) – Desired speed in m/s. Not used when speed of provided_params param is 0.
  • radius_variation (float) – Desired relative radius variation. A value of 2 means that the ending radius will be twice as big as the starting radius. A value of -2 means that the ending radius will half of the size of the starting radius. A value of 1 means that the radius will not change during the animation. Not used when radius variation of provided_params param is 0.
  • vertical_distance (float) – Desired vertical distance in m. If negative, the spiral will be directed to the ground. Not used when vertical distance of provided_params param is 0.
  • revolution_nb (float) – The number of revolution (in turn). Positive value makes a clockwise spiral, negative is anti-clockwise. Example: 1.5 makes an entire turn plus half of a turn
  • play_mode (olympe.enums.animation.play_mode) – Desired play mode. Not used when play mode of provided_params param is 0.
  • _timeout (int) – command message timeout (defaults to 5)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, spiral_state() is triggered with state equals to running and state() is triggered with type equals to Spiral.

Expectations: spiral_state(state='running', _policy='wait') & state(type='spiral', _policy='wait')

event messageolympe.messages.animation.spiral_state(state=None, speed=None, radius_variation=None, vertical_distance=None, revolution_nb=None, play_mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Spiral_state

Spiral state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • speed (float) – Speed in m/s. (only accurate if state is not idle)
  • radius_variation (float) – Relative radius variation in m. (only accurate if state is not idle)
  • vertical_distance (float) – Vertical distance in m. Negative value means the animation is directed toward the ground. (only accurate if state is not idle)
  • revolution_nb (float) – The number of revolution (in turn). (only accurate if state is not idle)
  • play_mode (olympe.enums.animation.play_mode) – Play mode. (only accurate if state is not idle)
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_spiral() and when the state changes.

command messageolympe.messages.animation.start_parabola(provided_params, speed, vertical_distance, play_mode, _timeout=5, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_parabola

Start a parabola animation. Starting this animation when another animation is started (or canceling), will cancel the current one to start this one. This animation will make the drone makes a parabola on top of its target and ends on the other side of it.

Parameters:
  • provided_params (BitfieldOf(olympe.enums.animation.parabola_config_param, u8)) – Bitfield of the config parameters on which given values should be used. Setting a bit to 1 means that the corresponding parameter should be used, otherwise default value should be used.
  • speed (float) – Desired speed in m/s. Not used when speed of provided_params param is 0.
  • vertical_distance (float) – Desired vertical distance in m. Not used when vertical distance of provided_params param is 0.
  • play_mode (olympe.enums.animation.play_mode) – Desired play mode. Not used when play mode of provided_params param is 0.
  • _timeout (int) – command message timeout (defaults to 5)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, parabola_state() is triggered with state equals to running and state() is triggered with type equals to Parabola.

Expectations: parabola_state(state='running', _policy='wait') & state(type='parabola', _policy='wait')

event messageolympe.messages.animation.parabola_state(state=None, speed=None, vertical_distance=None, play_mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Parabola_state

Parabola state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • speed (float) – Speed in m/s. (only accurate if state is not idle)
  • vertical_distance (float) – Vertical distance in m. (only accurate if state is not idle)
  • play_mode (olympe.enums.animation.play_mode) – Play mode. (only accurate if state is not idle)
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_parabola() and when the state changes.

command messageolympe.messages.animation.start_candle(provided_params, speed, vertical_distance, play_mode, _timeout=5, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_candle

Start a candle animation. Starting this animation when another animation is started (or canceling), will cancel the current one to start this one. This animation will make the drone flies horizontally in direction of the target then flies up.

Parameters:
  • provided_params (BitfieldOf(olympe.enums.animation.candle_config_param, u8)) – Bitfield of the config parameters on which given values should be used. Setting a bit to 1 means that the corresponding parameter should be used, otherwise default value should be used.
  • speed (float) – Desired speed in m/s. Not used when speed of provided_params param is 0.
  • vertical_distance (float) – Desired vertical distance in m. Not used when vertical distance of provided_params param is 0.
  • play_mode (olympe.enums.animation.play_mode) – Desired play mode. Not used when play mode of provided_params param is 0.
  • _timeout (int) – command message timeout (defaults to 5)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, candle_state() is triggered with state equals to running and state() is triggered with type equals to Candle.

Expectations: candle_state(state='running', _policy='wait') & state(type='candle', _policy='wait')

event messageolympe.messages.animation.candle_state(state=None, speed=None, vertical_distance=None, play_mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Candle_state

Candle state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • speed (float) – Speed in m/s. (only accurate if state is not idle)
  • vertical_distance (float) – Vertical distance in m. (only accurate if state is not idle)
  • play_mode (olympe.enums.animation.play_mode) – Play mode. (only accurate if state is not idle)
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_candle() and when the state changes.

command messageolympe.messages.animation.start_dolly_slide(provided_params, speed, angle, horizontal_distance, play_mode, _timeout=5, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_dolly_slide

Start a dolly slide animation. Starting this animation when another animation is started (or canceling), will cancel the current one to start this one. This animation will make the drone slides horizontally.

Parameters:
  • provided_params (BitfieldOf(olympe.enums.animation.dolly_slide_config_param, u8)) – Bitfield of the config parameters on which given values should be used. Setting a bit to 1 means that the corresponding parameter should be used, otherwise default value should be used.
  • speed (float) – Desired speed in m/s. Not used when speed of provided_params param is 0.
  • angle (float) – Desired drone-target-destination angle in rad. Not used when angle of provided_params param is 0.
  • horizontal_distance (float) – Desired horizontal distance in m.. Not used when angle of provided_params param is 0.
  • play_mode (olympe.enums.animation.play_mode) – Desired play mode. Not used when play mode of provided_params param is 0.
  • _timeout (int) – command message timeout (defaults to 5)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, dolly_slide_state() is triggered with state equals to running and state() is triggered with type equals to DollySlide.

Expectations: dolly_slide_state(state='running', _policy='wait') & state(type='dolly_slide', _policy='wait')

event messageolympe.messages.animation.dolly_slide_state(state=None, speed=None, angle=None, horizontal_distance=None, play_mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Dolly_slide_state

Dolly slide state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • speed (float) – Speed in m/s. (only accurate if state is not idle)
  • angle (float) – Drone-target-destination angle in rad. (only accurate if state is not idle)
  • horizontal_distance (float) – Horizontal distance in m. (only accurate if state is not idle)
  • play_mode (olympe.enums.animation.play_mode) – Play mode. (only accurate if state is not idle)
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_dolly_slide() and when the state changes.

command messageolympe.messages.animation.start_vertigo(provided_params, duration, max_zoom_level, finish_action, play_mode, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_vertigo

Start a vertigo animation. Starting this animation when another animation is started (or canceling) will cancel the current one to start this one. This animation will make the drone slides horizontally.

Parameters:
  • provided_params (BitfieldOf(olympe.enums.animation.vertigo_config_param, u8)) – Bitfield of the config parameters on which given values should be used. Setting a bit to 1 means that the corresponding parameter should be used, otherwise default value should be used.
  • duration (float) – Desired duration in seconds. Not used when duration of provided_params param is 0.
  • max_zoom_level (float) – Desired maximum zoom level. Not used when max_zoom_level of provided_params param is 0.
  • finish_action (olympe.enums.animation.vertigo_finish_action) – Desired action to execute at the end of the animation. Not used when finish_action of provided_params param is 0.
  • play_mode (olympe.enums.animation.play_mode) – Desired play mode. Not used when play mode of provided_params param is 0.
  • _timeout (int) – command message timeout (defaults to 10)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, vertigo_state() is triggered with state equals to running and state() is triggered with type equals to Vertigo.

Expectations: vertigo_state(state='running', _policy='wait') & state(type='vertigo', _policy='wait')

event messageolympe.messages.animation.vertigo_state(state=None, duration=None, max_zoom_level=None, finish_action=None, play_mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Vertigo_state

Vertigo state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation.
  • duration (float) – Duration in seconds. (only accurate if state is not idle)
  • max_zoom_level (float) – Maximum zoom level. (only accurate if state is not idle)
  • finish_action (olympe.enums.animation.vertigo_finish_action) – Action that will be executed at the end of the animation. (only accurate if state is not idle)
  • play_mode (olympe.enums.animation.play_mode) – Play mode. (only accurate if state is not idle)
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_vertigo() and when the state changes.

command messageolympe.messages.animation.start_twist_up(provided_params, speed, vertical_distance, rotation_angle, rotation_speed, play_mode, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_twist_up

Starts a twist-up animation. Starting this animation when another animation is started (or canceling), will cancel the current one to start this one. This animation will make the drone move up and rotate slowly on itself until the end of the animation, first with the camera looking down and when it reaches its target altitude, slowly looking up to the horizon.

Parameters:
  • provided_params (BitfieldOf(olympe.enums.animation.twist_up_config_param, u8)) – Bitfield of the config parameters on which given values should be used. Setting a bit to 1 means that the corresponding parameter should be used, otherwise default value should be used.
  • speed (float) – Desired speed in m/s. Not used when speed of provided_params param is 0.
  • vertical_distance (float) – Desired vertical distance in m. Not used when vertical distance of provided_params param is 0.
  • rotation_angle (float) – Desired rotation angle in rad. Positive value makes a clockwise panorama, negative is anti- clockwise. Not used when rotation angle of provided_params param is 0.
  • rotation_speed (float) – The desired rotation speed of the anim in rad/s Not used when rotation speed of provided_params param is 0.
  • play_mode (olympe.enums.animation.play_mode) – Desired play mode. Not used when play mode of provided_params param is 0.
  • _timeout (int) – command message timeout (defaults to 10)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, twist_up_state() is triggered with state equals to running and state() is triggered with type equals to TwistUp.

Expectations: twist_up_state(state='running', _policy='wait') & state(type='twist_up', _policy='wait')

event messageolympe.messages.animation.twist_up_state(state=None, speed=None, vertical_distance=None, rotation_angle=None, rotation_speed=None, play_mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Twist_up_state

Twist-up state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • speed (float) – Speed in m/s. (only accurate if state is not idle)
  • vertical_distance (float) – Vertical distance in m. (only accurate if state is not idle)
  • rotation_angle (float) – Rotation angle in rad. Positive value makes a clockwise panorama, negative is anti-clockwise. (only accurate if state is not idle)
  • rotation_speed (float) – The rotation speed of the anim in rad/s (only accurate if state is not idle)
  • play_mode (olympe.enums.animation.play_mode) – Play mode. (only accurate if state is not idle)
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_twist_up() and when the state changes.

command messageolympe.messages.animation.start_position_twist_up(provided_params, speed, vertical_distance, rotation_angle, rotation_speed, play_mode, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_position_twist_up

Starts a positionned twist-up animation. Starting this animation when another animation is started (or canceling), will cancel the current one to start this one. This animation needs a target. This animation will make the drone move above the target then up and rotate slowly on itself until the end of the animation.

Parameters:
  • provided_params (BitfieldOf(olympe.enums.animation.twist_up_config_param, u8)) – Bitfield of the config parameters on which given values should be used. Setting a bit to 1 means that the corresponding parameter should be used, otherwise default value should be used.
  • speed (float) – Desired speed in m/s. Not used when speed of provided_params param is 0.
  • vertical_distance (float) – Desired vertical distance in m. Not used when vertical distance of provided_params param is 0.
  • rotation_angle (float) – Desired rotation angle in rad. Positive value makes a clockwise panorama, negative is anti- clockwise. Not used when rotation angle of provided_params param is 0.
  • rotation_speed (float) – The desired rotation speed of the anim in rad/s Not used when rotation speed of provided_params param is 0.
  • play_mode (olympe.enums.animation.play_mode) – Desired play mode. Not used when play mode of provided_params param is 0.
  • _timeout (int) – command message timeout (defaults to 10)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, position_twist_up_state() is triggered with state equals to running and state() is triggered with type equals to PositionTwistUp.

Expectations: position_twist_up_state(state='running', _policy='wait') & state(type='position_twist_up', _policy='wait')

event messageolympe.messages.animation.position_twist_up_state(state=None, speed=None, vertical_distance=None, rotation_angle=None, rotation_speed=None, play_mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Position_twist_up_state

Positionned Twist-up state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • speed (float) – Speed in m/s. (only accurate if state is not idle)
  • vertical_distance (float) – Vertical distance in m. (only accurate if state is not idle)
  • rotation_angle (float) – Rotation angle in rad. Positive value makes a clockwise panorama, negative is anti-clockwise. (only accurate if state is not idle)
  • rotation_speed (float) – The rotation speed of the anim in rad/s (only accurate if state is not idle)
  • play_mode (olympe.enums.animation.play_mode) – Play mode. (only accurate if state is not idle)
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_position_twist_up() and when the state changes.

command messageolympe.messages.animation.start_horizontal_180_photo_panorama(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_horizontal_180_photo_panorama

Starts an horizontal 180 degrees photo panorama animation. Starting this animation when another animation is started (or canceling) will cancel the current one to start this one. This animation will make the drone perform a 180 degrees rotation on the yaw axis while take photos at various angles

Parameters:
  • _timeout (int) – command message timeout (defaults to 10)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, horizontal_180_photo_panorama_state() is triggered with state running and state() is triggered with type equals to horizontal_180_photo_panorama.

Expectations: horizontal_180_photo_panorama_state(state='running', _policy='wait') & state(type='horizontal_180_photo_panorama', _policy='wait')

event messageolympe.messages.animation.horizontal_180_photo_panorama_state(state=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Horizontal_180_photo_panorama_state

Horizontal 180 degrees photo panorama state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_horizontal_180_photo_panorama() and when the state changes.

command messageolympe.messages.animation.start_vertical_180_photo_panorama(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_vertical_180_photo_panorama

Starts a vertical 180 degrees photo panorama animation. Starting this animation when another animation is started (or canceling) will cancel the current one to start this one. This animation will make the the drone camera perform a 180 degrees rotation on the tilt axis while taking photos at various angles.

Parameters:
  • _timeout (int) – command message timeout (defaults to 10)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, vertical_180_photo_panorama_state() is triggered with state running and state() is triggered with type equals to vertical_180_photo_panorama.

Expectations: vertical_180_photo_panorama_state(state='running', _policy='wait') & state(type='vertical_180_photo_panorama', _policy='wait')

event messageolympe.messages.animation.vertical_180_photo_panorama_state(state=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Vertical_180_photo_panorama_state

Vertical 180 degrees photo panorama state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_vertical_180_photo_panorama() and when the state changes.

command messageolympe.messages.animation.start_spherical_photo_panorama(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Animation.Start_spherical_photo_panorama

Starts a spherical photo panorama animation. Starting this animation when another animation is started (or canceling) will cancel the current one to start this one. This animation will make the drone perform a 360 degrees rotation on the yaw axis. At various angles, rotation pauses, drone camera performs a 180 degrees rotation on the tilt axis while taking photos at various angles, then drone yaw rotation resumes.

Parameters:
  • _timeout (int) – command message timeout (defaults to 10)
  • _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Result: If an animation was running, this animation is canceling, then canceled. Then, this animation is started, spherical_photo_panorama_state() is triggered with state running and state() is triggered with type equals to spherical_photo_panorama.

Expectations: spherical_photo_panorama_state(state='running', _policy='wait') & state(type='spherical_photo_panorama', _policy='wait')

event messageolympe.messages.animation.spherical_photo_panorama_state(state=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Animation.Spherical_photo_panorama_state

Spherical photo panorama state

Parameters:
  • state (olympe.enums.animation.state) – State of the animation
  • _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)
  • _float_tol (tuple) – specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

Triggered by start_spherical_photo_panorama() and when the state changes.

enumolympe.enums.animation.type

Animation type.

none:No animation (0)
flip:The drone makes a flip (1)
horizontal_panorama:
 The drone horizontaly rotates on itself (2)
dronie:The drone flies away on a given distance with a computed angle (3)
horizontal_reveal:
 The drone starts looking down, then moves forward while slowly looking at the horizon (4)
vertical_reveal:
 The drone starts looking down, then moves up while slowly looking at the horizon. When it reaches its target altitude, it rotates on itself to do a panorama. (5)
spiral:The drone circles around its target. (6)
parabola:The drone makes a parabola on top of its target and ends on the other side of it. (7)
candle:The drone flies horizontally in direction of the target then flies up. (8)
dolly_slide:The drone slides horizontally. (9)
vertigo:Zoom in on the subject, while the drone moves away from it. (10)
twist_up:The drone moves up while rotating slowly on itself. (11)
position_twist_up:
 The drone place itself above the target, then moves up while rotating slowly on itself. (12)
horizontal_180_photo_panorama:
 The drone performs a 180 degrees rotation on the yaw axis while taking photos at various angles. The resulting set of photos can then be retrieved as a single media that may be post-processed to make panoramic images. (13)
vertical_180_photo_panorama:
 The drone camera performs a 180 degrees rotation on the tilt axis while taking photos at various angles. The resulting set of photos can then be retrieved as a single media that may be post-processed to make panoramic images. (14)
spherical_photo_panorama:
 The drone performs a 360 degrees rotation on the yaw axis. At various angles, rotation pauses, drone camera performs a 180 degrees rotation on the tilt axis while taking photos at various angles, then drone yaw rotation resumes. The resulting set of photos can then be retrieved as a single media that may be post-processed to make panoramic images. (15)
enumolympe.enums.animation.state

Animation state.

idle:The animation is not running. (0)
running:The animation is running. (1)
canceling:The current animation is canceling. (2)
enumolympe.enums.animation.play_mode

Animation play mode.

normal:Animation is played once, normally. (0)
once_then_mirrored:
 Animation is played once and then the animation is played mirrored. (1)
enumolympe.enums.animation.flip_type

Animation flip type.

front:The drone makes a front flip (0)
back:The drone makes a back flip (1)
left:The drone makes a left flip (its left side goes up) (2)
right:The drone makes a right flip (its right side goes up) (3)
enumolympe.enums.animation.horizontal_panorama_config_param

Horizontal panorama configuration parameter.

rotation_angle:Rotation angle parameter. (0)
rotation_speed:Rotation speed parameter. (1)
enumolympe.enums.animation.dronie_config_param

Dronie animation configuration parameter.

Enum aliases:

speed:Speed parameter. (0)
distance:Distance parameter. (1)
play_mode:Play mode parameter. (2)
enumolympe.enums.animation.horizontal_reveal_config_param

Horizontal reveal animation configuration parameter.

Enum aliases:

speed:Speed parameter. (0)
distance:Distance parameter. (1)
play_mode:Play mode parameter. (2)
enumolympe.enums.animation.vertical_reveal_config_param

Vertical reveal animation configuration parameter.

Enum aliases:

speed:Speed parameter. (0)
vertical_distance:
 Vertical distance parameter. (1)
rotation_angle:Rotation angle parameter. (2)
rotation_speed:Rotation speed parameter. (3)
play_mode:Play mode parameter. (4)
enumolympe.enums.animation.spiral_config_param

Spiral animation configuration parameter.

speed:Speed parameter. (0)
radius_variation:
 Radius variation parameter. (1)
vertical_distance:
 Vertical distance parameter. (2)
revolution_nb:Revolution number parameter. (3)
play_mode:Play mode parameter. (4)
enumolympe.enums.animation.parabola_config_param

Parabola animation configuration parameter.

Enum aliases:

speed:Speed parameter. (0)
vertical_distance:
 Vertical distance parameter. (1)
play_mode:Play mode parameter. (2)
enumolympe.enums.animation.candle_config_param

Candle animation configuration parameter.

Enum aliases:

speed:Speed parameter. (0)
vertical_distance:
 Vertical distance parameter. (1)
play_mode:Play mode parameter. (2)
enumolympe.enums.animation.dolly_slide_config_param

Dolly slide animation configuration parameter.

speed:Speed parameter. (0)
angle:Angle parameter. (1)
horizontal_distance:
 Horizontal distance parameter. (2)
play_mode:Play mode parameter. (3)
enumolympe.enums.animation.vertigo_config_param

Vertigo animation configuration parameter.

duration:Duration parameter. (0)
max_zoom_level:Maximum zoom level parameter. (1)
finish_action:Finish action parameter. (2)
play_mode:Play mode parameter. (3)
enumolympe.enums.animation.twist_up_config_param

Twist-up animation configuration parameter.

Enum aliases:

speed:Speed parameter. (0)
vertical_distance:
 Vertical distance parameter. (1)
rotation_angle:Rotation angle parameter. (2)
rotation_speed:Rotation speed parameter. (3)
play_mode:Play mode parameter. (4)
enumolympe.enums.animation.vertigo_finish_action

Action to execute at the end of a Vertigo.

none:Do nothing special. (0)
unzoom:Move zoom level back to x1. (1)
enumolympe.enums.animation.list_flags

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages

First: Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages (0)
Last: Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages (1)
Empty: Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages (2)
Remove: Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages (3)