KINOVA^® KORTEX™ API Reference

Description

The official repository containing documentation and examples explaining how to use the KINOVA^® KORTEX™ API client with multiple languages (C++, Python).

Kortex GitHub: https://github.com/Kinovarobotics/kortex

Table Of Contents

• Description
• Licensing
• Role of Google Protobuf in Kortex API
  • Quick Start HowTo Python
• API Download Links
• API details for a specific language
• Reference - Useful Links

Licensing

Note that this repository is licenced under the BSD 3-Clause "Revised" License: LICENSE File

Role of Google Protobuf in Kortex API

The Kortex API is using Google Protobuf message objects¹ for exhange data between client & server side.

Protobuf offers structured data objects with standard methods for each member field.
Here are their main features:

• structured nested objects
• basic types & collections
• getters/setters/has methods on basic types
• iterators, dimension & appending methods on collections
• many helpers (ex: serialize/deserialize, io functions)

When using the Kortex API a developer will have to understand the protobuf features set to maximize his efficiency.

Quick Start HowTo Python

To run Python examples you will need to install at least the python interpreter and the Pip installation module.
Note that even for C++ developper it could be usefull to install the Python Kortex API. That will allow quick tests and validations.

Here some general information about python interpreter & pip modules' manager.
Python General Information

API Download Links

Download the archive via the Kinova goggle drive: kortex_api
More details about it in following section: API details for a specific language

API details for a specific language

C++ API
Python API

Reference

Useful Links

Kinova home page:	https://www.kinovarobotics.com
Google Protobuf home page:	https://developers.google.com/protocol-buffers