Skip to content

Commit bb06d30

Browse files
authored
Merge pull request #609 from iRobotEducation/shamlian/release_I.0.0
Release I.0.0
2 parents 1bab193 + 9710925 commit bb06d30

File tree

5 files changed

+42
-1
lines changed

5 files changed

+42
-1
lines changed

docs/releases/i_0_0.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# iRobot® Create® 3 Release I.0.0
2+
[[Click here to download release I.0.0.CycloneDDS]](https://github.com/iRobotEducation/create3_docs/releases/download/I.0.0/Create3-I.0.0.CycloneDDS.swu)
3+
[[Click here to download release I.0.0.FastDDS]](https://github.com/iRobotEducation/create3_docs/releases/download/I.0.0/Create3-I.0.0.FastDDS.swu)
4+
5+
!!! warning
6+
Be sure to download the correct release for your choice of middleware.
7+
8+
## This release is running ROS 2 Iron with the following interface library versions:
9+
10+
- [irobot_create_msgs - 2.1.0](https://github.com/iRobotEducation/irobot_create_msgs/tree/2.1.0)
11+
- [cyclonedds - 0.10.3](https://github.com/eclipse-cyclonedds/cyclonedds/tree/0.10.3)
12+
- [Fast-DDS - 2.10.1](https://github.com/eProsima/Fast-DDS/tree/2.10.1)
13+
14+
## Release Overview
15+
For ROS 2[^1] users, this is a feature release, and our first upgrade to ROS 2 Iron.
16+
For iRobot® Education Bluetooth[^2] users, there are no changes.
17+
See below for details.
18+
19+
!!! note
20+
In testing, this release appears to be fully compatible with ROS 2 Jazzy, as well. Please be sure to let us know if you run into any [issues](https://github.com/iRobotEducation/create3_docs/issues).
21+
22+
## Changelog (from H.2.6)
23+
### ROS 2
24+
* Topics
25+
* The robot can now be tele-operated via `geometry_msgs/msg/TwistStamped` messages on the `cmd_vel_stamped` topic. (You may also continue to use the `cmd_vel` topic; don't use both at the same time.)
26+
27+
28+
[^1]: ROS 2 is governed by Open Robotics.
29+
[^2]: The Bluetooth® word mark and logos are registered trademarks owned by Bluetooth SIG, Inc. and any use of such marks by iRobot is under license.
30+
[^3]: All other trademarks mentioned are the property of their respective owners.

docs/releases/overview.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ One exception is that beta features may be added in minor releases.
1919
The latest stable release can be found at
2020
[http://edu.irobot.com/create3-latest-fw](http://edu.irobot.com/create3-latest-fw).
2121

22+
The latest stable Iron release can be found at
23+
[http://edu.irobot.com/create3-iron-latest-fw](http://edu.irobot.com/create3-iron-latest-fw).
2224
The latest stable Humble release can be found at
2325
[http://edu.irobot.com/create3-humble-latest-fw](http://edu.irobot.com/create3-humble-latest-fw).
2426
The latest stable Galactic release can be found at
@@ -28,8 +30,11 @@ Downloads of a particular version can be found on each individual release page.
2830

2931
## Releases
3032

33+
### Iron
34+
* [I.0.0](../i_0_0) (iron-latest, latest)
35+
3136
### Humble
32-
* [H.2.6](../h_2_6) (humble-latest, latest)
37+
* [H.2.6](../h_2_6) (humble-latest)
3338
* [H.2.5](../h_2_5)
3439
* [H.2.4](../h_2_4)
3540
* [H.2.3](../h_2_3)

docs/setup/xml-config.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
ROS 2[^1] is built on top of DDS/RTPS as its middleware, which provides advanced networking features such as: discovery, serialization and transportation. This **R**OS 2 **m**iddle**w**are is abbreviated **RMW** for short.
44

5+
The middleware running on the robot can be selected using the [Application Configuration](../webserver/application.md) page on the webserver. Note that the choice of middleware available may be restricted by the firmware installed on your robot; check the [releases](https://github.com/iRobotEducation/create3_docs/releases) for more details on available firmware.
6+
57
This page contains some examples that may be useful when interacting with the iRobot® Create® 3.
68

79
!!! important

docs/webserver/application.md

+2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ Further details on these settings can be found in the official ROS 2 documentati
2626
For robots running Galactic >= G.4 and Humble >= H.1, when Fast-DDS is selected as the RMW, it is possible to direct the robot to use an offboard Fast-DDS Discovery server, as well.
2727
Further details on the Fast-DDS Discovery Server can be found [here](https://fast-dds.docs.eprosima.com/en/latest/fastdds/ros2/discovery_server/ros2_discovery_server.html).
2828

29+
When running Create 3 firmware for Iron, only one middleware selection is available at a time; to switch middleware, it is necessary to install the matching firmware.
30+
2931
### Application ROS 2 Parameters File
3032
This is a raw yaml file used for configuring ROS 2 parameters.
3133
The web server will not validate this yaml file; setting it incorrectly may cause the application to fail to start properly.

mkdocs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -162,4 +162,6 @@ nav:
162162
- H.2.3: releases/h_2_3.md
163163
- H.2.4: releases/h_2_4.md
164164
- H.2.5: releases/h_2_5.md
165+
- Iron:
166+
- I.0.0: releases/i_0_0.md
165167
- FAQ: faq/faq.md

0 commit comments

Comments
 (0)