Skip to content

Commit

Permalink
add en
Browse files Browse the repository at this point in the history
  • Loading branch information
knorrrr committed Oct 31, 2024
1 parent cf6262b commit 6eb8028
Show file tree
Hide file tree
Showing 2 changed files with 139 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/finals/index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Finals Overview

For the latest information on the semifinals and finals, please visit the following Society of Automotive Engineers of Japan website:
[https://www.jsae.or.jp/jaaic/2024ver/](https://www.jsae.or.jp/jaaic/2024ver/)

## Event Details

### Schedule

| Event | Date | Time |
| ------------------------------ | ----------------------------- | ---- |
| Final Practice Day | November 1, 2024 (Postponed) | 8:30~20:00 |
| Semifinals | November 2, 2024 (Postponed) | 8:30~20:00 |
| Finals | November 3, 2024 (Postponed) | 9:00~17:30 |
| Awards Ceremony & Networking | December 13, 2024 | TBD |

### Venue

[City Circuit Tokyo Bay](https://city-circuit.com/)
<iframe width="704" height="396" src="https://www.youtube.com/embed/GsuCUoNrMDM?si=zoh1mL_U0yRnB2fj" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

## [Next: How to Operate the Vehicle](./operation.en.md)
117 changes: 117 additions & 0 deletions docs/finals/operation.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# How to Operate the Vehicle

## Information Provided to Each Team
The following information will be shared with each team before the event.
| Item | Purpose |
| ---- | ------- |
| Vehicle Number (A1-A8) | Identification number assigned to each team's vehicle |
| Vehicle ECU Username | Username for logging in and SSH connection to the vehicle ECU |
| Vehicle ECU Password | Password for logging in and SSH connection to the vehicle ECU |

## Important Notes
- Please do not rename the `aichallenge-2024` directory under home as scripts are path-dependent.
- ROSBAG recording is not automatic, so please execute the recording command during operation.
- By default, Zenoh communication is set to only receive topics. If you need to change settings during operation, please use either of the following methods:
- Connect via SSH and execute directly from within the ECU without using Zenoh Bridge
- Comment out the `allow` section (lines 55-62) in the configuration file (`vehicle/zenoh.json5`) inside `aichallenge-2024` on the ECU
- To connect using a vehicle number, you need to install arp-scan software using the following command:
- `sudo apt install arp-scan`

## How to Connect to Vehicle ECU
- Connect your PC to the Wi-Fi network `CCTB_office_01` (same network as vehicle ECU)
- On your PC, execute `cd aichallege-2024/remote` to change working directory
- Execute `bash connect_ssh.bash <vehicle_name> <username>` on your PC (e.g., `bash connect_ssh.bash A9 aic-team`)
- Enter your PC password if prompted
- Enter the vehicle ECU password when prompted
- If the above command doesn't work:
- Ask staff for the vehicle's `<IP address>`
- Execute `ssh <username>@<IP address>` on your PC

## How to Transfer Autoware to Vehicle ECU
- Please keep the folder name as `aichallenge-2024` due to script path dependencies.
1. An `aichallenge-2024` folder is located under `/home` on the ECU; edit the submit folder within.
2. Transfer aichallenge-2024 from your PC using SCP or VSCode Remote SSH

## Operations After Connecting to Vehicle ECU
### 1. Starting Drivers and Docker Containers
```bash
cd aichallenge-2024
./docker_build.sh dev (only needs to be executed once initially)
bash run_vehicle_tmux.sh
```
The terminal will be split as shown below:
![tmux-image](./images/tmux.png)
- Left ①: Starts ./docker_run dev cpu and enters aichallenge-2024 container
- Right ②: Starts ./docker_run dev cpu and enters aichallenge-2024 container
- Right ③: Vehicle driver software starts
- Right ④: Zenoh bridge starts
- Right ⑤: Nothing specific

### 2. Starting Autoware
Execute within Docker container. By default, use terminal ① on the left or ② on the right.
```bash
cd /aichallenge
./build_autoware.bash (execute only once initially, then as needed when making changes that require rebuilding)
./run_autoware.bash vehicle (autoware starts and is ready)
```

### 3. Recording ROSBAG
Execute within Docker container. By default, use terminal ① on the left or ② on the right.
```bash
cd /aichallenge
source workspace/install/setup.bash
ros2 bag record -a
# If you want to avoid warnings (though they don't affect operation), use this alternative command:
ros2 bag record -a -x "(/racing_kart/.*|/to_can_bus|/from_can_bus)"
# You can also record using this command:
cd /aichallenge
./record_rosbag.bash
```

## For ROS Communication Between Local PC and ECU
- Execute the following on your local PC:
```bash
# Only needed once initially
./docker_build.sh dev
# Enter Docker container
./docker_run.sh dev cpu
# Launch terminator (GUI version of tmux) and split screen by right-clicking
# In one terminator terminal, connect to vehicle via Zenoh
cd /remote
./connect_zenoh.bash <vehicle_number>
# In the other terminator terminal, you can communicate with ECU
# (Example: Launch Rviz)
cd /aichallenge
./run_rviz.bash
```
- Press CTRL+C in the Zenoh terminal to end communication.

## FAQ: Troubleshooting
### Q. ROS communication not working between local PC and ECU / Topic duplication
A. Restart Zenoh on both local PC and ECU
#### Restarting Zenoh on ECU
Stop Zenoh in terminal ⑤ by executing:
```bash
cd vehicle
./kill_zenoh.bash
```
Then restart Zenoh in terminal ④:
```bash
./run_zenoh.bash
```
#### Restarting Zenoh on Local PC
Press CTRL+C in the Zenoh terminal to stop it
Then execute `./connect_zenoh.bash <vehicle_number>` to restart

### Q. Low ROS Topic publishing frequency during Zenoh communication
A. The config file `./vehicle/zenoh.json5` is set for stable communication, default 10Hz.
If needed, you can adjust the publishing frequency by modifying `pub_max_frequencies: ["/*=10"]`.

### Q. ROS Topics delayed or missing on local PC
A. Topics may be delayed or lost due to communication conditions.
- Try reducing the number of topics displayed on local PC or adjusting publishing frequency
- You can set topic priorities in `./vehicle/zenoh.json5` config file using `pub_priorities: ["/racing_kart/joy=1:express"]`
- Try executing `./remote/network_setting.bash`

### Q. Unsure if inside aichallenge-2024 container
A. A simple check: execute the docker command in the terminal - if you get `bash: docker: command not found`, you're inside Docker.

0 comments on commit 6eb8028

Please sign in to comment.