Battery feature#

event messageolympe.messages.battery.alert(alert=None, level=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

battery.alert

Battery alerts

Parameters
  • alert (olympe.enums.battery.alert) – Alert.

  • level (olympe.enums.battery.alert_level) – Alert level.

  • list_flags (BitfieldOf(olympe.enums.battery.list_flags, u8)) –

  • _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/AnafiFPV

with an up to date firmware

Anafi Ai

with an up to date firmware

Triggered when an alert level changes.

event messageolympe.messages.battery.capacity(full_charge=None, remaining=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

battery.capacity

Battery Capacity

Parameters
  • full_charge (u32) – Battery Full Charge Capacity in mAh

  • remaining (u32) – Battery Remaining Capacity in mAh

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

with an up to date firmware

Triggered at connection and when Capacity changes.

event messageolympe.messages.battery.cell_voltage(index=None, cell_voltage=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

battery.cell_voltage

Battery cell voltage.

Parameters
  • index (u16) – Cell index starting from 0

  • cell_voltage (u16) – Cell Voltage in mV

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

with an up to date firmware

Triggered regularly.

event messageolympe.messages.battery.cycle_count(count=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

battery.cycle_count

Battery Cycle Count

Parameters
  • count (u32) – Battery Cycle Count

  • _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/AnafiFPV

with an up to date firmware

AnafiThermal

with an up to date firmware

Anafi Ai

with an up to date firmware

Triggered at connection and when Cycle Count changes.

event messageolympe.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))#

battery.description

Battery Description

Parameters
  • serial (string) – Battery Serial

  • date (string) – Battery Configuration Date

  • design (u32) – Battery Design Capacity in mAh

  • cell_count (u16) – Battery cell count

  • cell_min_voltage (u16) – Battery cell minimum Voltage in mV

  • cell_max_voltage (u16) – Battery cell maximum Voltage in mV

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

with an up to date firmware

Triggered at connection.

event messageolympe.messages.battery.health(state_of_health=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

battery.health

Battery Health

Parameters
  • state_of_health (u8) – Battery State-Of-Health (%)

  • _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/AnafiFPV

with an up to date firmware

AnafiThermal

with an up to date firmware

Anafi Ai

with an up to date firmware

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

event messageolympe.messages.battery.serial(serial=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

battery.serial

Battery Serial

Parameters
  • serial (string) – Battery Serial

  • _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/AnafiFPV

with an up to date firmware

AnafiThermal

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 messageolympe.messages.battery.temperature(temperature=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

battery.temperature

Battery Temperature

Parameters
  • temperature (u16) – Battery Temperature in Kelvin

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

with an up to date firmware

Triggered regularly.

event messageolympe.messages.battery.voltage(voltage=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))#

battery.voltage

Battery voltage.

Parameters
  • voltage (u16) – Battery voltage in mV

  • _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/AnafiFPV

with an up to date firmware

AnafiThermal

with an up to date firmware

Anafi Ai

with an up to date firmware

Triggered regularly.

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

enumolympe.enums.battery.alert_level#

Alert level.

none

Alert is not active. (0)

warning

Alert level is warning. (1)

critical

Alert level is critical. (2)

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