Ardrone3.GPS*#
- command message olympe.messages.ardrone3.GPSSettings.HomeType(type, _timeout=20, _no_expect=False, _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettings.HomeType
Set the preferred home type. Please note that this is only a preference. The actual type chosen is given by the event
HomeTypeChosenChanged()
. You can get the currently available types with the eventHomeTypeAvailabilityChanged()
.- Parameters:
_timeout (int) – command message timeout (defaults to 20)
_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
Supported by:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Deprecated message
Warning
This message is deprecated and should no longer be used
Result: The user choice is known by the drone. Then, event
HomeTypeChanged()
is triggered.Expectations:
HomeTypeChanged(type=self.type, _policy='wait')
- command message olympe.messages.ardrone3.GPSSettings.ResetHome(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettings.ResetHome
Reset home position.
- 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
Unsupported message
Todo
Remove unsupported message ardrone3.GPSSettings.ResetHome
Deprecated message
Warning
This message is deprecated and should no longer be used
Result: The home position is reset. Then, event
ResetHomeChanged()
is triggered.
- command message olympe.messages.ardrone3.GPSSettings.ReturnHomeDelay(delay, _timeout=20, _no_expect=False, _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettings.ReturnHomeDelay
Set the delay after which the drone will automatically try to return home after a disconnection.
- Parameters:
delay (u16) – Delay in second
_timeout (int) – command message timeout (defaults to 20)
_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
Supported by:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Deprecated message
Warning
This message is deprecated and should no longer be used
Result: The delay of the return home is set. Then, event
ReturnHomeDelayChanged()
is triggered.Expectations:
ReturnHomeDelayChanged(delay=self.delay, _policy='wait')
- command message olympe.messages.ardrone3.GPSSettings.ReturnHomeMinAltitude(value, _timeout=20, _no_expect=False, _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettings.ReturnHomeMinAltitude
Set the return home minimum altitude. If the drone is below this altitude when starting its return home, it will first reach the minimum altitude. If it is higher than this minimum altitude, it will operate its return home at its actual altitude.
- Parameters:
value (float) – Altitude in meters, relative to the take off point. Bounds are given by the event
ReturnHomeMinAltitudeChanged()
._timeout (int) – command message timeout (defaults to 20)
_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
Supported by:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Deprecated message
Warning
This message is deprecated and should no longer be used
Result: The minimum altitude for the return home is set. Then, event
ReturnHomeMinAltitudeChanged()
is triggered.Expectations:
ReturnHomeMinAltitudeChanged(value=self.value, _policy='wait')
- command message olympe.messages.ardrone3.GPSSettings.SendControllerGPS(latitude, longitude, altitude, horizontalAccuracy=1.0, verticalAccuracy=1.0, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettings.SendControllerGPS
Set controller gps location. The user location might be used in case of return home, according to the home type and the accuracy of the given position. You can get the current home type with the event
HomeTypeChanged()
.- Parameters:
latitude (double) – GPS latitude in decimal degrees
longitude (double) – GPS longitude in decimal degrees
altitude (double) – GPS altitude in meters
horizontalAccuracy (double) – Horizontal Accuracy in meter ; equal -1 if no horizontal Accuracy
verticalAccuracy (double) – Vertical Accuracy in meter ; equal -1 if no vertical Accuracy
_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
Unsupported message
Todo
Remove unsupported message ardrone3.GPSSettings.SendControllerGPS
Result: The controller position is known by the drone. Then, event
GPSFixStateChanged()
is triggered.Expectations:
GPSFixStateChanged(_policy='wait')
- command message olympe.messages.ardrone3.GPSSettings.SetHome(latitude, longitude, altitude, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettings.SetHome
Set home position.
- Parameters:
latitude (double) – Home latitude in decimal degrees
longitude (double) – Home longitude in decimal degrees
altitude (double) – Home altitude in meters
_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
Unsupported message
Todo
Remove unsupported message ardrone3.GPSSettings.SetHome
Deprecated message
Warning
This message is deprecated and should no longer be used
- enum olympe.enums.ardrone3.GPSSettings.HomeType_Type#
The type of the home position
Enum aliases:
olympe.enums.ardrone3.HomeType_Type
olympe.enums.ardrone3.HomeTypeChanged_Type
- TAKEOFF:
The drone will try to return to the take off position (0)
- PILOT:
The drone will try to return to the pilot position (1)
- FOLLOWEE:
The drone will try to return to the target of the current (or last) follow me (2)
- event message olympe.messages.ardrone3.GPSSettingsState.GPSFixStateChanged(fixed=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettingsState.GPSFixStateChanged
Gps fix info.
- Parameters:
fixed (u8) – 1 if gps on drone is fixed, 0 otherwise
_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
Supported by:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Triggered on change.
- event message olympe.messages.ardrone3.GPSSettingsState.GPSUpdateStateChanged(state=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettingsState.GPSUpdateStateChanged
Gps update state.
- Parameters:
state (
olympe.enums.ardrone3.GPSSettingsState.GPSUpdateStateChanged_State
) –_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
Unsupported message
Todo
Remove unsupported message ardrone3.GPSSettingsState.GPSUpdateStateChanged
Deprecated message
Warning
This message is deprecated and should no longer be used
Triggered on change.
- event message olympe.messages.ardrone3.GPSSettingsState.GeofenceCenterChanged(latitude=None, longitude=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettingsState.GeofenceCenterChanged
Geofence center location. This location represents the center of the geofence zone. This is updated at a maximum frequency of 1 Hz.
- Parameters:
latitude (double) – GPS latitude in decimal degrees
longitude (double) – GPS longitude in decimal degrees
_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
Unsupported message
Todo
Remove unsupported message ardrone3.GPSSettingsState.GeofenceCenterChanged
Triggered when
HomeChanged()
and whenGpsLocationChanged()
before takeoff.
- event message olympe.messages.ardrone3.GPSSettingsState.HomeChanged(latitude=None, longitude=None, altitude=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettingsState.HomeChanged
Home location.
- Parameters:
latitude (double) – Home latitude in decimal degrees
longitude (double) – Home longitude in decimal degrees
altitude (double) – Home altitude in meters
_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
Supported by:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Triggered when
HomeTypeChosenChanged()
changes. Or bySendControllerGPS()
whenHomeTypeChosenChanged()
is Pilot. Or regularly aftergps()
whenHomeTypeChosenChanged()
is FollowMeTarget. Or at take offHomeTypeChosenChanged()
is Takeoff. Or when the first fix occurs and theHomeTypeChosenChanged()
is FirstFix.
- event message olympe.messages.ardrone3.GPSSettingsState.HomeTypeChanged(type=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettingsState.HomeTypeChanged
User preference for the home type. See
HomeTypeChosenChanged()
to get the drone actual home type.- Parameters:
type (
olympe.enums.ardrone3.GPSSettingsState.HomeTypeChanged_Type
) –_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
Supported by:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Deprecated message
Warning
This message is deprecated and should no longer be used
Triggered by
HomeType()
.
- event message olympe.messages.ardrone3.GPSSettingsState.ResetHomeChanged(latitude=None, longitude=None, altitude=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettingsState.ResetHomeChanged
Home location has been reset.
- Parameters:
latitude (double) – Home latitude in decimal degrees
longitude (double) – Home longitude in decimal degrees
altitude (double) – Home altitude in meters
_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
Unsupported message
Todo
Remove unsupported message ardrone3.GPSSettingsState.ResetHomeChanged
Deprecated message
Warning
This message is deprecated and should no longer be used
Triggered by
ResetHome()
.
- event message olympe.messages.ardrone3.GPSSettingsState.ReturnHomeDelayChanged(delay=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettingsState.ReturnHomeDelayChanged
Return home trigger delay. This delay represents the time after which the return home is automatically triggered after a disconnection.
- Parameters:
delay (u16) – Delay in second
_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
Supported by:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Deprecated message
Warning
This message is deprecated and should no longer be used
Triggered by
ReturnHomeDelay()
.
- event message olympe.messages.ardrone3.GPSSettingsState.ReturnHomeMinAltitudeChanged(value=None, min=None, max=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
ardrone3.GPSSettingsState.ReturnHomeMinAltitudeChanged
Minumum altitude for return home changed.
- Parameters:
value (float) – Current value in meters, relative to take off altitude.
min (float) – Lower bound in meters, relative to take off altitude.
max (float) – Upper bound in meters, relative to take off altitude.
_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
Supported by:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Deprecated message
Warning
This message is deprecated and should no longer be used
Triggered by
ReturnHomeMinAltitude()
.
- enum olympe.enums.ardrone3.GPSSettingsState.GPSUpdateStateChanged_State#
The state of the gps update
- updated:
Drone GPS update succeed (0)
- inProgress:
Drone GPS update In progress (1)
- failed:
Drone GPS update failed (2)
- enum olympe.enums.ardrone3.GPSSettingsState.HomeTypeChanged_Type#
The type of the home position
Enum aliases:
olympe.enums.ardrone3.HomeType_Type
olympe.enums.ardrone3.HomeTypeChanged_Type
- TAKEOFF:
The drone will try to return to the take off position (0)
- PILOT:
The drone will try to return to the pilot position (1)
- FOLLOWEE:
The drone will try to return to the target of the current (or last) follow me (2)
- event message olympe.messages.ardrone3.GPSState.HomeTypeAvailabilityChanged(type=None, available=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
ardrone3.GPSState.HomeTypeAvailabilityChanged
Home type availability.
- Parameters:
type (
olympe.enums.ardrone3.GPSState.HomeTypeAvailabilityChanged_Type
) –available (u8) – 1 if this type is available, 0 otherwise
_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
Supported by:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Deprecated message
Warning
This message is deprecated and should no longer be used
Triggered when the availability of, at least, one type changes. This might be due to controller position availability, gps fix before take off or other reason.
- event message olympe.messages.ardrone3.GPSState.HomeTypeChosenChanged(type=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
ardrone3.GPSState.HomeTypeChosenChanged
Home type. This choice is made by the drone, according to the
HomeTypeChanged()
and theHomeTypeAvailabilityChanged()
. The drone will choose the type matching with the user preference only if this type is available. If not, it will chose a type in this order: FOLLOWEE ; TAKEOFF ; PILOT ; FIRST_FIX- Parameters:
type (
olympe.enums.ardrone3.GPSState.HomeTypeChosenChanged_Type
) –_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
Supported by:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Deprecated message
Warning
This message is deprecated and should no longer be used
Triggered when the return home type chosen by the drone changes. This might be produced by a user preference triggered by
HomeType()
or by a change in theHomeTypeAvailabilityChanged()
.
- event message olympe.messages.ardrone3.GPSState.NumberOfSatelliteChanged(numberOfSatellite=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#
ardrone3.GPSState.NumberOfSatelliteChanged
Number of GPS satellites.
- Parameters:
numberOfSatellite (u8) – The number of satellite
_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
Supported by:
- ANAFI:
with an up to date firmware
- ANAFI Thermal:
with an up to date firmware
Triggered on change.
- enum olympe.enums.ardrone3.GPSState.HomeTypeAvailabilityChanged_Type#
The type of the return home
Enum aliases:
olympe.enums.ardrone3.HomeTypeAvailabilityChanged_Type
olympe.enums.ardrone3.HomeTypeChosenChanged_Type
- TAKEOFF:
The drone has enough information to return to the take off position (0)
- PILOT:
The drone has enough information to return to the pilot position (1)
- FIRST_FIX:
The drone has not enough information, it will return to the first GPS fix (2)
- FOLLOWEE:
The drone has enough information to return to the target of the current (or last) follow me (3)
- enum olympe.enums.ardrone3.GPSState.HomeTypeChosenChanged_Type#
The type of the return home chosen
Enum aliases:
olympe.enums.ardrone3.HomeTypeAvailabilityChanged_Type
olympe.enums.ardrone3.HomeTypeChosenChanged_Type
- TAKEOFF:
The drone will return to the take off position (0)
- PILOT:
The drone will return to the pilot position In this case, the drone will use the position given by ARDrone3-SendControllerGPS (1)
- FIRST_FIX:
The drone has not enough information, it will return to the first GPS fix (2)
- FOLLOWEE:
The drone will return to the target of the current (or last) follow me In this case, the drone will use the position of the target of the followMe (given by ControllerInfo-GPS) (3)