Skip to content

lm.hardware.v2#

zen_api.lm.hardware.v2 #

Classes:

ObjectiveChangerImmersionTypes #

Bases: Enum

Immersion types to match ObjectiveImmersionTypes

Attributes:

UNSPECIFIED class-attribute instance-attribute #

UNSPECIFIED = 0

Unspecified

AIR class-attribute instance-attribute #

AIR = 1

Air

WATER class-attribute instance-attribute #

WATER = 2

Water

OIL class-attribute instance-attribute #

OIL = 4

Oil

GLYCERINE class-attribute instance-attribute #

GLYCERINE = 8

Glycerin

SILICONE class-attribute instance-attribute #

SILICONE = 16

Silicone

HIOIL class-attribute instance-attribute #

HIOIL = 32

HI Oil

POLYOL class-attribute instance-attribute #

POLYOL = 64

Polyol

GetCameraData dataclass #

GetCameraData(name: str = betterproto.string_field(1), id: str = betterproto.string_field(2), is_preset: bool = betterproto.bool_field(3), exposure_time: float = betterproto.double_field(4), min_exposure_time: float = betterproto.double_field(5), max_exposure_time: float = betterproto.double_field(6), binning: int = betterproto.int32_field(7), binning_description: str = betterproto.string_field(8), available_binnings: List[str] = betterproto.string_field(9), frame: DoubleFrame = betterproto.message_field(10), max_frame_size: DoubleSize = betterproto.message_field(11))

Bases: Message

Describes a camera.

Attributes:

name class-attribute instance-attribute #

name: str = betterproto.string_field(1)

The Name.

id class-attribute instance-attribute #

id: str = betterproto.string_field(2)

The Id.

is_preset class-attribute instance-attribute #

is_preset: bool = betterproto.bool_field(3)

A value indicating whether the camera is preset.

exposure_time class-attribute instance-attribute #

exposure_time: float = betterproto.double_field(4)

The ExposureTime.

min_exposure_time class-attribute instance-attribute #

min_exposure_time: float = betterproto.double_field(5)

The MinExposureTime.

max_exposure_time class-attribute instance-attribute #

max_exposure_time: float = betterproto.double_field(6)

The MaxExposureTime.

binning class-attribute instance-attribute #

binning: int = betterproto.int32_field(7)

The Binning.

binning_description class-attribute instance-attribute #

binning_description: str = betterproto.string_field(8)

The BinningDescription.

available_binnings class-attribute instance-attribute #

available_binnings: List[str] = betterproto.string_field(9)

The AvailableBinnings.

frame class-attribute instance-attribute #

frame: DoubleFrame = betterproto.message_field(10)

The Frame.

max_frame_size class-attribute instance-attribute #

max_frame_size: DoubleSize = betterproto.message_field(11)

The MaxFrameWidth.

SetCameraData dataclass #

SetCameraData(id: str = betterproto.string_field(1), exposure_time: float = betterproto.double_field(2), binning: int = betterproto.int32_field(3), frame: DoubleFrame = betterproto.message_field(10))

Bases: Message

Describes the info needed to set a camera.

Attributes:

id class-attribute instance-attribute #

id: str = betterproto.string_field(1)

The Id.

exposure_time class-attribute instance-attribute #

exposure_time: float = betterproto.double_field(2)

The ExposureTime.

binning class-attribute instance-attribute #

binning: int = betterproto.int32_field(3)

The Binning.

frame class-attribute instance-attribute #

frame: DoubleFrame = betterproto.message_field(10)

The Frame.

CameraServiceConfigureCameraRequest dataclass #

CameraServiceConfigureCameraRequest(data: SetCameraData = betterproto.message_field(1))

Bases: Message

The CameraServiceConfigureCameraRequest class.

Attributes:

data class-attribute instance-attribute #

data: SetCameraData = betterproto.message_field(1)

New configuration data.

CameraServiceConfigureCameraResponse dataclass #

CameraServiceConfigureCameraResponse()

Bases: Message

Describes the result of a configure camera request.

CameraServiceGetAllCamerasResponse dataclass #

CameraServiceGetAllCamerasResponse(cameras: List[GetCameraData] = betterproto.message_field(1))

Bases: Message

A list of available cameras.

Attributes:

cameras class-attribute instance-attribute #

cameras: List[GetCameraData] = betterproto.message_field(1)

The cameras.

CameraServiceGetCameraRequest dataclass #

CameraServiceGetCameraRequest(id: str = betterproto.string_field(1))

Bases: Message

The CameraServiceGetCameraRequest class.

Attributes:

  • id (str) –

    Id of the camera.

id class-attribute instance-attribute #

id: str = betterproto.string_field(1)

Id of the camera.

CameraServiceGetCameraResponse dataclass #

CameraServiceGetCameraResponse(camera: GetCameraData = betterproto.message_field(1))

Bases: Message

Position index of the camera.

Attributes:

camera class-attribute instance-attribute #

camera: GetCameraData = betterproto.message_field(1)

The position index.

CameraServiceGetCamerasRequest dataclass #

CameraServiceGetCamerasRequest()

Bases: Message

The CameraServiceGetCamerasRequest class.

FilterData dataclass #

FilterData(name: str = betterproto.string_field(1), id: str = betterproto.string_field(2), is_present: bool = betterproto.bool_field(3), position: int = betterproto.int32_field(4))

Bases: Message

Describes a filter.

Attributes:

  • name (str) –

    The name/ id of the filter.

  • id (str) –

    The id.

  • is_present (bool) –

    A value indicating whether the filter is present.

  • position (int) –

    The position index, starting at 1.

name class-attribute instance-attribute #

name: str = betterproto.string_field(1)

The name/ id of the filter.

id class-attribute instance-attribute #

id: str = betterproto.string_field(2)

The id.

is_present class-attribute instance-attribute #

is_present: bool = betterproto.bool_field(3)

A value indicating whether the filter is present.

position class-attribute instance-attribute #

position: int = betterproto.int32_field(4)

The position index, starting at 1.

FilterWheelServiceGetFiltersRequest dataclass #

FilterWheelServiceGetFiltersRequest()

Bases: Message

The FilterWheelServiceGetFiltersRequest class.

FilterWheelServiceGetFiltersResponse dataclass #

FilterWheelServiceGetFiltersResponse(filters: List[FilterData] = betterproto.message_field(1))

Bases: Message

A list of available filters.

Attributes:

filters class-attribute instance-attribute #

filters: List[FilterData] = betterproto.message_field(1)

The filters.

FilterWheelServiceGetPositionRequest dataclass #

FilterWheelServiceGetPositionRequest()

Bases: Message

The FilterWheelServiceGetPositionRequest class.

FilterWheelServiceGetPositionResponse dataclass #

FilterWheelServiceGetPositionResponse(value: int = betterproto.int32_field(1))

Bases: Message

Position index of the filter wheel.

Attributes:

  • value (int) –

    The position index.

value class-attribute instance-attribute #

value: int = betterproto.int32_field(1)

The position index.

FilterWheelServiceMoveToRequest dataclass #

FilterWheelServiceMoveToRequest(position_index: int = betterproto.int32_field(1))

Bases: Message

The FilterWheelServiceMoveToRequest class.

Attributes:

position_index class-attribute instance-attribute #

position_index: int = betterproto.int32_field(1)

New position index.

FilterWheelServiceMoveToResponse dataclass #

FilterWheelServiceMoveToResponse()

Bases: Message

Describes the result of a filter wheel MoveTo request.

FocusServiceGetAccelerationRequest dataclass #

FocusServiceGetAccelerationRequest()

Bases: Message

The FocusServiceGetAccelerationRequest class.

FocusServiceGetAccelerationResponse dataclass #

FocusServiceGetAccelerationResponse(value: float = betterproto.double_field(1))

Bases: Message

Acceleration of the focus in %.

Attributes:

  • value (float) –

    The acceleration in %.

value class-attribute instance-attribute #

value: float = betterproto.double_field(1)

The acceleration in %.

FocusServiceGetPositionRequest dataclass #

FocusServiceGetPositionRequest()

Bases: Message

The FocusServiceGetPositionRequest class.

FocusServiceGetPositionResponse dataclass #

FocusServiceGetPositionResponse(value: float = betterproto.double_field(1))

Bases: Message

Position of the focus in meters.

Attributes:

  • value (float) –

    The position in meters.

value class-attribute instance-attribute #

value: float = betterproto.double_field(1)

The position in meters.

FocusServiceGetSpeedRequest dataclass #

FocusServiceGetSpeedRequest()

Bases: Message

The FocusServiceGetSpeedRequest class.

FocusServiceGetSpeedResponse dataclass #

FocusServiceGetSpeedResponse(value: float = betterproto.double_field(1))

Bases: Message

Speed of the focus in %.

Attributes:

  • value (float) –

    The speed in %.

value class-attribute instance-attribute #

value: float = betterproto.double_field(1)

The speed in %.

FocusServiceMoveToRequest dataclass #

FocusServiceMoveToRequest(value: float = betterproto.double_field(1))

Bases: Message

The FocusServiceMoveToRequest class.

Attributes:

  • value (float) –

    New position in meters.

value class-attribute instance-attribute #

value: float = betterproto.double_field(1)

New position in meters.

FocusServiceMoveToResponse dataclass #

FocusServiceMoveToResponse(position_changed: bool = betterproto.bool_field(1))

Bases: Message

Describes the result of a Focus.MoveTo request.

Attributes:

  • position_changed (bool) –

    A value indicating whether the position was changed.

position_changed class-attribute instance-attribute #

position_changed: bool = betterproto.bool_field(1)

A value indicating whether the position was changed.

FocusServiceSetAccelerationRequest dataclass #

FocusServiceSetAccelerationRequest(acceleration: float = betterproto.double_field(1))

Bases: Message

The FocusServiceSetAccelerationRequest class.

Attributes:

  • acceleration (float) –

    Acceleration in percent, i.e. values from range [0;100].

acceleration class-attribute instance-attribute #

acceleration: float = betterproto.double_field(1)

Acceleration in percent, i.e. values from range [0;100].

FocusServiceSetAccelerationResponse dataclass #

FocusServiceSetAccelerationResponse()

Bases: Message

The FocusServiceSetAccelerationResponse class.

FocusServiceSetSpeedRequest dataclass #

FocusServiceSetSpeedRequest(speed: float = betterproto.double_field(1))

Bases: Message

The FocusServiceSetSpeedRequest class.

Attributes:

  • speed (float) –

    Speed in percent, i.e. values from range [0;100].

speed class-attribute instance-attribute #

speed: float = betterproto.double_field(1)

Speed in percent, i.e. values from range [0;100].

FocusServiceSetSpeedResponse dataclass #

FocusServiceSetSpeedResponse()

Bases: Message

The FocusServiceSetSpeedResponse class.

FocusServiceStopRequest dataclass #

FocusServiceStopRequest()

Bases: Message

The FocusServiceStopRequest class.

FocusServiceStopResponse dataclass #

FocusServiceStopResponse()

Bases: Message

The FocusServiceStopResponse class.

ObjectiveData dataclass #

ObjectiveData(name: str = betterproto.string_field(1), na: float = betterproto.double_field(2), immersion_type: ObjectiveChangerImmersionTypes = betterproto.enum_field(3), magnification: float = betterproto.double_field(4), position: int = betterproto.int32_field(5))

Bases: Message

Describes an objective.

Attributes:

name class-attribute instance-attribute #

name: str = betterproto.string_field(1)

The name.

na class-attribute instance-attribute #

na: float = betterproto.double_field(2)

The Numerical Apperture.

immersion_type class-attribute instance-attribute #

immersion_type: ObjectiveChangerImmersionTypes = betterproto.enum_field(3)

The immersion type.

magnification class-attribute instance-attribute #

magnification: float = betterproto.double_field(4)

The magnification.

position class-attribute instance-attribute #

position: int = betterproto.int32_field(5)

The position index.

ObjectiveChangerServiceGetObjectivesRequest dataclass #

ObjectiveChangerServiceGetObjectivesRequest()

Bases: Message

The ObjectiveChangerServiceGetObjectivesRequest class.

ObjectiveChangerServiceGetObjectivesResponse dataclass #

ObjectiveChangerServiceGetObjectivesResponse(objectives: List[ObjectiveData] = betterproto.message_field(1))

Bases: Message

A list of available objectives.

Attributes:

objectives class-attribute instance-attribute #

objectives: List[ObjectiveData] = betterproto.message_field(1)

The objectives.

ObjectiveChangerServiceGetPositionRequest dataclass #

ObjectiveChangerServiceGetPositionRequest()

Bases: Message

The ObjectiveChangerServiceGetPositionRequest class.

ObjectiveChangerServiceGetPositionResponse dataclass #

ObjectiveChangerServiceGetPositionResponse(value: int = betterproto.int32_field(1))

Bases: Message

Position index of the objective.

Attributes:

  • value (int) –

    The position index.

value class-attribute instance-attribute #

value: int = betterproto.int32_field(1)

The position index.

ObjectiveChangerServiceMoveToRequest dataclass #

ObjectiveChangerServiceMoveToRequest(position_index: int = betterproto.int32_field(1))

Bases: Message

The ObjectiveChangerServiceMoveToRequest class.

Attributes:

position_index class-attribute instance-attribute #

position_index: int = betterproto.int32_field(1)

New position index.

ObjectiveChangerServiceMoveToResponse dataclass #

ObjectiveChangerServiceMoveToResponse()

Bases: Message

Describes the result of a ObjectiveChanger.MoveTo request.

OptovarData dataclass #

OptovarData(name: str = betterproto.string_field(1), magnification: float = betterproto.double_field(2), position: int = betterproto.int32_field(3))

Bases: Message

Describes an optovar.

Attributes:

name class-attribute instance-attribute #

name: str = betterproto.string_field(1)

The name.

magnification class-attribute instance-attribute #

magnification: float = betterproto.double_field(2)

The magnification.

position class-attribute instance-attribute #

position: int = betterproto.int32_field(3)

The position index.

OptovarServiceGetOptovarsRequest dataclass #

OptovarServiceGetOptovarsRequest()

Bases: Message

The OptovarServiceGetOptovarsRequest class.

OptovarServiceGetOptovarsResponse dataclass #

OptovarServiceGetOptovarsResponse(optovars: List[OptovarData] = betterproto.message_field(1))

Bases: Message

A list of available optovars.

Attributes:

optovars class-attribute instance-attribute #

optovars: List[OptovarData] = betterproto.message_field(1)

The optovars.

OptovarServiceGetPositionRequest dataclass #

OptovarServiceGetPositionRequest()

Bases: Message

The OptovarServiceGetPositionRequest class.

OptovarServiceGetPositionResponse dataclass #

OptovarServiceGetPositionResponse(value: int = betterproto.int32_field(1))

Bases: Message

Position index of the optovar.

Attributes:

  • value (int) –

    The position index.

value class-attribute instance-attribute #

value: int = betterproto.int32_field(1)

The position index.

OptovarServiceMoveToRequest dataclass #

OptovarServiceMoveToRequest(position_index: int = betterproto.int32_field(1))

Bases: Message

The OptovarServiceMoveToRequest class.

Attributes:

position_index class-attribute instance-attribute #

position_index: int = betterproto.int32_field(1)

New position index.

OptovarServiceMoveToResponse dataclass #

OptovarServiceMoveToResponse()

Bases: Message

Describes the result of a Optovar.MoveTo request.

ReflectorData dataclass #

ReflectorData(name: str = betterproto.string_field(1), position: int = betterproto.int32_field(2))

Bases: Message

Describes a reflector.

Attributes:

  • name (str) –

    The name.

  • position (int) –

    The position index.

name class-attribute instance-attribute #

name: str = betterproto.string_field(1)

The name.

position class-attribute instance-attribute #

position: int = betterproto.int32_field(2)

The position index.

ReflectorChangerServiceGetPositionRequest dataclass #

ReflectorChangerServiceGetPositionRequest()

Bases: Message

The ReflectorChangerServiceGetPositionRequest class.

ReflectorChangerServiceGetPositionResponse dataclass #

ReflectorChangerServiceGetPositionResponse(value: int = betterproto.int32_field(1))

Bases: Message

Position index of the objective.

Attributes:

  • value (int) –

    The position index.

value class-attribute instance-attribute #

value: int = betterproto.int32_field(1)

The position index.

ReflectorChangerServiceGetReflectorsRequest dataclass #

ReflectorChangerServiceGetReflectorsRequest()

Bases: Message

The ReflectorChangerServiceGetReflectorsRequest class.

ReflectorChangerServiceGetReflectorsResponse dataclass #

ReflectorChangerServiceGetReflectorsResponse(reflectors: List[ReflectorData] = betterproto.message_field(1))

Bases: Message

A list of available objectives.

Attributes:

reflectors class-attribute instance-attribute #

reflectors: List[ReflectorData] = betterproto.message_field(1)

The objectives.

ReflectorChangerServiceMoveToRequest dataclass #

ReflectorChangerServiceMoveToRequest(position_index: int = betterproto.int32_field(1))

Bases: Message

The ReflectorChangerServiceMoveToRequest class.

Attributes:

position_index class-attribute instance-attribute #

position_index: int = betterproto.int32_field(1)

New position index.

ReflectorChangerServiceMoveToResponse dataclass #

ReflectorChangerServiceMoveToResponse()

Bases: Message

Describes the result of a ReflectorChanger.MoveTo request.

CameraServiceStub #

Bases: ServiceStub

Methods:

configure_camera async #

configure_camera(camera_service_configure_camera_request: CameraServiceConfigureCameraRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CameraServiceConfigureCameraResponse

Configures a camera based on the given data.

get_camera async #

get_camera(camera_service_get_camera_request: CameraServiceGetCameraRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CameraServiceGetCameraResponse

Gets the camera by id.

get_cameras async #

get_cameras(camera_service_get_cameras_request: CameraServiceGetCamerasRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CameraServiceGetAllCamerasResponse

Gets the cameras.

FilterWheelServiceStub #

Bases: ServiceStub

Methods:

  • get_filters –

    Gets the filters.

  • get_position –

    Gets the filter wheel position, starting at 1.

  • move_to –

    Moves the filter wheel to the given position index.

get_filters async #

get_filters(filter_wheel_service_get_filters_request: FilterWheelServiceGetFiltersRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FilterWheelServiceGetFiltersResponse

Gets the filters.

get_position async #

get_position(filter_wheel_service_get_position_request: FilterWheelServiceGetPositionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FilterWheelServiceGetPositionResponse

Gets the filter wheel position, starting at 1.

move_to async #

move_to(filter_wheel_service_move_to_request: FilterWheelServiceMoveToRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FilterWheelServiceMoveToResponse

Moves the filter wheel to the given position index.

FocusServiceStub #

Bases: ServiceStub

Methods:

get_acceleration async #

get_acceleration(focus_service_get_acceleration_request: FocusServiceGetAccelerationRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceGetAccelerationResponse

Gets the focus acceleration.

get_position async #

get_position(focus_service_get_position_request: FocusServiceGetPositionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceGetPositionResponse

Gets the focus position.

get_speed async #

get_speed(focus_service_get_speed_request: FocusServiceGetSpeedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceGetSpeedResponse

Gets the focus speed.

move_to async #

move_to(focus_service_move_to_request: FocusServiceMoveToRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceMoveToResponse

Moves the focus to the given position in meters.

set_acceleration async #

set_acceleration(focus_service_set_acceleration_request: FocusServiceSetAccelerationRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceSetAccelerationResponse

Sets the acceleration of the focus in percent.

set_speed async #

set_speed(focus_service_set_speed_request: FocusServiceSetSpeedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceSetSpeedResponse

Sets the speed of the focus in percent.

stop async #

stop(focus_service_stop_request: FocusServiceStopRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceStopResponse

Stops the focus if it is moving.

ObjectiveChangerServiceStub #

Bases: ServiceStub

Methods:

get_objectives async #

get_objectives(objective_changer_service_get_objectives_request: ObjectiveChangerServiceGetObjectivesRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ObjectiveChangerServiceGetObjectivesResponse

Gets the objectives

get_position async #

get_position(objective_changer_service_get_position_request: ObjectiveChangerServiceGetPositionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ObjectiveChangerServiceGetPositionResponse

Gets the objective position.

move_to async #

move_to(objective_changer_service_move_to_request: ObjectiveChangerServiceMoveToRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ObjectiveChangerServiceMoveToResponse

Moves the objective to the given position index.

OptovarServiceStub #

Bases: ServiceStub

Methods:

get_optovars async #

get_optovars(optovar_service_get_optovars_request: OptovarServiceGetOptovarsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> OptovarServiceGetOptovarsResponse

Gets the optovars.

get_position async #

get_position(optovar_service_get_position_request: OptovarServiceGetPositionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> OptovarServiceGetPositionResponse

Gets the optovar position.

move_to async #

move_to(optovar_service_move_to_request: OptovarServiceMoveToRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> OptovarServiceMoveToResponse

Moves the optovar to the given position index.

ReflectorChangerServiceStub #

Bases: ServiceStub

Methods:

get_position async #

get_position(reflector_changer_service_get_position_request: ReflectorChangerServiceGetPositionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ReflectorChangerServiceGetPositionResponse

Gets the reflector position.

get_reflectors async #

get_reflectors(reflector_changer_service_get_reflectors_request: ReflectorChangerServiceGetReflectorsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ReflectorChangerServiceGetReflectorsResponse

Gets the reflectors.

move_to async #

move_to(reflector_changer_service_move_to_request: ReflectorChangerServiceMoveToRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ReflectorChangerServiceMoveToResponse

Moves the reflector changer to the given position index.

CameraServiceBase #

Bases: ServiceBase

Methods:

configure_camera async #

configure_camera(camera_service_configure_camera_request: CameraServiceConfigureCameraRequest) -> CameraServiceConfigureCameraResponse

Configures a camera based on the given data.

get_camera async #

get_camera(camera_service_get_camera_request: CameraServiceGetCameraRequest) -> CameraServiceGetCameraResponse

Gets the camera by id.

get_cameras async #

get_cameras(camera_service_get_cameras_request: CameraServiceGetCamerasRequest) -> CameraServiceGetAllCamerasResponse

Gets the cameras.

FilterWheelServiceBase #

Bases: ServiceBase

Methods:

  • get_filters –

    Gets the filters.

  • get_position –

    Gets the filter wheel position, starting at 1.

  • move_to –

    Moves the filter wheel to the given position index.

get_filters async #

get_filters(filter_wheel_service_get_filters_request: FilterWheelServiceGetFiltersRequest) -> FilterWheelServiceGetFiltersResponse

Gets the filters.

get_position async #

get_position(filter_wheel_service_get_position_request: FilterWheelServiceGetPositionRequest) -> FilterWheelServiceGetPositionResponse

Gets the filter wheel position, starting at 1.

move_to async #

move_to(filter_wheel_service_move_to_request: FilterWheelServiceMoveToRequest) -> FilterWheelServiceMoveToResponse

Moves the filter wheel to the given position index.

FocusServiceBase #

Bases: ServiceBase

Methods:

get_acceleration async #

get_acceleration(focus_service_get_acceleration_request: FocusServiceGetAccelerationRequest) -> FocusServiceGetAccelerationResponse

Gets the focus acceleration.

get_position async #

get_position(focus_service_get_position_request: FocusServiceGetPositionRequest) -> FocusServiceGetPositionResponse

Gets the focus position.

get_speed async #

get_speed(focus_service_get_speed_request: FocusServiceGetSpeedRequest) -> FocusServiceGetSpeedResponse

Gets the focus speed.

move_to async #

move_to(focus_service_move_to_request: FocusServiceMoveToRequest) -> FocusServiceMoveToResponse

Moves the focus to the given position in meters.

set_acceleration async #

set_acceleration(focus_service_set_acceleration_request: FocusServiceSetAccelerationRequest) -> FocusServiceSetAccelerationResponse

Sets the acceleration of the focus in percent.

set_speed async #

set_speed(focus_service_set_speed_request: FocusServiceSetSpeedRequest) -> FocusServiceSetSpeedResponse

Sets the speed of the focus in percent.

stop async #

stop(focus_service_stop_request: FocusServiceStopRequest) -> FocusServiceStopResponse

Stops the focus if it is moving.

ObjectiveChangerServiceBase #

Bases: ServiceBase

Methods:

get_objectives async #

get_objectives(objective_changer_service_get_objectives_request: ObjectiveChangerServiceGetObjectivesRequest) -> ObjectiveChangerServiceGetObjectivesResponse

Gets the objectives

get_position async #

get_position(objective_changer_service_get_position_request: ObjectiveChangerServiceGetPositionRequest) -> ObjectiveChangerServiceGetPositionResponse

Gets the objective position.

move_to async #

move_to(objective_changer_service_move_to_request: ObjectiveChangerServiceMoveToRequest) -> ObjectiveChangerServiceMoveToResponse

Moves the objective to the given position index.

OptovarServiceBase #

Bases: ServiceBase

Methods:

get_optovars async #

get_optovars(optovar_service_get_optovars_request: OptovarServiceGetOptovarsRequest) -> OptovarServiceGetOptovarsResponse

Gets the optovars.

get_position async #

get_position(optovar_service_get_position_request: OptovarServiceGetPositionRequest) -> OptovarServiceGetPositionResponse

Gets the optovar position.

move_to async #

move_to(optovar_service_move_to_request: OptovarServiceMoveToRequest) -> OptovarServiceMoveToResponse

Moves the optovar to the given position index.

ReflectorChangerServiceBase #

Bases: ServiceBase

Methods:

get_position async #

get_position(reflector_changer_service_get_position_request: ReflectorChangerServiceGetPositionRequest) -> ReflectorChangerServiceGetPositionResponse

Gets the reflector position.

get_reflectors async #

get_reflectors(reflector_changer_service_get_reflectors_request: ReflectorChangerServiceGetReflectorsRequest) -> ReflectorChangerServiceGetReflectorsResponse

Gets the reflectors.

move_to async #

move_to(reflector_changer_service_move_to_request: ReflectorChangerServiceMoveToRequest) -> ReflectorChangerServiceMoveToResponse

Moves the reflector changer to the given position index.