The official repository contains documentation and examples explaining how to use the KINOVA® KORTEX 3™ API client with Python. The repository has been tested on Windows 10 and Ubuntu 20.04.
- Description
- Licensing
- Role of Google Protocol Buffer in Kortex API
- Download links
- Build and Run instructions
- Reference - Useful Links
This repository is licenced under the BSD 3-Clause "Revised" License
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.
To run the Python examples you will need to install the Python interpreter and the pip installation module.
Here is some general information about the Python interpreter and the pip module manager.
- Python General Information
- API mechanism
- Transport / Router / Session / Notification
- Device routing
- Error management
- Examples
The robot handle the communication via Modbus and Ethernet/IP. This is done via the FieldBusAdapter plugin provided by Kinova.
Before getting started, please review the release notes to learn about any limitations or known issues of the Kortex API for Link 6. Ensure proper training from reviewing the user guide on how to safely use the product.
| Firmware | Release notes | API |
|---|---|---|
| 3.3.0 | release notes | 3.3.0 |
| 3.2.0 | release notes | 3.2.0 |
| Kinova home page: | https://www.kinovarobotics.com |
| Google Protocol Buffers home page: | https://developers.google.com/protocol-buffers |