Skip to content

Commit b00d113

Browse files
authored
Merge pull request #566 from iRobotEducation/asoragna/docs-fixes
Minor docs fixes
2 parents 1284c10 + d7193ab commit b00d113

File tree

3 files changed

+7
-11
lines changed

3 files changed

+7
-11
lines changed

docs/api/ros2.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ $ ros2 topic list -t
1717
/cmd_audio [irobot_create_msgs/msg/AudioNoteVector]
1818
/cmd_lightring [irobot_create_msgs/msg/LightringLeds]
1919
/cmd_vel [geometry_msgs/msg/Twist]
20-
/dock [irobot_create_msgs/msg/Dock]
20+
/dock_status [irobot_create_msgs/msg/DockStatus]
2121
/hazard_detection [irobot_create_msgs/msg/HazardDetectionVector]
2222
/imu [sensor_msgs/msg/Imu]
2323
/interface_buttons [irobot_create_msgs/msg/InterfaceButtons]
@@ -93,7 +93,7 @@ You can see the ROS 2 action servers exposed by the Create® 3 robot running the
9393
```bash
9494
$ ros2 action list -t
9595
/audio_note_sequence [irobot_create_msgs/action/AudioNoteSequence]
96-
/dock [irobot_create_msgs/action/DockServo]
96+
/dock [irobot_create_msgs/action/Dock]
9797
/drive_arc [irobot_create_msgs/action/DriveArc]
9898
/drive_distance [irobot_create_msgs/action/DriveDistance]
9999
/led_animation [irobot_create_msgs/action/LedAnimation]

docs/setup/pi4humble.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
# Connect Create® 3 to Raspberry Pi® 4 and set up ROS 2 Humble
22

3-
!!! note
4-
As of March 2023, use of Galactic is recommended, as it is more performant than Humble on Create 3.
5-
63
## Before you start
74
!!! attention
85
**These directions are written for someone with experience with embedded Linux and basic embedded computers.**
96
It is highly recommended to read through the following documents before beginning:
107

118
* [How to install Ubuntu Server on your Raspberry Pi](https://ubuntu.com/tutorials/how-to-install-ubuntu-on-your-raspberry-pi)[^1] - official Canonical documentation
12-
* [Installing ROS 2 on Ubuntu Linux](https://docs.ros.org/en/galactic/Installation/Ubuntu-Install-Debians.html)[^1] - official Open Robotics documentation
9+
* [Installing ROS 2 on Ubuntu Linux](https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html)[^1] - official Open Robotics documentation
1310

1411
## Step-by-step
1512

@@ -19,10 +16,12 @@ It is highly recommended to read through the following documents before beginnin
1916

2017
1. Insert your microSD card into your computer and under storage in the Raspberry Pi Imager, select your microSD card.
2118

22-
1. Select the gear icon to optionally customize advanced options including enabling SSH, setting a unique username and password, and configuring a wireless LAN.
19+
1. It's recommended to customize advanced options for the image before flashing it.
20+
To do it, either click on the gear icon, if visible, or press "ctrl + shift + x" keyboard shortcut ("command + shift + x" on MacOS).
21+
Advanced options include enabling SSH, setting a unique username and password, and configuring a wireless LAN.
2322
It is recommended to uncheck the "Eject media when finished" box in advanced options so you can edit the necessary files in the following steps without re-inserting the SD card.
2423

25-
1. Once all options have been selected, click the "WRITE" button to write the image to your SD card.
24+
1. Once all options have been selected, click the "WRITE" (or "NEXT") button to write the image to your SD card.
2625

2726
1. In the system-boot partition, edit config.txt and add `dtoverlay=dwc2,dr_mode=peripheral` at the end of the file.
2827

docs/setup/ubuntu2204.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
# Install ROS 2 Humble with Create 3 Messages on an Ubuntu 22.04 Machine
22

3-
!!! note
4-
As of March 2023, use of Galactic is recommended, as it is more performant than Humble on Create 3.
5-
63
## Before you start
74
These directions should work on a machine natively running Ubuntu[^1] 22.04, as well as in a virtualized container within another operating system.
85
Note that there might be some network setup required if in a virtualized container; for example, RMWs seem to like running in a bridged network configuration rather than a NATted one.

0 commit comments

Comments
 (0)