zen_api/lm/hardware/v1/sample_carrier_service.proto#
Version: 2026.5.1
Package: zen_api.lm.hardware.v1
Service SampleCarrierService#
The ISampleCarrierService interface.
ActivateContainer#
Activates a tile region or position that is placed in the specified container.
rpc ActivateContainer (zen_api.lm.hardware.v1.SampleCarrierServiceActivateContainerRequest) returns (zen_api.lm.hardware.v1.SampleCarrierServiceActivateContainerResponse);
Request: zen_api.lm.hardware.v1.SampleCarrierServiceActivateContainerRequest
Response: zen_api.lm.hardware.v1.SampleCarrierServiceActivateContainerResponse
ActivateContainerRange#
Activates all tile regions and/or positions that are placed in the specified container range (e.g., "C3-D8").
rpc ActivateContainerRange (zen_api.lm.hardware.v1.SampleCarrierServiceActivateContainerRangeRequest) returns (zen_api.lm.hardware.v1.SampleCarrierServiceActivateContainerRangeResponse);
Request: zen_api.lm.hardware.v1.SampleCarrierServiceActivateContainerRangeRequest
Response: zen_api.lm.hardware.v1.SampleCarrierServiceActivateContainerRangeResponse
ActivateContainers#
Activates all tile regions and/or positions that are placed in the specified containers (e.g., ["A1", "A2", "B7"]).
rpc ActivateContainers (zen_api.lm.hardware.v1.SampleCarrierServiceActivateContainersRequest) returns (zen_api.lm.hardware.v1.SampleCarrierServiceActivateContainersResponse);
Request: zen_api.lm.hardware.v1.SampleCarrierServiceActivateContainersRequest
Response: zen_api.lm.hardware.v1.SampleCarrierServiceActivateContainersResponse
DeactivateContainer#
Deactivates a tile region or position that is placed in the specified container.
rpc DeactivateContainer (zen_api.lm.hardware.v1.SampleCarrierServiceDeactivateContainerRequest) returns (zen_api.lm.hardware.v1.SampleCarrierServiceDeactivateContainerResponse);
Request: zen_api.lm.hardware.v1.SampleCarrierServiceDeactivateContainerRequest
Response: zen_api.lm.hardware.v1.SampleCarrierServiceDeactivateContainerResponse
DeactivateContainerRange#
Deactivates all tile regions and/or positions that are placed in the specified container range (e.g., "C3-D8").
rpc DeactivateContainerRange (zen_api.lm.hardware.v1.SampleCarrierServiceDeactivateContainerRangeRequest) returns (zen_api.lm.hardware.v1.SampleCarrierServiceDeactivateContainerRangeResponse);
Request: zen_api.lm.hardware.v1.SampleCarrierServiceDeactivateContainerRangeRequest
Response: zen_api.lm.hardware.v1.SampleCarrierServiceDeactivateContainerRangeResponse
DeactivateContainers#
Deactivates all tile regions and/or positions that are placed in the specified containers (e.g., ["A1", "A2", "B7"]).
rpc DeactivateContainers (zen_api.lm.hardware.v1.SampleCarrierServiceDeactivateContainersRequest) returns (zen_api.lm.hardware.v1.SampleCarrierServiceDeactivateContainersResponse);
Request: zen_api.lm.hardware.v1.SampleCarrierServiceDeactivateContainersRequest
Response: zen_api.lm.hardware.v1.SampleCarrierServiceDeactivateContainersResponse
GetConfiguredContainers#
Gets the information about the configured containers in an experiment.
rpc GetConfiguredContainers (zen_api.lm.hardware.v1.SampleCarrierServiceGetConfiguredContainersRequest) returns (zen_api.lm.hardware.v1.SampleCarrierServiceGetConfiguredContainersResponse);
Request: zen_api.lm.hardware.v1.SampleCarrierServiceGetConfiguredContainersRequest
Response: zen_api.lm.hardware.v1.SampleCarrierServiceGetConfiguredContainersResponse
GetCurrentContainer#
Gets the information in which container of the sample carrier the stage is positioned at. Note that the stage might not be positioned exactly in the center of the container.
rpc GetCurrentContainer (zen_api.lm.hardware.v1.SampleCarrierServiceGetCurrentContainerRequest) returns (zen_api.lm.hardware.v1.SampleCarrierServiceGetCurrentContainerResponse);
Request: zen_api.lm.hardware.v1.SampleCarrierServiceGetCurrentContainerRequest
Response: zen_api.lm.hardware.v1.SampleCarrierServiceGetCurrentContainerResponse
GetInfo#
Gets the information of the currently inserted sample carrier.
rpc GetInfo (zen_api.lm.hardware.v1.SampleCarrierServiceGetInfoRequest) returns (zen_api.lm.hardware.v1.SampleCarrierServiceGetInfoResponse);
Request: zen_api.lm.hardware.v1.SampleCarrierServiceGetInfoRequest
Response: zen_api.lm.hardware.v1.SampleCarrierServiceGetInfoResponse
MoveToContainer#
Move the stage to a sample holder container.
rpc MoveToContainer (zen_api.lm.hardware.v1.SampleCarrierServiceMoveToContainerRequest) returns (zen_api.lm.hardware.v1.SampleCarrierServiceMoveToContainerResponse);
Request: zen_api.lm.hardware.v1.SampleCarrierServiceMoveToContainerRequest
Response: zen_api.lm.hardware.v1.SampleCarrierServiceMoveToContainerResponse
Message SampleCarrierServiceActivateContainerRangeRequest#
The SampleCarrierServiceActivateContainerRangeRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | Experiment ID. |
start_container_name |
2 | string |
singular | Name of the container where the range starts (e.g., "C3"). |
end_container_name |
3 | string |
singular | Name of the container where the range ends (e.g., "D8"). |
Message SampleCarrierServiceActivateContainerRangeResponse#
The SampleCarrierServiceActivateContainerRangeResponse class.
Message SampleCarrierServiceActivateContainerRequest#
The SampleCarrierServiceActivateContainerRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | Experiment ID. |
container_name |
2 | string |
singular | Name of the container (e.g., "B1"). |
Message SampleCarrierServiceActivateContainerResponse#
The SampleCarrierServiceActivateContainerResponse class.
Message SampleCarrierServiceActivateContainersRequest#
The SampleCarrierServiceActivateContainersRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | Experiment ID. |
container_names |
2 | string |
repeated | Names of the containers (e.g., ["A1", "A2", "B7"]). |
Message SampleCarrierServiceActivateContainersResponse#
The SampleCarrierServiceActivateContainersResponse class.
Message SampleCarrierServiceDeactivateContainerRangeRequest#
The SampleCarrierServiceDeactivateContainerRangeRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | Experiment ID. |
start_container_name |
2 | string |
singular | Name of the container where the range starts (e.g., "C3"). |
end_container_name |
3 | string |
singular | Name of the container where the range ends (e.g., "D8"). |
Message SampleCarrierServiceDeactivateContainerRangeResponse#
The SampleCarrierServiceDeactivateContainerRangeResponse class.
Message SampleCarrierServiceDeactivateContainerRequest#
The SampleCarrierServiceDeactivateContainerRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | Experiment ID. |
container_name |
2 | string |
singular | Name of the container (e.g., "B1"). |
Message SampleCarrierServiceDeactivateContainerResponse#
The SampleCarrierServiceDeactivateContainerResponse class.
Message SampleCarrierServiceDeactivateContainersRequest#
The SampleCarrierServiceDeactivateContainersRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | Experiment ID. |
container_names |
2 | string |
repeated | Names of the containers (e.g., ["A1", "A2", "B7"]). |
Message SampleCarrierServiceDeactivateContainersResponse#
The SampleCarrierServiceDeactivateContainersResponse class.
Message SampleCarrierServiceGetConfiguredContainersRequest#
The SampleCarrierServiceGetConfiguredContainersRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | Experiment ID. |
Message SampleCarrierServiceGetConfiguredContainersResponse#
Contains the information about the configured containers in an experiment.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
configured_containers |
1 | zen_api.lm.hardware.v1.ConfiguredContainerInfo | repeated | The information about the configured containers in an experiment. |
Message SampleCarrierServiceGetCurrentContainerRequest#
The SampleCarrierServiceGetCurrentContainerRequest class.
Message SampleCarrierServiceGetCurrentContainerResponse#
Contains the information in which container of the sample carrier the stage is positioned at.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
row_index |
1 | int32 |
singular | The row index of the container in the sample carrier (starts with index 0). |
column_index |
2 | int32 |
singular | The column index of the container in the sample carrier (starts with index 0). |
Message SampleCarrierServiceGetInfoRequest#
The SampleCarrierServiceGetInfoRequest class.
Message SampleCarrierServiceGetInfoResponse#
Contains the sample carrier information.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
rows |
1 | int32 |
singular | The number of rows in the sample carrier. |
columns |
2 | int32 |
singular | The number of columns in the sample carrier. |
name |
3 | string |
singular | The name of the sample carrier. |
material |
4 | string |
singular | The bottom material which is used for this sample carrier. |
thickness |
5 | double |
singular | The bottom thickness of this sample carrier (in meters). |
skirt |
6 | double |
singular | The skirt (i.e. bottom offset) of this sample carrier (in meters). |
refractive_index |
7 | double |
singular | The refractive index of the bottom material of this sample carrier. |
Message SampleCarrierServiceMoveToContainerRequest#
The SampleCarrierServiceMoveToContainerRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
row_index |
1 | int32 |
singular | The row index of the container (starts with index 0). |
column_index |
2 | int32 |
singular | The column index of the container (starts with index 0). |
Message SampleCarrierServiceMoveToContainerResponse#
The SampleCarrierServiceMoveToContainerResponse class.