PreciseHome feature

event messageolympe.messages.precise_home.capabilities(modes=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Precise_home.Capabilities

Capabilities

Parameters
  • modes (BitfieldOf(olympe.enums.precise_home.mode, u8)) – Supported precise home modes.

  • _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 At connection only.

event messageolympe.messages.precise_home.mode(mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

Precise_home.Mode

Current precise home mode

Parameters
  • mode (olympe.enums.precise_home.mode) – Current precise home mode

  • _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 At connection; on changes by set_mode().

command messageolympe.messages.precise_home.set_mode(mode, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Precise_home.Set_mode

Configures precise home mode.

Parameters
  • mode (olympe.enums.precise_home.mode) – Requested precise home mode.

  • _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: mode() event with the new mode.

Expectations: mode(mode=self.mode, _policy='wait')

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

Precise_home.State

Current precise home state

Parameters
  • state (olympe.enums.precise_home.state) – Current precise home 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

Triggered At connection; on changes.

enumolympe.enums.precise_home.mode

Thermal state

disabled

Thermal is disabled (0)

standard

Standard thermal mode (1)

enumolympe.enums.precise_home.state

Precise home feature state.

unavailable

It is currently impossible to activate precise home if the drone lands. (0)

available

Precise home will be activated if the drone lands. (1)

active

Precise home is currently active (drone is landing). (2)

enumolympe.enums.precise_home.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)