Skip to content

Commit 53753c6

Browse files
committed
Update README
* Fix/remove broken links * Update documentation * Add build badges for Humble and Iron (and reorder from newest to oldest distro / ROS 2 -> ROS 1) Signed-off-by: Jacob Perron <jacobmperron@gmail.com>
1 parent 4024e1d commit 53753c6

1 file changed

Lines changed: 22 additions & 19 deletions

File tree

README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# create_robot
22

3-
[ROS 2](https://docs.ros.org/en/foxy/) driver for iRobot [Create 1 and 2](http://www.irobot.com/About-iRobot/STEM/Create-2.aspx).
3+
[ROS](https://docs.ros.org) driver for iRobot Create 1 and 2.
44
This package wraps the C++ library [libcreate][libcreate], which uses iRobot's [Open Interface Specification][oi_spec].
55

66
<!--[](* Documentation: TODO)-->
@@ -10,9 +10,12 @@ This package wraps the C++ library [libcreate][libcreate], which uses iRobot's [
1010

1111
## Build Status
1212

13-
- ROS Melodic (branch: `melodic`) ![](https://github.com/autonomylab/create_robot/workflows/Continuous%20Integration/badge.svg?branch=melodic)
14-
- ROS Noetic (branch: `noetic`) ![](https://github.com/autonomylab/create_robot/workflows/Continuous%20Integration/badge.svg?branch=noetic)
13+
- ROS Rolling (branch: `rolling`) ![](https://github.com/autonomylab/create_robot/workflows/Continuous%20Integration/badge.svg?branch=rolling)
14+
- ROS Iron (branch: `iron`) ![](https://github.com/autonomylab/create_robot/workflows/Continuous%20Integration/badge.svg?branch=iron)
15+
- ROS Humble (branch: `humble`) ![](https://github.com/autonomylab/create_robot/workflows/Continuous%20Integration/badge.svg?branch=humble)
1516
- ROS Foxy (branch: `foxy`) ![](https://github.com/autonomylab/create_robot/workflows/Continuous%20Integration/badge.svg?branch=foxy)
17+
- ROS Noetic (branch: `noetic`) ![](https://github.com/autonomylab/create_robot/workflows/Continuous%20Integration/badge.svg?branch=noetic)
18+
- ROS Melodic (branch: `melodic`) ![](https://github.com/autonomylab/create_robot/workflows/Continuous%20Integration/badge.svg?branch=melodic)
1619

1720
## Supported Robots
1821

@@ -55,16 +58,15 @@ _* Not verified. Anyone who is able to verify that this driver works or not is e
5558
| Battery info | Available |
5659
| Light sensors | Available |
5760
| **_Diagnostics_** | |
58-
| Corrupt packets | Planned |
59-
| Physical tests | Planned |
60-
| Overcurrent info | Planned |
61+
| Corrupt packets | Available |
62+
| Overcurrent info | N/A |
6163

6264
## Install
6365

6466
#### Prerequisites
6567

6668
* Internet connection
67-
* [ROS 2](https://index.ros.org/doc/ros2/Installation) _Foxy_
69+
* [ROS 2](https://index.ros.org/doc/ros2/Installation)
6870
* Ubuntu packages: `python3-rosdep`, `python3-colcon-common-extensions`
6971

7072
``` bash
@@ -76,25 +78,25 @@ $ sudo apt install python3-rosdep python3-colcon-common-extensions
7678
1. Create a colcon workspace
7779
``` bash
7880
$ cd ~
79-
$ mkdir -p create_ws/src
81+
$ mkdir -p create_ws/src
8082
$ cd create_ws
8183
```
8284

83-
2. Clone this repo
85+
2. Clone this repo
8486
``` bash
8587
$ cd ~/create_ws/src
86-
$ git clone https://github.com/autonomylab/create_robot.git --branch foxy
87-
$ git clone https://github.com/AutonomyLab/libcreate
88+
$ git clone https://github.com/autonomylab/create_robot.git
89+
$ git clone https://github.com/AutonomyLab/libcreate.git
8890
```
89-
90-
3. Install dependencies
91+
92+
3. Install dependencies
9193
``` bash
9294
$ cd ~/create_ws
93-
$ rosdep update
94-
$ rosdep install --from-paths src -i
95+
$ rosdep update
96+
$ rosdep install --from-paths src -i
9597
```
9698

97-
4. Build
99+
4. Build
98100
``` bash
99101
$ cd ~/create_ws
100102
$ colcon build
@@ -111,7 +113,7 @@ $ sudo apt install python3-rosdep python3-colcon-common-extensions
111113

112114
### Setup
113115

114-
1. After compiling from source, don't forget to source your workspace:
116+
1. After compiling from source, don't forget to source your workspace:
115117
``` bash
116118
$ source ~/create_ws/install/setup.bash
117119
```
@@ -158,7 +160,7 @@ $ ros2 launch create_bringup create_2.launch config:=/abs/path/to/config.yaml de
158160
`odom_frame` | The robot's odometry frame ID | `odom`
159161
`latch_cmd_duration` | If this many seconds passes without receiving a velocity command the robot stops | `0.2`
160162
`loop_hz` | Frequency of internal update loop | `10.0`
161-
`publish_tf` | Publish the transform from `odom_frame` to `base_frame` | `true`
163+
`publish_tf` | Publish the transform from `odom_frame` to `base_frame` | `true`
162164
`robot_model` | The type of robot being controlled (supported values: `ROOMBA_400`, `CREATE_1` and `CREATE_2`) | `CREATE_2`
163165
`baud` | Serial baud rate | Inferred based on robot model, but is overwritten upon providing a value
164166
`oi_mode_workaround` | Some Roomba models incorrectly report the current OI mode in their sensor streams. Setting this to `true` will cause `libcreate` to decrement the OI mode received in the sensor stream by `1` | `false`
@@ -188,6 +190,7 @@ $ ros2 launch create_bringup create_2.launch config:=/abs/path/to/config.yaml de
188190
`odom` | Robot odometry according to wheel encoders | [nav_msgs/msg/Odometry][odometry]
189191
`wheeldrop` | At least one of the drive wheels has dropped | [std_msgs/msg/Empty][empty]
190192
`/tf` | The transform from the `odom` frame to `base_footprint`. Only if the parameter `publish_tf` is `true` | [tf2_msgs/msg/TFMessage](https://docs.ros2.org/foxy/api/tf2_msgs/msg/TFMessage.html)
193+
`diagnostics` | Info about the battery charge, wheeldrop/cliff state, robot mode, and serial connection | [diagnostic_msgs/msg/DiagnosticArray](https://docs.ros2.org/foxy/api/diagnostic_msgs/msg/DiagnosticArray.html)
191194

192195

193196
### Subscribers
@@ -240,7 +243,7 @@ Contributing to the development and maintenance of _create\_autonomy_ is encoura
240243
- Confirms driver works with Roomba 700 and 800 series.
241244
* [Clyde McQueen](https://github.com/clydemcqueen)
242245
- Added support for sound ([#37](https://github.com/AutonomyLab/create_robot/pull/37)).
243-
* [Ben Wolsieffer](https://github.com/lopsided98)
246+
* [Ben Wolsieffer](https://github.com/lopsided98)
244247
- Added JointState publisher for wheels ([#26](https://github.com/AutonomyLab/create_robot/pull/26)).
245248
- Added Create 1 description ([#27](https://github.com/AutonomyLab/create_robot/pull/27)).
246249
* [Pedro Grojsgold](https://github.com/pgold)

0 commit comments

Comments
 (0)