PyNiryo Nate

pyniryo-nate is the Python client of the Niryo Nate robot API. It drives the arm, reads and writes the IOs, runs and manages programs, and subscribes to the robot’s events, from a remote host or from a program the robot runs itself.

Install

The package is on PyPI and supports Python 3.10 and later:

pip install pyniryo-nate

First steps

Connect with the address and the credentials of a user of the robot, then move the arm. The key selector of the robot must be on manual, see Direct control.

1 from pyniryo_nate import Nate
2 from pyniryo_nate.models import Joints
3
4 with Nate(hostname="10.10.10.10", login=("user", "secret")) as nate:
5     print(nate.device.get_identity())
6     nate.robot.move(Joints(0, 0, 0, 0, 0, 0)).wait()

The same client reads NATE_HOSTNAME, NATE_USERNAME and NATE_PASSWORD from the environment when the constructor is given nothing, and a program run by the robot needs neither address nor credentials. Connecting to a robot covers both.

API reference

Indices and tables