Gauge Firmware Updater feature#

command message olympe.messages.gauge_fw_updater.prepare(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#

gauge_fw_updater.prepare

Prepare Update

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

Supported by:

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Result: status() with ‘preparation_in_progress’ then ‘ready_to_update’ state, and progress() with ‘in_progress’ then ‘success’ result and percent

Expectations: status(state='preparation_in_progress', _policy='wait') & progress(result='in_progress', _policy='wait') & status(state='ready_to_update', _policy='wait') & progress(result='success', _policy='wait')

event message olympe.messages.gauge_fw_updater.progress(result=None, percent=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

gauge_fw_updater.progress

Progress of the command Prepare or Update

Parameters:

  • result (olympe.enums.gauge_fw_updater.result) – Result.

  • percent (u8) – Percentage (%), only for prepare().

  • _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 changes by prepare() and update()

event message olympe.messages.gauge_fw_updater.status(diag=None, missing_requirements=None, state=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

gauge_fw_updater.status

Status of the Gauge Firmware Updater

Parameters:

  • diag (olympe.enums.gauge_fw_updater.diag) – Diagnostic.

  • missing_requirements (BitfieldOf(olympe.enums.gauge_fw_updater.requirements, u32)) – Missing Requirements.

  • state (olympe.enums.gauge_fw_updater.state) – 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

Supported by:

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Triggered At connection; on changes by prepare() and update()

command message olympe.messages.gauge_fw_updater.update(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))#

gauge_fw_updater.update

Update

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

Supported by:

ANAFI:

with an up to date firmware

ANAFI Thermal:

with an up to date firmware

Result: status() with ‘update_in_progress’ state, and progress() with ‘in_progress’ result

Expectations: status(state='update_in_progress', _policy='wait') & progress(result='in_progress', _policy='wait')

enum olympe.enums.gauge_fw_updater.diag#

Gauge Firmware Diagnostic

up_to_date:

Gauge Firmware is Up-to-Date. (0)

cannot_update:

Gauge Firmware cannot be updated. (1)

updatable:

Gauge Firmware can be updated. (2)

enum olympe.enums.gauge_fw_updater.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)

enum olympe.enums.gauge_fw_updater.requirements#

Requirements of Gauge Firmware Service

usb:

USB power is provided. (0)

rsoc:

RSOC is enough. (1)

drone_state:

Drone is landed. (2)

enum olympe.enums.gauge_fw_updater.result#

Result of Gauge Firmware Service

success:

Result is Success. (0)

in_progress:

In Progress. (1)

bad_diag:

Bad Diagnostic. (2)

not_prepared:

Not Prepared. (3)

requirements_not_achieved:

Requirements not Achieved. (4)

battery_error:

Problem with Battery. (5)

enum olympe.enums.gauge_fw_updater.state#

State of Gauge Firmware Service

ready_to_prepare:

Service is ready to prepare Update. (0)

preparation_in_progress:

Service Preparation is in Progress. (1)

ready_to_update:

Service is ready to Update. (2)

update_in_progress:

Service Update is in Progress. (3)