Sequoia feature

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

sequoia_cam.close_session

Close current mission session.

Parameters:

idu8

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

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

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

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.close_session

Result: New medias will be taken in legacy filesystem, all live stitch media are cleaned up, live stitch is not available anymore and session state is fired.

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

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

sequoia_cam.factory_reset

This command will request a factory reset from the Sequoia. The factory reset procedure implies an automatic reboot the sequoia, which will be done immediately after recieving this command.

Parameters:

idu8

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

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

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

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.factory_reset

Result: The Sequoia will reboot, all settings will be reset to their default values.

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

sequoia_cam.get_storage_infos

Ask to send back a storage_event

Parameters:

idu8

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

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

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

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.get_storage_infos

Result: Sorage infos are asked, then storage_infos() is sent back

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

event message olympe.messages.sequoia_cam.live_stitch_last_picture_id_changed(cam_id=None, picture_id=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

sequoia_cam.live_stitch_last_picture_id_changed

Last picture id available for live stitch.

Parameters:

cam_idu8

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

picture_id : u32

list_flags : BitfieldOf(olympe.enums.sequoia_cam.list_flags, u8)

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.live_stitch_last_picture_id_changed

event message olympe.messages.sequoia_cam.live_stitch_mask_changed(cam_id=None, mask=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

sequoia_cam.live_stitch_mask_changed

Current live stitch mask value.

Parameters:

cam_idu8

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

mask : BitfieldOf(olympe.enums.sequoia_cam.sensor_value, u8)

list_flags : BitfieldOf(olympe.enums.sequoia_cam.list_flags, u8)

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.live_stitch_mask_changed

Result: Sends current mask used for live stitch. Returns 0 if a session is not opened.

event message olympe.messages.sequoia_cam.live_stitch_pictures_in_progress_number_changed(cam_id=None, nb_pictures=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

sequoia_cam.live_stitch_pictures_in_progress_number_changed

Number of pictures that are currently processed.

Parameters:

cam_idu8

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

nb_pictures : u32

list_flags : BitfieldOf(olympe.enums.sequoia_cam.list_flags, u8)

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.live_stitch_pictures_in_progress_number_changed

Triggered: when all states have been requested and when the number of pictures in progress changed.

command message olympe.messages.sequoia_cam.open_session(id, name, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

sequoia_cam.open_session

Changes sequoia path for future media

Parameters:

idu8

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

namestring

Name of the session, only letters, numbers, ‘-’ and ‘_’ are allowed.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

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

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.open_session

Result: New directory is created for subsequent media, live stitch feature is available, previous session with different name is closed and event session_state_changed() is fired

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

event message olympe.messages.sequoia_cam.radiometric_calib_result(cam_id=None, value=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

sequoia_cam.radiometric_calib_result

Last radiometric calibration result.

Parameters:

cam_idu8

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

value : olympe.enums.sequoia_cam.radiometric_calib_result_value

list_flags : BitfieldOf(olympe.enums.sequoia_cam.list_flags, u8)

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.radiometric_calib_result

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

sequoia_cam.radiometric_calib_start

Launch capture on radiometric calibration mode. This PTP mode is 0x8004

Parameters:

idu8

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

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

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

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.radiometric_calib_start

Result: None

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

event message olympe.messages.sequoia_cam.radiometric_calib_status(cam_id=None, value=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

sequoia_cam.radiometric_calib_status

Is radiometric calibration available ?

Parameters:

cam_idu8

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

value : olympe.enums.sequoia_cam.radiometric_calib_status_value

list_flags : BitfieldOf(olympe.enums.sequoia_cam.list_flags, u8)

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.radiometric_calib_status

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

sequoia_cam.session_state_changed

Session state changed

Parameters:

cam_idu8

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

state : olympe.enums.sequoia_cam.session_status_value

session_path : string

live_stitch_path : string

list_flags : BitfieldOf(olympe.enums.sequoia_cam.list_flags, u8)

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.session_state_changed

command message olympe.messages.sequoia_cam.set_live_stitch_mask(id, sensors_mask, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

sequoia_cam.set_live_stitch_mask

Configure live stitch mode

Parameters:

idu8

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

sensors_maskBitfieldOf(olympe.enums.sequoia_cam.sensor_value, u8)

Sensors to use for live stitch

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

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

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.set_live_stitch_mask

Result: Live pictures are available for live processing on sensors specified by mask value; if 0, live_stitch is off

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

event message olympe.messages.sequoia_cam.storage_infos(cam_id=None, selected=None, internal_available=None, internal_total_size=None, internal_free_size=None, internal_is_ro=None, internal_is_corrupted=None, sd_available=None, sd_total_size=None, sd_free_size=None, sd_is_ro=None, sd_is_corrupted=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

sequoia_cam.storage_infos

Storage infos

Parameters:

cam_idu8

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

selected : olympe.enums.sequoia_cam.storage_infos_selected

internal_availableu8

Boolean. 1 if ro, 0 if rw

internal_total_sizeu64

Total size in bytes of internal

internal_free_sizeu64

Free bytes of the internal

internal_is_rou8

Boolean. 1 if ro, 0 if rw

internal_is_corruptedu8

Boolean. 1 if corrupted, 0 otherwise

sd_availableu8

Boolean. 1 if ro, 0 if rw

sd_total_sizeu64

Total size in bytes of the sd

sd_free_sizeu64

Free bytes of the sd

sd_is_rou8

Boolean. 1 if ro, 0 if rw

sd_is_corruptedu8

Boolean. 1 if corrupted, 0 otherwise

list_flags : BitfieldOf(olympe.enums.sequoia_cam.list_flags, u8)

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.storage_infos

Triggered: during the connection and by get_storage_infos()

event message olympe.messages.sequoia_cam.system_status(cam_id=None, errors=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

sequoia_cam.system_status

System status, 0x00 for all ok

Parameters:

cam_idu8

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

errorsBitfieldOf(olympe.enums.sequoia_cam.system_error, u16)

System errors bitfield. 0 is no error.

list_flags : BitfieldOf(olympe.enums.sequoia_cam.list_flags, u8)

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message sequoia_cam.system_status

Triggered: during the connection and on error

enum olympe.enums.sequoia_cam.list_flags

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

First:

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

Last:

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

Empty:

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

Remove:

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

enum olympe.enums.sequoia_cam.radiometric_calib_result_value

Last radiometric calibration result

success:

Radiometric calibration is successfull (0)

error:

Radiometric calibration failed (1)

enum olympe.enums.sequoia_cam.radiometric_calib_status_value

Radiometric calibration status

available:

Radiometric calibration is available (0)

unavailable:

Radiometric calibration is not available (1)

in_progress:

Radiometric calibration In progress (2)

enum olympe.enums.sequoia_cam.sensor_value

Sensor to use

near_infra_red:

near infra red (0)

green:

green (1)

red:

red (2)

red_edge:

red edge (3)

enum olympe.enums.sequoia_cam.session_status_value

Last session state

opened:

A session is currently opened (0)

closed:

No session is currently opened (1)

enum olympe.enums.sequoia_cam.storage_infos_selected

Storage selection

sd:

sd is selected (0)

internal:

internal is selected (1)

enum olympe.enums.sequoia_cam.system_error

Errors bits

update_err:

UPDATE ERR. (0)

temp_err:

TEMP ERR. (1)

no_sunshine_err:

NO SUNSHINE ERR. (2)