diff --git a/docs/index.md b/docs/index.md index 206ab1ac..c7134496 100644 --- a/docs/index.md +++ b/docs/index.md @@ -27,6 +27,7 @@ More detailed documentation can be accessed using the left navigation bar, or if - [Hardware](hw/overview) - [ROS 2 API](api/ros2/) + - [Software Releases](releases/overview) ## Useful external links diff --git a/docs/releases/g_1_1.md b/docs/releases/g_1_1.md new file mode 100644 index 00000000..b333a6fd --- /dev/null +++ b/docs/releases/g_1_1.md @@ -0,0 +1,17 @@ +# iRobot® Create® 3 Release G.1.1 + +This is the first production Create® 3 release. + +## This release is running ROS 2 Galactic with the following interface library versions: + +- [irobot_create_msgs - 1.2.2](https://github.com/iRobotEducation/irobot_create_msgs/tree/1.2.2) +- [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 + +This release provides the robot's sensors and controls via topics, actions, and services, see [ROS 2 API](../../api/ros2/). + +The robot runs a webserver for updating software, configuring to the network, getting error logs from the robot, and configuring ROS 2 environment variables and parameters. +This release has some known issues using the network configuration webserver page to associate with networks using characters that are not alphanumeric 7-bit ASCII. +If there is an issue getting on the network, it is recommended to first update the software via the robot's host AP mode, then try getting on the network with the latest version, see [Create® 3 Setup](https://edu.irobot.com/create3-setup). diff --git a/docs/releases/overview.md b/docs/releases/overview.md new file mode 100644 index 00000000..ea438ec5 --- /dev/null +++ b/docs/releases/overview.md @@ -0,0 +1,22 @@ +# iRobot® Create® 3 Releases Overview + +Create® 3 releases take the version schema + +.. + +The letter corresponds with the ROS 2 Release. +For example, G corresponds with the Galactic release, H will correspond with Humble. +See [ROS 2 Releases](https://docs.ros.org/en/rolling/Releases.html). + +The first number corresponds with a major release number within the ROS 2 letter release. +Increments to major release imply API breaking changes or significant new features. + +The second number corresponds with a minor release number within the major release number. +Increments to the minor release imply bug fixes or small feature additions that should be backwards compatible with code that currently integrates with the major release number. + +The latest release can be found at: +[http://edu.irobot.com/create3-latest-fw](http://edu.irobot.com/create3-latest-fw) + +## Releases: + +- [G.1.1](../g_1_1) diff --git a/mkdocs.yml b/mkdocs.yml index 98664e11..f5223e8d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -43,3 +43,6 @@ nav: - Software Examples: - Overview: examples/overview.md - Driving via CLI: examples/driving-cli.md + - Create® 3 Software Releases: + - Overview: releases/overview.md + - G.1.1: releases/g_1_1.md