/kortex

KINOVA® KORTEX™ API Reference

Primary LanguageC++OtherNOASSERTION

KINOVA® KORTEX™ API Reference

Description

The official repository contains documentation and examples explaining how to use the KINOVA® KORTEX™ API client with C++ or Python:

https://github.com/Kinovarobotics/kortex

Table of Contents

Licensing

This repository is licenced under the BSD 3-Clause "Revised" License

Role of Google Protocol Buffer in Kortex API

The Kortex API uses Google Protocol Buffer message objects1 to exchange data between client and server.

Google Protocol Buffer offers structured data objects with standard methods for each member field:

  • structured, nested objects
  • basic types and collections
  • getter/setter methods on basic types
  • iterators, dimension and appending methods on collections
  • many helpers (e.g. serialize/deserialize, I/O functions)

When using the Kortex API a developer will need to understand the Google Protocol Buffer feature set to maximize their efficiency.

Quick Start for C++ users

The following links provide some helpful guidance for C++ developer. You will find information about Kortex mechanism and some code examples.

Quick Start for Python users

To run the Python examples you will need to install the Python interpreter and the pip installation module.

Note that for C++ developers it could be useful to install the Python Kortex API to allow for quick tests and validations.

Here is some general information about the Python interpreter and the pip module manager.

Download links

Download the latest SWU firmware package

Download the Kortex API

Download the latest release notes

More details are in: Language-specific details

Language-specific details

C++ API
Python API

Reference

Useful Links
Kinova home page: https://www.kinovarobotics.com
Google Protocol Buffers home page: https://developers.google.com/protocol-buffers