Skip to main content

A tool to create and package ROS 2 robot applications

Project description

A tool to generate skeletons of robot applications, mission controllers, tasks and skills.

Relies on ROS 2 and the ROS 2 Intents interface.

Installation

rpk is written in python3.

Installation with pip

pip install rpk

Installation from source with pip

You require the following libraries:

pip install jinja2

You can install rpk as any other python package as follows:

pip install .

If the location where it is installed is not yet on your path, you will get a warning which includes the path location where it has been installed. You need to add this location to your path, e.g., in linux export PATH="$HOME/.local/bin:$PATH" or in [windows use the GUI or command line](https://stackoverflow.com/questions/9546324/adding-a-directory-to-the-path-environment-variable-in-windows)

Installation with ROS debian (only availabe in PAL Robotics docker images/robots)

sudo apt install pal-alum-rpk

The re-source /opt/pal/alum/setup.bash: source /opt/pal/alum/setup.bash

Building your first rpk

Once you have installed rpk, you are ready to create new applications for your robots. To do so, you just have to run:

rpk create

… and follow the instructions!

It will create a ROS2 package ready to be run.

You’re then ready to play with the application controller. Visit the PAL SDK documentation for further information.

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

rpk-5.7.0.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

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

rpk-5.7.0-py3-none-any.whl (1.6 MB view details)

Uploaded Python 3

File details

Details for the file rpk-5.7.0.tar.gz.

File metadata

  • Download URL: rpk-5.7.0.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for rpk-5.7.0.tar.gz
Algorithm Hash digest
SHA256 af97fd680c5cf70dc96082d752bb8b3c28fed8f42e331423f8a3a0dc255d7ff1
MD5 3d891967e0a15b5faf702dc7be52b3ce
BLAKE2b-256 2b41a1f5f8cbab3c8480d0748747c3d69dca7ac877d88b5006a7637e538602bd

See more details on using hashes here.

File details

Details for the file rpk-5.7.0-py3-none-any.whl.

File metadata

  • Download URL: rpk-5.7.0-py3-none-any.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for rpk-5.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1d577feb432029f9aa874934366c606777151ffb70824e18e7f46f30ea0d5fb2
MD5 11d1ae5f6f9c8ede57acaa1d86e92819
BLAKE2b-256 8ee10c89f574f1228efb80213ce45153a06443c05bb4a0bb68b45cadd1f8043c

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