Skip to content

Latest commit

 

History

History
168 lines (125 loc) · 7.75 KB

README.md

File metadata and controls

168 lines (125 loc) · 7.75 KB
Raw

rpi_pwm_hardware_interface

ROS2 control hardware interface package for controlling a servo motor through a PWM pin on Raspberry Pi's GPIO

Licence

Quick Start Instructions

If you are familiar with ROS2, here are the quick-and-dirty build instructions.

cd $COLCON_WS
git clone git@github.com:rpi_pwm_hardware_interface/rpi_pwm_hardware_interface.git src/rpi_pwm_hardware_interface
vcs import src --input src/rpi_pwm_hardware_interface/rpi_pwm_hardware_interface.<ros-distro>.repos
rosdep install --ignore-src --from-paths src -y -r
colcon build --cmake-args -DCMAKE_BUILD_TYPE=Release    # Faster and more efficient build type
cd ..

If you end up with missing dependencies, install them using commands from Setup ROS Workspace section.

How to use this Package and ROS Introduction

Install and Build

Install ROS Humble and Development Tooling

These instructions assume you are running Ubuntu 20.04:

  1. Install ROS2 Humble. You can stop following along with the tutorial after you complete the section titled: Environment setup. Make sure you setup your environment with:

    source /opt/ros/$ros_distro$/setup.bash

    NOTE: You may want to add that line to your ~/.bashrc

    NOTE: There is also a zsh version of the setup script.

  2. Install ROS2 Build Tools. You do not need to build ROS2 from source. Simply install the tooling under the section titled "Install development tools and ROS tools".

  3. Install ccache:

    sudo apt install ccache

  4. Setup colcon mixin Reference for convenience commands.

    sudo apt install python3-colcon-mixin
colcon mixin add default https://raw.githubusercontent.com/colcon/colcon-mixin-repository/master/index.yaml
colcon mixin update default

Setup ROS Workspace

  1. Create a colcon workspace:

    export COLCON_WS=~/workspace/ros_ws_foxy
mkdir -p $COLCON_WS/src

    NOTE: Feel free to change ~/workspace/ros_ws_foxy to whatever absolute path you want.

    NOTE: Over time you will probably have multiple ROS workspaces, so it makes sense to them all in a subfolder. Also, it is good practice to put the ROS version in the name of the workspace, for different tests you could just add a suffix to the base name ros_ws_foxy.

  2. Download the required repositories and install package dependencies:

    cd $COLCON_WS
git clone git@github.com:rpi_pwm_hardware_interface/rpi_pwm_hardware_interface.git src/rpi_pwm_hardware_interface
vcs import src --input src/rpi_pwm_hardware_interface/rpi_pwm_hardware_interface.<ros_distro>.repos
rosdep install --ignore-src --from-paths src -y -r       # install also is there are unreleased packages

    Sometimes packages do not list all their dependencies so rosdep will not install everything. If you are getting missing dependency errors, try manually install the following packages:

    sudo apt install ros2-foxy-forward_command_controller ros2-foxy-joint_state_broadcaster ros2-foxy-joint_trajectory_controller ros2-foxy-xacro

Configure and Build Workspace:

To configure and build workspace execute following commands:

cd $COLCON_WS
colcon build --symlink-install --mixin rel-with-deb-info compile-commands ccache

Running Executable

See README.md files of the packages for information regarding running executables.

Using the Local Workspace

To use the local workspace you have to source it by using local setup script:

source $COLCON_WS/install/local_setup.bash

Since there are many errors one unintentionally do with wrong sourcing, please check also Notes on Sourcing ROS Workspace.

Notes on Sourcing ROS Workspace

Sourcing of a workspace appends the binary and resource directories to appropriate environment variables. It is important that you do not run the build command in the same terminal that you have previously sourced your local workspace. This can cause dependency resolution issues. Here is some advice copied from Official ROS Workspace Tutorial on this:

Before sourcing the overlay, it is very important that you open a new terminal, separate from the one where you built the workspace. Sourcing an overlay in the same terminal where you built, or likewise building where an overlay is sourced, may create complex issues.

Sourcing the local_setup of the overlay will only add the packages available in the overlay to your environment. setup sources the overlay as well as the underlay it was created in, allowing you to utilize both workspaces.

So, sourcing your main ROS 2 installation’s setup and then the dev_ws overlay’s local_setup, like you just did, is the same as just sourcing dev_ws’s setup, because that includes the environment of the underlay it was created in.

Testing and Linting

To test the packages packages built from source, use the following command with colcon. In order to run tests and linters you will have had to already built the workspace. To run the tests use following commands:

cd $COLCON_WS
colcon test
colcon test-result

There are --mixin arguments that can be used to control testing with linters, specifically linters-only and linters-skip.

Creating a new ROS2 Package

If you need to create a new ros2 package it is helpful to start with the official boilerplate for a ros2 package. The command ros2 pkg can be used to generate the boilerplate details. For example to create a new ros2 package called example_package with a node called example_node and library called example_library use this command:

ros2 pkg create --build-type ament_cmake --node-name example_node --library-name example_library example_package

References

Here are some useful references for developing with ROS2:

Pluginlib-Library: rpi_pwm_hardware_interface Plugin: rpi_pwm_hardware_interface/RPiPWMHardwareInterface (hardware_interface::SystemInterface)