Skip to content

Commit

Permalink
Add H.1.2 and G.4.5
Browse files Browse the repository at this point in the history
* fix publishing rate of /stop_status and /battery_status
* use asynchronous publication mode in Humble and Galactic for Fast-DDS
* Add beta feature to change wired subnet
  • Loading branch information
shamlian committed Apr 6, 2023
1 parent e7b99e1 commit 3f1211e
Show file tree
Hide file tree
Showing 17 changed files with 78 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/api/odometry.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,6 @@ This topic publishes at 20 Hz.

The `stop_status` topic produces messages of type [`irobot_create_msgs/msg/StopStatus`](https://github.com/iRobotEducation/irobot_create_msgs/blob/rolling/msg/StopStatus.msg).
The Create® 3 robot will periodically publish a boolean estimate of whether it is currently moving or not on the `stop_status` topic.
This topic publishes at 1 Hz.

[^1]: All trademarks mentioned are the property of their respective owners.
26 changes: 26 additions & 0 deletions docs/releases/g_4_5.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# iRobot® Create® 3 Release G.4.5
[[Click here to download release G.4.5]](https://edu.irobot.com/create3/firmware/G.4.5)

## This release is running ROS 2 Galactic with the following interface library versions:

- [irobot_create_msgs - 1.2.4](https://github.com/iRobotEducation/irobot_create_msgs/tree/1.2.4)
- [cyclonedds - 0.8.1](https://github.com/eclipse-cyclonedds/cyclonedds/tree/0.8.1)
- [Fast-DDS - 2.3.3](https://github.com/eProsima/Fast-DDS/tree/2.3.3)

## Release Overview
For iRobot® Education Bluetooth[^1] users, there are no changes.
For ROS 2[^2] users, this release fixes a few issues and adds a beta feature.
See below for details.

## Changelog (from G.4.4)
### ROS 2
* Corrected rate of `/stop_status` publication (at least 1 Hz)
* Corrected rate of `/battery_status` publication (at least 0.1 Hz)

### Core Robot
* Webserver / OS
* Added beta feature: [set wired subnet](../../webserver/set-wired-subnet/).

[^1]: 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.
[^2]: ROS 2 is governed by Open Robotics.
[^3]: All other trademarks mentioned are the property of their respective owners.
32 changes: 32 additions & 0 deletions docs/releases/h_1_2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# iRobot® Create® 3 Release H.1.2
[[Click here to download release H.1.2]](https://edu.irobot.com/create3/firmware/H.1.2)

!!! warning
When using Fast-DDS, startup times are about 30s longer than in our Galactic release. We are working on a fix.

## This release is running ROS 2 Humble with the following interface library versions:

- [irobot_create_msgs - 2.1.0](https://github.com/iRobotEducation/irobot_create_msgs/tree/2.1.0)
- [cyclonedds - 0.9.0](https://github.com/eclipse-cyclonedds/cyclonedds/tree/0.9.0)
- [Fast-DDS - 2.6.4](https://github.com/eProsima/Fast-DDS/tree/2.6.4)

## Release Overview
For iRobot® Education Bluetooth[^1] users, there are no changes.
For ROS 2[^2] users, this release fixes a few issues and adds a beta feature.
See below for details.

## Changelog (from H.1.1)
### ROS 2
* Publications
* Corrected rate of `/stop_status` publication (at least 1 Hz)
* Corrected rate of `/battery_status` publication (at least 0.1 Hz)
* Fast-DDS
* Changed [publication mode](https://www.eprosima.com/index.php/resources-all/performance/dds-asynchronous-vs-synchronous-publishing) from synchronous to asynchronous (matches Galactic)

### Core Robot
* Webserver / OS
* Added beta feature: [set wired subnet](../../webserver/set-wired-subnet/).

[^1]: ROS 2 is governed by Open Robotics.
[^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.
[^3]: All other trademarks mentioned are the property of their respective owners.
6 changes: 4 additions & 2 deletions docs/releases/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,14 @@ Downloads of a particular version can be found on each individual release page.

### Humble

* [H.1.1](../h_1_1) (humble-latest)
* [H.1.2](../h_1_2) (humble-latest)
* [H.1.1](../h_1_1)
* [H.1.0](../h_1_0)
* [H.0.0](../h_0_0)

### Galactic
* [G.4.4](../g_4_4) (galactic-latest, latest)
* [G.4.5](../g_4_5) (galactic-latest, latest)
* [G.4.4](../g_4_4)
* [G.4.3](../g_4_3)
* [G.4.1](../g_4_1)
* [G.3.1](../g_3_1)
Expand Down
Binary file modified docs/webserver/data/about.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/webserver/data/app-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/webserver/data/connect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/webserver/data/home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/webserver/data/logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/webserver/data/serial-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/webserver/data/set-datetime.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/webserver/data/set-wired-subnet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/webserver/data/update-expanded.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/webserver/data/update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/webserver/set-datetime.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# iRobot® Create® 3 Webserver - Set Date and Time
The Set Date and Time page of the Create® 3 webserver allows the user to directy change the robot's date and time.

![Picture of set date and timepage](data/set-datetime.png)
![Picture of set date and time page](data/set-datetime.png)

Please note that this is a beta feature, and as such is not supported by the customer service team.
Please exercise caution, as improper use of beta features may result in an inoperable robot.
Expand Down
11 changes: 11 additions & 0 deletions docs/webserver/set-wired-subnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# iRobot® Create® 3 Webserver - Set Wired Subnet
The Set Wired Subnet page of the Create® 3 webserver allows the user to change the robot's /24 subnet within the class C private address area.

![Picture of set wired subnet page](data/set-wired-subnet.png)

Please note that this is a beta feature, and as such is not supported by the customer service team.
Please exercise caution, as improper use of beta features may result in an inoperable robot.

This page allows the user to change the robot's /24 subnet within the class C private address area (192.168.nnn.0/24). After pressing "save," the robot must have its power cycled in order for the change to be made.

[^1]: All trademarks mentioned are the property of their respective owners.
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ nav:
- Serial Port Forward: webserver/serial-config.md
- Set Date and Time: webserver/set-datetime.md
- Restart ntpd: webserver/restart-ntpd.md
- Set Wired Subnet: webserver/set-wired-subnet.md
- About: webserver/about.md
- Setup:
- Connect to Wi-Fi: setup/provision.md
Expand Down Expand Up @@ -116,7 +117,9 @@ nav:
- G.4.1: releases/g_4_1.md
- G.4.3: releases/g_4_3.md
- G.4.4: releases/g_4_4.md
- G.4.5: releases/g_4_5.md
- Humble:
- H.0.0: releases/h_0_0.md
- H.1.0: releases/h_1_0.md
- H.1.1: releases/h_1_1.md
- H.1.2: releases/h_1_2.md

0 comments on commit 3f1211e

Please sign in to comment.