zen_api/em/hardware/v1/simple_acquisition_service.proto#
Version: 2026.5.1
Package: zen_api.em.hardware.v1
Service SimpleAcquisitionService#
The ISimpleAcquisitionService interface.
AcquireExtendedSingleFrame#
Call to start single channel acquisition of a single frame with given settings. The task returned represents the ongoing acquisition. The resulting image is send once the acquisition completed.
rpc AcquireExtendedSingleFrame (zen_api.em.hardware.v1.SimpleAcquisitionServiceAcquireExtendedSingleFrameRequest) returns (zen_api.em.hardware.v1.SimpleAcquisitionServiceAcquireExtendedSingleFrameResponse);
Request: zen_api.em.hardware.v1.SimpleAcquisitionServiceAcquireExtendedSingleFrameRequest
Response: zen_api.em.hardware.v1.SimpleAcquisitionServiceAcquireExtendedSingleFrameResponse
AcquireSingleFrame#
Call to start single channel acquisition of a single frame with given settings. The task returned represents the ongoing acquisition. The resulting image is send once the acquisition completed.
rpc AcquireSingleFrame (zen_api.em.hardware.v1.SimpleAcquisitionServiceAcquireSingleFrameRequest) returns (zen_api.em.hardware.v1.SimpleAcquisitionServiceAcquireSingleFrameResponse);
Request: zen_api.em.hardware.v1.SimpleAcquisitionServiceAcquireSingleFrameRequest
Response: zen_api.em.hardware.v1.SimpleAcquisitionServiceAcquireSingleFrameResponse
ChangeDwellTime#
Changes the dwell time for any ongoing acquisition task.
rpc ChangeDwellTime (zen_api.em.hardware.v1.SimpleAcquisitionServiceChangeDwellTimeRequest) returns (zen_api.em.hardware.v1.SimpleAcquisitionServiceChangeDwellTimeResponse);
Request: zen_api.em.hardware.v1.SimpleAcquisitionServiceChangeDwellTimeRequest
Response: zen_api.em.hardware.v1.SimpleAcquisitionServiceChangeDwellTimeResponse
GetAcquisitionStatus#
Retrieves the current state of the acquisition hardware. Allows to deduce if the hardware is available for a new acquisition, is blocked by some other task, or acquires currently images.
rpc GetAcquisitionStatus (zen_api.em.hardware.v1.SimpleAcquisitionServiceGetAcquisitionStatusRequest) returns (zen_api.em.hardware.v1.SimpleAcquisitionServiceGetAcquisitionStatusResponse);
Request: zen_api.em.hardware.v1.SimpleAcquisitionServiceGetAcquisitionStatusRequest
Response: zen_api.em.hardware.v1.SimpleAcquisitionServiceGetAcquisitionStatusResponse
GetBrightness#
Retrieves the brightness value applied to a specific detector in percentage.
rpc GetBrightness (zen_api.em.hardware.v1.SimpleAcquisitionServiceGetBrightnessRequest) returns (zen_api.em.hardware.v1.SimpleAcquisitionServiceGetBrightnessResponse);
Request: zen_api.em.hardware.v1.SimpleAcquisitionServiceGetBrightnessRequest
Response: zen_api.em.hardware.v1.SimpleAcquisitionServiceGetBrightnessResponse
GetContrast#
Retrieves the contrast value applied to a specific detector in percentage.
rpc GetContrast (zen_api.em.hardware.v1.SimpleAcquisitionServiceGetContrastRequest) returns (zen_api.em.hardware.v1.SimpleAcquisitionServiceGetContrastResponse);
Request: zen_api.em.hardware.v1.SimpleAcquisitionServiceGetContrastRequest
Response: zen_api.em.hardware.v1.SimpleAcquisitionServiceGetContrastResponse
RegisterOnAcquisitionStatusChanged#
Subscribes to acquisition status changed events.
rpc RegisterOnAcquisitionStatusChanged (zen_api.em.hardware.v1.SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedRequest) returns (stream zen_api.em.hardware.v1.SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedResponse);
Request: zen_api.em.hardware.v1.SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedRequest
Response: zen_api.em.hardware.v1.SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedResponse
SetBrightness#
Applies a brightness value to a specified detector. The brightness value is applied immediately and has to be in [0, 1].
rpc SetBrightness (zen_api.em.hardware.v1.SimpleAcquisitionServiceSetBrightnessRequest) returns (zen_api.em.hardware.v1.SimpleAcquisitionServiceSetBrightnessResponse);
Request: zen_api.em.hardware.v1.SimpleAcquisitionServiceSetBrightnessRequest
Response: zen_api.em.hardware.v1.SimpleAcquisitionServiceSetBrightnessResponse
SetContrast#
Applies a contrast value to a specified detector. The contrast value is applied immediately and has to be in [0, 1].
rpc SetContrast (zen_api.em.hardware.v1.SimpleAcquisitionServiceSetContrastRequest) returns (zen_api.em.hardware.v1.SimpleAcquisitionServiceSetContrastResponse);
Request: zen_api.em.hardware.v1.SimpleAcquisitionServiceSetContrastRequest
Response: zen_api.em.hardware.v1.SimpleAcquisitionServiceSetContrastResponse
StartExtendedLiveAcquisition#
This starts a live single channel acquisition with the given settings.
rpc StartExtendedLiveAcquisition (zen_api.em.hardware.v1.SimpleAcquisitionServiceStartExtendedLiveAcquisitionRequest) returns (zen_api.em.hardware.v1.SimpleAcquisitionServiceStartExtendedLiveAcquisitionResponse);
Request: zen_api.em.hardware.v1.SimpleAcquisitionServiceStartExtendedLiveAcquisitionRequest
Response: zen_api.em.hardware.v1.SimpleAcquisitionServiceStartExtendedLiveAcquisitionResponse
StartLiveAcquisition#
This starts a live single channel acquisition with the given settings.
rpc StartLiveAcquisition (zen_api.em.hardware.v1.SimpleAcquisitionServiceStartLiveAcquisitionRequest) returns (zen_api.em.hardware.v1.SimpleAcquisitionServiceStartLiveAcquisitionResponse);
Request: zen_api.em.hardware.v1.SimpleAcquisitionServiceStartLiveAcquisitionRequest
Response: zen_api.em.hardware.v1.SimpleAcquisitionServiceStartLiveAcquisitionResponse
StopLiveAcquisition#
Stops any ongoing live acquisition. Has only an effect if ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.GetAcquisitionStatus returns ZenApi.EM.Hardware.V1.AcquisitionStatus.LiveRunning.
rpc StopLiveAcquisition (zen_api.em.hardware.v1.SimpleAcquisitionServiceStopLiveAcquisitionRequest) returns (zen_api.em.hardware.v1.SimpleAcquisitionServiceStopLiveAcquisitionResponse);
Request: zen_api.em.hardware.v1.SimpleAcquisitionServiceStopLiveAcquisitionRequest
Response: zen_api.em.hardware.v1.SimpleAcquisitionServiceStopLiveAcquisitionResponse
Message SimpleAcquisitionServiceAcquireExtendedSingleFrameRequest#
The SimpleAcquisitionServiceAcquireExtendedSingleFrameRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
settings |
1 | zen_api.em.hardware.v1.ExtendedAcquisitionSettings | singular | The imaging settings used to acquire a frame. |
Message SimpleAcquisitionServiceAcquireExtendedSingleFrameResponse#
Response object of the AcquireExtendedSingleFrame method of the ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
task_success |
1 | bool |
singular | A value indicating whether the task to initialize the stage succeeded or not. |
width |
2 | int32 |
singular | The width in pixels of the image. |
height |
3 | int32 |
singular | The height in pixels of the image. |
image_data |
4 | bytes |
singular | The image raw data, 1 frame. Frame data as 16 bit per pixel, #pixels = ZenApi.EM.Hardware.V1.SimpleAcquisitionServiceAcquireExtendedSingleFrameResponse.Width * ZenApi.EM.Hardware.V1.SimpleAcquisitionServiceAcquireExtendedSingleFrameResponse.Height. Total length in byte = #pixels * 2. |
message |
5 | string |
singular | A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success. |
Message SimpleAcquisitionServiceAcquireSingleFrameRequest#
The SimpleAcquisitionServiceAcquireSingleFrameRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
settings |
1 | zen_api.em.hardware.v1.AcquisitionSettings | singular | The imaging settings used to acquire a frame. |
Message SimpleAcquisitionServiceAcquireSingleFrameResponse#
Response object of the AcquireSingleFrame method of the ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
task_success |
1 | bool |
singular | A value indicating whether the task to initialize the stage succeeded or not. |
width |
2 | int32 |
singular | The width in pixels of the image. |
height |
3 | int32 |
singular | The height in pixels of the image. |
image_data |
4 | bytes |
singular | The image raw data, 1 frame. Frame data as 16 bit per pixel, #pixels = ZenApi.EM.Hardware.V1.SimpleAcquisitionServiceAcquireSingleFrameResponse.Width * ZenApi.EM.Hardware.V1.SimpleAcquisitionServiceAcquireSingleFrameResponse.Height. Total length in byte = #pixels * 2. |
message |
5 | string |
singular | A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success. |
Message SimpleAcquisitionServiceChangeDwellTimeRequest#
The SimpleAcquisitionServiceChangeDwellTimeRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
dwell_seconds |
1 | double |
singular | The new dwell time in seconds. Must be in [25e-9, 107] and only multiples of 25e-9s are supported. |
Message SimpleAcquisitionServiceChangeDwellTimeResponse#
Response object representing the current acquisition status.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
task_success |
1 | bool |
singular | A value indicating whether the task to initialize the stage succeeded or not. |
Message SimpleAcquisitionServiceGetAcquisitionStatusRequest#
The SimpleAcquisitionServiceGetAcquisitionStatusRequest class.
Message SimpleAcquisitionServiceGetAcquisitionStatusResponse#
Response object representing the current acquisition status.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
status |
1 | zen_api.em.hardware.v1.AcquisitionStatus | singular | A value indicating whether the task to initialize the stage succeeded or not. |
Message SimpleAcquisitionServiceGetBrightnessRequest#
The SimpleAcquisitionServiceGetBrightnessRequest class.
Message SimpleAcquisitionServiceGetBrightnessResponse#
Response object representing a detector brightness value.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
brightness |
1 | double |
singular | The brightness in percentage [0, 100]. |
Message SimpleAcquisitionServiceGetContrastRequest#
The SimpleAcquisitionServiceGetContrastRequest class.
Message SimpleAcquisitionServiceGetContrastResponse#
Response object representing a detector contrast value.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
contrast |
1 | double |
singular | The contrast in percentage [0, 100]. |
Message SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedRequest#
The SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedRequest class.
Message SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedResponse#
Response object representing the current acquisition status.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
status |
1 | zen_api.em.hardware.v1.AcquisitionStatus | singular | A value indicating whether the task to initialize the stage succeeded or not. |
Message SimpleAcquisitionServiceSetBrightnessRequest#
The SimpleAcquisitionServiceSetBrightnessRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
brightness |
1 | double |
singular | The brightness value to apply in percentage [0, 1]. |
Message SimpleAcquisitionServiceSetBrightnessResponse#
Response object representing a detector brightness value.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
brightness |
1 | double |
singular | The brightness in percentage [0, 100]. |
Message SimpleAcquisitionServiceSetContrastRequest#
The SimpleAcquisitionServiceSetContrastRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
contrast |
1 | double |
singular | The contrast value to apply in percentage [0, 1]. |
Message SimpleAcquisitionServiceSetContrastResponse#
Response object representing a detector contrast value.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
contrast |
1 | double |
singular | The contrast in percentage [0, 100]. |
Message SimpleAcquisitionServiceStartExtendedLiveAcquisitionRequest#
The SimpleAcquisitionServiceStartExtendedLiveAcquisitionRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
settings |
1 | zen_api.em.hardware.v1.ExtendedAcquisitionSettings | singular | The imaging settings used to acquire multiple frames. |
Message SimpleAcquisitionServiceStartExtendedLiveAcquisitionResponse#
Response object of the StartExtendedLiveAcquisition method of the ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
task_success |
1 | bool |
singular | A value indicating whether the task to acquire an image succeeded or not. |
message |
2 | string |
singular | A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success. |
Message SimpleAcquisitionServiceStartLiveAcquisitionRequest#
The SimpleAcquisitionServiceStartLiveAcquisitionRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
settings |
1 | zen_api.em.hardware.v1.AcquisitionSettings | singular | The imaging settings used to acquire multiple frames. |
Message SimpleAcquisitionServiceStartLiveAcquisitionResponse#
Response object of the StartLiveAcquisition method of the ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
task_success |
1 | bool |
singular | A value indicating whether the task to acquire an image succeeded or not. |
message |
2 | string |
singular | A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success. |
Message SimpleAcquisitionServiceStopLiveAcquisitionRequest#
The SimpleAcquisitionServiceStopLiveAcquisitionRequest class.
Message SimpleAcquisitionServiceStopLiveAcquisitionResponse#
The SimpleAcquisitionServiceStopLiveAcquisitionResponse class.