Common¶

class DeviceHandle¶

Reference to a specific device

Canonical

kortex_api.autogen.messages.Common_pb2.DeviceHandle

Parameters

device_type (DeviceTypes) – Device type
device_identifier (int) – Unique device identifier (used with other services)
order (int) – Unique value indicating the order of that device versus the others to facilitate representation

class Empty¶

Message used when no information needs to be exchanged between client application and robot, and vice versa

Canonical: kortex_api.autogen.messages.Common_pb2.Empty

class NotificationOptions¶

Specifies options associated to a notification

Canonical

kortex_api.autogen.messages.Common_pb2.NotificationOptions

Parameters

type (NotificationType) – Type of notification
rate_m_sec (int) – Rate value (in meters per second) (if applicable)
threshold_value (float) – Threshold value (if applicable)

class DiagnosticHandle¶

Reference to a specific diagnostic

Canonical

kortex_api.autogen.messages.Common_pb2.DiagnosticHandle

Parameters

identifier (int) – Diagnostic identifier
bank (DiagnosticBank) – Diagnostic bank

class NotificationHandle¶

Reference to a specific notification topic

Canonical: kortex_api.autogen.messages.Common_pb2.NotificationHandle
Parameters: identifier (int) – Notification identifier

class DiagnosticNotification¶

Notification about a single diagnostic event

Canonical

kortex_api.autogen.messages.Common_pb2.DiagnosticNotification

Parameters

diagnostic_handle (DiagnosticHandle) – Diagnostic handle
value (DiagnosticStatusValue) – New diagnostic status
generic_info (NotificationInformation) – Generic notification information

class Timestamp¶

Timestamp based on Epoch (00:00:00 Thursday, January 1, 1970)

Canonical

kortex_api.autogen.messages.Common_pb2.Timestamp

Parameters

sec (int) – Number of seconds that have elapsed since Epoch
usec (int) – Number of microseconds that have elapsed since the last second (0-999999)

class UserProfileHandle¶

Reference to a user profile

Canonical

kortex_api.autogen.messages.Common_pb2.UserProfileHandle

Parameters

identifier (int) – User profile identifier
permission (int) – Must use ‘Permission’ as bitwise (see enum Permission)

class UserRole¶

User Role

Canonical

kortex_api.autogen.messages.Common_pb2.UserRole

Parameters

identifier (str) –
permissions (UserPermission [ ]) –

class UserRoleList¶

User Role List

Canonical: kortex_api.autogen.messages.Common_pb2.UserRoleList
Parameters: roles (UserRole [ ]) –

class Connection¶

Connection between a user and the robot

Canonical

kortex_api.autogen.messages.Common_pb2.Connection

Parameters

user_handle (UserProfileHandle) – User profile handle. It is equal to 0 if the connection has not created a session.
connection_information (str) – Connection information
is_local (bool) – True if the connection was initiated from within the controller, false if it came from the external interface
session_identifier (int) – Session identifier of the connection. It is equal to 0 if the connection has not created a session.
connection_inactivity_timeout (int) – Inactivity period (in milliseconds) allowed before the robot stops any movement initiated from this session. It is equal to 0 if the connection has not created a session.
roles (UserRole [ ]) – Roles for the connection. It is empty if the connection has not created a session.
connection_type (ConnectionType) – Connection type
is_webapp (bool) – True if the connection is initiated by a WebApp client, false otherwise
username (str) – Username for the connection, if applicable

class ModeSelection¶

Selected mode information

Canonical: kortex_api.autogen.messages.Common_pb2.ModeSelection
Parameters: operating_mode (OperatingModeType) – Selected operating mode

class UARTConfiguration¶

UART configuration details This message is deprecated and will be removed in a future release.

Canonical

kortex_api.autogen.messages.Common_pb2.UARTConfiguration

Parameters

port_id (int) – UART port identification
enabled (bool) – True if UART device is enabled, false otherwise
speed (UARTSpeed) – Speed selection
word_length (UARTWordLength) – Word length
stop_bits (UARTStopBits) – Stop bits
parity (UARTParity) – Parity mode

class UARTDeviceIdentification¶

UART port id identification This message is deprecated and will be removed in a future release.

Canonical: kortex_api.autogen.messages.Common_pb2.UARTDeviceIdentification
Parameters: port_id (int) – UART device port id

class CountryCode¶

Country code

Canonical: kortex_api.autogen.messages.Common_pb2.CountryCode
Parameters: identifier (CountryCodeIdentifier) – ISO3166 country code identifier

class CartesianVector¶

A generic vector

Canonical

kortex_api.autogen.messages.Common_pb2.CartesianVector

Parameters

x (float) – Component X of the vector
y (float) – Component Y of the vector
z (float) – Component Z of the vector

class ActionHandle¶

Program Action handle

Canonical: kortex_api.autogen.messages.Common_pb2.ActionHandle
Parameters: identifier (int) –

class ProgramHandle¶

Program handle

Canonical

kortex_api.autogen.messages.Common_pb2.ProgramHandle

Parameters

identifier (int) –
permission (int) – Program permission. See ‘Kinova.Api.Common.Permission’ enum.

class Icon¶

Standard Icon Object

Canonical

kortex_api.autogen.messages.Common_pb2.Icon

Parameters

type (IconType) – Specifies the icon type format: SVG or PNG
data (str) – Icon raw image data, either SVG path <path> or Base64 encoded PNG image

class CustomData¶

Canonical

kortex_api.autogen.messages.Common_pb2.CustomData

Parameters

type (DataType) – Type of serialization for the “data” field
data (str) – The raw data.

class RotationMatrixRow¶

Single row of a 3x3 rotation matrix. To be a valid possible row of a rotation matrix, the norm of the row must be 1 (the sum of the squares of the row elements has to equal 1).

Canonical

kortex_api.autogen.messages.Common_pb2.RotationMatrixRow

Parameters

column1 (float) – Value between -1.0 and 1.0
column2 (float) – Value between -1.0 and 1.0
column3 (float) – Value between -1.0 and 1.0

class RotationMatrix¶

Representation of a 3x3 rotation matrix. To be a valid rotation matrix, the rows must be orthonormal (the rows must each have norm of 1 and the row vectors must be orthogonal to each other). The determinant of the matrix must also be +1.

Canonical

kortex_api.autogen.messages.Common_pb2.RotationMatrix

Parameters

row1 (RotationMatrixRow) – First rotation matrix row
row2 (RotationMatrixRow) – Second rotation matrix row
row3 (RotationMatrixRow) – Third rotation matrix row

class SymmetricMatrix3x3¶

Value needed from a 3X3 symmetric matrix

Canonical

kortex_api.autogen.messages.Common_pb2.SymmetricMatrix3x3

Parameters

ixx (float) – ixx value
ixy (float) – ixy value
ixz (float) – ixz value
iyy (float) – iyy value
iyz (float) – iyz value
izz (float) – izz value

class Matrix3x3¶

Value needed from a 3X3 matrix

Canonical

kortex_api.autogen.messages.Common_pb2.Matrix3x3

Parameters

ixx (float) – ixx value
ixy (float) – ixy value
ixz (float) – ixz value
iyx (float) – iyx value
iyy (float) – iyy value
iyz (float) – iyz value
izx (float) – izx value
izy (float) – izy value
izz (float) – izz value

class LocalFileDescriptor¶

File informations

Canonical

kortex_api.autogen.messages.Common_pb2.LocalFileDescriptor

Parameters

id (int) – Reference ID for file
file_name (str) – File name
size (int) – File size in bytes
type (FileType) – File type

class FileList¶

List of file descriptors

Canonical: kortex_api.autogen.messages.Common_pb2.FileList
Parameters: files (LocalFileDescriptor [ ]) – File descriptor list

class FileId¶

File reference identifier

Canonical: kortex_api.autogen.messages.Common_pb2.FileId
Parameters: id (int) – File reference ID

class StorageMountPoint¶

Mount point information corresponding to storage

Canonical

kortex_api.autogen.messages.Common_pb2.StorageMountPoint

Parameters

uid (int) – Mount point unique ID
name (str) – Mount point name
full_path (str) – Mount point full path

class StorageMountPointList¶

List of storage mount points

Canonical: kortex_api.autogen.messages.Common_pb2.StorageMountPointList
Parameters: mount_points (StorageMountPoint [ ]) – List of mount points

class FSPath¶

Path descriptor for removable storage

Canonical

kortex_api.autogen.messages.Common_pb2.FSPath

Parameters

path (str) – Path relative to mount point
mount_point_id (int) – Mount point in which item is found

class FSItem¶

Filesystem item descriptor

Canonical

kortex_api.autogen.messages.Common_pb2.FSItem

Parameters

path (FSPath) – Item path relative to mount point
type (FSItemType) – Type: file or directory
size (int) – Size in bytes
timestamp (Timestamp) – Timestamp of last modification

class FSItemList¶

File system item list

Canonical: kortex_api.autogen.messages.Common_pb2.FSItemList
Parameters: items (FSItem [ ]) – File system item list

class NotificationInformation¶

General informations about a notification

Canonical

kortex_api.autogen.messages.Common_pb2.NotificationInformation

Parameters

severity (NotificationSeverity) – Severity of the notification
timestamp (Timestamp) – Event timestamp
connection (Connection) – Connection that caused the event

class CRC32Checksum¶

CRC-32 checksum

Canonical: kortex_api.autogen.messages.Common_pb2.CRC32Checksum
Parameters: crc32 (int) – CRC-32 checksum