Skip to content

lm.hardware.v1#

zen_api.lm.hardware.v1 #

Classes:

ConfiguredContainerInfo dataclass #

ConfiguredContainerInfo(container_name: str = betterproto.string_field(1), is_activated: bool = betterproto.bool_field(2))

Bases: Message

Contains the information about a configured container in an experiment.

Attributes:

  • container_name (str) –

    The name of the container (e.g., "B1").

  • is_activated (bool) –

    A value indicating whether the container is activated or not.

container_name class-attribute instance-attribute #

container_name: str = string_field(1)

The name of the container (e.g., "B1").

is_activated class-attribute instance-attribute #

is_activated: bool = bool_field(2)

A value indicating whether the container is activated or not.

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.

SampleCarrierServiceActivateContainerRangeRequest dataclass #

SampleCarrierServiceActivateContainerRangeRequest(experiment_id: str = betterproto.string_field(1), start_container_name: str = betterproto.string_field(2), end_container_name: str = betterproto.string_field(3))

Bases: Message

The SampleCarrierServiceActivateContainerRangeRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment ID.

start_container_name class-attribute instance-attribute #

start_container_name: str = string_field(2)

Name of the container where the range starts (e.g., "C3").

end_container_name class-attribute instance-attribute #

end_container_name: str = string_field(3)

Name of the container where the range ends (e.g., "D8").

SampleCarrierServiceActivateContainerRangeResponse dataclass #

SampleCarrierServiceActivateContainerRangeResponse()

Bases: Message

The SampleCarrierServiceActivateContainerRangeResponse class.

SampleCarrierServiceActivateContainerRequest dataclass #

SampleCarrierServiceActivateContainerRequest(experiment_id: str = betterproto.string_field(1), container_name: str = betterproto.string_field(2))

Bases: Message

The SampleCarrierServiceActivateContainerRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment ID.

container_name class-attribute instance-attribute #

container_name: str = string_field(2)

Name of the container (e.g., "B1").

SampleCarrierServiceActivateContainerResponse dataclass #

SampleCarrierServiceActivateContainerResponse()

Bases: Message

The SampleCarrierServiceActivateContainerResponse class.

SampleCarrierServiceActivateContainersRequest dataclass #

SampleCarrierServiceActivateContainersRequest(experiment_id: str = betterproto.string_field(1), container_names: List[str] = betterproto.string_field(2))

Bases: Message

The SampleCarrierServiceActivateContainersRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment ID.

container_names class-attribute instance-attribute #

container_names: List[str] = string_field(2)

Names of the containers (e.g., ["A1", "A2", "B7"]).

SampleCarrierServiceActivateContainersResponse dataclass #

SampleCarrierServiceActivateContainersResponse()

Bases: Message

The SampleCarrierServiceActivateContainersResponse class.

SampleCarrierServiceDeactivateContainerRangeRequest dataclass #

SampleCarrierServiceDeactivateContainerRangeRequest(experiment_id: str = betterproto.string_field(1), start_container_name: str = betterproto.string_field(2), end_container_name: str = betterproto.string_field(3))

Bases: Message

The SampleCarrierServiceDeactivateContainerRangeRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment ID.

start_container_name class-attribute instance-attribute #

start_container_name: str = string_field(2)

Name of the container where the range starts (e.g., "C3").

end_container_name class-attribute instance-attribute #

end_container_name: str = string_field(3)

Name of the container where the range ends (e.g., "D8").

SampleCarrierServiceDeactivateContainerRangeResponse dataclass #

SampleCarrierServiceDeactivateContainerRangeResponse()

Bases: Message

The SampleCarrierServiceDeactivateContainerRangeResponse class.

SampleCarrierServiceDeactivateContainerRequest dataclass #

SampleCarrierServiceDeactivateContainerRequest(experiment_id: str = betterproto.string_field(1), container_name: str = betterproto.string_field(2))

Bases: Message

The SampleCarrierServiceDeactivateContainerRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment ID.

container_name class-attribute instance-attribute #

container_name: str = string_field(2)

Name of the container (e.g., "B1").

SampleCarrierServiceDeactivateContainerResponse dataclass #

SampleCarrierServiceDeactivateContainerResponse()

Bases: Message

The SampleCarrierServiceDeactivateContainerResponse class.

SampleCarrierServiceDeactivateContainersRequest dataclass #

SampleCarrierServiceDeactivateContainersRequest(experiment_id: str = betterproto.string_field(1), container_names: List[str] = betterproto.string_field(2))

Bases: Message

The SampleCarrierServiceDeactivateContainersRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment ID.

container_names class-attribute instance-attribute #

container_names: List[str] = string_field(2)

Names of the containers (e.g., ["A1", "A2", "B7"]).

SampleCarrierServiceDeactivateContainersResponse dataclass #

SampleCarrierServiceDeactivateContainersResponse()

Bases: Message

The SampleCarrierServiceDeactivateContainersResponse class.

SampleCarrierServiceGetConfiguredContainersRequest dataclass #

SampleCarrierServiceGetConfiguredContainersRequest(experiment_id: str = betterproto.string_field(1))

Bases: Message

The SampleCarrierServiceGetConfiguredContainersRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment ID.

SampleCarrierServiceGetConfiguredContainersResponse dataclass #

SampleCarrierServiceGetConfiguredContainersResponse(configured_containers: List[ConfiguredContainerInfo] = betterproto.message_field(1))

Bases: Message

Contains the information about the configured containers in an experiment.

Attributes:

configured_containers class-attribute instance-attribute #

configured_containers: List[ConfiguredContainerInfo] = message_field(1)

The information about the configured containers in an experiment.

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.