Skip to content

lm.hardware.v1#

zen_api.lm.hardware.v1 #

Classes:

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 = 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 µm.

Attributes:

  • value (float) –

    The position in µm.

value class-attribute instance-attribute #

value: float = double_field(1)

The position in µm.

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 = 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 µm.

value class-attribute instance-attribute #

value: float = double_field(1)

New position in µm.

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 = 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 = 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 = 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.

SampleCarrierServiceGetCurrentContainerRequest dataclass #

SampleCarrierServiceGetCurrentContainerRequest()

Bases: Message

The SampleCarrierServiceGetCurrentContainerRequest class.

SampleCarrierServiceGetCurrentContainerResponse dataclass #

SampleCarrierServiceGetCurrentContainerResponse(row_index: int = betterproto.int32_field(1), column_index: int = betterproto.int32_field(2))

Bases: Message

Contains the information in which container of the sample carrier the stage is positioned at.

Attributes:

  • row_index (int) –

    The row index of the container in the sample carrier (starts with index 0).

  • column_index (int) –

    The column index of the container in the sample carrier (starts with index 0).

row_index class-attribute instance-attribute #

row_index: int = int32_field(1)

The row index of the container in the sample carrier (starts with index 0).

column_index class-attribute instance-attribute #

column_index: int = int32_field(2)

The column index of the container in the sample carrier (starts with index 0).

SampleCarrierServiceGetInfoRequest dataclass #

SampleCarrierServiceGetInfoRequest()

Bases: Message

The SampleCarrierServiceGetInfoRequest class.

SampleCarrierServiceGetInfoResponse dataclass #

SampleCarrierServiceGetInfoResponse(rows: int = betterproto.int32_field(1), columns: int = betterproto.int32_field(2), name: str = betterproto.string_field(3), material: str = betterproto.string_field(4), thickness: float = betterproto.double_field(5), skirt: float = betterproto.double_field(6), refractive_index: float = betterproto.double_field(7))

Bases: Message

Contains the sample carrier information.

Attributes:

  • rows (int) –

    The number of rows in the sample carrier.

  • columns (int) –

    The number of columns in the sample carrier.

  • name (str) –

    The name of the sample carrier.

  • material (str) –

    The bottom material which is used for this sample carrier.

  • thickness (float) –

    The bottom thickness of this sample carrier (in meters).

  • skirt (float) –

    The skirt (i.e. bottom offset) of this sample carrier (in meters).

  • refractive_index (float) –

    The refractive index of the bottom material of this sample carrier.

rows class-attribute instance-attribute #

rows: int = int32_field(1)

The number of rows in the sample carrier.

columns class-attribute instance-attribute #

columns: int = int32_field(2)

The number of columns in the sample carrier.

name class-attribute instance-attribute #

name: str = string_field(3)

The name of the sample carrier.

material class-attribute instance-attribute #

material: str = string_field(4)

The bottom material which is used for this sample carrier.

thickness class-attribute instance-attribute #

thickness: float = double_field(5)

The bottom thickness of this sample carrier (in meters).

skirt class-attribute instance-attribute #

skirt: float = double_field(6)

The skirt (i.e. bottom offset) of this sample carrier (in meters).

refractive_index class-attribute instance-attribute #

refractive_index: float = double_field(7)

The refractive index of the bottom material of this sample carrier.

SampleCarrierServiceMoveToContainerRequest dataclass #

SampleCarrierServiceMoveToContainerRequest(row_index: int = betterproto.int32_field(1), column_index: int = betterproto.int32_field(2))

Bases: Message

The SampleCarrierServiceMoveToContainerRequest class.

Attributes:

  • row_index (int) –

    The row index of the container (starts with index 0).

  • column_index (int) –

    The column index of the container (starts with index 0).

row_index class-attribute instance-attribute #

row_index: int = int32_field(1)

The row index of the container (starts with index 0).

column_index class-attribute instance-attribute #

column_index: int = int32_field(2)

The column index of the container (starts with index 0).

SampleCarrierServiceMoveToContainerResponse dataclass #

SampleCarrierServiceMoveToContainerResponse()

Bases: Message

The SampleCarrierServiceMoveToContainerResponse class.

StageServiceGetAccelerationRequest dataclass #

StageServiceGetAccelerationRequest()

Bases: Message

The StageServiceGetAccelerationRequest class.

StageServiceGetAccelerationResponse dataclass #

StageServiceGetAccelerationResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))

Bases: Message

Acceleration of the stage.

Attributes:

  • x (float) –

    The X component of the position in in μm.

  • y (float) –

    The Y component of the position in in μm.

x class-attribute instance-attribute #

x: float = double_field(1)

The X component of the position in in μm.

y class-attribute instance-attribute #

y: float = double_field(2)

The Y component of the position in in μm.

StageServiceGetPositionRequest dataclass #

StageServiceGetPositionRequest()

Bases: Message

The StageServiceGetPositionRequest class.

StageServiceGetPositionResponse dataclass #

StageServiceGetPositionResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))

Bases: Message

Position of the stage in µm.

Attributes:

  • x (float) –

    The X component of the position in μm.

  • y (float) –

    The Y component of the position in μm.

x class-attribute instance-attribute #

x: float = double_field(1)

The X component of the position in μm.

y class-attribute instance-attribute #

y: float = double_field(2)

The Y component of the position in μm.

StageServiceGetSpeedRequest dataclass #

StageServiceGetSpeedRequest()

Bases: Message

The StageServiceGetSpeedRequest class.

StageServiceGetSpeedResponse dataclass #

StageServiceGetSpeedResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))

Bases: Message

Speed of the stage.

Attributes:

  • x (float) –

    The X component of the speed in %.

  • y (float) –

    The Y component of the speed in %.

x class-attribute instance-attribute #

x: float = double_field(1)

The X component of the speed in %.

y class-attribute instance-attribute #

y: float = double_field(2)

The Y component of the speed in %.

StageServiceMoveToRequest 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 μm. Leave out if x position should not be changed.

  • y (Optional[float]) –

    Target position y in μm. Leave out if y position should not be changed.

x class-attribute instance-attribute #

x: Optional[float] = message_field(1, wraps=TYPE_DOUBLE)

Target position x in μm. Leave out if x position should not be changed.

y class-attribute instance-attribute #

y: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)

Target position y in μm. Leave out if y position should not be changed.

StageServiceMoveToResponse 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.

position_changed class-attribute instance-attribute #

position_changed: bool = bool_field(1)

A value indicating whether the position was changed.

StageServiceSetAccelerationRequest 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].

acceleration_x 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].

acceleration_y 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].

StageServiceSetAccelerationResponse dataclass #

StageServiceSetAccelerationResponse()

Bases: Message

The StageServiceSetAccelerationResponse class.

StageServiceSetSpeedRequest 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].

speed_x 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].

speed_y 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].

StageServiceSetSpeedResponse dataclass #

StageServiceSetSpeedResponse()

Bases: Message

The StageServiceSetSpeedResponse class.

StageServiceStopRequest dataclass #

StageServiceStopRequest()

Bases: Message

The StageServiceStopRequest class.

StageServiceStopResponse dataclass #

StageServiceStopResponse()

Bases: Message

The StageServiceStopResponse class.