ProgramConfig

class Action

Program Action instance

Canonical

kortex_api.autogen.messages.ProgramConfig_pb2.Action

Parameters

  • handle (ActionHandle) – Handle to identify the action

  • next (ActionHandle) – ActionHandle indicating which action is next

  • name (str) – Friendly name for the action

  • plugin_action_handle (PluginActionHandle) – Handle to indicate which plugin action this action is implementing (optional)

  • configuration (str) – Execution steps of the action (JSON)

  • store_output_to (ActionOutputStorer) – Variable in which the action output will be stored (optional)

  • type (ActionType) – Type of the action

  • branches (ActionHandle [ ]) – Array of branches representing the start action of each branch

  • blocking (bool) – Indicates if the action is blocking. If set to true, this action must be completed before playing the next action. If set to false, the next action can immediately be played.

class ActionOutputStorer

Variable in which the action output will be stored

Canonical

kortex_api.autogen.messages.ProgramConfig_pb2.ActionOutputStorer

Parameters

  • identifier (str) – Variable identifier

  • schema_key (str) – Key of the schema used to type a json variable

  • type (VariableType) – Variable type

class PluginActionHandle

Handle to uniquely identify a plugin’s action

Canonical

kortex_api.autogen.messages.ProgramConfig_pb2.PluginActionHandle

Parameters

  • action_handle (ActionDescriptionHandle) – Handle to identify an action within the context of a plugin

  • plugin_handle (PluginHandle) – Handle for the parent plugin of the action

class ConfigurationChangeNotification

Notification about a change in the configuration of Programs

Canonical

kortex_api.autogen.messages.ProgramConfig_pb2.ConfigurationChangeNotification

Parameters
class ProgramVariable

Program Variables

Canonical

kortex_api.autogen.messages.ProgramConfig_pb2.ProgramVariable

Parameters

  • variable (Variable) – Variable Info

  • bool_default_value (bool) – Default Boolean value (only filled if variable.type is VARIABLE_TYPE_BOOL)

  • number_default_value (float) – Default Number value (only filled if variable.type is VARIABLE_TYPE_NUMBER)

  • string_default_value (str) – Default String value (only filled if variable.type is VARIABLE_TYPE_STRING or VARIABLE_TYPE_JSON)

  • is_persistent (bool) – Indicates if the variable will be persisted in database after the program ends

  • is_input (bool) – Indicates if the variable is used as an input of the program

  • is_output (bool) – Indicates if the variable is used as an output of the program

  • is_required (bool) – Indicates if the variable must be set before the program starts (only applies if is_input equals true)

  • has_default_value (bool) – Indicates if the variable has a default value

class Program

Program instance

Canonical

kortex_api.autogen.messages.ProgramConfig_pb2.Program

Parameters

  • actions (Action [ ]) – Actions of the program

  • handle (ProgramHandle) – Handle to identify the program

  • name (str) – Friendly name of the program

  • variables (ProgramVariable [ ]) – List of program variables

  • is_validated (bool) – True if the program has been validated, false otherwise

class ProgramList

List of programs

Canonical

kortex_api.autogen.messages.ProgramConfig_pb2.ProgramList

Parameters

programs (Program [ ]) –

class ProgramJSON

Program instance as JSON

Canonical

kortex_api.autogen.messages.ProgramConfig_pb2.ProgramJSON

Parameters

payload (str) – JSON representing a Kinova.Api.ProgramConfig.Program

class ProgramOptions

Defines the value of the Program options

Canonical

kortex_api.autogen.messages.ProgramConfig_pb2.ProgramOptions

Parameters

need_acknowledge_before_run_auto (bool) – True if acknowledge is needed before running a program in automatic mode, false otherwise.