Common

class DeviceTypes

Admissible device types

Canonical

kortex_api.autogen.messages.Common_pb2.DeviceTypes

UNSPECIFIED_DEVICE_TYPE (0):   Unspecified device type

BASE (1):   Base module

VISION (2):   Vision module

BIG_ACTUATOR (3):   Big actuator module

SMALL_ACTUATOR (4):   Small actuator module

INTERCONNECT (5):   Interface module

GRIPPER (6):   Gripper module

MEDIUM_ACTUATOR (7):   Medium actuator module

XBIG_ACTUATOR (8):   XBig actuator module

ACTUATOR_SAFETY_MCU (9):   Actuator safety MCU

SCU (10):   Safety Control Unit module

class DiagnosticStatusValue

Admissible diagnostic statuses

Canonical

kortex_api.autogen.messages.Common_pb2.DiagnosticStatusValue

DIAGNOSTIC_STATUS_UNSPECIFIED (0):   Unspecified diagnostic status

DIAGNOSTIC_STATUS_WARNING (1):   Warning diagnostic reached

DIAGNOSTIC_STATUS_ERROR (2):   Error diagnostic reached

DIAGNOSTIC_STATUS_NORMAL (3):   Diagnostic is off

class Permission

Admissible permissions. Used as bitfields

Canonical

kortex_api.autogen.messages.Common_pb2.Permission

NO_PERMISSION (0):   No permission

READ_PERMISSION (1):   Read permission. Refers to an entity that can be read

UPDATE_PERMISSION (2):   Update permission. Refers to an entity that can be modified

DELETE_PERMISSION (4):   Delete permission. Refers to an entity that can be deleted

class NotificationType

Admissible notification types

Canonical

kortex_api.autogen.messages.Common_pb2.NotificationType

NOTIFICATION_TYPE_UNSPECIFIED (0):

NOTIFICATION_TYPE_FIX_RATE(2):   Fix rate notification. Refers to a notification sent at a predetermined fix rate (not implemented yet)

NOTIFICATION_TYPE_EVENT (3):   Event type notification. Refers to a notification sent in response to an event

class Unit

Admissible units used throughout API methods

Canonical

kortex_api.autogen.messages.Common_pb2.Unit

UNSPECIFIED_UNIT (0):   Unspecified unit

CELSIUS (1):   Degree Celsius

AMPERE (2):   Ampere

VOLT (3):   Volt

METER_PER_SECOND (4):   Meter per second

DEGREE_PER_SECOND (5):   Degree per second

METER_PER_SECOND_2 (6):   Meter per second squared

DEGREE_PER_SECOND_2 (7):   Degree per second squared

NEWTON (8):   Newton

NEWTON_METER (9):   Newton * meter

KILOGRAM (10):   Kilogram

DEGREE (11):   Degree

TICK (12):   Tick

DEGREE_PER_MILLISECOND (13):   Degre per millisecond

MICROSECOND(14):   Microsecond (us)

class DiagnosticBank

Canonical

kortex_api.autogen.messages.Common_pb2.DiagnosticBank

UNSPECIFIED_DIAGNOSTIC_BANK (0):

DIAGNOSTIC_BANK_A (1):

DIAGNOSTIC_BANK_B (2):

DIAGNOSTIC_BANK_C (3):

DIAGNOSTIC_BANK_D (4):

class UserPermission

User permissions associated with User Roles

Canonical

kortex_api.autogen.messages.Common_pb2.UserPermission

USER_PERMISSION_UNSPECIFIED (0):

USER_PERMISSION_OPERATE (1):

USER_PERMISSION_CONFIGURE (2):

USER_PERMISSION_SAFETIES (3):

USER_PERMISSION_SYSTEM (4):

USER_PERMISSION_READ_ONLY (5):

class ConnectionType

Canonical

kortex_api.autogen.messages.Common_pb2.ConnectionType

CONNECTION_TYPE_UNSPECIFIED (0):   Unspecified connection type

CONNECTION_TYPE_MQTT_TCP (1):   MQTT connection through TCP

CONNECTION_TYPE_MQTT_WEBSOCKET (2):   MQTT connection through Websocket

CONNECTION_TYPE_UDP (3):   UDP connection

class ArmState

Admissible robot arm states

Canonical

kortex_api.autogen.messages.Common_pb2.ArmState

ARMSTATE_UNSPECIFIED (0):   Unspecified arm state

ARMSTATE_BASE_INITIALIZATION (1):   Cannot be reported as the Base initialization must be completed before allowing user connection. This state is deprecated

ARMSTATE_IDLE (2):   Arm is in idle mode waiting to be initialized

ARMSTATE_INITIALIZATION (3):   Arm is being initialized

ARMSTATE_IN_FAULT (4):   Arm is in fault

ARMSTATE_MAINTENANCE (5):   Arm is in maintenance

ARMSTATE_SERVOING_LOW_LEVEL (6):   Arm is in low-level servoing mode

ARMSTATE_SERVOING_READY (7):   Arm is ready to be controlled. This state will eventually be deprecated

ARMSTATE_SERVOING_PLAYING_SEQUENCE (8):   Arm is currently being controlled via a sequence. This state will eventually be deprecated

ARMSTATE_SERVOING_MANUALLY_CONTROLLED (9):   Arm is currently being controlled manually. This state will eventually be deprecated

ARMSTATE_BRAKE_RELEASING (10):   Arm brakes are released

ARMSTATE_POSITION_UNKNOWN (11):   Arm joint positions are unknown. This state is deprecated

ARMSTATE_ARM_OPERATIONAL (12):   Arm is operational

ARMSTATE_RECOVERY (13):   Arm is recovering from a fault

ARMSTATE_CONTROLLER_INITIALIZATION (14):   State in which the mpu is doing its self test and updating the safety control unit firmware

ARMSTATE_WAIT_FOR_POSITION_CONFIRMATION (15):   Arm is waiting for the user to confirm that its position is valid

ARMSTATE_IN_FAULT_POWERED_OFF (16):   Arm is in fault and powered off

ARMSTATE_IN_UNRECOVERABLE_FAULT (17):   Arm is in unrecoverable fault

class OperatingModeType

Operating mode type

Canonical

kortex_api.autogen.messages.Common_pb2.OperatingModeType

OPERATING_MODE_UNSPECIFIED (0):   Unspecified operating mode

OPERATING_MODE_JOG_MANUAL (1):   Jog manual operating mode

OPERATING_MODE_HAND_GUIDING (2):   Hand guiding operating mode

OPERATING_MODE_HOLD_TO_RUN (3):   Hold to run operating mode

OPERATING_MODE_AUTO (4):   Automatic operating mode

OPERATING_MODE_MONITORED_STOP (5):   Monitored stop operating mode

class UARTSpeed

Admissible UART baudrates This enum is deprecated and will be removed in a future release. It will be replaced with “Kinova.Api.SerialCommunication.BaudRate”.

Canonical

kortex_api.autogen.messages.Common_pb2.UARTSpeed

UART_SPEED_UNSPECIFIED (0):   Unspecified UART speed

UART_SPEED_4800 (1):   4800 bps

UART_SPEED_9600 (2):   9600 bps

UART_SPEED_19200 (3):   19200 bps

UART_SPEED_38400 (4):   38400 bps

UART_SPEED_57600 (5):   57600 bps

UART_SPEED_115200 (6):   115200 bps

UART_SPEED_230400 (7):   230400 bps

UART_SPEED_460800 (8):   460800 bps

UART_SPEED_921600 (9):   921600 bps

UART_SPEED_1382400 (10):   1382400 bps

UART_SPEED_1612800 (11):   1612800 bps

UART_SPEED_1843200 (12):   1843200 bps

UART_SPEED_2073600 (13):   2073600 bps

UART_SPEED_2188800 (14):   2188800 bps

UART_SPEED_2246400 (15):   2246400 bps

class UARTWordLength

Admissible UART word lengths This enum is deprecated and will be removed in a future release. It will be replaced with “Kinova.Api.SerialCommunication.WordLength”.

Canonical

kortex_api.autogen.messages.Common_pb2.UARTWordLength

UART_WORD_LENGTH_UNSPECIFIED (0):   Unspecified UART word length

UART_WORD_LENGTH_7 (1):   7 bits

UART_WORD_LENGTH_8 (2):   8 bits

UART_WORD_LENGTH_9 (3):   9 bits

class UARTStopBits

Admissible UART stop bits This enum is deprecated and will be removed in a future release. It will be replaced with “Kinova.Api.SerialCommunication.StopBits”.

Canonical

kortex_api.autogen.messages.Common_pb2.UARTStopBits

UART_STOP_BITS_UNSPECIFIED (0):   Unspecified UART stop bits

UART_STOP_BITS_0_5 (1):   0.5 stop bit

UART_STOP_BITS_1 (2):   1 stop bit

UART_STOP_BITS_1_5 (3):   1.5 stop bits

UART_STOP_BITS_2 (4):   2 stop bits

class UARTParity

Admissible UART parity mode This enum is deprecated and will be removed in a future release. It will be replaced with “Kinova.Api.SerialCommunication.Parity”.

Canonical

kortex_api.autogen.messages.Common_pb2.UARTParity

UART_PARITY_UNSPECIFIED (0):   Unspecified UART parity

UART_PARITY_NONE (1):   No parity

UART_PARITY_ODD (2):   Odd parity

UART_PARITY_EVEN (3):   Even parity

class CartesianReferenceFrame

Admissible Cartesian reference frame modes

Canonical

kortex_api.autogen.messages.Common_pb2.CartesianReferenceFrame

CARTESIAN_REFERENCE_FRAME_UNSPECIFIED (0):   Unspecified Cartesian reference frame

CARTESIAN_REFERENCE_FRAME_MIXED (1):   Mixed reference frame where translation reference = base and  orientation reference = tool

CARTESIAN_REFERENCE_FRAME_TOOL (2):   Tool reference frame where translation reference = tool and orientation reference = tool

CARTESIAN_REFERENCE_FRAME_BASE (3):   Base reference frame where the translation reference = base and orientation reference = base

class CountryCodeIdentifier

Supported ISO3166 country identifiers

Canonical

kortex_api.autogen.messages.Common_pb2.CountryCodeIdentifier

UNSPECIFIED_COUNTRY_CODE (0):

UNITED_ARAB_EMIRATES_AE (1):

ANTIGUA_AND_BARBUDA_AG (2):

ANGUILLA_AI (3):

ALBANIA_AL (4):

AMERICAN_SAMOA_AS (5):

AUSTRIA_AT (6):

AUSTRALIA_AU (7):

ARUBA_AW (8):

AZERBAIJAN_AZ (9):

BOSNIA_AND_HERZEGOVINA_BA (10):

BANGLADESH_BD (11):

BELGIUM_BE (12):

BULGARIA_BG (13):

BAHRAIN_BH (14):

BERMUDA_BM (15):

BRUNEI_DARUSSALAM_BN (16):

BRAZIL_BR (17):

BAHAMAS_BS (18):

BELARUS_BY (19):

SWITZERLAND_CH (20):

CANADA_CA (21):

CHINA_CN (22):

COLOMBIA_CO (23):

COSTA_RICA_CR (24):

CYPRUS_CY (25):

CZECH_REPUBLIC_CZ (26):

GERMANY_DE (27):

DENMARK_DK (28):

ECUADOR_EC (29):

ESTONIA_EE (30):

EGYPT_EG (31):

SPAIN_ES (32):

ETHIOPIA_ET (33):

FINLAND_FI (34):

FRANCE_FR (35):

UNITED_KINGDOM_GB (36):

GRENADA_GD (37):

FRENCH_GUIANA_GF (38):

GUADELOUPE_GP (39):

GREECE_GR (40):

GUATEMALA_GT (41):

GUAM_GU (42):

HONG_KONG_HK (43):

CROATIA_HR (44):

HUNGARY_HU (45):

INDIA_IN (46):

INDONESIA_ID (47):

IRELAND_IE (48):

ISRAEL_IL (49):

ICELAND_IS (50):

ITALY_IT (51):

JORDAN_JO (52):

JAPAN_JP (53):

CAMBODIA_KH (54):

REPUBLIC_OF_KOREA_KR (55):

KUWAIT_KW (56):

CAYMAN_ISLANDS_KY (57):

LAO_PDR_LA (58):

LEBANON_LB (59):

LIECHTENSTEIN_LI (60):

SRI_LANKA_LK (61):

LESOTHO_LS (62):

LITHUANIA_LT (63):

LUXEMBOURG_LU (64):

LATVIA_LV (65):

MOROCCO_MA (66):

MONACO_MC (67):

MOLDOVA_MD (68):

MONTENEGRO_ME (69):

REPUBLIC_OF_MACEDONIA_MK (70):

MONGOLIA_MN (71):

MARTINIQUE_MQ (72):

MAURITANIA_MR (73):

MALTA_MT (74):

MAURITIUS_MU (75):

MALDIVES_MV (76):

MALAWI_MW (77):

MEXICO_MX (78):

MALAYSIA_MY (79):

NICARAGUA_NI (80):

NETHERLANDS_NL (81):

NORWAY_NO (82):

NEW_ZEALAND_NZ (83):

OMAN_OM (84):

PANAMA_PA (85):

PERU_PE (86):

PHILIPPINES_PH (87):

POLAND_PL (88):

PUERTO_RICO_PR (89):

PORTUGAL_PT (90):

PARAGUAY_PY (91):

REUNION_RE (92):

ROMANIA_RO (93):

SERBIA_RS (94):

RUSSIAN_FEDERATION_RU (95):

SWEDEN_SE (96):

SINGAPORE_SI (97):

SLOVAKIA_SK (98):

EL_SALVADOR_SV (99):

THAILAND_TH (100):

TUNISIA_TN (101):

TURKEY_TR (102):

TRINIDAD_AND_TOBAGO_TT (103):

TAIWAN_PROVINCE_OF_CHINA_TW (104):

UKRAINE_UA (105):

UNITED_STATES_US (106):

HOLY_SEE_VATICAN_CITY_STATE_VA (107):

BOLIVARIAN_REPUBLIC_OF_VENEZUELA_VE (108):

BRITISH_VIRGIN_ISLANDS_VG (109):

VIETNAM_VN (110):

MAYOTTE_YT (111):

SOUTH_AFRICA_ZA (112):

class DataType

Data Type for configurations

Canonical

kortex_api.autogen.messages.Common_pb2.DataType

CONFIGURATION_TYPE_UNSPECIFIED (0):

CONFIGURATION_TYPE_JSON (1):

class IconType

Icon Type for Icon

Canonical

kortex_api.autogen.messages.Common_pb2.IconType

ICON_TYPE_UNSPECIFIED (0):

ICON_TYPE_SVG (1):

class ConfigurationNotificationEvent

Admissible configuration events

Canonical

kortex_api.autogen.messages.Common_pb2.ConfigurationNotificationEvent

UNSPECIFIED_CONFIGURATION_EVENT (0):   Unspecified configuration event

CONFIGURATION_UPDATED (1):   Configuration deleted

CONFIGURATION_DELETED (2):   Configuration updated

CONFIGURATION_DELETED_ALL (3):   All configurations deleted

CONFIGURATION_CREATED (4):   Configuration created

class FileType

File type

Canonical

kortex_api.autogen.messages.Common_pb2.FileType

FILETYPE_UNSPECIFIED (0):   No information provided

FILETYPE_SWU (1):   Robot upgrade file

FILETYPE_KP (2):   Plugin upgrade file

class FSItemType

Files system item type

Canonical

kortex_api.autogen.messages.Common_pb2.FSItemType

UNSPECIFIED_FSITEMTYPE (0):   Unspecified File system item type

FSITEMTYPE_FILE (1):   File item type

FSITEMTYPE_DIRECTORY (2):   Directory item type

class NotificationSeverity

Notification severity level

Canonical

kortex_api.autogen.messages.Common_pb2.NotificationSeverity

NOTIF_DEBUG (0):   Debugging stuff

NOTIF_INFO (1):   Information

NOTIF_WARNING (2):   A warning

NOTIF_ERROR (3):   An error

NOTIF_CRITICAL (4):   A critical error