Skip to content

Commit 7f93e56

Browse files
pablogs9ralph-lange
authored andcommitted
Text improvements
1 parent f28680e commit 7f93e56

1 file changed

Lines changed: 17 additions & 21 deletions

File tree

  • _docs/tutorials/demos/crazyflie_demo

‎_docs/tutorials/demos/crazyflie_demo/index.md‎

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,16 @@ Both of them rely on **micro-ROS** publication and subscription mechanisms and u
1313

1414
This demo also includes conventional ROS 2 tooling as a demonstration of integration with **ROS 2**. We use Gazebo, RVIZ and simple ROS 2 nodes (aka **external nodes**) acting as data converters.
1515

16-
## Index
17-
- [Index](#index)
18-
- [Setup](#setup)
19-
- [Required Hardware](#required-hardware)
2016
- [Installation](#installation)
21-
- [Install external ROS2 nodes](#install-external-ros2-nodes)
22-
- [Compile and flash Crazyflie 2.1 firmware](#compile-and-flash-crazyflie-21-firmware)
23-
- [Install Crazyflie Client + Bridge](#install-crazyflie-client--bridge)
24-
- [Compile and flash Kobuki Turtlebot 2 firmware](#compile-and-flash-kobuki-turtlebot-2-firmware)
17+
- [Install external ROS2 nodes](#install-external-ros2-nodes)
18+
- [Build and flash Crazyflie 2.1 firmware](#build-and-flash-crazyflie-21-firmware)
19+
- [Install Crazyflie Client + Bridge](#install-crazyflie-client--bridge)
20+
- [Build and flash Kobuki Turtlebot 2 firmware](#build-and-flash-kobuki-turtlebot-2-firmware)
2521
- [Usage](#usage)
26-
- [Run Kobuki Turtlebot 2 Node](#run-kobuki-turtlebot-2-node)
27-
- [Run Crazyflie 2.1 Node](#run-crazyflie-21-node)
28-
- [Run external ROS2 nodes](#run-external-ros2-nodes)
29-
- [Run RVIZ visualizers](#run-rviz-visualizers)
22+
- [Run Kobuki Turtlebot 2 Node](#run-kobuki-turtlebot-2-node)
23+
- [Run Crazyflie 2.1 Node](#run-crazyflie-21-node)
24+
- [Run external ROS2 nodes](#run-external-ros2-nodes)
25+
- [Run RVIZ visualizers](#run-rviz-visualizers)
3026

3127
## Setup
3228

@@ -36,7 +32,7 @@ The **Crazyflie 2.1** drone relies on [ST STM32F405](https://www.st.com/en/micro
3632
- its own relative position as a 3D vector (X, Y and Z) using a *geometry_msg/Point32* message type on */drone/odometry* topic.
3733
- its own attitude as a 3D vector (pitch, roll and yaw) using a *geometry_msg/Point32* message type on */drone/attitude* topic.
3834

39-
The **Kobuki Turtlebot 2** robot is controlled using a UART protocol through a custom DB25 connector. The Micro ROS node runs on an Olimex STM32-E407 board attached to that UART port. This hardware features a [ST STM32F407](https://www.st.com/en/microcontrollers-microprocessors/stm32f407-417.html) MCU running **[Nuttx](https://nuttx.org/)** RTOS. In the same way, this node can communicate with the robot (UART) and with the ROS2 world (integrated Ethernet). Its used topics are:
35+
The **Kobuki Turtlebot 2** robot is controlled using a UART protocol through a custom DB25 connector. The micro-ROS node runs on an Olimex STM32-E407 board attached to that UART port. This hardware features a [ST STM32F407](https://www.st.com/en/microcontrollers-microprocessors/stm32f407-417.html) MCU running **[Nuttx](https://nuttx.org/)** RTOS. In the same way, this node can communicate with the robot (UART) and with the ROS2 world (integrated Ethernet). Its used topics are:
4036
- a subscription on */cmd_vel* topic (*geometry_msg/Twist* message type) to receive the controlling angular and linear velocity.
4137
- a publication on */robot_pose* topic (*geometry_msg/Vector3* message type) which includes X position, Y position and robot yaw.
4238

@@ -107,14 +103,14 @@ rosdep update && rosdep install --from-paths src --ignore-src -r -y
107103
rm ros2.yaml
108104
```
109105

110-
Compile the project:
106+
Build the project:
111107
```bash
112108
source /opt/ros/dashing/setup.bash
113109
rosdep update && rosdep install --from-paths src --ignore-src -r -y
114110
colcon build --symlink-install
115111
```
116112

117-
## Compile and flash Crazyflie 2.1 firmware
113+
## Build and flash Crazyflie 2.1 firmware
118114

119115
Install the toolchain:
120116
```bash
@@ -173,9 +169,9 @@ Clone the repo dependencies:
173169
git clone -b Micro-XRCE-DDS_Bridge https://github.com/eProsima/crazyflie-clients-python
174170
```
175171

176-
## Compile and flash Kobuki Turtlebot 2 firmware
172+
## Build and flash Kobuki Turtlebot 2 firmware
177173

178-
Create a workspace for compiling **Micro ROS**:
174+
Create a workspace for building **micro-ROS**:
179175
```
180176
source /opt/ros/crystal/setup.bash
181177
sudo apt install python-rosdep
@@ -186,7 +182,7 @@ colcon build --packages-select micro_ros_setup
186182
source install/local_setup.bash
187183
```
188184

189-
Build **Micro ROS Agent**:
185+
Build **micro-ROS Agent**:
190186
```
191187
colcon build --packages-select micro_ros_setup
192188
source install/local_setup.bash
@@ -215,7 +211,7 @@ After installation, the following packages should be present in your system:
215211
.
216212
+-- Micro-XRCE-DDS # used for installing Micro-XRCE-DDS
217213
+-- crazyflie_demo
218-
+-- crazyflie-firmware # used for compiling and flashing Crazyflie 2.1 firmware
214+
+-- crazyflie-firmware # used for building and flashing Crazyflie 2.1 firmware
219215
+-- kobuki-firmware # used for building and flashing Kobuki Turtlebot 2 firmware
220216
+-- crazyflie-clients-python
221217
```
@@ -226,14 +222,14 @@ Make sure that all ROS2 or MicroROS nodes created along with the following steps
226222

227223
TODO: Explain data and power connections between Kobuki Turtlebot 2, Olimex STM32-E407 and MiniRouter.
228224

229-
Run the **Micro ROS Agent**:
225+
Run the **micro-ROS Agent**:
230226
```
231227
cd kobuki-firmware
232228
source /opt/ros/crystal/setup.bash && source install/local_setup.bash
233229
ros2 run micro_ros_agent micro_ros_agent udp 9999
234230
```
235231

236-
**Micro ROS Agent** should receive an incoming client connection and */robot_pose* topic should be published. Check it with `ros2 topic echo /robot_pose`
232+
**micro-ROS Agent** should receive an incoming client connection and */robot_pose* topic should be published. Check it with `ros2 topic echo /robot_pose`
237233

238234
## Run Crazyflie 2.1 Node
239235

0 commit comments

Comments
 (0)