Skip to content

Commit

Permalink
Merge pull request #32 from imagidan-ets/main
Browse files Browse the repository at this point in the history
Update docker_architecture_dev.puml and fix typos
  • Loading branch information
SimonR99 authored Apr 5, 2024
2 parents 79b93ba + 41a29d5 commit 759801e
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Rove is a robot developed by the Capra team at ÉTS. Utilizing ROS2 Humble, Rove

## Work in a docker container (Preferred)

Working in a dev container will allow you to have the same environnement as the CI and make sure that your code will work on another computer. It will also allow you to easily switch package version and test thing without breaking your computer.
Working in a dev container will allow you to have the same environment as the CI and make sure that your code will work on another computer. It will also allow you to easily switch package version and test things without breaking your computer.

### Windows docker installation

Expand All @@ -19,15 +19,15 @@ Working in a dev container will allow you to have the same environnement as the

### Linux docker installation

Same as the windows installation, step 4 and 8 can be skipped.
Same as the windows installation, step 3 and 8 can be skipped.

Replace the DISPLAY environemnt variable in the .env file
Replace the DISPLAY environment variable in the .env file
```bash
echo DISPLAY=$DISPLAY
```

To be able to use the controller node, the user need read/write permissions on the inputs.
Exemple:
Example:
```bash
cat /dev/input/event0
```
Expand Down Expand Up @@ -69,11 +69,11 @@ source install/setup.bash
ros2 launch rove_bringup rove_controller_usb.launch.py
```

## Running the controller with a usb cable
## Running the controller with bluetooth

```bash
source install/setup.bash
ros2 launch rove_bringup rove_controller_bluethoot.launch.py
ros2 launch rove_bringup rove_controller_bluetooth.launch.py
```

## Adding New Packages
Expand Down Expand Up @@ -109,10 +109,10 @@ This package serves as a comprehensive wrapper for SLAM operations, incorporatin

## Docker architecture

It's possible to run the entire project into multiple docker containers. Each container can be run independantly and are built using the following structure :
It's possible to run the entire project into multiple docker containers. Each container can be run independently and are built using the following structure :

![Docker structure](https://www.plantuml.com/plantuml/svg/VP71Ri8m38RlUOgezwvZq8vnc3XmsLDKJkgLGEj4JbfjU_gr0QgWJHoGVjl_xtouUn-0mz1tyc3r6Ldwm8CE0wCGmOGEPNOTVFJGeZoWGsgGj46V2S6e0r0xszgZvYTZ2zqDIeDZA5huGMLtH-3Uaj6P12zlHPfawulfjpiElUemRz2VWtNHFhNhQ_qWCSbSWSSbCXUfdyOB6uscCL0O3w3ZWgzjLLURUS5BVLbMA_rPhak4jNfhLXLiomq0gjNhymfK2TigFdB2u2tLbWs9Ux1n_WEZjXJ0479qJmtihEkHGhrC_iGOl5F8_9qx4sFip0Fx1I6V4HAa922IPsMUlzyTCz5njdoNcuZT_y55jg3A2NLsBbUNOb6nxSnTy8G-M98HEXhIGoOwdINvFL8pz9tu1G00 "Docker structure")

# Documentation

To update the UML diagram, create a new encoded link on the PlantUML website. Copy the existing UML, make your changes, and then update the markdown file with the new link.
To update the UML diagram, create a new encoded link on the PlantUML website. Copy the existing UML, make your changes, and then update the Markdown file with the new link.
2 changes: 1 addition & 1 deletion docs/docker_architecture_dev.puml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title "Docker Image Dependencies"
rectangle "ghcr.io/clubcapra/gazebo:harmonic" as harmonic
rectangle "ros/ros:humble-desktop" as ros_desktop
rectangle "ros/ros:humble-ros-base" as ros_base
rectangle "nvcr.io/nvidia/isaac/ros:x86_64-ros2_humble_bcf535ea3b9d16a854aaeb1701ab5a86" as jetson_orin
rectangle "nvcr.io/nvidia/isaac/ros:aarch64-ros2_humble_b7e1ed6c02a6fa3c1c7392479291c035" as jetson_orin

rectangle "rove-devcontainer" as development_container
rectangle "rove-raspberry-pi" as rpi_container
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
RS_Y: 3
RT: 4
D_PAD_X: 6
D_PAD_Y: 7
D_PAD_Y: 7
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ def generate_launch_description():
# Get params files
joy_params_file = dir + '/config/joy_params.yaml'
teleope_joy_params_file = dir + '/config/teleop_joy_params.yaml'
bluethoot_mapping_file = dir + '/config/bluethoot_mapping.yaml'
bluetooth_mapping_file = dir + '/config/bluetooth_mapping.yaml'

return LaunchDescription([
Node(
Expand All @@ -32,7 +32,7 @@ def generate_launch_description():
package=package_name,
executable='rove_controller_node',
name='rove_controller_node',
parameters=[bluethoot_mapping_file],
parameters=[bluetooth_mapping_file],
output='screen',
),
])
])

0 comments on commit 759801e

Please sign in to comment.