Camera feature

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, _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.
  • _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

Triggered only during the connection

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, u16)) – 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

Triggered only during the connection

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

Triggered only during the connection

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

Triggered only during the connection if antiflickering is supported.

command messageolympe.messages.camera.set_exposure_settings(cam_id, mode, shutter_speed, iso_sensitivity, max_iso_sensitivity, _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.
  • _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

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

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

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

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.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, _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.
  • _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

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.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, _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

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

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

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

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

event messageolympe.messages.camera.white_balance(cam_id=None, mode=None, temperature=None, lock=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

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

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

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

event messageolympe.messages.camera.ev_compensation(cam_id=None, value=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

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

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

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

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

Triggered during the connection and by set_antiflicker_mode()

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

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

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

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

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

Result: set the target.

event messageolympe.messages.camera.zoom_level(cam_id=None, level=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

Triggered regularly.

event messageolympe.messages.camera.zoom_info(cam_id=None, available=None, high_quality_maximum_level=None, maximum_level=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

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

event messageolympe.messages.camera.max_zoom_speed(cam_id=None, min=None, max=None, current=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

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

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

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

event messageolympe.messages.camera.zoom_velocity_quality_degradation(cam_id=None, allowed=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

Triggered during connection, and by set_zoom_velocity_quality_degradation().

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

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

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

event messageolympe.messages.camera.hdr_setting(cam_id=None, value=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

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

event messageolympe.messages.camera.hdr(cam_id=None, available=None, state=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

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

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

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

event messageolympe.messages.camera.camera_mode(cam_id=None, mode=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

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

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

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

event messageolympe.messages.camera.recording_mode(cam_id=None, mode=None, resolution=None, framerate=None, hyperlapse=None, bitrate=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

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

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

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

event messageolympe.messages.camera.photo_mode(cam_id=None, mode=None, format=None, file_format=None, burst=None, bracketing=None, capture_interval=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

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

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

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

event messageolympe.messages.camera.streaming_mode(cam_id=None, value=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

Triggered during the connection and by set_streaming_mode().

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

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

event messageolympe.messages.camera.photo_progress(cam_id=None, result=None, photo_count=None, media_id=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

Triggered while taking a picture.

event messageolympe.messages.camera.photo_state(cam_id=None, available=None, state=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

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

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

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

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.recording_progress(cam_id=None, result=None, media_id=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

Triggered during connection and while recording.

event messageolympe.messages.camera.recording_state(cam_id=None, available=None, state=None, start_timestamp=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

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

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

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

event messageolympe.messages.camera.autorecord(cam_id=None, state=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

Triggered during connection and by set_autorecord().

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

Result: Zoom level is reset.

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

Triggered during connection and when state changes.

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

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

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

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

enumolympe.enums.camera.model

Camera model.

main:Main camera, for photo and/or video. (0)
thermal:Thermal camera, for photo and/or video. (1)
enumolympe.enums.camera.supported

Indicate if a feature is supported by the drone.

not_supported:Not Supported. (0)
supported:Supported. (1)
enumolympe.enums.camera.availability

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

not_available:Not Available. (0)
available:Available. (1)
enumolympe.enums.camera.state

Feature current state.

inactive:Feature is not currently active. (0)
active:Feature is currently active. (1)
enumolympe.enums.camera.exposure_mode

Exposure mode.

automatic:Automatic shutter speed and iso, balanced. (0)
automatic_prefer_iso_sensitivity:
 Automatic shutter speed and iso, prefer increasing iso sensitivity over using low shutter speed. This mode provides better results when the drone is moving dynamically. (1)
automatic_prefer_shutter_speed:
 Automatic shutter speed and iso, prefer reducing shutter speed over using high iso sensitivity. This mode provides better results when the drone is moving slowly. (2)
manual_iso_sensitivity:
 Manual iso sensitivity, automatic shutter speed. (3)
manual_shutter_speed:
 Manual shutter speed, automatic iso. (4)
manual:Manual iso sensitivity and shutter speed. (5)
enumolympe.enums.camera.shutter_speed

The shutter speed in seconds.

shutter_1_over_10000:
 1/10000 sec. (0)
shutter_1_over_8000:
 1/8000 sec. (1)
shutter_1_over_6400:
 1/6400 sec. (2)
shutter_1_over_5000:
 1/5000 sec. (3)
shutter_1_over_4000:
 1/4000 sec. (4)
shutter_1_over_3200:
 1/3200 sec. (5)
shutter_1_over_2500:
 1/2500 sec. (6)
shutter_1_over_2000:
 1/2000 sec. (7)
shutter_1_over_1600:
 1/1600 sec. (8)
shutter_1_over_1250:
 1/1250 sec. (9)
shutter_1_over_1000:
 1/1000 sec. (10)
shutter_1_over_800:
 1/800 sec. (11)
shutter_1_over_640:
 1/640 sec. (12)
shutter_1_over_500:
 1/500 sec. (13)
shutter_1_over_400:
 1/400 sec. (14)
shutter_1_over_320:
 1/320 sec. (15)
shutter_1_over_240:
 1/240 sec. (16)
shutter_1_over_200:
 1/200 sec. (17)
shutter_1_over_160:
 1/160 sec. (18)
shutter_1_over_120:
 1/120 sec. (19)
shutter_1_over_100:
 1/100 sec. (20)
shutter_1_over_80:
 1/80 sec. (21)
shutter_1_over_60:
 1/60 sec. (22)
shutter_1_over_50:
 1/50 sec. (23)
shutter_1_over_40:
 1/40 sec. (24)
shutter_1_over_30:
 1/30 sec. (25)
shutter_1_over_25:
 1/25 sec. (26)
shutter_1_over_15:
 1/15 sec. (27)
shutter_1_over_10:
 1/10 sec. (28)
shutter_1_over_8:
 1/8 sec. (29)
shutter_1_over_6:
 1/6 sec. (30)
shutter_1_over_4:
 1/4 sec. (31)
shutter_1_over_3:
 1/3 sec. (32)
shutter_1_over_2:
 1/2 sec. (33)
shutter_1_over_1_5:
 1/1.5 sec. (34)
shutter_1:1 sec. (35)
enumolympe.enums.camera.iso_sensitivity

ISO Sensitivity levels.

iso_50:ISO 50. (0)
iso_64:ISO 64. (1)
iso_80:ISO 80. (2)
iso_100:ISO 100. (3)
iso_125:ISO 125. (4)
iso_160:ISO 160. (5)
iso_200:ISO 200. (6)
iso_250:ISO 250. (7)
iso_320:ISO 320. (8)
iso_400:ISO 400. (9)
iso_500:ISO 500. (10)
iso_640:ISO 640. (11)
iso_800:ISO 800. (12)
iso_1200:ISO 1200. (13)
iso_1600:ISO 1600. (14)
iso_2500:ISO 2500. (15)
iso_3200:ISO 3200. (16)
enumolympe.enums.camera.ev_compensation

Exposure compensation.

ev_minus_3_00:-3.00 EV. (0)
ev_minus_2_67:-2.67 EV. (1)
ev_minus_2_33:-2.33 EV. (2)
ev_minus_2_00:-2.00 EV. (3)
ev_minus_1_67:-1.67 EV. (4)
ev_minus_1_33:-1.33 EV. (5)
ev_minus_1_00:-1.00 EV. (6)
ev_minus_0_67:-0.67 EV. (7)
ev_minus_0_33:-0.33 EV. (8)
ev_0_00:0.00 EV. (9)
ev_0_33:0.33 EV. (10)
ev_0_67:0.67 EV. (11)
ev_1_00:1.00 EV. (12)
ev_1_33:1.33 EV. (13)
ev_1_67:1.67 EV. (14)
ev_2_00:2.00 EV. (15)
ev_2_33:2.33 EV. (16)
ev_2_67:2.67 EV. (17)
ev_3_00:3.00 EV. (18)
enumolympe.enums.camera.white_balance_mode

The white balance mode.

automatic:Automatic Estimation of White Balance scales. (0)
candle:Candle preset. (1)
sunset:Sunset preset. (2)
incandescent:Incandescent light preset. (3)
warm_white_fluorescent:
 Warm white fluorescent light preset. (4)
halogen:Halogen light preset. (5)
fluorescent:Fluorescent light preset. (6)
cool_white_fluorescent:
 Cool white fluorescent light preset. (7)
flash:Flash light preset. (8)
daylight:Daylight preset. (9)
sunny:Sunny preset. (10)
cloudy:Cloudy preset. (11)
snow:Snow preset. (12)
hazy:Hazy preset. (13)
shaded:Shaded preset. (14)
green_foliage:Green foliage preset. (15)
blue_sky:Blue sky preset. (16)
custom:Custom white balance value. (17)
enumolympe.enums.camera.white_balance_temperature

The white balance temperature.

t_1500:1500 K. (0)
t_1750:1750 K. (1)
t_2000:2000 K. (2)
t_2250:2250 K. (3)
t_2500:2500 K. (4)
t_2750:2750 K. (5)
t_3000:3000 K. (6)
t_3250:3250 K. (7)
t_3500:3500 K. (8)
t_3750:3750 K. (9)
t_4000:4000 K. (10)
t_4250:4250 K. (11)
t_4500:4500 K. (12)
t_4750:4750 K. (13)
t_5000:5000 K. (14)
t_5250:5250 K. (15)
t_5500:5500 K. (16)
t_5750:5750 K. (17)
t_6000:6000 K. (18)
t_6250:6250 K. (19)
t_6500:6500 K. (20)
t_6750:6750 K. (21)
t_7000:7000 K. (22)
t_7250:7250 K. (23)
t_7500:7500 K. (24)
t_7750:7750 K. (25)
t_8000:8000 K. (26)
t_8250:8250 K. (27)
t_8500:8500 K. (28)
t_8750:8750 K. (29)
t_9000:9000 K. (30)
t_9250:9250 K. (31)
t_9500:9500 K. (32)
t_9750:9750 K. (33)
t_10000:10000 K. (34)
t_10250:10250 K. (35)
t_10500:10500 K. (36)
t_10750:10750 K. (37)
t_11000:11000 K. (38)
t_11250:11250 K. (39)
t_11500:11500 K. (40)
t_11750:11750 K. (41)
t_12000:12000 K. (42)
t_12250:12250 K. (43)
t_12500:12500 K. (44)
t_12750:12750 K. (45)
t_13000:13000 K. (46)
t_13250:13250 K. (47)
t_13500:13500 K. (48)
t_13750:13750 K. (49)
t_14000:14000 K. (50)
t_14250:14250 K. (51)
t_14500:14500 K. (52)
t_14750:14750 K. (53)
t_15000:15000 K. (54)
enumolympe.enums.camera.style

Images style.

standard:Natural look style. (0)
plog:Parrot Log, produce flat and desaturated images, best for post-processing. (1)
intense:Intense style: bright colors, warm shade, high contrast. (2)
pastel:Pastel style: soft colors, cold shade, low contrast. (3)
enumolympe.enums.camera.camera_mode

Camera mode.

recording:Camera is in recording mode. (0)
photo:Camera is in photo mode. (1)
enumolympe.enums.camera.recording_mode
standard:Standard mode. (0)
hyperlapse:Create an accelerated video by dropping some frame at a user specified rate define by hyperlapse_value. (1)
slow_motion:Record x2 or x4 slowed-down videos. (2)
high_framerate:Record high-framerate videos (playback speed is x1). (3)
enumolympe.enums.camera.photo_mode
single:Single shot mode. (0)
bracketing:Bracketing mode. Takes a burst of 3 or 5 frames with a different exposure. (1)
burst:Burst mode. Takes burst of frames. (2)
time_lapse:Time-lapse mode. Takes frames at a regular time interval. (3)
gps_lapse:GPS-lapse mode. Takse frames at a regular GPS position interval. (4)
enumolympe.enums.camera.resolution

Video resolution.

res_dci_4k:4096x2160 pixels (4k cinema). (0)
res_uhd_4k:3840x2160 pixels (UHD). (1)
res_2_7k:2704x1524 pixels. (2)
res_1080p:1920x1080 pixels (Full HD). (3)
res_720p:1280x720 pixels (HD). (4)
res_480p:856x480 pixels. (5)
res_1080p_sd:1440x1080 pixels (SD). (6)
res_720p_sd:960x720 pixels (SD). (7)
enumolympe.enums.camera.framerate

Video recording frame rate

fps_24:23.97 fps. (0)
fps_25:25 fps. (1)
fps_30:29.97 fps. (2)
fps_48:47.952 fps. (3)
fps_50:50 fps. (4)
fps_60:59.94 fps. (5)
fps_96:95.88 fps. (6)
fps_100:100 fps. (7)
fps_120:119.88 fps. (8)
fps_9:For thermal only, capture triggered by thermal sensor. (9)
enumolympe.enums.camera.photo_format

The photo format.

full_frame:Sensor full resolution, not dewarped. (0)
rectilinear:Rectilinear projection, dewarped. (1)
enumolympe.enums.camera.photo_file_format

The photo format.

jpeg:photo recorded in JPEG format. (0)
dng:photo recorded in DNG format. (1)
dng_jpeg:photo recorded in both DNG and JPEG format. (2)
enumolympe.enums.camera.antiflicker_mode

Anti-flicker mode.

off:Anti-flicker off. (0)
auto:Auto detect. (1)
mode_50hz:force the exposure time to be an integer multiple of 10ms. (2)
mode_60hz:force the exposure time to be an integer multiple of 8.33ms. (3)
enumolympe.enums.camera.hyperlapse_value

Values for hyperlapse mode.

ratio_15:Record 1 of 15 frames. (0)
ratio_30:Record 1 of 30 frames. (1)
ratio_60:Record 1 of 60 frames. (2)
ratio_120:Record 1 of 120 frames. (3)
ratio_240:Record 1 of 240 frames. (4)
enumolympe.enums.camera.burst_value

Values for burst photo mode.

burst_14_over_4s:
 Record 14 picture over 4 second. (0)
burst_14_over_2s:
 Record 14 picture over 2 second. (1)
burst_14_over_1s:
 Record 14 picture over 1 second. (2)
burst_10_over_4s:
 Record 10 picture over 4 second. (3)
burst_10_over_2s:
 Record 10 picture over 2 second. (4)
burst_10_over_1s:
 Record 10 picture over 1 second. (5)
burst_4_over_4s:
 Record 4 picture over 4 second. (6)
burst_4_over_2s:
 Record 4 picture over 2 second. (7)
burst_4_over_1s:
 Record 4 picture over 1 second. (8)
enumolympe.enums.camera.bracketing_preset

Bracketing mode preset.

preset_1ev:3 frames, with EV compensation of [-1 EV, 0 EV, +1 EV]. (0)
preset_2ev:3 frames, with EV compensation of [-2 EV, 0 EV, +2 EV]. (1)
preset_3ev:3 frames, with EV compensation of [-3 EV, 0 EV, +3 EV]. (2)
preset_1ev_2ev:5 frames, with EV compensation of [-2 EV, -1 EV, 0 EV, +1 EV, +2 EV]. (3)
preset_1ev_3ev:5 frames, with EV compensation of [-3 EV, -1 EV, 0 EV, +1 EV, +3 EV]. (4)
preset_2ev_3ev:5 frames, with EV compensation of [-3 EV, -2 EV, 0 EV, +2 EV, +3 EV]. (5)
preset_1ev_2ev_3ev:
 7 frames, with EV compensation of [-3 EV, -2 EV, -1 EV, 0 EV, +1 EV, +2 EV, +3 EV]. (6)
enumolympe.enums.camera.streaming_mode

Video stream mode.

Enum aliases:

low_latency:Minimize latency with average reliability (best for piloting). (0)
high_reliability:
 Maximize the reliability with an average latency (best when streaming quality is important but not the latency). (1)
high_reliability_low_framerate:
 Maximize the reliability using a framerate decimation with an average latency (best when streaming quality is important but not the latency). (2)
enumolympe.enums.camera.photo_result

Result for command take_photo.

taking_photo:Taking a new photo. (0)
photo_taken:A photo has been taken. (1)
photo_saved:A photo has been saved to the file system. (2)
error_no_storage_space:
 Error taking photo: not enough space in storage. (3)
error_bad_state:
 Error taking photo: wrong state. (4)
error:Error taking photo: generic error. (5)
enumolympe.enums.camera.recording_result

Start/Stop recording result.

started:Recording started. (0)
stopped:Recording stopped. (1)
stopped_no_storage_space:
 Recording stopped because storage is full. (2)
stopped_storage_too_slow:
 Recording stopped because storage write speed is too slow. (3)
error_bad_state:
 Error starting recording: wrong state. (4)
error:Error starting or during recording. (5)
stopped_reconfigured:
 Recording stopped because of internal reconfiguration. (6)
enumolympe.enums.camera.zoom_control_mode

Zoom control mode.

level:Zoom is set by giving a level. (0)
velocity:Zoom is set by giving a velocity. (1)
enumolympe.enums.camera.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)