zen_api/em/hardware/v1/external_procedure_service.proto#
Version: 2026.5.1
Package: zen_api.em.hardware.v1
Service ExternalProcedureService#
The IExternalProcedureService interface.
RegisterExternalProcedure#
Registers the caller to get notified about ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse's (for all external procedures; filtering must be done by the caller).
rpc RegisterExternalProcedure (zen_api.em.hardware.v1.ExternalProcedureServiceRegisterExternalProcedureRequest) returns (stream zen_api.em.hardware.v1.ExternalProcedureServiceRegisterExternalProcedureResponse);
Request: zen_api.em.hardware.v1.ExternalProcedureServiceRegisterExternalProcedureRequest
Response: zen_api.em.hardware.v1.ExternalProcedureServiceRegisterExternalProcedureResponse
ReportCommandFailure#
Reports the failure of execution of the given ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.
rpc ReportCommandFailure (zen_api.em.hardware.v1.ExternalProcedureServiceReportCommandFailureRequest) returns (zen_api.em.hardware.v1.ExternalProcedureServiceReportCommandFailureResponse);
Request: zen_api.em.hardware.v1.ExternalProcedureServiceReportCommandFailureRequest
Response: zen_api.em.hardware.v1.ExternalProcedureServiceReportCommandFailureResponse
ReportCommandSuccess#
Reports the successful execution of the given ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.
rpc ReportCommandSuccess (zen_api.em.hardware.v1.ExternalProcedureServiceReportCommandSuccessRequest) returns (zen_api.em.hardware.v1.ExternalProcedureServiceReportCommandSuccessResponse);
Request: zen_api.em.hardware.v1.ExternalProcedureServiceReportCommandSuccessRequest
Response: zen_api.em.hardware.v1.ExternalProcedureServiceReportCommandSuccessResponse
ReportInitializationError#
Reports an error that has occurred during the initialization of an external procedure, leads to error state.
rpc ReportInitializationError (zen_api.em.hardware.v1.ExternalProcedureServiceReportInitializationErrorRequest) returns (zen_api.em.hardware.v1.ExternalProcedureServiceReportInitializationErrorResponse);
Request: zen_api.em.hardware.v1.ExternalProcedureServiceReportInitializationErrorRequest
Response: zen_api.em.hardware.v1.ExternalProcedureServiceReportInitializationErrorResponse
ReportProgress#
reports the progress of the external procedure with the given id.
rpc ReportProgress (zen_api.em.hardware.v1.ExternalProcedureServiceReportProgressRequest) returns (zen_api.em.hardware.v1.ExternalProcedureServiceReportProgressResponse);
Request: zen_api.em.hardware.v1.ExternalProcedureServiceReportProgressRequest
Response: zen_api.em.hardware.v1.ExternalProcedureServiceReportProgressResponse
ReportReady#
Reports, that the external procedure with the given id is ready to be executed.
rpc ReportReady (zen_api.em.hardware.v1.ExternalProcedureServiceReportReadyRequest) returns (zen_api.em.hardware.v1.ExternalProcedureServiceReportReadyResponse);
Request: zen_api.em.hardware.v1.ExternalProcedureServiceReportReadyRequest
Response: zen_api.em.hardware.v1.ExternalProcedureServiceReportReadyResponse
ReportStatus#
reports a status message to zen.
rpc ReportStatus (zen_api.em.hardware.v1.ExternalProcedureServiceReportStatusRequest) returns (zen_api.em.hardware.v1.ExternalProcedureServiceReportStatusResponse);
Request: zen_api.em.hardware.v1.ExternalProcedureServiceReportStatusRequest
Response: zen_api.em.hardware.v1.ExternalProcedureServiceReportStatusResponse
Message ExternalProcedureServiceRegisterExternalProcedureRequest#
The ExternalProcedureServiceRegisterExternalProcedureRequest class.
Message ExternalProcedureServiceRegisterExternalProcedureResponse#
transfer object definition used to send commands to external procedures
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
parameters |
1 | string |
repeated | An array of string parameters, may be empty |
id |
2 | string |
singular | The System.Guid of the external procedure the command is for, needs to be filtered by external procedures, as all procedures use the same channel to listen for commands default value could not be applied: 00000000-0000-0000-0000-000000000000 |
command_id |
3 | zen_api.em.hardware.v1.CommandId | singular | The ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.CommandId telling the external procedure what to do |
Message ExternalProcedureServiceReportCommandFailureRequest#
The ExternalProcedureServiceReportCommandFailureRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
id |
1 | string |
singular | the System.Guid of a given running script a command has been send to. default value could not be applied: 00000000-0000-0000-0000-000000000000 |
command_id |
2 | zen_api.em.hardware.v1.CommandId | singular | the ZenApi.EM.Hardware.V1.CommandId of a given command. |
Message ExternalProcedureServiceReportCommandFailureResponse#
The ExternalProcedureServiceReportCommandFailureResponse class.
Message ExternalProcedureServiceReportCommandSuccessRequest#
The ExternalProcedureServiceReportCommandSuccessRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
id |
1 | string |
singular | the System.Guid of a given running script a command has been send to. default value could not be applied: 00000000-0000-0000-0000-000000000000 |
command_id |
2 | zen_api.em.hardware.v1.CommandId | singular | the ZenApi.EM.Hardware.V1.CommandId of a given command. |
Message ExternalProcedureServiceReportCommandSuccessResponse#
The ExternalProcedureServiceReportCommandSuccessResponse class.
Message ExternalProcedureServiceReportInitializationErrorRequest#
The ExternalProcedureServiceReportInitializationErrorRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
id |
1 | string |
singular | the id as System.Guid of the external procedure. default value could not be applied: 00000000-0000-0000-0000-000000000000 |
error_message |
2 | string |
singular | a System.String error message. |
Message ExternalProcedureServiceReportInitializationErrorResponse#
The ExternalProcedureServiceReportInitializationErrorResponse class.
Message ExternalProcedureServiceReportProgressRequest#
The ExternalProcedureServiceReportProgressRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
id |
1 | string |
singular | the id as System.Guid of the external procedure. default value could not be applied: 00000000-0000-0000-0000-000000000000 |
progress |
2 | double |
singular | The progress to be reported i the range [0, 1]. Alternatively, -1 for undetermined progress. |
Message ExternalProcedureServiceReportProgressResponse#
The ExternalProcedureServiceReportProgressResponse class.
Message ExternalProcedureServiceReportReadyRequest#
The ExternalProcedureServiceReportReadyRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
id |
1 | string |
singular | the id as System.Guid of the external procedure. default value could not be applied: 00000000-0000-0000-0000-000000000000 |
error_message |
2 | string |
singular | a nullable System.String to report an error during the execution of the last run. |
Message ExternalProcedureServiceReportReadyResponse#
The ExternalProcedureServiceReportReadyResponse class.
Message ExternalProcedureServiceReportStatusRequest#
The ExternalProcedureServiceReportStatusRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
id |
1 | string |
singular | the id as System.Guid of the external procedure. default value could not be applied: 00000000-0000-0000-0000-000000000000 |
message |
2 | string |
singular | the System.String to be reported. |
Message ExternalProcedureServiceReportStatusResponse#
The ExternalProcedureServiceReportStatusResponse class.