This folder contains the Python API installation process, as well as examples going over the main functionalities of the API. The full documentation of the API is available at https://docs.kinovarobotics.com/index.html . If you have any questions, reach out to us at [email protected].
- Description
- Setup (Python environment)
- How to use the examples
- Reference
- Back to root topic: readme.md
- Python >= 3.9
- pip
Refer to the python quick start for Python installation details: python_quick_start
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>.whlNote: root privilege is usually required to install a new module under Linux.
On Windows:
python -m pip install <whl relative fullpath name>.whlWe assume the robot is using its default IP address: 192.168.1.10
If you don't use the default IP address, you can add the argument --ip with the right IP of the robot.
python3 --ip 192.168.2.22 <example-file>.pyBefore starting, ensure that you run the test in a safe area since some examples contain wide movements at full speed (default behaviour, but you can reduce speeds by modyfing the example code). Also, verify that your robot is correctly fixed 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)
Some examples may require json programs to be uploaded on your controller to be able to run as is. You can either find these programs in 400-Json_programs, or modify the examples to use your own programs.
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| Google Proto Buffer generated Python: | https://developers.google.com/protocol-buffers/docs/reference/python-generated |