Battery feature

event message olympe.messages.battery.alert(alert=None, level=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

battery.alert

Battery alerts

Parameters:

alertolympe.enums.battery.alert

Alert.

levelolympe.enums.battery.alert_level

Alert level.

list_flags : BitfieldOf(olympe.enums.battery.list_flags, u8)

_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 Ai:

with an up to date firmware

Triggered: when an alert level changes.

event message olympe.messages.battery.capacity(full_charge=None, remaining=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

battery.capacity

Battery Capacity

Parameters:

full_chargeu32

Battery Full Charge Capacity in mAh

remainingu32

Battery Remaining Capacity in mAh

_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 Ai:

with an up to date firmware

Triggered: at connection and when Capacity changes.

event message olympe.messages.battery.cell_config(config=None, series=None, parallel=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

battery.cell_config

Number of cells in series and parallel

Parameters:

configstring

Battery cell config

seriesu8

Battery cells in series

parallelu8

Battery cells in parallel

_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_3_INSPECT:

with an up to date firmware

ANAFI_3_MIL:

with an up to date firmware

ANAFI_3_GOV:

with an up to date firmware

Triggered: at connection.

event message olympe.messages.battery.cell_voltage(index=None, cell_voltage=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

battery.cell_voltage

Battery cell voltage.

Parameters:

indexu16

Cell index starting from 0

cell_voltageu16

Cell Voltage in mV

_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 Ai:

with an up to date firmware

Triggered: regularly.

event message olympe.messages.battery.cycle_count(count=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

battery.cycle_count

Battery Cycle Count

Parameters:

countu32

Battery Cycle Count

_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

ANAFI Ai:

with an up to date firmware

Triggered: at connection and when Cycle Count changes.

event message olympe.messages.battery.description(serial=None, date=None, design=None, cell_count=None, cell_min_voltage=None, cell_max_voltage=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

battery.description

Battery Description

Parameters:

serialstring

Battery Serial

datestring

Battery Configuration Date

designu32

Battery Design Capacity in mAh

cell_countu16

Battery cell count

cell_min_voltageu16

Battery cell minimum Voltage in mV

cell_max_voltageu16

Battery cell maximum Voltage in mV

_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 Ai:

with an up to date firmware

Triggered: at connection.

event message olympe.messages.battery.health(state_of_health=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

battery.health

Battery Health

Parameters:

state_of_healthu8

Battery State-Of-Health (%)

_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

ANAFI Ai:

with an up to date firmware

Triggered: at connection and when State-Of-Health changes.

event message olympe.messages.battery.reliability(is_charge_level_reliable=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

battery.reliability

Whether the BatteryStateChanged() is reliable or not.

Parameters:

is_charge_level_reliableu8

1 if battery state is reliable, 0 if not.

_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_3_INSPECT:

with an up to date firmware

ANAFI_3_MIL:

with an up to date firmware

ANAFI_3_GOV:

with an up to date firmware

Triggered: At connection.

event message olympe.messages.battery.serial(serial=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

battery.serial

Battery Serial

Parameters:

serialstring

Battery Serial

_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

ANAFI Ai:

with an up to date firmware

Deprecated message

Warning

This message is deprecated and should no longer be used

Triggered: at connection.

event message olympe.messages.battery.temperature(temperature=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

battery.temperature

Battery Temperature

Parameters:

temperatureu16

Battery Temperature in Kelvin

_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 Ai:

with an up to date firmware

Triggered: regularly.

event message olympe.messages.battery.version(hw_revision=None, fw_version=None, gauge_version=None, usb_version=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

battery.version

Version of the components of the battery.

Parameters:

hw_revisionu16

Battery Hardware Revision

fw_versionstring

Battery Firmware Version

gauge_versionstring

Battery Gauge Version

usb_versionstring

Battery USB Version

_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 Ai:

with an up to date firmware

Triggered: at connection.

event message olympe.messages.battery.voltage(voltage=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

battery.voltage

Battery voltage.

Parameters:

voltageu16

Battery voltage in mV

_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:

for firmware release versions 1.6.2

ANAFI Thermal:

for firmware release versions 1.6.2

ANAFI Ai:

with an up to date firmware

Triggered: regularly.

enum olympe.enums.battery.alert

Battery alerts.

power_level:

Power level is low. (0)

too_hot:

Battery is too hot. (1)

too_cold:

Battery is too cold. (2)

gauge_too_old:

Battery Gauge is too old. (3)

authentication_failure:

Authentication has failed. (4)

lost_comm:

Lost comm with battery. (5)

enum olympe.enums.battery.alert_level

Alert level.

none:

Alert is not active. (0)

warning:

Alert level is warning. (1)

critical:

Alert level is critical. (2)

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