Skip to content

zen_api/em/hardware/v1/detector_service.proto#

Version: 2026.5.1

Package: zen_api.em.hardware.v1

Download proto source

Service DetectorService#

The IDetectorService interface.

GetAvailableDetectors#

Retrieves a list of all available detectors of the system. Their name serves as an identifier for this API service.

rpc GetAvailableDetectors (zen_api.em.hardware.v1.DetectorServiceGetAvailableDetectorsRequest) returns (zen_api.em.hardware.v1.DetectorServiceGetAvailableDetectorsResponse);

Request: zen_api.em.hardware.v1.DetectorServiceGetAvailableDetectorsRequest

Response: zen_api.em.hardware.v1.DetectorServiceGetAvailableDetectorsResponse

GetBrightness#

Retrieves the brightness value applied to a specific detector in percentage.

rpc GetBrightness (zen_api.em.hardware.v1.DetectorServiceGetBrightnessRequest) returns (zen_api.em.hardware.v1.DetectorServiceGetBrightnessResponse);

Request: zen_api.em.hardware.v1.DetectorServiceGetBrightnessRequest

Response: zen_api.em.hardware.v1.DetectorServiceGetBrightnessResponse

GetContrast#

Retrieves the contrast value applied to a specific detector in percentage.

rpc GetContrast (zen_api.em.hardware.v1.DetectorServiceGetContrastRequest) returns (zen_api.em.hardware.v1.DetectorServiceGetContrastResponse);

Request: zen_api.em.hardware.v1.DetectorServiceGetContrastRequest

Response: zen_api.em.hardware.v1.DetectorServiceGetContrastResponse

RegisterOnBrightnessChanged#

Registers a subscriber on brightness changes of a specific detector.

rpc RegisterOnBrightnessChanged (zen_api.em.hardware.v1.DetectorServiceRegisterOnBrightnessChangedRequest) returns (stream zen_api.em.hardware.v1.DetectorServiceRegisterOnBrightnessChangedResponse);

Request: zen_api.em.hardware.v1.DetectorServiceRegisterOnBrightnessChangedRequest

Response: zen_api.em.hardware.v1.DetectorServiceRegisterOnBrightnessChangedResponse

RegisterOnContrastChanged#

Registers a subscriber on contrast changes of a specific detector.

rpc RegisterOnContrastChanged (zen_api.em.hardware.v1.DetectorServiceRegisterOnContrastChangedRequest) returns (stream zen_api.em.hardware.v1.DetectorServiceRegisterOnContrastChangedResponse);

Request: zen_api.em.hardware.v1.DetectorServiceRegisterOnContrastChangedRequest

Response: zen_api.em.hardware.v1.DetectorServiceRegisterOnContrastChangedResponse

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.DetectorServiceSetBrightnessRequest) returns (zen_api.em.hardware.v1.DetectorServiceSetBrightnessResponse);

Request: zen_api.em.hardware.v1.DetectorServiceSetBrightnessRequest

Response: zen_api.em.hardware.v1.DetectorServiceSetBrightnessResponse

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.DetectorServiceSetContrastRequest) returns (zen_api.em.hardware.v1.DetectorServiceSetContrastResponse);

Request: zen_api.em.hardware.v1.DetectorServiceSetContrastRequest

Response: zen_api.em.hardware.v1.DetectorServiceSetContrastResponse

Message DetectorServiceGetAvailableDetectorsRequest#

The DetectorServiceGetAvailableDetectorsRequest class.

Message DetectorServiceGetAvailableDetectorsResponse#

Response object representing a list of available detectors.

Field Number Type Presence Description
detector_names 1 string repeated The available detectors on the system.

Message DetectorServiceGetBrightnessRequest#

The DetectorServiceGetBrightnessRequest class.

Field Number Type Presence Description
detector_name 1 string singular The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

Message DetectorServiceGetBrightnessResponse#

Response object representing a detector brightness value.

Field Number Type Presence Description
brightness 1 double singular The brightness in percentage [0, 100].

Message DetectorServiceGetContrastRequest#

The DetectorServiceGetContrastRequest class.

Field Number Type Presence Description
detector_name 1 string singular The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

Message DetectorServiceGetContrastResponse#

Response object representing a detector contrast value.

Field Number Type Presence Description
contrast 1 double singular The contrast in percentage [0, 100].

Message DetectorServiceRegisterOnBrightnessChangedRequest#

The DetectorServiceRegisterOnBrightnessChangedRequest class.

Field Number Type Presence Description
detector_name 1 string singular The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

Message DetectorServiceRegisterOnBrightnessChangedResponse#

Response object representing a detector brightness value.

Field Number Type Presence Description
brightness 1 double singular The brightness in percentage [0, 100].

Message DetectorServiceRegisterOnContrastChangedRequest#

The DetectorServiceRegisterOnContrastChangedRequest class.

Field Number Type Presence Description
detector_name 1 string singular The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

Message DetectorServiceRegisterOnContrastChangedResponse#

Response object representing a detector contrast value.

Field Number Type Presence Description
contrast 1 double singular The contrast in percentage [0, 100].

Message DetectorServiceSetBrightnessRequest#

The DetectorServiceSetBrightnessRequest class.

Field Number Type Presence Description
detector_name 1 string singular The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.
brightness 2 double singular The brightness value to apply in percentage [0, 1].

Message DetectorServiceSetBrightnessResponse#

Response object representing a detector brightness value.

Field Number Type Presence Description
brightness 1 double singular The brightness in percentage [0, 100].

Message DetectorServiceSetContrastRequest#

The DetectorServiceSetContrastRequest class.

Field Number Type Presence Description
detector_name 1 string singular The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.
contrast 2 double singular The contrast value to apply in percentage [0, 1].

Message DetectorServiceSetContrastResponse#

Response object representing a detector contrast value.

Field Number Type Presence Description
contrast 1 double singular The contrast in percentage [0, 100].