Thermal feature

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

thermal.background_temperature

background temperature value.

Parameters:

background_temperaturefloat

background 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 Thermal:

with an up to date firmware

Triggered: At connection or on changes by set_background_temperature().

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

thermal.capabilities

Capabilities

Parameters:

modesBitfieldOf(olympe.enums.thermal.mode, u8)

Supported thermal modes.

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

with an up to date firmware

Triggered: At connection only.

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

thermal.emissivity

Emissivity value.

Parameters:

emissivityfloat

Emissivity. Normalized between 0 and 1.

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

with an up to date firmware

Triggered: At connection or on changes by set_emissivity().

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

thermal.mode

Thermal mode.

Parameters:

modeolympe.enums.thermal.mode

Current thermal mode.

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

with an up to date firmware

Triggered: At connection or on changes by set_mode().

event message olympe.messages.thermal.palette_part(red=None, green=None, blue=None, index=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal.palette_part

Palette part.

Parameters:

redfloat

Red value. Normalized between 0 and 1.

greenfloat

Green value. Normalized between 0 and 1.

bluefloat

Blue value. Normalized between 0 and 1.

indexfloat

Index where red, green and blue have been applied. Normalized between 0 and 1.

list_flagsBitfieldOf(olympe.enums.thermal.list_flags, u8)

List flags.

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

with an up to date firmware

Triggered: At connection or on changes by set_palette_part().

event message olympe.messages.thermal.palette_settings(mode=None, lowest_temp=None, highest_temp=None, outside_colorization=None, relative_range=None, spot_type=None, spot_threshold=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal.palette_settings

Used palette settings.

Parameters:

modeolympe.enums.thermal.palette_mode

Used palette mode.

lowest_tempfloat

Used lowest temperature in the palette; in Kelvin.

highest_tempfloat

Used highest temperature in the palette; in Kelvin.

outside_colorizationolympe.enums.thermal.colorization_mode

Used colorization mode outside of the palette bounds in absolute mode.

relative_rangeolympe.enums.thermal.relative_range_mode

Used relative range. Valid only in relative mode. If set to locked, equivalent to absolute mode with lowest_temp, highest_temp and extended outside_colorization.

spot_typeolympe.enums.thermal.spot_type

Used spot type. Valid only in spot mode.

spot_thresholdfloat

Used threshold palette index of the spot. Normalized between 0 and 1. Valid only in spot mode.

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

with an up to date firmware

Triggered: At connection or on changes by set_palette_settings().

event message olympe.messages.thermal.rendering(mode=None, blending_rate=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal.rendering

Rendering parameters for blending.

Parameters:

modeolympe.enums.thermal.rendering_mode

Rendering mode.

blending_ratefloat

Blending rate, normalized between 0 (visible image and thermal chrominance) and 1 (thermal with edges). Valid only if mode is blended.

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

with an up to date firmware

Triggered: At connection or on changes by set_rendering().

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

thermal.sensitivity

Thermal cam sensitivity range.

Parameters:

current_rangeolympe.enums.thermal.range

Current range of the thermal sensor

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

with an up to date firmware

Triggered: At connection or on changes by set_sensitivity()

command message olympe.messages.thermal.set_background_temperature(background_temperature, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal.set_background_temperature

Set background temperature value.

Parameters:

background_temperaturefloat

Requested background temperature in Kelvin.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

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

with an up to date firmware

Result: Requested background temperature is set and background_temperature() event is triggered with the new background temperature.

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

command message olympe.messages.thermal.set_emissivity(emissivity, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal.set_emissivity

Set emissivity value.

Parameters:

emissivityfloat

Requested emissivity. Normalized between 0 and 1.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

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

with an up to date firmware

Result: Requested emissivity is set and emissivity() event is triggered with the new emissivity.

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

command message olympe.messages.thermal.set_mode(mode, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal.set_mode

Set thermal mode. Changing thermal mode may activate or deactivate some cameras on some drones.

Parameters:

modeolympe.enums.thermal.mode

Requested thermal mode.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

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

with an up to date firmware

Result: Requested thermal mode is set and mode() event is triggered with the new mode.

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

command message olympe.messages.thermal.set_palette_part(red, green, blue, index, list_flags, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal.set_palette_part

Set palette value for a given index.

Parameters:

redfloat

Requested red value. Normalized between 0 and 1.

greenfloat

Requested green value. Normalized between 0 and 1.

bluefloat

Requested blue value. Normalized between 0 and 1.

indexfloat

Index in the palette where given red, green and blue should be applied. Normalized between 0 and 1.

list_flagsBitfieldOf(olympe.enums.thermal.list_flags, u8)

List flags.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

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

with an up to date firmware

Result: Requested RGB is set for the given index in the palette and palette_part() event is triggered with the updated values.

Expectations: palette_part(red=self.red, green=self.green, blue=self.blue, index=self.index, _policy='wait')

command message olympe.messages.thermal.set_palette_settings(mode, lowest_temp, highest_temp, outside_colorization, relative_range, spot_type, spot_threshold, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal.set_palette_settings

Set palette settings.

Parameters:

modeolympe.enums.thermal.palette_mode

Requested palette mode.

lowest_tempfloat

Requested lowest temperature in the palette to use in absolute mode. This value is also used when the palette is relative and the relative_range is set to locked. Unit is Kelvin.

highest_tempfloat

Requested highest temperature in the palette to use in absolute mode. This value is also used when the palette is relative and the relative_range is set to locked. Unit is Kelvin.

outside_colorizationolympe.enums.thermal.colorization_mode

Requested colorization mode outside of the palette bounds in absolute mode.

relative_rangeolympe.enums.thermal.relative_range_mode

Requested relative range. Valid only in relative mode. If set to locked, equivalent to absolute mode with given lowest_temp, given highest_temp and extended outside_colorization.

spot_typeolympe.enums.thermal.spot_type

Requested spot type. Valid only in spot mode.

spot_thresholdfloat

Requested threshold palette index of the spot. Normalized between 0 and 1. Valid only in spot mode.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

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

with an up to date firmware

Result: Palette settings are set and palette_settings() event is triggered with the new palette settings.

Expectations: palette_settings(mode=self.mode, lowest_temp=self.lowest_temp, highest_temp=self.highest_temp, outside_colorization=self.outside_colorization, relative_range=self.relative_range, spot_type=self.spot_type, spot_threshold=self.spot_threshold, _policy='wait')

command message olympe.messages.thermal.set_rendering(mode, blending_rate, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal.set_rendering

Set rendering parameters for blending.

Parameters:

modeolympe.enums.thermal.rendering_mode

Requested rendering mode.

blending_ratefloat

Requested blending rate, normalized between 0 (visible image and thermal chrominance) and 1 (thermal with edges). Ignored if mode is not blended.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

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

with an up to date firmware

Result: Requested rendering parameters are set and rendering() event is triggered with the new rendering parameters.

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

command message olympe.messages.thermal.set_sensitivity(range, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal.set_sensitivity

Set the thermal camera sensitivity range.

Parameters:

rangeolympe.enums.thermal.range

Desired range of the thermal sensor

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

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

with an up to date firmware

Result: Sensitivity range of the camera is changed, and event sensitivity() is sent accordingly.

Expectations: sensitivity(current_range=self.range, _policy='wait')

command message olympe.messages.thermal.set_shutter_mode(trigger, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal.set_shutter_mode

Set the thermal camera shutter mode.

Parameters:

triggerolympe.enums.thermal.shutter_trigger

Desired shutter trigger mode of the thermal sensor

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

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

with an up to date firmware

Result: shutter mode of the camera is changed, and event shutter_mode() is sent accordingly.

Expectations: shutter_mode(current_trigger=self.trigger, _policy='wait')

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

thermal.shutter_mode

Thermal cam shutter trigger mode.

Parameters:

current_triggerolympe.enums.thermal.shutter_trigger

Current shutter trigger mode of the thermal sensor

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

with an up to date firmware

Triggered: At connection or on changes by set_shutter_mode()

command message olympe.messages.thermal.trigg_shutter(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal.trigg_shutter

Trigg the thermal cam shutter.

Parameters:

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

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

with an up to date firmware

Result: Thermal camera triggs its shutter to perform a Flat Field Calibration.

enum olympe.enums.thermal.colorization_mode

Colorization mode

limited:

Use black if temperature is outside of palette bounds (0)

extended:

Use boundary color if temperature is outside of palette bounds (1)

enum olympe.enums.thermal.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.thermal.mode

Thermal state

disabled:

Thermal is disabled (0)

standard:

Standard thermal mode, streaming blended on controller side (1)

blended:

Blended thermal mode, streaming blended on drone side (2)

enum olympe.enums.thermal.palette_mode

Palette mode

absolute:

Absolute palette range (0)

relative:

Relative palette range (1)

spot:

Palette above or under relative threshold (2)

enum olympe.enums.thermal.range

Thermal range

high:

High range (from 0 to 400°C) (0)

low:

Low range (from 0 to 120°C) (1)

enum olympe.enums.thermal.relative_range_mode

Relative range mode

locked:

Relative range is locked (0)

unlocked:

Relative range is unlocked (1)

enum olympe.enums.thermal.rendering_mode

Rendering mode

visible:

Visible image only (0)

thermal:

Thermal image only (1)

blended:

Blending between visible and thermal images (2)

monochrome:

Visible image in black and white (3)

enum olympe.enums.thermal.shutter_trigger

Thermal shutter trigger mode

Enum aliases:

• olympe.enums.thermal.shutter_trigger

• olympe.enums.ardrone3.WifiSelection_Type

auto:

Automatic trigger (0)

manual:

Manual trigger (1)

enum olympe.enums.thermal.spot_type

Spot type

cold:

Colorize only if temperature is below threshold (0)

hot:

Colorize only if temperature is above threshold (1)