readme.md

Python examples

Table of Contents

• Setup (Python environment)
  • Required Python version and module
  • Install Kortex Python API and required dependencies
• How to use the examples
• Python API documentation
• Reference - useful links
  • Back to root topic: readme.md

Setup (Python environment)

Required Python version and module

• Python >= 3.5
• pip

Refer to the main README for Python installation details: parent readme

Install Kortex Python API and required dependencies

Install what is needed to run the examples via a downloaded whl file (Python wheel package).

The whl file can be downloaded via the Kinova Artifactory: kortex_api

On Linux:

python3 -m pip install <whl relative fullpath name>.whl

Note: root privilege is usually required to install a new module under Linux.

On Windows:

python -m pip install <whl relative fullpath name>.whl

How to use the examples

We assume the robot is using its default IP address: 192.168.1.10

Before starting, ensure that you run the test in a safe area with some examples that contain movement. Also, verify that your robot is correctly afixed to the working surface.

Prerequisites:

• The examples require a wired network connection to your computer
• Configure a static IP address on your network interface (e.g. 192.168.1.11/24)

Now you're ready to run the examples. Each Python example has its own __main__ instruction. You need only to cd into the example directory and invoke the Python file using the command:

• On Linux:

python3 <example-file>.py

• On Windows:

python <example-file>.py

Python API documentation

Here's a link to the generated documentation
Python API Services Documentation

Reference

useful links

Google Proto Buffer generated Python:	https://developers.google.com/protocol-buffers/docs/reference/python-generated

---

Back to root topic: readme.md