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.4.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.4.0-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rpk-5.4.0.tar.gz
Algorithm Hash digest
SHA256 08746795a87cc614f51d06a6c26272ebd1f79320a1dc43127a6a8fdf85a41a87
MD5 47fe20018553dd84a66243a985e348e5
BLAKE2b-256 5f3912cb38e1b3c8ebe9d57a8e2b8bcdd5faf59b334b94bc492359c2fae945d7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rpk-5.4.0-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for rpk-5.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 58394fe4c94f47ccff6d73b4934fb0c8eed933c77b5f7c045f43d8d808b39c00
MD5 117db943dbecedc1a563d687107746ed
BLAKE2b-256 67b9e48be34fb11ef79f0d89c0bd57e7b0ec1088cddfbe1e3cf6ab70215edbd9

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