Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release G.5.4 / H.2.4 #505

Merged
merged 5 commits into from
Jan 19, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/hw/face.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,10 @@ The LEDs expose internal state information about the robot, but can also be over
| Device is connected to <br> robot’s Access Point page. | Robot downloading <br> update file | Robot updating firmware <br> Do not remove from dock | Update successful |

### While Operating
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like there might be a spacing issue with the table that is squishing three of the gifs. Looks like it does that on the current page as well, but only to one of them. At first glance, I cannot identify any issues in the code. It may be this section needs a second table like in the "While Connecting to Wi-Fi" section
Screenshot 2024-01-09 at 6 47 06 PM

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blurg.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This squishing is thanks to markdown tables wanting to be smart, I think. I am not enough of a CSS expert to fix it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One thing I can do is to increase the maximum width of the site, so that it looks good if you have a wide monitor. I could also make the images smaller. I will try a few other things before giving up. ;-)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Committed d4be417 ; what do you think?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good news, this totally fixed it on Chrome! Looks great there...bad news, on Safari it is worse
Screenshot 2024-01-10 at 9 32 08 PM

But I can sacrifice since I'm probably the only person who uses Safari :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just checked Firefox and it looks great there, too. Apparently Safari has like ~20% share on the browser market, so we shouldn't be flip about it. The only other idea I have is to make a table of tables; maybe if I do that, instead of squooshing the cells, it might make line breaks happen?

Copy link
Collaborator Author

@shamlian shamlian Jan 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The other other idea I have is to make each row a preformatted image, but that will be a real pain to maintain.

| Spinning White | Solid White | Pulsing Red | Half Solid Orange | Half Solid Yellow |
| ----- | ----- | ----- | ----- | ----- |
| ![Full spinning white](data/lightring/boot.gif){: style="height:100px;width:100px"} | ![Solid white](data/lightring/white_solid.jpg){: style="height:100px;width:100px"} | ![Pulsing Red](data/lightring/red_pulsing.gif){: style="height:100px;width:100px"} | ![Rear Half Orange](data/lightring/orange_half_solid.jpg){: style="height:100px;width:100px"} | ![Rear Half Yellow](data/lightring/yellow_half_solid.jpg){: style="height:100px;width:100px"} |
| Robot is booting up.<br>Wait for "happy sound" to play. | Default light color | Battery <10%. | Back-up safety activated | Wheels disabled |
| Spinning White | Solid White | Pulsing Red | Spinning Red | Half Solid Orange | Half Solid Yellow |
| ----- | ----- | ----- | ----- | ----- | ----- |
| ![Full spinning white](data/lightring/boot.gif){: style="height:100px;width:100px"} | ![Solid white](data/lightring/white_solid.jpg){: style="height:100px;width:100px"} | ![Pulsing Red](data/lightring/red_pulsing.gif){: style="height:100px;width:100px"} | ![Spinning Red](data/lightring/red_spinning.gif){: style="height:100px;width:100px"} | ![Rear Half Orange](data/lightring/orange_half_solid.jpg){: style="height:100px;width:100px"} | ![Rear Half Yellow](data/lightring/yellow_half_solid.jpg){: style="height:100px;width:100px"} |
| Robot is booting up.<br>Wait for "happy sound" to play. | Default light color | Battery < 10% | Battery < 3% | Back-up safety activated | Wheels disabled |

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

## 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 ROS 2[^1] users, this is a bugfix release.
For iRobot® Education Bluetooth[^2] users, there are no changes.
See below for details.

## Changelog (from G.5.3)
### Core Robot
* Webserver
* Add [beta feature](../../webserver/forget-wifi/) to disconnect from `wlan0` and forget the SSID [(#110)](https://github.com/iRobotEducation/create3_docs/issues/110)
* Power Management
* Robot will now change its light ring to "spinning red" when the battery level dips below 3%, and will explicitly call the `/robot_power` service when it falls below 2%.

### ROS 2
* Actions
* The `/rotate_angle` action no longer accepts overriding goals; an ongoing goal must be completed (successfully or unsuccessfully) before a new goal will be accepted. [(#351)](https://github.com/iRobotEducation/create3_docs/issues/351)
* Improve reliability of robot docking and undocking.

[^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.
32 changes: 32 additions & 0 deletions docs/releases/h_2_4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# iRobot® Create® 3 Release H.2.4
[[Click here to download release H.2.4]](https://edu.irobot.com/create3/firmware/H.2.4)

!!! 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 ROS 2[^1] users, this is a bugfix release.
For iRobot® Education Bluetooth[^2] users, there are no changes.
See below for details.

## Changelog (from H.2.3)
### Core Robot
* Webserver
* Add [beta feature](../../webserver/forget-wifi/) to disconnect from `wlan0` and forget the SSID [(#110)](https://github.com/iRobotEducation/create3_docs/issues/110)
* Power Management
* Robot will now change its light ring to "spinning red" when the battery level dips below 3%, and will explicitly call the `/robot_power` service when it falls below 2%.

### ROS 2
* Actions
* The `/rotate_angle` action no longer accepts overriding goals; an ongoing goal must be completed (successfully or unsuccessfully) before a new goal will be accepted. [(#351)](https://github.com/iRobotEducation/create3_docs/issues/351)
* Improve reliability of robot docking and undocking.

[^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 @@ -30,7 +30,8 @@ Downloads of a particular version can be found on each individual release page.

### Humble

* [H.2.3](../h_2_3) (humble-latest)
* [H.2.4](../h_2_4) (humble-latest)
* [H.2.3](../h_2_3)
* [H.2.2](../h_2_2)
* [H.2.1](../h_2_1)
* [H.1.2](../h_1_2)
Expand All @@ -39,7 +40,8 @@ Downloads of a particular version can be found on each individual release page.
* [H.0.0](../h_0_0)

### Galactic
* [G.5.3](../g_5_3) (galactic-latest, latest)
* [G.5.3](../g_5_4) (galactic-latest, latest)
shamlian marked this conversation as resolved.
Show resolved Hide resolved
* [G.5.3](../g_5_3)
* [G.5.2](../g_5_2)
* [G.5.1](../g_5_1)
* [G.4.5](../g_4_5)
Expand Down
14 changes: 14 additions & 0 deletions docs/webserver/forget-wifi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# iRobot® Create® 3 Webserver - Forget Wi-Fi Network
The "Forget Wi-Fi Network" beta menu option of the Create® 3 webserver instructs the Create® 3 robot to forget about and disconnect from any Wi-Fi networks to which it had been connected.

!!!warning
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.

Selecting the "Forget Wi-Fi Network" option will spawn a pop-up requesting confirmation.
Once confirmed, the robot will forget about any SSIDs to which it has connected, and to immediately disconnect from the `wlan0` inteface if it is currently connected.
If this command is issued over `wlan0`, it will be necessary to communicate with the robot either in AP mode or using Ethernet-over-USB.

This feature can also be accessed by sending a POST to `/api/forget-wifi`.

[^1]: All trademarks mentioned are the property of their respective owners.
7 changes: 5 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ nav:
- Restart ntpd: webserver/restart-ntpd.md
- Set Wired Subnet: webserver/set-wired-subnet.md
- Override RMW Profile: webserver/rmw-profile-override.md
- Forget Wi-Fi Network: webserver/forget-wifi.md
- About: webserver/about.md
- Setup:
- Connect to Wi-Fi: setup/provision.md
Expand Down Expand Up @@ -116,7 +117,7 @@ nav:
- Firmware Releases:
- Overview: releases/overview.md
- Galactic:
- G.5.3: releases/g_5_3.md
- G.5.4: releases/g_5_4.md
- Older:
- G.1.1: releases/g_1_1.md
- G.2.2: releases/g_2_2.md
Expand All @@ -127,12 +128,14 @@ nav:
- G.4.5: releases/g_4_5.md
- G.5.1: releases/g_5_1.md
- G.5.2: releases/g_5_2.md
- G.5.3: releases/g_5_3.md
- Humble:
- H.2.3: releases/h_2_3.md
- H.2.4: releases/h_2_4.md
- Older:
- 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
- H.2.1: releases/h_2_1.md
- H.2.2: releases/h_2_2.md
- H.2.3: releases/h_2_3.md