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

Add Jazzy documentation #26

Open
wants to merge 44 commits into
base: gh-pages
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
aa48816
Start adding Jazzy docs
civerachb-cpr Aug 8, 2024
cc55660
Change Nav2 links to docs.nav2.org. Addresses https://github.com/turt…
civerachb-cpr Aug 8, 2024
1d5d7a6
Update README with changes for Ubuntu 24.04, modify the debug configu…
civerachb-cpr Aug 29, 2024
d5da836
Bump major version for Jazzy
civerachb-cpr Aug 29, 2024
22397aa
More jazzy sections added
civerachb-cpr Sep 3, 2024
682eb75
Fix bad tab delimiter, update visualization package
civerachb-cpr Sep 3, 2024
8c4da95
Add Jazzy section to create3.md
civerachb-cpr Sep 4, 2024
88d6886
Add a note about firmware versions needing to match the ROS release
civerachb-cpr Sep 4, 2024
1bb5bd9
Remove the note about letter prefixes; it doesn't matter
civerachb-cpr Sep 4, 2024
206d9db
Add a deprecation notice to all Galactic tabs
civerachb-cpr Oct 10, 2024
8d05b70
Add a full stop
civerachb-cpr Oct 10, 2024
0eae41b
More full stops
civerachb-cpr Oct 10, 2024
2433c2e
Use the styled warning box for the galactic deprecation notices
civerachb-cpr Oct 10, 2024
de65136
Add deprecation notice to the main galactic page
civerachb-cpr Oct 10, 2024
5cedfec
Add more Jazzy sections
civerachb-cpr Oct 10, 2024
a7aed03
Add a note about the firmware being DDS-specific in Jazzy
civerachb-cpr Oct 10, 2024
bd40fc1
Move the deprecation notice below the title
civerachb-cpr Oct 10, 2024
999884b
Update Jazzy changelog
civerachb-cpr Oct 10, 2024
8dc2cca
Update jazzy package versions
civerachb-cpr Oct 10, 2024
2a50448
Fix the Create3 firmware version
civerachb-cpr Oct 10, 2024
df1e667
Add a note about needing wireless equipment that provides 2.5 and 5 GHz
civerachb-cpr Oct 10, 2024
d6e94a9
Fix missing Jazzy section for discovery server
civerachb-cpr Oct 16, 2024
1acca5c
Update discovery server & simple discovery instructions for Jazzy
civerachb-cpr Oct 16, 2024
fedff56
Add a note for Jazzy and Humble about NOT using the `_do_not_use` nam…
civerachb-cpr Oct 16, 2024
bd77900
Make sensor installation instructions generic with ROS_DISTRO envar, …
civerachb-cpr Oct 16, 2024
3a835b9
Consolidate more sections, remove duplicate debian install instructio…
civerachb-cpr Oct 16, 2024
7f562c5
More tab consolidations
civerachb-cpr Oct 16, 2024
815e402
Add an additional note about choosing the correct RMW implementation …
civerachb-cpr Oct 16, 2024
0b65650
Add a note to the bash setup table about RMW implementation needing t…
civerachb-cpr Oct 16, 2024
16b9f29
Add a section for the Reset Create3 setup menu item
civerachb-cpr Oct 16, 2024
b1275ad
Add disable-diagnostics tab for jazzy
civerachb-cpr Oct 16, 2024
c1de5a4
Add sourcing-jazzy tab
civerachb-cpr Oct 16, 2024
be90253
Add tabs for the Create3 topics not being visible, rewrite that secti…
civerachb-cpr Oct 16, 2024
6dd6174
Forgot to save before last commit
civerachb-cpr Oct 16, 2024
63742f0
Consolidate keyboard teleop tabs by using envars
civerachb-cpr Oct 16, 2024
8a75ff5
Add Jazzy sections to the first-node examples
civerachb-cpr Oct 16, 2024
86c1e1a
Add jazzy slam
civerachb-cpr Oct 16, 2024
be6fba2
Add jazzy nav2
civerachb-cpr Oct 16, 2024
28795fe
Add jazzy tabls for navigation, reword missing galactic tutorial notices
civerachb-cpr Oct 16, 2024
f11cd3f
Remove theme lines that are already in _config.yaml
civerachb-cpr Oct 16, 2024
ef63fdf
Remove command that's already in Makefile
civerachb-cpr Oct 16, 2024
8fd28a0
Add `make update` to build commands
civerachb-cpr Oct 16, 2024
25545a0
Update simple discovery networking for Jazzy
civerachb-cpr Oct 16, 2024
1ed71bb
Remove superfluous line breaks
civerachb-cpr Oct 16, 2024
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
6 changes: 1 addition & 5 deletions .debug.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
remote_theme: false

debug:
compress: false
dist: true
shortcodes: true

theme: jekyll-rtd-theme
shortcodes: true
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ body:
- Select One
- Galactic
- Humble
- Jazzy
validations:
required: true
- type: dropdown
Expand All @@ -52,6 +53,7 @@ body:
- Select One
- Ubuntu 20.04
- Ubuntu 22.04
- Ubuntu 24.04
- Other Linux
- Windows / MAC
validations:
Expand Down
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This repository contains the source code for building the Turtlebot4 User Manual

## Build

To build the Turtlebot4's User Manual locally, first [install Ruby version 2.7.7](https://gorails.com/setup/ubuntu/22.04)
To build the Turtlebot4's User Manual locally, first [install Ruby version 3.2](https://gorails.com/setup/ubuntu/24.04)

You can check your ruby the version using:
```bash
Expand All @@ -14,26 +14,24 @@ Ensure that it is showing the correct version.

<p>
<details>
<summary><b>Using Ruby 3+</b></summary>
Ruby 3+ isn't recommended due to [this issue](https://talk.jekyllrb.com/t/error-no-implicit-conversion-of-hash-into-integer/5890/2). Unfortunately, Ruby 3+ is required for `sass-converter` to be installed; a dependency of jekyll. If you don't want to (or can't) juggle multiple Ruby versions, you can run this patch to fix Ruby 3+ such that it works with Github Pages.

```shell
sudo sed -i.bak 's/, kwd/, **kwd/' $(gem which pathutil)
```
<summary><b>Configuring Ubuntu 24.04</b></summary>
By default, Ubuntu 24.04 uses a debian-packaged version of Ruby, which installs gems to a root-owned path. This makes installing additional gems problematic.
To work around this issue, run the following commands:
```shell
mkdir $HOME/.ruby
echo 'export GEM_HOME=$HOME/.ruby/' >> $HOME/.bashrc
echo 'export PATH="$PATH:$HOME/.ruby/bin"' >> $HOME/.bashrc
source $HOME/.bashrc
```
This will make the `gem` command install Ruby gems to your local user's `.ruby` directory.
</details>
</p>

If you get the warning "No version is set for command ruby" then you need to set the active ruby version in asdf:
```bash
asdf global ruby 2.7.7
```
Ensure your Ruby gems are up to date:
```bash
```shell
gem update --system
```

Next [install Jekyll and the rest of the prerequisites](https://jekyllrb.com/docs/). Be careful to not overwrite the Ruby version.

Clone this repository:

```bash
Expand All @@ -45,7 +43,8 @@ Build and start a local server:
```bash
cd turtlebot4-user-manual
make
make update
make server
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add the update command into this process so it looks like:

make
make update
make server

This will ensure that the dependencies get updated, aligning with how the actual release will get built. (Otherwise the versions that you use locally stay locked to when you first built.) It is a future discussion to be had, (or you can look into) whether we can include the Gemfile.lock in the repo and whether that will be respected by Github Pages when it gets built, and not have to deal with the constant dependency updates.

Copy link
Author

Choose a reason for hiding this comment

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

Done

```

The webpage will now be available at `127.0.0.1:4000`
The webpage will now be available at `http://127.0.0.1:4000/turtlebot4-user-manual`
2 changes: 1 addition & 1 deletion _includes/templates/addons.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</div>
<div class="branch p-1">
<span class="name">
v1.0.0
v2.0.0
</span>
<i class="fa fa-caret-down"></i>
</div>
Expand Down
6 changes: 5 additions & 1 deletion changelogs/galactic.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sort: 1

# TurtleBot 4 Galactic

```warning
**ROS 2 Galactic is no longer supported.** Please consider updating to a newer release
```

TurtleBot 4 RPi4 image changelogs. Latest images are available [here](http://download.ros.org/downloads/turtlebot4/).

## v0.1.3
Expand All @@ -19,7 +23,7 @@ TurtleBot 4 RPi4 image changelogs. Latest images are available [here](http://dow
- Added a service to forward the Create® 3 webserver through the RPi4
- Users can now access the Create® 3 webserver by navigating to the IP address of their TurtleBot 4 with the port 8080 on a web browser.
- The Create® 3 does not need to be placed into AP mode to access the webserver.
- Example: TurtleBot 4 with an IP address of `192.168.0.187`.
- Example: TurtleBot 4 with an IP address of `192.168.0.187`.
- Enter `192.168.0.187:8080` into your browser:
<figure class="aligncenter">
<img src="media/webserver.png" alt="Webserver" style="width: 90%"/>
Expand Down
83 changes: 83 additions & 0 deletions changelogs/jazzy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
sort: 3
---

# TurtleBot 4 Jazzy

TurtleBot 4 RPi4 image changelogs. Latest images are available [here](http://download.ros.org/downloads/turtlebot4/).

## v2.0.0

**OS**: Ubuntu Server 24.04.5 LTS

**ROS**: Jazzy

**Create® 3 Firmware**: I.0.0

### General

- Due to technical limitations, the Create3 firmware only supports FastRTPS or CycloneDDS; changing
RMW implementations requires installing the correct firwmare version on the Create3
- Updated `install.py` to support Jazzy
- Use `create3_republisher` by default to expose base platform topics from the RPi4
- ROS Control changes to use `TwistStamped` messages for velocity control instead of `Twist`
- Renamed `ignition` and `ign` packages & launch files to use preferred `gz` nomenclature

### TurtleBot 4 Packages

<table>
<thead>
<tr>
<th>Package</th>
<th>Version</th>
<th>Changes</th>
</tr>
</thead>
<tbody>
<tr>
<td>turtlebot4_base</td>
<td>2.0.0</td>
<td>-</td>
</tr>
<tr>
<td>turtlebot4_bringup</td>
<td>2.0.0</td>
<td>-</td>
</tr>
<tr>
<td>turtlebot4_description</td>
<td>2.0.0</td>
<td>-</td>
</tr>
<tr>
<td>turtlebot4_diagnostics</td>
<td>2.0.0</td>
<td>-</td>
</tr>
<tr>
<td>turtlebot4_msgs</td>
<td>2.0.0</td>
<td>-</td>
</tr>
<tr>
<td>turtlebot4_navigation</td>
<td>2.0.0</td>
<td>-</td>
</tr>
<tr>
<td>turtlebot4_node</td>
<td>2.0.0</td>
<td>-</td>
</tr>
<tr>
<td>turtlebot4_robot</td>
<td>2.0.0</td>
<td>-</td>
</tr>
<tr>
<td>turtlebot4_tests</td>
<td>2.0.0</td>
<td>-</td>
</tr>
</tbody>
</table>
3 changes: 2 additions & 1 deletion overview/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ sort: 2
### Ubuntu
- Ubuntu 20.04 LTS Desktop (Focal Fossa): <https://releases.ubuntu.com/20.04/>
- Ubuntu 22.04 LTS Desktop (Jammy Jellyfish): <https://releases.ubuntu.com/22.04/>
- Ubuntu 24.04 LTS Desktop (Noble Numbat): <https://releases.ubuntu.com/24.04/>

### Raspberry Pi
- Raspberry Pi Imager: <https://www.raspberrypi.com/software/>
Expand All @@ -17,7 +18,7 @@ sort: 2
### ROS 2
- Documentation: <https://docs.ros.org/en/humble/index.html>
- Ubuntu (Debian) Install: <https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html>
- Nav2 Documentation: <https://navigation.ros.org/>
- Nav2 Documentation: <https://docs.nav2.org/>
- Nav2 Github: <https://github.com/ros-planning/navigation2>
- SLAM Toolbox: <https://github.com/SteveMacenski/slam_toolbox>

Expand Down
Loading