Camera feature¶

event messageolympe.messages.camera.alignment_offsets(cam_id=None, min_bound_yaw=None, max_bound_yaw=None, current_yaw=None, min_bound_pitch=None, max_bound_pitch=None, current_pitch=None, min_bound_roll=None, max_bound_roll=None, current_roll=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Alignment_offsets

Alignment Offsets

Parameters

cam_id (u8) – Id of the camera.
min_bound_yaw (float) – Lower bound of the alignment offset that can be set on the yaw axis, in degrees
max_bound_yaw (float) – Upper bound of the alignment offset that can be set on the yaw axis, in degrees
current_yaw (float) – Current alignment offset applied to the yaw axis, in degrees
min_bound_pitch (float) – Lower bound of the alignment offset that can be set on the pitch axis, in degrees
max_bound_pitch (float) – Upper bound of the alignment offset that can be set on the pitch axis, in degrees
current_pitch (float) – Current alignment offset applied to the pitch axis, in degrees
min_bound_roll (float) – Lower bound of the alignment offset that can be set on the roll axis, in degrees
max_bound_roll (float) – Upper bound of the alignment offset that can be set on the roll axis, in degrees
current_roll (float) – Current alignment offset applied to the roll axis, in degrees
_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:

Triggered at connection and by set_alignment_offsets() or by reset_alignment_offsets().

event messageolympe.messages.camera.antiflicker_capabilities(supported_modes=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Antiflicker_capabilities

Describe anti-flickering. Antiflickering is global for all cameras

Parameters

supported_modes (BitfieldOf(olympe.enums.camera.antiflicker_mode, u8)) – Supported anti-flicker 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:

Triggered only during the connection if antiflickering is supported.

event messageolympe.messages.camera.antiflicker_mode(mode=None, value=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Antiflicker_mode

Notify of actual anti-flicker mode

Parameters

mode (olympe.enums.camera.antiflicker_mode) – Anti-flicker mode as set by set_antiflicker_mode().
value (olympe.enums.camera.antiflicker_mode) – Actual anti-flicker value selected by the drone. When mode is auto, indicate the actual anti-flicker value selected by the drone. (50hz or 60hz) In all other modes, this is the same that 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:

Triggered during the connection and by set_antiflicker_mode()

event messageolympe.messages.camera.autorecord(cam_id=None, state=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Autorecord

State of autorecord.

Parameters

cam_id (u8) – Id of the camera.
state (olympe.enums.camera.state) – Auto-record state.
_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:

Triggered during connection and by set_autorecord().

event messageolympe.messages.camera.camera_capabilities(cam_id=None, model=None, exposure_modes=None, exposure_lock_supported=None, exposure_roi_lock_supported=None, ev_compensations=None, white_balance_modes=None, custom_white_balance_temperatures=None, white_balance_lock_supported=None, styles=None, camera_modes=None, hyperlapse_values=None, bracketing_presets=None, burst_values=None, streaming_modes=None, timelapse_interval_min=None, gpslapse_interval_min=None, auto_exposure_metering_modes=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Camera_capabilities

Describes camera supported capabilities.

Parameters

cam_id (u8) – id of the camera. Camera id is unique and persistent: the same camera model on a same drone model always has the same id. Main/Built-in camera has id zero.
model (olympe.enums.camera.model) – Camera model.
exposure_modes (BitfieldOf(olympe.enums.camera.exposure_mode, u8)) – Supported exposure modes.
exposure_lock_supported (olympe.enums.camera.supported) – Exposure lock support.
exposure_roi_lock_supported (olympe.enums.camera.supported) – Exposure lock on ROI support.
ev_compensations (BitfieldOf(olympe.enums.camera.ev_compensation, u64)) – Supported ev compensation values. Empty if ev_compensation is not supported.
white_balance_modes (BitfieldOf(olympe.enums.camera.white_balance_mode, u32)) – Supported white balances modes.
custom_white_balance_temperatures (BitfieldOf(olympe.enums.camera.white_balance_temperature, u64)) – Supported white balance temperature for “custom” white balance mode. Empty if “custom” mode is not supported.
white_balance_lock_supported (olympe.enums.camera.supported) – White balance lock support.
styles (BitfieldOf(olympe.enums.camera.style, u16)) – Supported image styles.
camera_modes (BitfieldOf(olympe.enums.camera.camera_mode, u8)) – Supported camera modes.
hyperlapse_values (BitfieldOf(olympe.enums.camera.hyperlapse_value, u16)) – Supported values for hyperlapse recording mode. Empty of hyperlapse recording mode is not supported.
bracketing_presets (BitfieldOf(olympe.enums.camera.bracketing_preset, u16)) – Supported values for bracketing photo mode. Empty of bracketing photo mode is not supported.
burst_values (BitfieldOf(olympe.enums.camera.burst_value, u16)) – Supported values for burst photo mode. Empty of burst photo mode is not supported.
streaming_modes (BitfieldOf(olympe.enums.camera.streaming_mode, u8)) – Supported streaming modes, Empty if streaming is not supported.
timelapse_interval_min (float) – Minimal time-lapse capture interval, in seconds.
gpslapse_interval_min (float) – Minimal GPS-lapse capture interval, in meters.
auto_exposure_metering_modes (BitfieldOf(olympe.enums.camera.auto_exposure_metering_mode, u16)) – Supported auto exposure metering 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:

Triggered only during the connection

event messageolympe.messages.camera.camera_mode(cam_id=None, mode=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Camera_mode

Notify of camera mode

Parameters

cam_id (u8) – Id of the camera.
mode (olympe.enums.camera.camera_mode) – Camera 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:

Triggered during the connection, when camera_states() occured and by set_camera_mode().

event messageolympe.messages.camera.camera_states(active_cameras=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Camera_states

Current camera state. Indicates which cameras are currently active.

Parameters

active_cameras (u32) – Bitfield showing which cameras are active. A camera is active when the bit corresponding to its cam_id is 1. A camera is inactive when the bit corresponding to its cam_id is 0.
_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:

Triggered during connection and when state changes.

event messageolympe.messages.camera.ev_compensation(cam_id=None, value=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Ev_compensation

Notify of actual EV compensation

Parameters

cam_id (u8) – Id of the camera.
value (olympe.enums.camera.ev_compensation) – Actual EV compensation value.
_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:

Triggered during the connection, when camera_states() occured and by supported_countries()

event messageolympe.messages.camera.exposure(cam_id=None, shutter_speed=None, iso_sensitivity=None, lock=None, lock_roi_x=None, lock_roi_y=None, lock_roi_width=None, lock_roi_height=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Exposure

Notify of actual exposure values (different from exposure_settings() values when one of the setting is in automatic mode).

Parameters

cam_id (u8) – Id of the camera.
shutter_speed (olympe.enums.camera.shutter_speed) – Effective shutter speed.
iso_sensitivity (olympe.enums.camera.iso_sensitivity) – Effective ISO sensitivity level.
lock (olympe.enums.camera.state) – Auto exposure lock state.
lock_roi_x (float) – Auto exposure lock ROI center on x axis, between 0 and 1, relative to streaming image width, less than 0 if exposure is not locked with on a ROI.
lock_roi_y (float) – Auto exposure lock ROI center on y axis, between 0 and 1, relative to streaming image height, less than if exposure is not locked with on a ROI.
lock_roi_width (float) – Auto exposure lock ROI width, between 0 and 1, relative to streaming image width, less than if exposure is not locked with on a ROI.
lock_roi_height (float) – Auto exposure lock ROI height, between 0 and 1, relative to streaming image height less than if exposure is not locked with on a ROI.
_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:

Triggered while camera is active (recording or photo): at connnection and periodically, if value changes

event messageolympe.messages.camera.exposure_settings(cam_id=None, mode=None, manual_shutter_speed=None, manual_shutter_speed_capabilities=None, manual_iso_sensitivity=None, manual_iso_sensitivity_capabilities=None, max_iso_sensitivity=None, max_iso_sensitivities_capabilities=None, metering_mode=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Exposure_settings

Notify current exposure settings. This can be different from the actually used exposure values notified by event exposure() if the mode is not manual.

Parameters

cam_id (u8) – Id of the camera.
mode (olympe.enums.camera.exposure_mode) – Exposure mode as set by command “set_exposure_mode”.
manual_shutter_speed (olympe.enums.camera.shutter_speed) – Shutter speed as set by command “set_manual_shutter_speed”.
manual_shutter_speed_capabilities (BitfieldOf(olympe.enums.camera.shutter_speed, u64)) – Supported shutter speeds for current photo or recording configuration. Empty if “manual” or “manual_shutter_speed” exposure modes are not supported.
manual_iso_sensitivity (olympe.enums.camera.iso_sensitivity) – ISO sensitivity level as set by command “set_manual_iso_sensitivity”.
manual_iso_sensitivity_capabilities (BitfieldOf(olympe.enums.camera.iso_sensitivity, u64)) – Supported manual iso sensitivity for current photo or recording configuration. Empty if “manual” or “manual_iso_sensitivity” exposure modes are not supported.
max_iso_sensitivity (olympe.enums.camera.iso_sensitivity) – Maximum ISO sensitivity level as set by command “set_max_iso_sensitivity”.
max_iso_sensitivities_capabilities (BitfieldOf(olympe.enums.camera.iso_sensitivity, u64)) – Supported max iso sensitivity for current photo or recording configuration. Empty if setting max iso sensitivity is not supported.
metering_mode (olympe.enums.camera.auto_exposure_metering_mode) – Auto Exposure metering 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:

Triggered during the connection, when [camera_states] (camera_states()) occured, by set_exposure_settings() or when shutter speeds or iso sensitivities capabilities changes, for example when the recording mode changes

event messageolympe.messages.camera.hdr(cam_id=None, available=None, state=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Hdr

Tells if HDR is available and if it’s currently active.

Parameters

cam_id (u8) – Id of the camera.
available (olympe.enums.camera.availability) – Tells if HDR is available in current configuration.
state (olympe.enums.camera.state) – Actual HDR state.
_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:

Triggered during the connection and when camera_states() occured, if the camera supports HDR, and when it changes.

event messageolympe.messages.camera.hdr_setting(cam_id=None, value=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Hdr_setting

Notify of camera HDR setting.

Parameters

cam_id (u8) – Id of the camera.
value (olympe.enums.camera.state) – Actual HDR setting value.
_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:

Triggered during the connection and when camera_states() occured, if the camera supports HDR, and by set_hdr_setting().

command messageolympe.messages.camera.lock_exposure(cam_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Lock_exposure

Lock shutter speed and iso sensitivity to current values. Valid for all exposure modes exepted manual. Auto exposure lock is automatically removed when the exposure mode is changed.

Parameters

cam_id (u8) – Id of the camera.
_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:

Result: Send exposure() event with the new Lock state and locked shutter speed and iso sentivity values. If auto exposure lock is not supported the exposure() event is sent with lock state inactive.

command messageolympe.messages.camera.lock_exposure_on_roi(cam_id, roi_center_x, roi_center_y, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Lock_exposure_on_roi

Lock shutter speed and iso sensitivity optimized on a specific region. Valid for all exposure modes exepted manual Auto exposure lock is automatically removed when the exposure mode is changed.

Parameters

cam_id (u8) – Id of the camera.
roi_center_x (float) – ROI center on x axis. between 0 and 1, relative to streaming image width.
roi_center_y (float) – ROI center on y axis. between 0 and 1, relative to streaming image height.
_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:

event messageolympe.messages.camera.max_zoom_speed(cam_id=None, min=None, max=None, current=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Max_zoom_speed

Max zoom speed setting. This setting contains the range and the current value. All values are expressed as the tangent of the angle in degrees per seconds.

Parameters

cam_id (u8) – Id of the camera.
min (float) – Minimal bound of the max zoom speed range. Expressed as a tan(deg) / sec.
max (float) – Maximal bound of the max zoom speed range Expressed as a tan(deg) / sec.
current (float) – Current max zoom speed. Expressed as a tan(deg) / sec.
_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:

Triggered during connection, when range changes and when the current value is set by max_zoom_speed().

event messageolympe.messages.camera.next_photo_delay(mode=None, remaining=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Next_photo_delay

Remaining time or distance before next photo.

Parameters

mode (olympe.enums.camera.photo_mode) – Selected mode: only time_lapse and gps_lapse are supported
remaining (float) – In time_lapse photo_mode: remaining time in seconds before next photo In gps_lapse photo_mode: remaining distance in meters before next photo
_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:

Triggered each 500ms, when take_photo() is triggered and photo_mode is time_lapse or gps_lapse

event messageolympe.messages.camera.photo_capabilities(id=None, photo_modes=None, photo_formats=None, photo_file_formats=None, hdr=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Photo_capabilities

Describe photo capabilities. Each entry of this list gives a valid format/fileformat pair for the listed modes and if HDR is supported in this configuration. The same mode can be in multiple entries.

Parameters

id (u16) – Setting id. U8 msb is cam_id of the related camera.
photo_modes (BitfieldOf(olympe.enums.camera.photo_mode, u16)) – Photo modes this capability applies to.
photo_formats (BitfieldOf(olympe.enums.camera.photo_format, u16)) – Supported photo formats in specified modes and file formats (DNG file will always be full- frame, regardless of this setting).
photo_file_formats (BitfieldOf(olympe.enums.camera.photo_file_format, u16)) – Supported photo file formats in specified modes and formats.
hdr (olympe.enums.camera.supported) – Indicate if hdr is supported in this configuration.
list_flags (BitfieldOf(olympe.enums.camera.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:

Triggered only during the connection

event messageolympe.messages.camera.photo_mode(cam_id=None, mode=None, format=None, file_format=None, burst=None, bracketing=None, capture_interval=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Photo_mode

Notify of camera photo mode

Parameters

cam_id (u8) – Id of the camera.
mode (olympe.enums.camera.photo_mode) – Camera photo mode.
format (olympe.enums.camera.photo_format) – Actual format.
file_format (olympe.enums.camera.photo_file_format) – Actual photo file format.
burst (olympe.enums.camera.burst_value) – Actual burst value when the photo mode is burst. Invalid in other modes.
bracketing (olympe.enums.camera.bracketing_preset) – Actual bracketing value when the photo mode is bracketing. Invalid in other modes.
capture_interval (float) – Actual time-lapse interval value (in seconds) when the photo mode is time_lapse. Actual GPS-lapse interval value (in meters) when the photo mode is gps_lapse. Ignored in other 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:

Triggered during the connection, when camera_states() occured and by set_photo_mode().

event messageolympe.messages.camera.photo_progress(cam_id=None, result=None, photo_count=None, media_id=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Photo_progress

Sent as progress and result of take_photo() command. This event is not sent during the connection.

Parameters

cam_id (u8) – Id of the camera.
result (olympe.enums.camera.photo_result) – Progress or result value: - taking_photo indicate that the camera starts taking photo (or multiple photos when mode is burst or bracketing). - photo_taken indicate that one photo has been taken and is about be saved to disk. In bracketing mode, this event is sent when the last photo of the bracketing sequence has been taken. In burst mode this event is sent after each photo but maximum every 100ms. - photo_saved indicate the media containing the photo has been saved to disk. In burst or bracketing mode, indicate that all photos of the burst or bracketing sequence have been saved to disk. Other results are errors.
photo_count (u8) – Only valid when result is photo_taken, indicate the number of photo taken in the sequence.
media_id (string) – Only valid when result is photo_saved, indicate the media id containing taken photo(s).
_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:

Triggered while taking a picture.

event messageolympe.messages.camera.photo_state(cam_id=None, available=None, state=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Photo_state

Current photo camera state. Indicates if the camera is ready to take a photo.

Parameters

cam_id (u8) – Id of the camera.
available (olympe.enums.camera.availability) – Tell if photo feature is available in current mode.
state (olympe.enums.camera.state) – Tell if photo feature is currently active.
_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:

Triggered during connection, when camera_states() occured and when state changes.

event messageolympe.messages.camera.recording_capabilities(id=None, recording_modes=None, resolutions=None, framerates=None, hdr=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Recording_capabilities

Describe recording capabilities. Each entry of this list gives valid resolutions/framerates pair for the listed modes and if HDR is supported in this configuration. The same mode can be in multiple entries.

Parameters

id (u16) – Setting id. U8 msb is cam_id of the related camera.
recording_modes (BitfieldOf(olympe.enums.camera.recording_mode, u16)) – Recording modes this capability applies to.
resolutions (BitfieldOf(olympe.enums.camera.resolution, u16)) – Supported resolutions in specified modes and framerates.
framerates (BitfieldOf(olympe.enums.camera.framerate, u32)) – Supported framerates in specified modes and resolutions.
hdr (olympe.enums.camera.supported) – Indicate if hdr is supported in this configuration.
list_flags (BitfieldOf(olympe.enums.camera.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:

Triggered only during the connection

event messageolympe.messages.camera.recording_mode(cam_id=None, mode=None, resolution=None, framerate=None, hyperlapse=None, bitrate=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Recording_mode

Notify of camera recording mode

Parameters

cam_id (u8) – Id of the camera.
mode (olympe.enums.camera.recording_mode) – Camera camera recording mode.
resolution (olympe.enums.camera.resolution) – Recording resolution.
framerate (olympe.enums.camera.framerate) – Recording framerate.
hyperlapse (olympe.enums.camera.hyperlapse_value) – Hyperlapse value when the recording mode is hyperlapse. Invalid in other modes.
bitrate (u32) – Recording bitrate for current configuration (bits/s). Zero if unavailable.
_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:

Triggered during the connection, when camera_states() occured and by set_recording_mode().

event messageolympe.messages.camera.recording_progress(cam_id=None, result=None, media_id=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Recording_progress

Sent when recording state change. This event is not sent during the connection.

Parameters

cam_id (u8) – Id of the camera.
result (olympe.enums.camera.recording_result) – Current recording result. Indicate if recording has started/stopped.
media_id (string) – Recorded media_id. Only valid when result is stopped or stopped_no_storage_space.
_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:

Triggered during connection and while recording.

event messageolympe.messages.camera.recording_state(cam_id=None, available=None, state=None, start_timestamp=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Recording_state

Current recording state. Indicates if the camera is currently recording.

Parameters

cam_id (u8) – Id of the camera.
available (olympe.enums.camera.availability) – Tell if recording feature is available in current mode.
state (olympe.enums.camera.state) – Current recording state.
start_timestamp (u64) – If state is active, the timestamp if the start of the recording, in milliseconds since 00:00:00 UTC on 1 January 1970.
_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:

Triggered during connection, when camera_states() occured and when state changes.

command messageolympe.messages.camera.reset_alignment_offsets(cam_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Reset_alignment_offsets

Alignment reset factory.

Parameters

cam_id (u8) – Id of the camera.
_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:

Result: Camera alignment is reset, and event alignment_offsets() is sent accordingly.

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

command messageolympe.messages.camera.reset_zoom(cam_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Reset_zoom

Reset the zoom level

Parameters

cam_id (u8) – id of the camera.
_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:

Result: Zoom level is reset.

command messageolympe.messages.camera.set_alignment_offsets(cam_id, yaw, pitch, roll, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_alignment_offsets

Set alignment offsets.

Parameters

cam_id (u8) – Id of the camera.
yaw (float) – Alignment offset, in degrees, that should be applied to the yaw axis. This value will be clamped between alignment_offsets() min_bound_yaw and max_bound_yaw
pitch (float) – Alignment offset, in degrees, that should be applied to the pitch axis. This value will be clamped between alignment_offsets() min_bound_pitch and max_bound_pitch
roll (float) – Alignment offset, in degrees, that should be applied to the roll axis. This value will be clamped between alignment_offsets() min_bound_roll and max_bound_roll
_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:

Result: Camera alignment is changed, and event alignment_offsets() is sent accordingly.

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

command messageolympe.messages.camera.set_antiflicker_mode(mode, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_antiflicker_mode

Change the anti-flicker mode.

Parameters

mode (olympe.enums.camera.antiflicker_mode) – Requested anti-flicker 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:

Result: antiflicker_mode() event with the new anti-flicker mode. If the requested anti-flicker mode is not supported, the antiflicker_mode() event is send with the actual anti-flicker mode unchanged.

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

command messageolympe.messages.camera.set_autorecord(cam_id, state, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_autorecord

When auto-record is enabled, if the drone is in recording mode, recording starts when taking-off and stops after landing.

Parameters

cam_id (u8) – Id of the camera.
state (olympe.enums.camera.state) – Requested auto-record state.
_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:

Result: Value is set then autorecord() is triggered with the new auto-record state.

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

command messageolympe.messages.camera.set_camera_mode(cam_id, value, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_camera_mode

Change camera mode.

Parameters

cam_id (u8) – Id of the camera.
value (olympe.enums.camera.camera_mode) – Requested camera 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:

Result: camera_mode() event with the new camera mode. If the requested camera mode is not supported, the camera_mode() event is sent when the camera mode unchanged.

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

command messageolympe.messages.camera.set_ev_compensation(cam_id, value, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_ev_compensation

Change the EV compensation value.

Parameters

cam_id (u8) – Id of the camera.
value (olympe.enums.camera.ev_compensation) – Requested EV compensation value.
_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:

Result: ev_compensation() event with the new ev compensation value. If the requested ev compensation value is not supported, the ev_compensation() event is send with the actual ev compensation unchanged.

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

command messageolympe.messages.camera.set_exposure_settings(cam_id, mode, shutter_speed, iso_sensitivity, max_iso_sensitivity, metering_mode, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_exposure_settings

Sets exposure mode, shutter speed, iso sensitivity and maximum iso sensitivity.

Parameters

cam_id (u8) – Id of the camera.
mode (olympe.enums.camera.exposure_mode) – Requested exposure mode: Auto, Manual Shutter Speed, Manual ISO or Manual.
shutter_speed (olympe.enums.camera.shutter_speed) – Requested shutter speed, ignored if mode is not Manual Shutter Speed or Manual.
iso_sensitivity (olympe.enums.camera.iso_sensitivity) – Requested ISO sensitivity level, ignored if mode is not Manual ISO or Manual.
max_iso_sensitivity (olympe.enums.camera.iso_sensitivity) – Requested maximum ISO sensitivity level, ignored is not Auto. This value define the maximum iso sensitivity the autoexposure engine can use to adjust exposure.
metering_mode (olympe.enums.camera.auto_exposure_metering_mode) – Auto Exposure metering mode, ignored if mode is Manual
_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:

Result: Send exposure_settings() event with the new exposure mode. If the requested settings are not supported, the exposure_settings() event is send with the actual exposure settings unchanged.

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

command messageolympe.messages.camera.set_hdr_setting(cam_id, value, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_hdr_setting

Change HDR setting. if HDR setting is active, HDR will be used when supported in active configuration.

Parameters

cam_id (u8) – Id of the camera.
value (olympe.enums.camera.state) – Requested HDR setting value.
_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:

Result: hdr_setting() event is sent back with the new HDR setting.

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

command messageolympe.messages.camera.set_max_zoom_speed(cam_id, max, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_max_zoom_speed

Set the max zoom speed setting. You can get bounds using set_max_zoom_speed().

Parameters

cam_id (u8) – Id of the camera.
max (float) – Desired current max zoom speed. Should lay between the bounds given by set_max_zoom_speed(). Expressed as a tan(deg) / sec.
_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:

Result: The max zoom speed is set. Then, event max_zoom_speed() is triggered with the current max value.

Expectations: max_zoom_speed(cam_id=self.cam_id, current=self.max, _policy='wait')

command messageolympe.messages.camera.set_photo_mode(cam_id, mode, format, file_format, burst, bracketing, capture_interval, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_photo_mode

Change photo mode and parameters to be used when the camera is in mode photo. Note that if the camera is in recording modes, actual camera mode is not changed, new photo mode and parameters are saved and are apply when the camera mode is changed to photo.

Parameters

cam_id (u8) – Id of the camera.
mode (olympe.enums.camera.photo_mode) – Requested camera photo mode.
format (olympe.enums.camera.photo_format) – Requested photo format.
file_format (olympe.enums.camera.photo_file_format) – Requested photo file format.
burst (olympe.enums.camera.burst_value) – Requested burst value when the photo mode is burst. Ignored in other modes.
bracketing (olympe.enums.camera.bracketing_preset) – Requested bracketing value when the photo mode is bracketing. Ignored in other modes.
capture_interval (float) – Requested time-lapse interval value (in seconds) when the photo mode is time_lapse. Requested GPS-lapse interval value (in meters) when the photo mode is gps_lapse. Ignored in other modes.
_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:

Result: photo_mode() event with the new camera photo mode. If the requested camera photo mode is not supported, the photo_mode() event is sent when the camera photo mode unchanged.

Expectations: photo_mode(cam_id=self.cam_id, mode=self.mode, format=self.format, file_format=self.file_format, _policy='wait')

command messageolympe.messages.camera.set_recording_mode(cam_id, mode, resolution, framerate, hyperlapse, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_recording_mode

Change recording mode and parameters to be used when the camera is in mode recording. Note that if the camera is in photo modes, actual camera mode is not changed, new recording mode and parameters are saved and are apply when the camera mode is changed to recording.

Parameters

cam_id (u8) – Id of the camera.
mode (olympe.enums.camera.recording_mode) – Requested camera recording mode.
resolution (olympe.enums.camera.resolution) – Requested recording resolution.
framerate (olympe.enums.camera.framerate) – Requested recording framerate.
hyperlapse (olympe.enums.camera.hyperlapse_value) – Requested hyperlapse value when the recording mode is hyperlapse. Ignored in other modes
_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:

Result: recording_mode() event with the new camera recording mode. If the requested camera recording mode is not supported, the recording_mode() event is sent when the camera recording mode unchanged.

Expectations: recording_mode(cam_id=self.cam_id, mode=self.mode, resolution=self.resolution, framerate=self.framerate, _policy='wait')

command messageolympe.messages.camera.set_streaming_mode(cam_id, value, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_streaming_mode

Change streaming mode setting.

Parameters

cam_id (u8) – Id of the camera.
value (olympe.enums.camera.streaming_mode) – New streaming 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:

Result: Send streaming_mode() event with the new streaming mode. If the requested mode is not supported, the streaming_mode() event is sent when the streaming mode unchanged.

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

command messageolympe.messages.camera.set_style(cam_id, style, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_style

Change the active style.

Parameters

cam_id (u8) – Id of the camera.
style (olympe.enums.camera.style) – Style to activate.
_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:

Result: style() event with the new active style. If the requested style is not supported, the style() event us send with the actual style unchanged.

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

command messageolympe.messages.camera.set_style_params(cam_id, saturation, contrast, sharpness, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_style_params

Change style saturation, contrast and sharpness of the current active style.

Parameters

cam_id (u8) – Id of the camera.
saturation (i8) – Requested saturation value for this style.
contrast (i8) – Requested contrast value for this style.
sharpness (i8) – Requested sharpness value for this style.
_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:

Result: style() event with the new style parameters.

Expectations: style(cam_id=self.cam_id, saturation=self.saturation, contrast=self.contrast, sharpness=self.sharpness, _policy='wait')

command messageolympe.messages.camera.set_white_balance(cam_id, mode, temperature, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_white_balance

Change the white balance mode and custom temperature.

Parameters

cam_id (u8) – Id of the camera.
mode (olympe.enums.camera.white_balance_mode) – Requested white balance mode.
temperature (olympe.enums.camera.white_balance_temperature) – Requested white balance temperature when mode is custom. Ignored else.
_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:

Result: white_balance() event with the new white balance mode and custom temperature. If the requested white balance mode mode is not supported, the white_balance() event is send with the actual white balance mode unchanged.

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

command messageolympe.messages.camera.set_white_balance_lock(cam_id, state, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_white_balance_lock

Lock/unlock white balance to current value. Valid when white balance mode not custom. White balance lock is automatically removed when the white balance mode is changed.

Parameters

cam_id (u8) – Id of the camera.
state (olympe.enums.camera.state) – Requested lock state.
_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:

Result: Send white_balance() event with the new Lock state. If white balance lock is not supported the white_balance() event is sent when the locked to zero.

Expectations: white_balance(cam_id=self.cam_id, lock=self.state, _policy='wait')

command messageolympe.messages.camera.set_zoom_target(cam_id, control_mode, target, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_zoom_target

Set the zoom target

Parameters

cam_id (u8) – id of the camera.
control_mode (olympe.enums.camera.zoom_control_mode) – Mode of changing the zoom. This parameter will characterize following parameters units.
target (float) – Zoom target. Units depend on the control_mode value: - level: value is in zoom level - velocity, value is in signed ratio (from -1 to 1) of the max_zoom_speed() current parameter. Negative values will produce a zoom out, positive values produce a zoom in.
_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:

Result: set the target.

command messageolympe.messages.camera.set_zoom_velocity_quality_degradation(cam_id, allow, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Set_zoom_velocity_quality_degradation

Set the max zoom velocity.

Parameters

cam_id (u8) – Id of the camera.
allow (u8) – 1 to allow quality degradation, 0 otherwise.
_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:

Result: Value is set. Then, event zoom_velocity_quality_degradation() is triggered.

Expectations: zoom_velocity_quality_degradation(cam_id=self.cam_id, allowed=self.allow, _policy='wait')

command messageolympe.messages.camera.start_recording(cam_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Start_recording

Start video recording.

Parameters

cam_id (u8) – Id of the camera.
_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:

Result: recording_progress() with the progress of the recording. recording_state() will change to active while the camera is recording

Expectations: recording_progress(cam_id=self.cam_id, _policy='wait') & recording_state(cam_id=self.cam_id, state='active', _policy='wait')

command messageolympe.messages.camera.stop_photo(cam_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Stop_photo

Stops an ongoing photos capture. Only for time_lapse and gps_lapse photo_mode. Only when photo_state is available and active.

Parameters

cam_id (u8) – Id of the camera.
_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:

Result: photo_progress() with progress of the last photo, then photo_state() will change to inactive.

Expectations: photo_progress(cam_id=self.cam_id, _policy='wait') & photo_state(cam_id=self.cam_id, state='inactive', _policy='wait')

command messageolympe.messages.camera.stop_recording(cam_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Stop_recording

Stop video recording.

Parameters

cam_id (u8) – Id of the camera.
_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:

Result: recording_progress() with the progress of the recording.

Expectations: recording_progress(cam_id=self.cam_id, result='stopped', _policy='wait')

event messageolympe.messages.camera.streaming_mode(cam_id=None, value=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Streaming_mode

Notify of actual streaming mode setting.

Parameters

cam_id (u8) – Id of the camera.
value (olympe.enums.camera.streaming_mode) – Actual streaming mode setting.
_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:

Triggered during the connection and by set_streaming_mode().

event messageolympe.messages.camera.style(cam_id=None, style=None, saturation=None, saturation_min=None, saturation_max=None, contrast=None, contrast_min=None, contrast_max=None, sharpness=None, sharpness_min=None, sharpness_max=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Style

Notify current style and its saturation, contrast and sharpness values.

Parameters

cam_id (u8) – Id of the camera.
style (olympe.enums.camera.style) – Active style.
saturation (i8) – Actual saturation value for this style.
saturation_min (i8) – Minimum supported value for style saturation.
saturation_max (i8) – Maximum supported value for style saturation.
contrast (i8) – Actual contrast value for this style.
contrast_min (i8) – Minimum supported value for style contrast.
contrast_max (i8) – Maximum supported value for style contrast.
sharpness (i8) – Actual sharpness value for this style.
sharpness_min (i8) – Minimum supported value for style sharpness.
sharpness_max (i8) – Maximum supported value for style sharpness.
_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:

Triggered during the connection, when camera_states() occured, when the style is changed by set_style() and when current style parameters are changed by set_style_params()

command messageolympe.messages.camera.take_photo(cam_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Take_photo

Take a photo. Can be sent when photo_state is available.

Parameters

cam_id (u8) – Id of the camera.
_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:

Result: photo_state() will change to active. In case of an error, it will change to inactive. When the drone has finished taking photos, it will change back to inactive. If photo_mode is time_lapse or `gps_lapse, it will stay at active as long as no error occurs and stop_photo() is not sent. While photo_state is active, multiple photo_progress() will be received to notify an error or a progress.

Expectations: photo_state(cam_id=self.cam_id, state='active', _policy='wait')

command messageolympe.messages.camera.unlock_exposure(cam_id, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))¶

Camera.Unlock_exposure

Valid when exposure is locked.

Parameters

cam_id (u8) – Id of the camera.
_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:

Result: Send exposure() event with the new Lock state. If auto exposure is not locked the exposure() event is sent with current lock state.

event messageolympe.messages.camera.white_balance(cam_id=None, mode=None, temperature=None, lock=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.White_balance

Notify of actual white balance mode

Parameters

cam_id (u8) – Id of the camera.
mode (olympe.enums.camera.white_balance_mode) – Actual white balance mode.
temperature (olympe.enums.camera.white_balance_temperature) – Actual white balance temperature if the mode custom, invalid else.
lock (olympe.enums.camera.state) – White balance lock state.
_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:

Triggered during the connection, when camera_states() occured and by set_environment() or environment_changed().

event messageolympe.messages.camera.zoom_info(cam_id=None, available=None, high_quality_maximum_level=None, maximum_level=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Zoom_info

Zoom information. This event is never sent if the device doesn’t have a zoom.

Parameters

cam_id (u8) – Id of the camera.
available (olympe.enums.camera.availability) – Tells if zoom is available in the current configuration.
high_quality_maximum_level (float) – Maximum zoom level without degrading image quality. Ignored if available is not_available.
maximum_level (float) – Maximum zoom level with image quality degradation. Ignored if available is not_available. Same value than high_quality_maximum_level if there is no digital zoom with quality degradation.
_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:

Triggered during the connection and when zoom availability or bounds change.

event messageolympe.messages.camera.zoom_level(cam_id=None, level=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Zoom_level

Current camera zoom level.

Parameters

cam_id (u8) – Id of the camera.
level (float) – Actual zoom level. Ignored if available is not_available.
_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:

Triggered regularly.

event messageolympe.messages.camera.zoom_velocity_quality_degradation(cam_id=None, allowed=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))¶

Camera.Zoom_velocity_quality_degradation

Whether zoom change by indicating a velocity is allowed to go on a zoom level that degrades video quality. If not allowed, zoom level will stop at the level given by the high_quality_maximum_level of the [Zoom](143-20) event.

Parameters

cam_id (u8) – Id of the camera.
allowed (u8) – 1 if quality degradation is allowed, 0 otherwise.
_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:

Triggered during connection, and by set_zoom_velocity_quality_degradation().

enumolympe.enums.camera.antiflicker_mode¶

Anti-flicker mode.

enumolympe.enums.camera.auto_exposure_metering_mode¶

Auto Exposure metering mode.

enumolympe.enums.camera.availability¶

Indicate if a feature is available in current mode/configuration.

enumolympe.enums.camera.bracketing_preset¶

Bracketing mode preset.

enumolympe.enums.camera.burst_value¶

Values for burst photo mode.

enumolympe.enums.camera.camera_mode¶

Camera mode.

enumolympe.enums.camera.ev_compensation¶

Exposure compensation.

enumolympe.enums.camera.exposure_mode¶

Exposure mode.

enumolympe.enums.camera.framerate¶

Video recording frame rate

enumolympe.enums.camera.hyperlapse_value¶

Values for hyperlapse mode.

enumolympe.enums.camera.iso_sensitivity¶

ISO Sensitivity levels.

enumolympe.enums.camera.list_flags¶

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages

enumolympe.enums.camera.model¶

Camera model.

enumolympe.enums.camera.photo_file_format¶

The photo format.

enumolympe.enums.camera.photo_format¶

The photo format.

enumolympe.enums.camera.photo_mode¶

enumolympe.enums.camera.photo_result¶

Result for command take_photo.

enumolympe.enums.camera.recording_mode¶

enumolympe.enums.camera.recording_result¶

Start/Stop recording result.

enumolympe.enums.camera.resolution¶

Video resolution.

enumolympe.enums.camera.shutter_speed¶

The shutter speed in seconds.

enumolympe.enums.camera.state¶

Feature current state.

enumolympe.enums.camera.streaming_mode¶

Video stream mode.

Enum aliases:

enumolympe.enums.camera.style¶

Images style.

enumolympe.enums.camera.supported¶

Indicate if a feature is supported by the drone.

enumolympe.enums.camera.white_balance_mode¶

The white balance mode.

enumolympe.enums.camera.white_balance_temperature¶

The white balance temperature.

enumolympe.enums.camera.zoom_control_mode¶

Zoom control mode.