Skip to content

Commit

Permalink
Enhance workshop documentation with improved formatting and additiona…
Browse files Browse the repository at this point in the history
…l details
horverno committed Nov 20, 2024
1 parent 93d92c3 commit f91288e
Showing 8 changed files with 109 additions and 15 deletions.
Binary file added docs/img/f1tenth01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 51 additions & 0 deletions docs/smt25/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
hide:
- navigation
---

## About F1/10 Autonomous Racing

F1TENTH (F1/10) Autonomous Racing is a semi-regular competition organized by an international community of researchers, engineers, and autonomous systems enthusiasts. The teams participating in an F1TENTH compatition will build a 1:10 scaled autonomous race car according to a given specification and write software for it to fulfill the objectives for the competition: Don’t crash and minimize laptime.


<figure markdown="span">
![f1tenth](../img/f1tenth01.png){ width="400" }
<figcaption>F1TENTH car</figcaption>
</figure>

## About SMT 2025

The 2nd Sustainable Mobility and Transportation Symposium, an interdisciplinary scientific conference organized by the Audi Hungaria Faculty of Vehicle Engineering and the Vehicle Industry Reserach Center of Széchenyi István University. The conference is dedicated to exploring the latest advancements and innovations in the field of automotive technology and transportation, and aims to bring together experts from various domains to foster collaboration, share insights, and shape the future of mobility.

## Official Websites

- [smtsymposium.sze.hu](https://smtsymposium.sze.hu/)
- [roboracer.ai](https://roboracer.ai/race.html)


# F1/10 @SMT2025

## Imortant Dates

- **Competition date**: october 2025 *(TODO: exact date to be announced)*
- **Registration opens**: *(TODO: exact date to be announced)*
- **Registration deadline**: *(TODO: exact date to be announced)*


## Place

Europe, Hungary, Győr, Széchenyi István University


<iframe src="https://www.google.com/maps/embed?pb=!1m18!1m12!1m3!1d2685.527007465113!2d17.626114976271186!3d47.69360507119796!2m3!1f0!2f0!3f0!3m2!1i1024!2i768!4f13.1!3m3!1m2!1s0x476bbfde2b86b24d%3A0xb0b816da0af54c2c!2sVehicle%20Industry%20Research%20Center!5e0!3m2!1sen!2shu!4v1732101780142!5m2!1sen!2shu" width="600" height="450" style="border:0;" allowfullscreen="" loading="lazy" referrerpolicy="no-referrer-when-downgrade"></iframe>

## Race Resources

All necessary information about the race e.g. rules, scoring system, simulation environments and track data will be displayed here.

- Rules
- Frequently Asked Questions
- In-person competition

# Flyer

8 changes: 8 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -18,4 +18,12 @@
--md-footer-fg-color: #43AEC5;
--md-footer-fg-color--light: #b9e7f2;
--md-footer-fg-color--lighter: #d9eef3;
}

.sze-color-primary {
color: #43AEC5;
}

.sze-color {
color: #43AEC5;
}
33 changes: 26 additions & 7 deletions docs/workshops/control_sim.md
Original file line number Diff line number Diff line change
@@ -27,7 +27,10 @@ Gazebo Fortress ROS 2 simulation for the waypoint and planner tools.
It is assumed that the workspace is `~/ros2_ws/`.

### Clone the packages
```

Clone [wayp_plan_tools](https://github.com/jkk-research/wayp_plan_tools) and [sim_wayp_plan_tools](https://github.com/jkk-research/sim_wayp_plan_tools) packages.

```bash
cd ~/ros2_ws/src && \
git clone https://github.com/jkk-research/wayp_plan_tools && \
git clone https://github.com/jkk-research/sim_wayp_plan_tools
@@ -51,11 +54,13 @@ ign gazebo -v 4 -r ackermann_steering.sdf

### 2. Start the Gazebo bridge

Don't forget to `source` before ROS commands.
<details>
<summary> Open a neew terminal and don't forget to source before ROS commands.</summary>

``` r
source ~/ros2_ws/install/local_setup.bash
``` bash
source ~/ros2_ws/install/setup.bash
```
</details>

``` r
ros2 launch sim_wayp_plan_tools gazebo_bridge.launch.py
@@ -130,13 +135,28 @@ ros2 launch sim_wayp_plan_tools rviz1.launch.py

# Or run everything with a single command

After `ign gazebo -v 4 -r ackermann_steering.sdf` (terminal 1) and `source ~/ros2_ws/install/local_setup.bash` (terminal 2), run this command (also in terminal 2):
After `ign gazebo -v 4 -r ackermann_steering.sdf` (terminal 1) open a new terminal.

<details>
<summary> Don't forget to source bashrc.</summary>

``` bash
source ~/.bashrc
```
</details>

Run this command (in terminal 2):

``` r
ros2 launch sim_wayp_plan_tools all_in_once.launch.py
```

## Evaluation

``` bash
ros2 run rqt_reconfigure rqt_reconfigure
```

The following image shows some example runs:

![](https://raw.githubusercontent.com/jkk-research/sim_wayp_plan_tools/ros2/img/csv_eval01.svg)
@@ -159,5 +179,4 @@ Once you have identified the PID, use the kill command followed by the PID to te

``` r
kill 12345
```

```
15 changes: 12 additions & 3 deletions docs/workshops/f1tenth_sim_a.md
Original file line number Diff line number Diff line change
@@ -54,10 +54,19 @@ All libraries should be ready to use and the `ign gazebo` app ready to be execut

Issue the following command:

```bash
sudo apt install ros-humble-ros-gz-bridge
```

=== "Humble"

```bash
sudo apt install ros-humble-ros-gz-bridge
```

=== "Jazzy"

```bash
sudo apt install ros-$ROS_DISTRO-ros-gz-bridge
```

## Additional settings to WSL2

!!! danger "Warning - WSL2"
2 changes: 1 addition & 1 deletion docs/workshops/ros2_a.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## `ROS 2` install hands-on workshop
## `ROS 2` install hands-on workshop :simple-ros:{ .sze-color }

This document will guide you through the installation process of `ROS 2`.

13 changes: 9 additions & 4 deletions docs/workshops/ros2_b.md
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ title: ROS 2 introduction



## `ROS 2` intro
## `ROS 2` :simple-ros:{ .sze-color } intro


`ROS 2`, the latest release of `ROS`, is a set of software libraries and tools (middleware) that help develop robot applications. By definition, middleware is software that connects software components. It is a layer that sits between the operating system and applications on both sides of a distributed computer network. `ROS 2` uses the permissive open source [Apache 2.0](https://choosealicense.com/licenses/apache-2.0/) license.
@@ -258,23 +258,28 @@ string frame_id

A `Header` és a`Point` a típusból épül fel a `PoseStamped` típus struktúrája:

``` bash
``` { .bash .annotate }
$ ros2 interface show geometry_msgs/msg/PoseStamped
std_msgs/Header header
uint32 seq
time stamp
string frame_id
geometry_msgs/Pose pose
geometry_msgs/Point position
geometry_msgs/Point position # (1)
float64 x
float64 y
float64 z
geometry_msgs/Quaternion orientation
geometry_msgs/Quaternion orientation # (2)
float64 x
float64 y
float64 z
float64 w

```
{ .annotate }

1. :man_raising_hand: This should look familiar: `geometry_msgs/msg/Point` has already been discussed.
2. :man_raising_hand: `geometry_msgs/Quaternion` is a type that represents a rotation in 3D space.

### Publishing / Subscribing

2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -116,6 +116,7 @@ nav:
- workshops/control_sim.md
- ROS 1 (legacy):
- Wheeltec hands-on (ROS 1) : workshops/wheeltec_real_a.md
- F1/10 @SMT25: smt25/index.md

# +--------------------------------------------------------------------------------------------------------+
# | |
@@ -487,6 +488,7 @@ extra:
# +--------------------------------------------------------------------------------------------------------+
markdown_extensions:
- attr_list
- md_in_html
- pymdownx.superfences:
custom_fences:
- name: mermaid

0 comments on commit f91288e

Please sign in to comment.