Thermal feature

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

Thermal.Background_temperature

background temperature value.

Parameters
  • background_temperature (float) – background 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:

AnafiThermal

with an up to date firmware

Triggered At connection or on changes by set_background_temperature().

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

Thermal.Capabilities

Capabilities

Parameters
  • modes (BitfieldOf(olympe.enums.thermal.mode, u8)) – Supported thermal 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

Supported by:

AnafiThermal

with an up to date firmware

Triggered At connection only.

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

Thermal.Emissivity

Emissivity value.

Parameters
  • emissivity (float) – Emissivity. Normalized between 0 and 1.

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

AnafiThermal

with an up to date firmware

Triggered At connection or on changes by set_emissivity().

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

Thermal.Mode

Thermal mode.

Parameters
  • mode (olympe.enums.thermal.mode) – Current thermal 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

Supported by:

AnafiThermal

with an up to date firmware

Triggered At connection or on changes by set_mode().

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

Thermal.Palette_part

Palette part.

Parameters
  • red (float) – Red value. Normalized between 0 and 1.

  • green (float) – Green value. Normalized between 0 and 1.

  • blue (float) – Blue value. Normalized between 0 and 1.

  • index (float) – Index where red, green and blue have been applied. Normalized between 0 and 1.

  • list_flags (BitfieldOf(olympe.enums.thermal.list_flags, u8)) – List flags.

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

AnafiThermal

with an up to date firmware

Triggered At connection or on changes by set_palette_part().

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

Thermal.Palette_settings

Used palette settings.

Parameters
  • mode (olympe.enums.thermal.palette_mode) – Used palette mode.

  • lowest_temp (float) – Used lowest temperature in the palette; in Kelvin.

  • highest_temp (float) – Used highest temperature in the palette; in Kelvin.

  • outside_colorization (olympe.enums.thermal.colorization_mode) – Used colorization mode outside of the palette bounds in absolute mode.

  • relative_range (olympe.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_type (olympe.enums.thermal.spot_type) – Used spot type. Valid only in spot mode.

  • spot_threshold (float) – Used threshold palette index of the spot. Normalized between 0 and 1. Valid only in spot 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

Supported by:

AnafiThermal

with an up to date firmware

Triggered At connection or on changes by set_palette_settings().

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

Thermal.Rendering

Rendering parameters for blending.

Parameters
  • mode (olympe.enums.thermal.rendering_mode) – Rendering mode.

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

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

AnafiThermal

with an up to date firmware

Triggered At connection or on changes by set_rendering().

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

Thermal.Sensitivity

Thermal cam sensitivity range.

Parameters
  • current_range (olympe.enums.thermal.range) – Current range of the thermal sensor

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

AnafiThermal

with an up to date firmware

Triggered At connection or on changes by set_sensitivity()

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

Thermal.Set_background_temperature

Set background temperature value.

Parameters
  • background_temperature (float) – Requested background temperature in Kelvin.

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

AnafiThermal

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 messageolympe.messages.thermal.set_emissivity(emissivity, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Thermal.Set_emissivity

Set emissivity value.

Parameters
  • emissivity (float) – Requested emissivity. Normalized between 0 and 1.

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

AnafiThermal

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 messageolympe.messages.thermal.set_mode(mode, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Thermal.Set_mode

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

Parameters
  • mode (olympe.enums.thermal.mode) – Requested thermal 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

Supported by:

AnafiThermal

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 messageolympe.messages.thermal.set_palette_part(red, green, blue, index, list_flags, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Thermal.Set_palette_part

Set palette value for a given index.

Parameters
  • red (float) – Requested red value. Normalized between 0 and 1.

  • green (float) – Requested green value. Normalized between 0 and 1.

  • blue (float) – Requested blue value. Normalized between 0 and 1.

  • index (float) – Index in the palette where given red, green and blue should be applied. Normalized between 0 and 1.

  • list_flags (BitfieldOf(olympe.enums.thermal.list_flags, u8)) – List flags.

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

AnafiThermal

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

Thermal.Set_palette_settings

Set palette settings.

Parameters
  • mode (olympe.enums.thermal.palette_mode) – Requested palette mode.

  • lowest_temp (float) – 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_temp (float) – 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_colorization (olympe.enums.thermal.colorization_mode) – Requested colorization mode outside of the palette bounds in absolute mode.

  • relative_range (olympe.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_type (olympe.enums.thermal.spot_type) – Requested spot type. Valid only in spot mode.

  • spot_threshold (float) – Requested threshold palette index of the spot. Normalized between 0 and 1. Valid only in spot 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

Supported by:

AnafiThermal

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 messageolympe.messages.thermal.set_rendering(mode, blending_rate, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Thermal.Set_rendering

Set rendering parameters for blending.

Parameters
  • mode (olympe.enums.thermal.rendering_mode) – Requested rendering mode.

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

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

AnafiThermal

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 messageolympe.messages.thermal.set_sensitivity(range, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Thermal.Set_sensitivity

Set the thermal camera sensitivity range.

Parameters
  • range (olympe.enums.thermal.range) – Desired range of the thermal sensor

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

AnafiThermal

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 messageolympe.messages.thermal.set_shutter_mode(trigger, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Thermal.Set_shutter_mode

Set the thermal camera shutter mode.

Parameters
  • trigger (olympe.enums.thermal.shutter_trigger) – Desired shutter trigger mode of the thermal sensor

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

AnafiThermal

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

Thermal.Shutter_mode

Thermal cam shutter trigger mode.

Parameters
  • current_trigger (olympe.enums.thermal.shutter_trigger) – Current shutter trigger mode of the thermal sensor

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

AnafiThermal

with an up to date firmware

Triggered At connection or on changes by set_shutter_mode()

command messageolympe.messages.thermal.trigg_shutter(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

Thermal.Trigg_shutter

Trigg the thermal cam shutter.

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:

AnafiThermal

with an up to date firmware

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

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

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

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

enumolympe.enums.thermal.palette_mode

Palette mode

absolute

Absolute palette range (0)

relative

Relative palette range (1)

spot

Palette above or under relative threshold (2)

enumolympe.enums.thermal.range

Thermal range

high

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

low

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

enumolympe.enums.thermal.relative_range_mode

Relative range mode

locked

Relative range is locked (0)

unlocked

Relative range is unlocked (1)

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

enumolympe.enums.thermal.shutter_trigger

Thermal shutter trigger mode

Enum aliases:

auto

Automatic trigger (0)

manual

Manual trigger (1)

enumolympe.enums.thermal.spot_type

Spot type

cold

Colorize only if temperature is below threshold (0)

hot

Colorize only if temperature is above threshold (1)