Thermal Camera feature

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

thermal_cam.activate

Activate a given thermal camera. Activating a camera may deactivate others on some drones.

Parameters:

cam_idu8

Thermal camera id, as given in the [connected accessories](ConnectedAccessories()) event.

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

Unsupported message

Todo

Remove unsupported message thermal_cam.activate

Result: Camera is activated and camera_state() is changed to activated.

Expectations: camera_state(cam_id=self.cam_id, state='activated', _policy='wait')

event message olympe.messages.thermal_cam.calibration_infos(cam_id=None, roll=None, pitch=None, yaw=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal_cam.calibration_infos

Visible camera position relative to the drone. The thermal camera is considered at an ideal position.

Parameters:

cam_idu8

Thermal camera id, as given in the [connected accessories](ConnectedAccessories()) event.

rollfloat

Euler angle roll in degree difference between visible cam and thermal cam.

pitchfloat

Euler angle pitch in degree difference between visible cam and thermal cam.

yawfloat

Euler angle yaw in degree difference between visible cam and thermal cam.

list_flags : BitfieldOf(olympe.enums.thermal_cam.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)

Unsupported message

Todo

Remove unsupported message thermal_cam.calibration_infos

Triggered: at connection or when the thermal cam is connected.

event message olympe.messages.thermal_cam.camera_state(cam_id=None, state=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal_cam.camera_state

Camera state.

Parameters:

cam_idu8

Thermal camera id, as given in the [connected accessories](ConnectedAccessories()) event.

state : olympe.enums.thermal_cam.state

list_flags : BitfieldOf(olympe.enums.thermal_cam.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)

Unsupported message

Todo

Remove unsupported message thermal_cam.camera_state

Triggered: by activate() or deactivate().

event message olympe.messages.thermal_cam.charging_status(cam_id=None, state=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal_cam.charging_status

Thermal cam charging status.

Parameters:

cam_idu8

Thermal camera id, as given in the [connected accessories](ConnectedAccessories()) event.

state : olympe.enums.thermal_cam.charging_state

list_flags : BitfieldOf(olympe.enums.thermal_cam.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)

Unsupported message

Todo

Remove unsupported message thermal_cam.charging_status

Triggered: when charging status changed

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

thermal_cam.deactivate

Deactivate a given thermal camera.

Parameters:

cam_idu8

Thermal camera id, as given in the [connected accessories](ConnectedAccessories()) event.

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

Unsupported message

Todo

Remove unsupported message thermal_cam.deactivate

Result: Camera is deactivated and camera_state() is changed to deactivated.

Expectations: camera_state(cam_id=self.cam_id, state='deactivated', _policy='wait')

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

thermal_cam.flat_field_calibrate

Request the sensor to start thermal flat field calibration

Parameters:

cam_idu8

Thermal camera id, as given in the [connected accessories](ConnectedAccessories()) event.

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

Unsupported message

Todo

Remove unsupported message thermal_cam.flat_field_calibrate

Result: Thermal sensor starts calibration process, and event flat_field_calibration_status() is sent accordingly.

Expectations: flat_field_calibration_status(cam_id=self.cam_id, _policy='wait')

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

thermal_cam.flat_field_calibration_mode

Thermal cam FFC mode.

Parameters:

cam_idu8

Thermal camera id, as given in the [connected accessories](ConnectedAccessories()) event.

mode : olympe.enums.thermal_cam.flat_field_calibration_mode

list_flags : BitfieldOf(olympe.enums.thermal_cam.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)

Unsupported message

Todo

Remove unsupported message thermal_cam.flat_field_calibration_mode

Triggered: when FFC mode changed

event message olympe.messages.thermal_cam.flat_field_calibration_status(cam_id=None, state=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

thermal_cam.flat_field_calibration_status

Thermal cam FFC status.

Parameters:

cam_idu8

Thermal camera id, as given in the [connected accessories](ConnectedAccessories()) event.

state : olympe.enums.thermal_cam.flat_field_calibration_state

list_flags : BitfieldOf(olympe.enums.thermal_cam.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)

Unsupported message

Todo

Remove unsupported message thermal_cam.flat_field_calibration_status

Triggered: when FFC status changed

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

thermal_cam.sensitivity

Thermal cam sensitivity range.

Parameters:

cam_idu8

Thermal camera id, as given in the [connected accessories](ConnectedAccessories()) event.

current_range : olympe.enums.thermal_cam.range

available_ranges : BitfieldOf(olympe.enums.thermal_cam.range, u8)

list_flags : BitfieldOf(olympe.enums.thermal_cam.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)

Unsupported message

Todo

Remove unsupported message thermal_cam.sensitivity

Triggered: by set_sensitivity()

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

thermal_cam.set_flat_field_calibration_mode

Set the FFC mode.

Parameters:

cam_idu8

Thermal camera id, as given in the [connected accessories](ConnectedAccessories()) event.

mode : olympe.enums.thermal_cam.flat_field_calibration_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)

Unsupported message

Todo

Remove unsupported message thermal_cam.set_flat_field_calibration_mode

Result: FFC mode is changed, and event flat_field_calibration_mode() is sent accordingly.

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

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

thermal_cam.set_sensitivity

Set the thermal camera sensitivity range.

Parameters:

cam_idu8

Thermal camera id, as given in the [connected accessories](ConnectedAccessories()) event.

range : olympe.enums.thermal_cam.range

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

Unsupported message

Todo

Remove unsupported message thermal_cam.set_sensitivity

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

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

enum olympe.enums.thermal_cam.charging_state

Battery state

not_charging:

Power cable is unplugged (0)

charging_only:

Power save mode when battery is criticaly low (1)

charging:

Battery is charging correctly (2)

unknown:

Charging state is unknown (3)

enum olympe.enums.thermal_cam.flat_field_calibration_mode

flat field calibration(FFC) mode

automatic:

calibration occurs automatically when needed (0)

manual:

calibration occurs on user request only (1)

enum olympe.enums.thermal_cam.flat_field_calibration_state

Camera Thermal sensor flat field calibration(FFC) status

calibrated:

Sensor is calibrated (0)

calibration_required:

Sensor needs to be calibrated (1)

calibration_in_progress:

Sensor calibration is in progress (2)

calibration_unknown:

Sensor FFC state is unknown (3)

enum olympe.enums.thermal_cam.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_cam.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_cam.state

Camera state

activated:

Camera is activated (0)

deactivated:

Camera is deactivated (1)

pending:

Activation is pending (2)