Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rafal-gorecki authored Apr 12, 2024
1 parent 337ed5f commit 8497c70
Showing 1 changed file with 10 additions and 21 deletions.
31 changes: 10 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@ ROS2 packages for ROSbot XL

You can find ROS API and detailed package description in [ROS_API.md](./ROS_API.md).

## Usage on hardware

To run the software on real ROSbot XL, also communication with Digital Board will be necessary.
First update your firmware to make sure that you use the latest version, then run the `micro-ROS` agent.
For detailed instructions refer to the [rosbot_xl_firmware repository](https://github.com/husarion/rosbot_xl_firmware).

## Prepare environment

1. **Install `ros-dev-tools` and `stm32flash`** (`stm32flash` is not in the ros index and should be installed manually).
Expand Down Expand Up @@ -56,28 +50,23 @@ For detailed instructions refer to the [rosbot_xl_firmware repository](https://g
colcon build
```

> [!NOTE]
> Before starting the software on the robot please make sure that you're using the latest firmware and run the `micro-ROS` agent as described in the [Usage on hardware](#usage-on-hardware) step.
2. **Running**

Flash firmware.
```bash
# Get admin permissions to flash firmware
sudo su
source install/setup.bash
ros2 run rosbot_xl_utils flash_firmware
exit
```
Launch ROSbot.
```bash
source install/setup.bash
ros2 launch rosbot_xl_bringup combined.launch.py
```

> [!IMPORTANT]
> Whenever the software version is changed, it is recommended to update the firmware version to ensure that the package version is compatible with the firmware version.
>
> ```bash
> sudo su # Get admin permissions to flash firmware
> source install/setup.bash
> ros2 run rosbot_xl_utils flash_firmware
> exit
> ```

### Build and run Gazebo simulation

1. **Building**
Expand Down

0 comments on commit 8497c70

Please sign in to comment.