Skip to main content

A package to control the Niryo Ned and the Kinova Gen3 Lite robot arms

Project description

RRIA-API

The rria-api is an easy-to-use package that provides a common interface to control robots used by the Residence in Robotics and AI at the UFPE's informatics center. The API currently supports the use of Kinova Gen3 lite and Niryo NED, this API supports a dummy robot for testing purposes.

Requirements

  • Python 3.9+
  • Kortex API .whl package

Installation

  1. Download the v2.3.0 Kortex API .whl package (required for controlling the Kinova Gen3 lite):

  2. Install the downloaded package with pip:

    $ pip install <path to kortex_api-2.3.0.post34-py3-none-any.whl>
    
  3. Install the latest rria-api package with pip:

    pip install rria-api
    

Example

from rria_api import RobotObject, RobotEnum

# Create gen3 RobotObject
gen3_lite = RobotObject('192.168.2.10', RobotEnum.GEN3_LITE)

# Create Niryo NED RobotObject
ned = RobotObject('169.254.200.200', RobotEnum.NED)

gen3_lite.connect_robot()
ned.connect_robot()

gen3_lite.move_joints(30.0, 30.0, 30.0, 30.0, 30.0, 30.0)
ned.move_joints(30.0, 30.0, 30.0, 30.0, 30.0, 30.0)

gen3_lite.get_joints()
ned.get_joints()

gen3_lite.close_gripper()
ned.close_gripper()

gen3_lite.open_gripper()
ned.open_gripper()

gen3_lite.move_to_home()
ned.move_to_home()

gen3_lite.safe_disconnect()
ned.safe_disconnect()

Contributors

If you want to contribute to the development of the rria-api, you can clone the repository from GitHub, develop your changes and submit a pull request.

To generate the documentation, you need to install the docs' dependencies and run this command:

task docs

# or

mkdocs serve # For live preview

mkdocs build # For build the documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rria_api-1.1.1.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rria_api-1.1.1-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file rria_api-1.1.1.tar.gz.

File metadata

  • Download URL: rria_api-1.1.1.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.4 Windows/10

File hashes

Hashes for rria_api-1.1.1.tar.gz
Algorithm Hash digest
SHA256 c0066aa4e855d036942401d2a599b6dd6ff7392030cffe671ca3506d472b3edd
MD5 e79b0e6cae68849b65aa769090c9215a
BLAKE2b-256 b5822abf55f31a76c3038345c9ac0d06ff15e5034e5b1e7b26578f76dcc3400b

See more details on using hashes here.

File details

Details for the file rria_api-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: rria_api-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.4 Windows/10

File hashes

Hashes for rria_api-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a0fd504900c1a16e79d6fcf63f0e647b0602d7c275773e6b89ade0ead60da2ba
MD5 7a12015bbc411e02aab2c9a51192f4a6
BLAKE2b-256 b242343e4dba99497e7aba95d9a0df715a79aa0d511856f369723b9e31fb2a42

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page