Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cgeller committed Jan 29, 2024
1 parent 929f130 commit f3d3878
Show file tree
Hide file tree
Showing 8 changed files with 39 additions and 24 deletions.
10 changes: 10 additions & 0 deletions FEATURES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Feature List
All changes are modifications to the original repository.

## Core Features
- GitHub workflow to automatically build Docker images using docker-ros
- Update to CARLA 0.9.15
- Update to Ubuntu 22.04 and Python3.10 including corresponding pip versions

## Minor Features
- ...
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,24 @@
# Communication Module: *carla-ros-bridge*
# Communication Actor: *carla-ros-bridge*

<p align="center"><img src="https://img.shields.io/github/v/release/carla-compose/carla-ros-bridge"/>
<img src="https://img.shields.io/github/v/release/carla-compose/carla-ros-bridge"/></a>
<p align="left">
<img src="https://img.shields.io/github/v/release/carla-compose/carla-ros-bridge"/>
<img src="https://img.shields.io/github/license/carla-compose/carla-ros-bridge"/>
<a href="https://github.com/carla-compose/carla-ros-bridge/actions/workflows/docker.yml"><img src="https://github.com/carla-compose/carla-ros-bridge/actions/workflows/docker.yml/badge.svg"/></a>
<a href="https://github.com/carla-compose/carla-ros-bridge/actions/workflows/docker.yml">
<img src="https://github.com/carla-compose/carla-ros-bridge/actions/workflows/docker.yml/badge.svg"/></a>
<img src="https://img.shields.io/badge/ROS 2-humble-blueviolet"/>
<img src="https://img.shields.io/badge/Python-3.10-blueviolet"/>
<img src="https://img.shields.io/github/stars/carla-compose/carla-ros-bridge?style=social"/>
</p>

We recommend to use the *carla-ros-bridge* as **communication module** within our proposed simulation framework <a href="https://github.com/carla-compose/carla-compose">carla-compose. <img src="https://img.shields.io/github/stars/carla-compose/carla-compose?style=social"/></a>
> [!IMPORTANT]
> This repository is a minimal fork of the official [ros-bridge](https://github.com/carla-simulator/ros-bridge)! All modifications to the original repository are documented in [FEATURES.md](./FEATURES.md).
> [!RECOMMENDATION]
> We recommend to use the *carla-ros-bridge* as **communication actor** in our open, modular and scalable simulation framework <a href="https://github.com/ika-rwth-aachen/carlos">**CARLOS**. <img src="https://img.shields.io/github/stars/ika-rwth-aachen/carlos?style=social"/></a> Here, it is the component that facilitates the powerful combination of CARLA and ROS. The component retrieves data from the simulation to publish it over ROS topics while simultaneously listening on different topics for requested actions, which are translated to commands to be executed in CARLA. It does this by using both the ROS communication standard DDS, as well as RPC via the CARLA Python API, in tandem, effectively bridging the two. Here, [docker-ros](https://github.com/ika-rwth-aachen/docker-ros) enables a continual building of container images with recent versions of ROS, Python, and Ubuntu.
**Note**: Please also have look to the [ROS specific README](./docker/README.md) giving detailed insights about available ROS nodes, topics and services but also useful information about the containerization.

**Note**: We set up a Continous Integration (CI) pipeline as [GitHub action](./github/workflows/docker.yml) to continously build Docker images for the `carla-ros-bridge`, publicly available on [Docker Hub](https://hub.docker.com/r/rwthika/carla-ros-bridge).

---
---
Expand Down
30 changes: 13 additions & 17 deletions docker/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
# ROS-Bridge

This repository aims to provide standalone images of the [CARLA ROS Bridge](https://gitlab.ika.rwth-aachen.de/fb-fi/simulation/carla/ros-bridge) fork by **ika** for usage in CI pipelines, cluster deployments etc. by utilizing [docker-ros](https://gitlab.ika.rwth-aachen.de/fb-fi/ops/docker-ros).

- [Nodes](#nodes)
- [carla_ros_bridge/bridge.py](#carla_ros_bridgebridgepy)
- [Usage of docker-ros Images](#usage-of-docker-ros-images)
- [Available Images](#available-images)
- [Default Command](#default-command)
- [Environment Variables](#environment-variables)
- [Launch Files](#launch-files)
- [Configuration Files](#configuration-files)
- [Additional Remarks](#additional-remarks)
- [Official Documentation](#official-documentation)

# Containerization of the carla-ros-bridge

- [ROS-Bridge](#ros-bridge)
- [Nodes](#nodes)
- [carla\_ros\_bridge/bridge.py](#carla_ros_bridgebridgepy)
- [Subscribed Topics](#subscribed-topics)
- [Published Topics](#published-topics)
- [Services](#services)
- [Usage of docker-ros Images](#usage-of-docker-ros-images)
- [Available Images](#available-images)
- [Default Command](#default-command)
- [Launch Files](#launch-files)
- [Official Documentation](#official-documentation)

## Nodes

Expand All @@ -22,8 +20,6 @@ This repository aims to provide standalone images of the [CARLA ROS Bridge](http

### carla_ros_bridge/bridge.py

This node, besides other components, comes from the ika fork of the [ros-bridge](https://gitlab.ika.rwth-aachen.de/fb-fi/simulation/carla/ros-bridge).

Also see the [official documentation](https://carla.readthedocs.io/projects/ros-bridge/en/latest/)

#### Subscribed Topics
Expand Down
4 changes: 2 additions & 2 deletions docker/additional-pip-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ pep8
autopep8
cmake_format==0.6.11
pylint
transforms3d
transforms3d==0.4.1
pygame
pexpect
simple-pid
networkx
pyproj
pyproj
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit f3d3878

Please sign in to comment.