lm.hardware.v2#
Classes:
-
ObjectiveChangerImmersionTypes–Immersion types to match ObjectiveImmersionTypes
-
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.
-
StageServiceGetAccelerationRequest–The StageServiceGetAccelerationRequest class.
-
StageServiceGetAccelerationResponse–Acceleration of the stage.
-
StageServiceGetPositionRequest–The StageServiceGetPositionRequest class.
-
StageServiceGetPositionResponse–Position of the stage.
-
StageServiceGetSpeedRequest–The StageServiceGetSpeedRequest class.
-
StageServiceGetSpeedResponse–Speed of the stage.
-
StageServiceMoveToRequest–The StageServiceMoveToRequest class.
-
StageServiceMoveToResponse–Describes the result of a Stage.MoveTo request.
-
StageServiceSetAccelerationRequest–The StageServiceSetAccelerationRequest class.
-
StageServiceSetAccelerationResponse–The StageServiceSetAccelerationResponse class.
-
StageServiceSetSpeedRequest–The StageServiceSetSpeedRequest class.
-
StageServiceSetSpeedResponse–The StageServiceSetSpeedResponse class.
-
StageServiceStopRequest–The StageServiceStopRequest class.
-
StageServiceStopResponse–The StageServiceStopResponse class.
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
#
StageServiceGetAccelerationRequest()
Bases: Message
The StageServiceGetAccelerationRequest class.
dataclass
#
StageServiceGetAccelerationResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))
Bases: Message
Acceleration of the stage.
Attributes:
dataclass
#
StageServiceGetPositionRequest()
Bases: Message
The StageServiceGetPositionRequest class.
dataclass
#
StageServiceGetPositionResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))
Bases: Message
Position of the stage.
Attributes:
dataclass
#
StageServiceGetSpeedRequest()
Bases: Message
The StageServiceGetSpeedRequest class.
dataclass
#
StageServiceGetSpeedResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))
Bases: Message
Speed of the stage.
Attributes:
dataclass
#
StageServiceMoveToRequest(x: Optional[float] = betterproto.message_field(1, wraps=(betterproto.TYPE_DOUBLE)), y: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)))
Bases: Message
The StageServiceMoveToRequest class.
Attributes:
-
x(Optional[float]) –Target position x in meters. Leave out if x position should not be changed.
-
y(Optional[float]) –Target position y in meters. Leave out if y position should not be changed.
class-attribute
instance-attribute
#
x: Optional[float] = message_field(1, wraps=TYPE_DOUBLE)
Target position x in meters. Leave out if x position should not be changed.
class-attribute
instance-attribute
#
y: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)
Target position y in meters. Leave out if y position should not be changed.
dataclass
#
StageServiceMoveToResponse(position_changed: bool = betterproto.bool_field(1))
Bases: Message
Describes the result of a Stage.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
#
StageServiceSetAccelerationRequest(acceleration_x: Optional[float] = betterproto.message_field(1, wraps=(betterproto.TYPE_DOUBLE)), acceleration_y: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)))
Bases: Message
The StageServiceSetAccelerationRequest class.
Attributes:
-
acceleration_x(Optional[float]) –Acceleration in x direction in percent, i.e. values from range [0;100].
-
acceleration_y(Optional[float]) –Acceleration in y direction in percent, i.e. values from range [0;100].
class-attribute
instance-attribute
#
acceleration_x: Optional[float] = message_field(1, wraps=TYPE_DOUBLE)
Acceleration in x direction in percent, i.e. values from range [0;100].
class-attribute
instance-attribute
#
acceleration_y: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)
Acceleration in y direction in percent, i.e. values from range [0;100].
dataclass
#
StageServiceSetAccelerationResponse()
Bases: Message
The StageServiceSetAccelerationResponse class.
dataclass
#
StageServiceSetSpeedRequest(speed_x: Optional[float] = betterproto.message_field(1, wraps=(betterproto.TYPE_DOUBLE)), speed_y: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)))
Bases: Message
The StageServiceSetSpeedRequest class.
Attributes:
-
speed_x(Optional[float]) –Speed in x direction in percent, i.e. values from range [0;100].
-
speed_y(Optional[float]) –Speed in y direction in percent, i.e. values from range [0;100].
class-attribute
instance-attribute
#
speed_x: Optional[float] = message_field(1, wraps=TYPE_DOUBLE)
Speed in x direction in percent, i.e. values from range [0;100].
class-attribute
instance-attribute
#
speed_y: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)
Speed in y direction in percent, i.e. values from range [0;100].
dataclass
#
StageServiceSetSpeedResponse()
Bases: Message
The StageServiceSetSpeedResponse class.
dataclass
#
StageServiceStopRequest()
Bases: Message
The StageServiceStopRequest class.
dataclass
#
StageServiceStopResponse()
Bases: Message
The StageServiceStopResponse class.