mecheye.shared.UserSet

class mecheye.shared.UserSet(*args, **kwargs)

Read and write the current device user set through a camera-owned handle.

Obtain this object with Camera.current_user_set() or UserSetManager.current_user_set(); direct construction is unavailable. Scalar reads return [status, value], structured reads return (status, value), and writes return an SDK ErrorStatus.

get_name()

Return [status, name] for this device user set.

rename(newName)

Rename this user set to newName; return ErrorStatus.

get_available_parameter_names()

Return the SDK list of available parameter names.

reset_all_parameters_to_default_values()

Reset current parameters to SDK defaults; return ErrorStatus.

save_all_parameters_to_device()

Persist current parameter values to the device; return ErrorStatus.

get_available_parameters()

Return available Parameter handles owned by this connection.

get_parameter(parameterName)

Return the named Parameter handle, or None when it is unavailable.

get_int_value(parameterName)

Read the named parameter and return [status, value].

Check the status before using the returned int value.

set_int_value(parameterName, value)

Write the named int parameter; return ErrorStatus.

get_float_value(parameterName)

Read the named parameter and return [status, value].

Check the status before using the returned float value.

set_float_value(parameterName, value)

Write the named float parameter; return ErrorStatus.

get_bool_value(parameterName)

Read the named parameter and return [status, value].

Check the status before using the returned bool value.

set_bool_value(parameterName, value)

Write the named bool parameter; return ErrorStatus.

get_enum_value(parameterName)

Read the named parameter and return [status, value].

Check the status before using the returned enum value.

get_enum_value_string(parameterName)

Read the named parameter and return [status, value].

Check the status before using the returned enum value string value.

set_enum_value(parameterName, value)

Write the named enum parameter; return ErrorStatus.

get_roi_value(parameterName)

Read the named parameter and return (status, value).

Check the status before using the returned roi value.

set_roi_value(parameterName, value)

Write the named roi parameter; return ErrorStatus.

get_profile_roi_value(parameterName)

Read the named parameter and return (status, value).

Check the status before using the returned profile roi value.

set_profile_roi_value(parameterName, value)

Write the named profile roi parameter; return ErrorStatus.

get_roi_array_value(parameterName)

Read the named parameter and return (status, value).

Check the status before using the returned roi array value.

get_range_value(parameterName)

Read the named parameter and return (status, value).

Check the status before using the returned range value.

set_range_value(parameterName, value)

Write the named range parameter; return ErrorStatus.

get_float_array_value(parameterName)

Read the named parameter and return (status, value).

Check the status before using the returned float array value.

set_float_array_value(parameterName, value)

Write the named float array parameter; return ErrorStatus.