Common.Mavlink*

command message olympe.messages.common.Mavlink.Pause(_timeout=20, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

common.Mavlink.Pause

Pause a FlightPlan that was playing. To unpause a FlightPlan, see Start()

Parameters:

_timeoutint

command message timeout (defaults to 20)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Result: The currently playing FlightPlan will be paused. Then, event MavlinkFilePlayingStateChanged() is triggered with param state set to the current state of the FlightPlan (should be paused if everything went well).

Expectations: MavlinkFilePlayingStateChanged(state='paused', _policy='wait')

command message olympe.messages.common.Mavlink.Start(filepath, type='flightPlan', _timeout=20, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

common.Mavlink.Start

Start a FlightPlan based on a mavlink file existing on the drone. Requirements are: * Product is calibrated * Product should be in outdoor mode * Product has fixed its GPS

Parameters:

filepathstring

flight plan file path from the mavlink ftp root

type : olympe.enums.common.Mavlink.Start_Type

_timeoutint

command message timeout (defaults to 20)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Result: If the FlightPlan has been started, event MavlinkFilePlayingStateChanged() is triggered with param state set to playing. Otherwise, event MavlinkFilePlayingStateChanged() is triggered with param state set to stopped and event MavlinkPlayErrorStateChanged() is triggered with an explanation of the error.

Expectations: MavlinkFilePlayingStateChanged(state='playing', type=self.type, _policy='wait')

command message olympe.messages.common.Mavlink.Stop(_timeout=20, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

common.Mavlink.Stop

Stop a FlightPlan that was playing.

Parameters:

_timeoutint

command message timeout (defaults to 20)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Result: The currently playing FlightPlan will be stopped. Then, event MavlinkFilePlayingStateChanged() is triggered with param state set to the current state of the FlightPlan (should be stopped if everything went well).

Expectations: MavlinkFilePlayingStateChanged(state='stopped', _policy='wait')

enum olympe.enums.common.Mavlink.Start_Type

type of the played mavlink file

Enum aliases:

• olympe.enums.common.Start_Type

• olympe.enums.common.MavlinkFilePlayingStateChanged_Type

• olympe.enums.flight_plan.mavlink_type

flightPlan:

Mavlink file for FlightPlan (0)

mapMyHouse:

Mavlink file for MapMyHouse (1)

flightPlanV2:

Mavlink file for FlightPlan V2 (better follow the standard) (2)

event message olympe.messages.common.MavlinkState.MavlinkFilePlayingStateChanged(state=None, filepath=None, type=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.MavlinkState.MavlinkFilePlayingStateChanged

Playing state of a FlightPlan.

Parameters:

state : olympe.enums.common.MavlinkState.MavlinkFilePlayingStateChanged_State

filepathstring

flight plan file path from the mavlink ftp root

type : olympe.enums.common.MavlinkState.MavlinkFilePlayingStateChanged_Type

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Triggered: by Start(), Pause() or Stop().

event message olympe.messages.common.MavlinkState.MavlinkPlayErrorStateChanged(error=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.MavlinkState.MavlinkPlayErrorStateChanged

FlightPlan error.

Parameters:

error : olympe.enums.common.MavlinkState.MavlinkPlayErrorStateChanged_Error

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message common.MavlinkState.MavlinkPlayErrorStateChanged

Deprecated message

Warning

This message is deprecated and should no longer be used

Triggered: by Start() if an error occurs.

event message olympe.messages.common.MavlinkState.MissionItemExecuted(idx=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

common.MavlinkState.MissionItemExecuted

Mission item has been executed.

Parameters:

idxu32

Index of the mission item. This is the place of the mission item in the list of the items of the mission. Begins at 0.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

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

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Supported by:

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Triggered: when a mission item has been executed during a flight plan.

enum olympe.enums.common.MavlinkState.MavlinkFilePlayingStateChanged_State

State of the mavlink

playing:

Mavlink file is playing (0)

stopped:

Mavlink file is stopped (arg filepath and type are useless in this state) (1)

paused:

Mavlink file is paused (2)

loaded:

Mavlink file is loaded (it will be played at take-off) (3)

enum olympe.enums.common.MavlinkState.MavlinkFilePlayingStateChanged_Type

type of the played mavlink file

Enum aliases:

• olympe.enums.common.Start_Type

• olympe.enums.common.MavlinkFilePlayingStateChanged_Type

• olympe.enums.flight_plan.mavlink_type

flightPlan:

Mavlink file for FlightPlan (0)

mapMyHouse:

Mavlink file for MapMyHouse (1)

flightPlanV2:

Mavlink file for FlightPlan V2 (better follow the standard) (2)

enum olympe.enums.common.MavlinkState.MavlinkPlayErrorStateChanged_Error

State of play error

none:

There is no error (0)

notInOutDoorMode:

The drone is not in outdoor mode (1)

gpsNotFixed:

The gps is not fixed (2)

notCalibrated:

The magnetometer of the drone is not calibrated (3)