lm.hardware.v2#
Classes:
-
ObjectiveChangerImmersionTypes–Immersion types to match ObjectiveImmersionTypes
-
GetCameraData–Describes a camera.
-
SetCameraData–Describes the info needed to set a camera.
-
CameraServiceConfigureCameraRequest–The CameraServiceConfigureCameraRequest class.
-
CameraServiceConfigureCameraResponse–Describes the result of a configure camera request.
-
CameraServiceGetAllCamerasResponse–A list of available cameras.
-
CameraServiceGetCameraRequest–The CameraServiceGetCameraRequest class.
-
CameraServiceGetCameraResponse–Position index of the camera.
-
CameraServiceGetCamerasRequest–The CameraServiceGetCamerasRequest class.
-
FilterData–Describes a filter.
-
FilterWheelServiceGetFiltersRequest–The FilterWheelServiceGetFiltersRequest class.
-
FilterWheelServiceGetFiltersResponse–A list of available filters.
-
FilterWheelServiceGetPositionRequest–The FilterWheelServiceGetPositionRequest class.
-
FilterWheelServiceGetPositionResponse–Position index of the filter wheel.
-
FilterWheelServiceMoveToRequest–The FilterWheelServiceMoveToRequest class.
-
FilterWheelServiceMoveToResponse–Describes the result of a filter wheel MoveTo request.
-
FocusServiceGetAccelerationRequest–The FocusServiceGetAccelerationRequest class.
-
FocusServiceGetAccelerationResponse–Acceleration of the focus in %.
-
FocusServiceGetPositionRequest–The FocusServiceGetPositionRequest class.
-
FocusServiceGetPositionResponse–Position of the focus in meters.
-
FocusServiceGetSpeedRequest–The FocusServiceGetSpeedRequest class.
-
FocusServiceGetSpeedResponse–Speed of the focus in %.
-
FocusServiceMoveToRequest–The FocusServiceMoveToRequest class.
-
FocusServiceMoveToResponse–Describes the result of a Focus.MoveTo request.
-
FocusServiceSetAccelerationRequest–The FocusServiceSetAccelerationRequest class.
-
FocusServiceSetAccelerationResponse–The FocusServiceSetAccelerationResponse class.
-
FocusServiceSetSpeedRequest–The FocusServiceSetSpeedRequest class.
-
FocusServiceSetSpeedResponse–The FocusServiceSetSpeedResponse class.
-
FocusServiceStopRequest–The FocusServiceStopRequest class.
-
FocusServiceStopResponse–The FocusServiceStopResponse class.
-
ObjectiveData–Describes an objective.
-
ObjectiveChangerServiceGetObjectivesRequest–The ObjectiveChangerServiceGetObjectivesRequest class.
-
ObjectiveChangerServiceGetObjectivesResponse–A list of available objectives.
-
ObjectiveChangerServiceGetPositionRequest–The ObjectiveChangerServiceGetPositionRequest class.
-
ObjectiveChangerServiceGetPositionResponse–Position index of the objective.
-
ObjectiveChangerServiceMoveToRequest–The ObjectiveChangerServiceMoveToRequest class.
-
ObjectiveChangerServiceMoveToResponse–Describes the result of a ObjectiveChanger.MoveTo request.
-
OptovarData–Describes an optovar.
-
OptovarServiceGetOptovarsRequest–The OptovarServiceGetOptovarsRequest class.
-
OptovarServiceGetOptovarsResponse–A list of available optovars.
-
OptovarServiceGetPositionRequest–The OptovarServiceGetPositionRequest class.
-
OptovarServiceGetPositionResponse–Position index of the optovar.
-
OptovarServiceMoveToRequest–The OptovarServiceMoveToRequest class.
-
OptovarServiceMoveToResponse–Describes the result of a Optovar.MoveTo request.
-
ReflectorData–Describes a reflector.
-
ReflectorChangerServiceGetPositionRequest–The ReflectorChangerServiceGetPositionRequest class.
-
ReflectorChangerServiceGetPositionResponse–Position index of the objective.
-
ReflectorChangerServiceGetReflectorsRequest–The ReflectorChangerServiceGetReflectorsRequest class.
-
ReflectorChangerServiceGetReflectorsResponse–A list of available objectives.
-
ReflectorChangerServiceMoveToRequest–The ReflectorChangerServiceMoveToRequest class.
-
ReflectorChangerServiceMoveToResponse–Describes the result of a ReflectorChanger.MoveTo request.
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(str) –The Name.
-
id(str) –The Id.
-
is_preset(bool) –A value indicating whether the camera is preset.
-
exposure_time(float) –The ExposureTime.
-
min_exposure_time(float) –The MinExposureTime.
-
max_exposure_time(float) –The MaxExposureTime.
-
binning(int) –The Binning.
-
binning_description(str) –The BinningDescription.
-
available_binnings(List[str]) –The AvailableBinnings.
-
frame(DoubleFrame) –The Frame.
-
max_frame_size(DoubleSize) –The MaxFrameWidth.
class-attribute
instance-attribute
#
is_preset: bool = bool_field(3)
A value indicating whether the camera is preset.
class-attribute
instance-attribute
#
exposure_time: float = double_field(4)
The ExposureTime.
class-attribute
instance-attribute
#
min_exposure_time: float = double_field(5)
The MinExposureTime.
class-attribute
instance-attribute
#
max_exposure_time: float = double_field(6)
The MaxExposureTime.
class-attribute
instance-attribute
#
binning_description: str = string_field(8)
The BinningDescription.
class-attribute
instance-attribute
#
available_binnings: List[str] = string_field(9)
The AvailableBinnings.
class-attribute
instance-attribute
#
max_frame_size: DoubleSize = message_field(11)
The MaxFrameWidth.
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(str) –The Id.
-
exposure_time(float) –The ExposureTime.
-
binning(int) –The Binning.
-
frame(DoubleFrame) –The Frame.
class-attribute
instance-attribute
#
exposure_time: float = double_field(2)
The ExposureTime.
dataclass
#
CameraServiceConfigureCameraRequest(data: SetCameraData = betterproto.message_field(1))
Bases: Message
The CameraServiceConfigureCameraRequest class.
Attributes:
-
data(SetCameraData) –New configuration data.
class-attribute
instance-attribute
#
data: SetCameraData = message_field(1)
New configuration data.
dataclass
#
CameraServiceConfigureCameraResponse()
Bases: Message
Describes the result of a configure camera request.
dataclass
#
CameraServiceGetAllCamerasResponse(cameras: List[GetCameraData] = betterproto.message_field(1))
Bases: Message
A list of available cameras.
Attributes:
-
cameras(List[GetCameraData]) –The cameras.
class-attribute
instance-attribute
#
cameras: List[GetCameraData] = message_field(1)
The cameras.
dataclass
#
CameraServiceGetCameraRequest(id: str = betterproto.string_field(1))
dataclass
#
CameraServiceGetCameraResponse(camera: GetCameraData = betterproto.message_field(1))
Bases: Message
Position index of the camera.
Attributes:
-
camera(GetCameraData) –The position index.
class-attribute
instance-attribute
#
camera: GetCameraData = message_field(1)
The position index.
dataclass
#
CameraServiceGetCamerasRequest()
Bases: Message
The CameraServiceGetCamerasRequest class.
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.
dataclass
#
FilterWheelServiceGetFiltersRequest()
Bases: Message
The FilterWheelServiceGetFiltersRequest class.
dataclass
#
FilterWheelServiceGetFiltersResponse(filters: List[FilterData] = betterproto.message_field(1))
Bases: Message
A list of available filters.
Attributes:
-
filters(List[FilterData]) –The filters.
class-attribute
instance-attribute
#
filters: List[FilterData] = message_field(1)
The filters.
dataclass
#
FilterWheelServiceGetPositionRequest()
Bases: Message
The FilterWheelServiceGetPositionRequest class.
dataclass
#
FilterWheelServiceGetPositionResponse(value: int = betterproto.int32_field(1))
dataclass
#
FilterWheelServiceMoveToRequest(position_index: int = betterproto.int32_field(1))
Bases: Message
The FilterWheelServiceMoveToRequest class.
Attributes:
-
position_index(int) –New position index.
class-attribute
instance-attribute
#
position_index: int = int32_field(1)
New position index.
dataclass
#
FilterWheelServiceMoveToResponse()
Bases: Message
Describes the result of a filter wheel MoveTo request.
dataclass
#
FocusServiceGetAccelerationRequest()
Bases: Message
The FocusServiceGetAccelerationRequest class.
dataclass
#
FocusServiceGetAccelerationResponse(value: float = betterproto.double_field(1))
dataclass
#
FocusServiceGetPositionRequest()
Bases: Message
The FocusServiceGetPositionRequest class.
dataclass
#
FocusServiceGetPositionResponse(value: float = betterproto.double_field(1))
dataclass
#
FocusServiceGetSpeedRequest()
Bases: Message
The FocusServiceGetSpeedRequest class.
dataclass
#
FocusServiceGetSpeedResponse(value: float = betterproto.double_field(1))
dataclass
#
FocusServiceMoveToRequest(value: float = betterproto.double_field(1))
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.
class-attribute
instance-attribute
#
position_changed: bool = bool_field(1)
A value indicating whether the position was changed.
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].
class-attribute
instance-attribute
#
acceleration: float = double_field(1)
Acceleration in percent, i.e. values from range [0;100].
dataclass
#
FocusServiceSetAccelerationResponse()
Bases: Message
The FocusServiceSetAccelerationResponse class.
dataclass
#
FocusServiceSetSpeedRequest(speed: float = betterproto.double_field(1))
dataclass
#
FocusServiceSetSpeedResponse()
Bases: Message
The FocusServiceSetSpeedResponse class.
dataclass
#
FocusServiceStopRequest()
Bases: Message
The FocusServiceStopRequest class.
dataclass
#
FocusServiceStopResponse()
Bases: Message
The FocusServiceStopResponse class.
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(str) –The name.
-
na(float) –The Numerical Apperture.
-
immersion_type(ObjectiveChangerImmersionTypes) –The immersion type.
-
magnification(float) –The magnification.
-
position(int) –The position index.
dataclass
#
ObjectiveChangerServiceGetObjectivesRequest()
Bases: Message
The ObjectiveChangerServiceGetObjectivesRequest class.
dataclass
#
ObjectiveChangerServiceGetObjectivesResponse(objectives: List[ObjectiveData] = betterproto.message_field(1))
Bases: Message
A list of available objectives.
Attributes:
-
objectives(List[ObjectiveData]) –The objectives.
class-attribute
instance-attribute
#
objectives: List[ObjectiveData] = message_field(1)
The objectives.
dataclass
#
ObjectiveChangerServiceGetPositionRequest()
Bases: Message
The ObjectiveChangerServiceGetPositionRequest class.
dataclass
#
ObjectiveChangerServiceGetPositionResponse(value: int = betterproto.int32_field(1))
dataclass
#
ObjectiveChangerServiceMoveToRequest(position_index: int = betterproto.int32_field(1))
Bases: Message
The ObjectiveChangerServiceMoveToRequest class.
Attributes:
-
position_index(int) –New position index.
class-attribute
instance-attribute
#
position_index: int = int32_field(1)
New position index.
dataclass
#
ObjectiveChangerServiceMoveToResponse()
Bases: Message
Describes the result of a ObjectiveChanger.MoveTo request.
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(str) –The name.
-
magnification(float) –The magnification.
-
position(int) –The position index.
dataclass
#
OptovarServiceGetOptovarsRequest()
Bases: Message
The OptovarServiceGetOptovarsRequest class.
dataclass
#
OptovarServiceGetOptovarsResponse(optovars: List[OptovarData] = betterproto.message_field(1))
Bases: Message
A list of available optovars.
Attributes:
-
optovars(List[OptovarData]) –The optovars.
class-attribute
instance-attribute
#
optovars: List[OptovarData] = message_field(1)
The optovars.
dataclass
#
OptovarServiceGetPositionRequest()
Bases: Message
The OptovarServiceGetPositionRequest class.
dataclass
#
OptovarServiceGetPositionResponse(value: int = betterproto.int32_field(1))
dataclass
#
OptovarServiceMoveToRequest(position_index: int = betterproto.int32_field(1))
Bases: Message
The OptovarServiceMoveToRequest class.
Attributes:
-
position_index(int) –New position index.
class-attribute
instance-attribute
#
position_index: int = int32_field(1)
New position index.
dataclass
#
OptovarServiceMoveToResponse()
Bases: Message
Describes the result of a Optovar.MoveTo request.
dataclass
#
ReflectorData(name: str = betterproto.string_field(1), position: int = betterproto.int32_field(2))
dataclass
#
ReflectorChangerServiceGetPositionRequest()
Bases: Message
The ReflectorChangerServiceGetPositionRequest class.
dataclass
#
ReflectorChangerServiceGetPositionResponse(value: int = betterproto.int32_field(1))
dataclass
#
ReflectorChangerServiceGetReflectorsRequest()
Bases: Message
The ReflectorChangerServiceGetReflectorsRequest class.
dataclass
#
ReflectorChangerServiceGetReflectorsResponse(reflectors: List[ReflectorData] = betterproto.message_field(1))
Bases: Message
A list of available objectives.
Attributes:
-
reflectors(List[ReflectorData]) –The objectives.
class-attribute
instance-attribute
#
reflectors: List[ReflectorData] = message_field(1)
The objectives.
dataclass
#
ReflectorChangerServiceMoveToRequest(position_index: int = betterproto.int32_field(1))
Bases: Message
The ReflectorChangerServiceMoveToRequest class.
Attributes:
-
position_index(int) –New position index.
class-attribute
instance-attribute
#
position_index: int = int32_field(1)
New position index.
dataclass
#
ReflectorChangerServiceMoveToResponse()
Bases: Message
Describes the result of a ReflectorChanger.MoveTo request.