ProgramRunner

class StateChangeNotification

Describes state change notification

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.StateChangeNotification

Parameters

  • sequence (StateSequence) – Sequence of actions executed when a program is playing

  • timestamp (Timestamp) – This field is deprecated and will be removed in a future release

  • connection (Connection) – This field is deprecated and will be removed in a future release

  • generic_info (NotificationInformation) – Generic notification information

class VariableState

Describes the state of a variable

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.VariableState

Parameters

  • identifier (str) – Variable unique identifier

  • value (str) – Current value

class StatusInformation

Describes the status of the Runner

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.StatusInformation

Parameters

  • status (Status) – Current status of the Runner

  • current_handles (ContextualizedRunnableHandles) – Handles to identify what is running or paused

  • start_operating_mode (OperatingModeType) – Operating mode at program start. Is OPERATING_MODE_UNSPECIFIED when runner status is STATUS_IDLE.

class StatusChangeNotification

Status event that is sent when program runner status changed. Use GetStatus for initial status discovery

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.StatusChangeNotification

Parameters

  • status_info (StatusInformation) – New status info

  • timestamp (Timestamp) – This field is deprecated and will be removed in a future release

  • connection (Connection) – This field is deprecated and will be removed in a future release

  • generic_info (NotificationInformation) – Generic notification information

class ExecutionEventNotification

Notification about a program execution event

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.ExecutionEventNotification

Parameters

  • event (ExecutionEvent) – Occured event

  • handle (RunnableHandle) – Handle to identify what is the runnable that is affected by the notification

  • payload (str) – Generic payload (JSON) whose content depends on the event. Can be a feedback, a reason or an output depending on the event

  • timestamp (Timestamp) – This field is deprecated and will be removed in a future release

  • connection (Connection) – This field is deprecated and will be removed in a future release

  • field_feedbacks (JSONFieldFeedback [ ]) – Field feedbacks in the Action form at runtime (optional)

  • generic_info (NotificationInformation) – Generic notification information

class ActionList

List of all available actions

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.ActionList

Parameters

actionList (PluginAction [ ]) –

class RunnableHandle

Handle to identify a runnable

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.RunnableHandle

Parameters
class ContextualizedActionHandle

Handle to identify a contextualized action

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.ContextualizedActionHandle

Parameters

  • handle (ActionHandle) – Handle of the action

  • context_action_ids (int [ ]) – This context is used to differentiate actions running in SubPrograms

class RunnableHandles

Handles to identify the runnables

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.RunnableHandles

Parameters
class ContextualizedRunnableHandles

Handles to identify the contextualized runnables

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.ContextualizedRunnableHandles

Parameters
class ProgramStartConfiguration

Program start configuration

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.ProgramStartConfiguration

Parameters

  • debug_mode (bool) – Is the program running in debug mode

  • handle (RunnableHandle) – Handle to identify what is the runnable

class ActionsStartConfiguration

Actions start configuration

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.ActionsStartConfiguration

Parameters

  • debug_mode (bool) – Are the actions running in debug mode

  • handle (RunnableHandles) – Handles to identify what are the runnables

  • variables (Variable [ ]) – Variables required to operate the actions

class ProgramValidationConfiguration

Program validation configuration

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.ProgramValidationConfiguration

Parameters

  • is_valid (bool) – True if the program is valid, false otherwise

  • program_handle (ProgramHandle) – Handle of the program

class PluginAction

Plugin Action

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.PluginAction

Parameters
class StateEvent

State event

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.StateEvent

Parameters

  • payload (str) – Generic payload (JSON) that changes depending on its type

  • timestamp (Timestamp) – Event timestamp

  • type (StateEventType) – Event type

class StateActionSnapshot

State action snapshot

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.StateActionSnapshot

Parameters

  • state (str) – Generic action state (JSON) that changes depending on action type

  • timestamp (Timestamp) – Snapshot timestamp

  • variables (VariableState [ ]) – Values of the variables when taking the snapshot

class StateActionStats

State action stats

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.StateActionStats

Parameters

  • execution_duration (int) – Duration (in milliseconds) of the execution of the action (without pre/post-processing)

  • failure_count (int) – Number of times a failure occured

  • pause_count (int) – Number of times an action has been paused

  • pause_duration (int) – How long (in milliseconds) an action has been paused

  • play_count (int) – Number of times the action has been played

  • play_duration (int) – How long (in milliseconds) an action has been playing

  • plugin_start_confirmation (int) – How long (in milliseconds) a plugin action has been waiting for the confirmation that it started

  • total_duration (int) – How long (in milliseconds) an action has been running

class StateAction

State action - all the events/snapshots/stats collected during the execution of an action

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.StateAction

Parameters
class StateSequenceStats

Sequence stats

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.StateSequenceStats

Parameters

  • average_time_between_actions (int) – Sequencer’s average time between 2 actions (milliseconds)

  • average_time_plugin_start_confirmation (int) – Average time between the moment the sequencer starts a plugin action and the moment it receives a confirmation that the plugin started (milliseconds)

  • average_time_waypoint_initialization (int) – Average time between the moment the sequencer receives a start confirmation for a waypoint action and the moment the robot actually starts to move (milliseconds)

  • average_time_action_processing (int) – Average time it takes for the pre/post-processing of an action

  • duration (int) – Total duration of the sequence (milliseconds)

  • end (Timestamp) – Sequence end timestamp

  • start (Timestamp) – Sequence start timestamp

class StateSequence

State sequence - list of actions with an identifier

Canonical

kortex_api.autogen.messages.ProgramRunner_pb2.StateSequence

Parameters

  • identifier (str) – Sequence identifier

  • actions (StateAction [ ]) – Actions that were played during the execution of a program

  • init_variables (VariableState [ ]) – Initial values of the variables when the program starts to play

  • pre_play_events (StateEvent [ ]) – Events that were captured before the first action is started

  • stats (StateSequenceStats) – Sequence stats

  • is_main (bool) – True if it is the main sequence of the program, otherwise (ex: thread) false