ProgramRunner

class ServiceVersion

Identifies ProgramRunner service current version

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.ServiceVersion

RESERVED_0 (0):   Reserved

CURRENT_VERSION (1):   Current version

class Status

All possible statuses of the Runner

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.Status

STATUS_UNSPECIFIED (0):

STATUS_IDLE (1):   Runner is idle. It can be started via Start or StartActions rpcs

STATUS_RUNNING (2):   Runner is running a program or action

STATUS_PAUSED (3):   Runner has paused the execution of a program or action.

STATUS_STARTING (4):   Runner is about to start a program or action. Runner is STARTING while it setups the Plugin action.

STATUS_STOPPING (5):   Runner is about to stop its execution. Runner is STOPPING while it teardowns the Plugin action.

STATUS_PAUSED_AUTOMATIC_RESUME (6):   Runner has paused the execution of a program or action, but it will resume automatically.

STATUS_WAITING_FOR_ACKNOWLEDGE (7):   Runner is waiting for an acknowledge action before starting a program in auto mode.

class ExecutionEvent

All possible events during a program execution

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.ExecutionEvent

EXECUTION_EVENT_UNSPECIFIED (0):

EXECUTION_EVENT_COMPLETED (1):

EXECUTION_EVENT_FAILED (2):

EXECUTION_EVENT_FEEDBACK (3):

EXECUTION_EVENT_PAUSED (4):

EXECUTION_EVENT_RESUMED (5):

EXECUTION_EVENT_STARTED (6):

EXECUTION_EVENT_STOPPED (7):

class StateEventType

State event type

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.StateEventType

STATE_EVENT_TYPE_UNSPECIFIED (0):   Unknown event

STATE_EVENT_TYPE_ACTION_CONFIGURATION_INTERPOLATION(1):   When an action configuration is interpolated (variables replaced by their values)

STATE_EVENT_TYPE_ACTION_FAILURE (2):   Action failures

STATE_EVENT_TYPE_ACTION_ENDED (3):   Action ended

STATE_EVENT_TYPE_ACTION_STARTED (4):   Action started

STATE_EVENT_TYPE_ACTION_STATE_CHANGED (5):   Action state change

STATE_EVENT_TYPE_ACTION_STATUS_CHANGED (6):   Action status change

STATE_EVENT_TYPE_HOOK (7):   When an action communicates with an external source

STATE_EVENT_TYPE_PLUGIN_ACTION_COMPLETED (8):   Plugin action is completed

STATE_EVENT_TYPE_PLUGIN_ACTION_CONFIRMATION (9):   When an action receives confirmation by a plugin action that it is playing, paused, etc.

STATE_EVENT_TYPE_SEQUENCER_FAILURE (10):   Sequencer failure

STATE_EVENT_TYPE_VARIABLE_CHANGED (11):   When a variable is added/changed