zen_api/em/hardware/v1/illumination_service.proto

Version: 2026.5.1

Package: zen_api.em.hardware.v1

Download proto source

Service IlluminationService

The IIlluminationService interface.

GetIlluminationIR

Gets the illumination IR value. Returns the current illumination IR value [0..100]%.

rpc GetIlluminationIR (zen_api.em.hardware.v1.IlluminationServiceGetIlluminationIRRequest) returns (zen_api.em.hardware.v1.IlluminationServiceGetIlluminationIRResponse);

Request: zen_api.em.hardware.v1.IlluminationServiceGetIlluminationIRRequest

Response: zen_api.em.hardware.v1.IlluminationServiceGetIlluminationIRResponse

GetIlluminationWhite

Gets the illumination white value. Returns the current illumination white value [0..100]%.

rpc GetIlluminationWhite (zen_api.em.hardware.v1.IlluminationServiceGetIlluminationWhiteRequest) returns (zen_api.em.hardware.v1.IlluminationServiceGetIlluminationWhiteResponse);

Request: zen_api.em.hardware.v1.IlluminationServiceGetIlluminationWhiteRequest

Response: zen_api.em.hardware.v1.IlluminationServiceGetIlluminationWhiteResponse

RegisterOnIlluminationIRChanged

Registers a subscriber on illumination IR changes. returns the current illumination IR value [0..100]%.

rpc RegisterOnIlluminationIRChanged (zen_api.em.hardware.v1.IlluminationServiceRegisterOnIlluminationIRChangedRequest) returns (stream zen_api.em.hardware.v1.IlluminationServiceRegisterOnIlluminationIRChangedResponse);

Request: zen_api.em.hardware.v1.IlluminationServiceRegisterOnIlluminationIRChangedRequest

Response: zen_api.em.hardware.v1.IlluminationServiceRegisterOnIlluminationIRChangedResponse

RegisterOnIlluminationWhiteChanged

Registers a subscriber on illumination white changes. Returns the current illumination white value [0..100]%.

rpc RegisterOnIlluminationWhiteChanged (zen_api.em.hardware.v1.IlluminationServiceRegisterOnIlluminationWhiteChangedRequest) returns (stream zen_api.em.hardware.v1.IlluminationServiceRegisterOnIlluminationWhiteChangedResponse);

Request: zen_api.em.hardware.v1.IlluminationServiceRegisterOnIlluminationWhiteChangedRequest

Response: zen_api.em.hardware.v1.IlluminationServiceRegisterOnIlluminationWhiteChangedResponse

SetIlluminationIR

Sets the illumination IR value. Returns the current illumination IR value [0..100]%.

rpc SetIlluminationIR (zen_api.em.hardware.v1.IlluminationServiceSetIlluminationIRRequest) returns (zen_api.em.hardware.v1.IlluminationServiceSetIlluminationIRResponse);

Request: zen_api.em.hardware.v1.IlluminationServiceSetIlluminationIRRequest

Response: zen_api.em.hardware.v1.IlluminationServiceSetIlluminationIRResponse

SetIlluminationWhite

Sets the illumination white value. Returns the current illumination white value [0..100]%.

rpc SetIlluminationWhite (zen_api.em.hardware.v1.IlluminationServiceSetIlluminationWhiteRequest) returns (zen_api.em.hardware.v1.IlluminationServiceSetIlluminationWhiteResponse);

Request: zen_api.em.hardware.v1.IlluminationServiceSetIlluminationWhiteRequest

Response: zen_api.em.hardware.v1.IlluminationServiceSetIlluminationWhiteResponse

Message IlluminationServiceGetIlluminationIRRequest

The IlluminationServiceGetIlluminationIRRequest class.

Message IlluminationServiceGetIlluminationIRResponse

Response object for the illuminator get illumination IR.

Field	Number	Type	Presence	Description
illumination_ir	1	double	singular	The illumination IR.

Message IlluminationServiceGetIlluminationWhiteRequest

The IlluminationServiceGetIlluminationWhiteRequest class.

Message IlluminationServiceGetIlluminationWhiteResponse

Response object for the illuminator get illumination white.

Field	Number	Type	Presence	Description
illumination_white	1	double	singular	The illumination white.

Message IlluminationServiceRegisterOnIlluminationIRChangedRequest

The IlluminationServiceRegisterOnIlluminationIRChangedRequest class.

Message IlluminationServiceRegisterOnIlluminationIRChangedResponse

Response object for register on illumination IR changed.

Field	Number	Type	Presence	Description
illumination_ir	1	double	singular	The illumination IR.

Message IlluminationServiceRegisterOnIlluminationWhiteChangedRequest

The IlluminationServiceRegisterOnIlluminationWhiteChangedRequest class.

Message IlluminationServiceRegisterOnIlluminationWhiteChangedResponse

Response object for register on illumination white changed.

Field	Number	Type	Presence	Description
illumination_white	1	double	singular	The illumination white.

Message IlluminationServiceSetIlluminationIRRequest

The IlluminationServiceSetIlluminationIRRequest class.

Field	Number	Type	Presence	Description
illumination_ir	1	double	singular	The illumination IR value to set [0..100]%.

Message IlluminationServiceSetIlluminationIRResponse

Response object for the illuminator set illumination IR.

Field	Number	Type	Presence	Description
illumination_ir	1	double	singular	The illumination IR.
success	2	bool	singular	A value indicating whether setting the brightness was successful.
message	3	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 IlluminationServiceSetIlluminationWhiteRequest

The IlluminationServiceSetIlluminationWhiteRequest class.

Field	Number	Type	Presence	Description
illumination_white	1	double	singular	The illumination white value to set [0..100]%.

Message IlluminationServiceSetIlluminationWhiteResponse

Response object for the illuminator set illumination white.

Field	Number	Type	Presence	Description
illumination_white	1	double	singular	The illumination white.
success	2	bool	singular	A value indicating whether setting the brightness was successful.
message	3	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.