Skip to content

Commit

Permalink
doc: add finals pages in EN (#56)
Browse files Browse the repository at this point in the history
* doc: add finals pages and yaml in EN

* doc: add finals path

* fix: fianls images path

* Update: Fix link, add minor modification for descriptions

* Update: Minor modification for some expressions

* Fix: minor fix of layout in index.md en

---------

Co-authored-by: yusuke-y819 <[email protected]>
Co-authored-by: toki-1441 <[email protected]>
Co-authored-by: g-ise <[email protected]>
  • Loading branch information
4 people authored Sep 27, 2023
1 parent f778648 commit 0a92f82
Show file tree
Hide file tree
Showing 6 changed files with 171 additions and 1 deletion.
8 changes: 8 additions & 0 deletions documentation/docfx_project_en/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@
"customize/index.md"
]
},
{
"files": [
"finals/toc.yml",
"finals/index.md",
"finals/rules.md",
"finals/operation.md"
]
},
{
"files": [
"operation/toc.yml",
Expand Down
38 changes: 38 additions & 0 deletions documentation/docfx_project_en/finals/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# [WIP] About the Finals

<br>

## Introduction
In the final competition, participants will operate a golf cart-style autonomous vehicle using their development laptops to showcase the performance of their self-driving software. All operations, from connecting the development laptop to the vehicle to initiating autonomous driving, are to be performed by the participants.
<br>

> [!Video https://www.youtube.com/embed/8oF-XcbsJes?si=mD5LQWd28DEj5L7L]
<br>

<div align="center">
<img src="../../images/operation/aichal-2022-expl.png" alt="Last year's run" width="500">

_Driving situation_<br>
(refer: https://www.jsae.or.jp/jaaic2022/final.html "Explanation of the competition")
</div>

<br>

## About the competition vehicle

<br>

<div align="center">
<img src="../../images/operation/aichal-vehicle.png" alt="Competition Vehicles" width="500">

_Vehicles used for competition_
</div>

<br>

- The vehicle used in the competition is fitted with the same sensors (LiDAR) as the one used in the E2E space during the qualifying round. However, the vehicle’s kinematic properties differ from the model in the simulation.
- The vehicle comes with a network interface linked to the LiDAR and a CAN interface. Autonomous driving is facilitated by connecting a development laptop to these interfaces.
- A mentor and a safety driver will accompany the competition vehicle. The mentor will handle the interface connections and aid in the operation of the autonomous driving software, while the safety driver will manually maneuver the vehicle and oversee it during autonomous driving.
- The vehicle offers two control modes: `automatic` and `manual`. The safety driver has the ability to switch between these modes.
- During autonomous driving, the safety driver has the capability to transition the vehicle's control mode from `automatic` to `manual` by pressing the brakes. This action is termed an override. The safety driver will initiate the override if continuing autonomous driving is deemed unsafe.
64 changes: 64 additions & 0 deletions documentation/docfx_project_en/finals/operation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# [WIP]Operation (Finals Competition)

**Note: This is a draft page. Information on this page may change.**

This page outlines the procedure to operate the competition vehicle (a drive-by-wired golf cart, hereafter referred to as “golf cart”) on a laptop with Autoware installed.

※Instructions are based on the assumption that the repository for development is located in `/home/autoware/aichallenge2023-integration-final`.


## Steps to Start Autonomous Driving

This section details the process from connecting your laptop to the vehicle up to initiating autonomous driving.

**※Please be sure to read [the safety precautions](#safety-precautions) before heading to the test field.**

1. (Competition participants) Open a terminal window and execute the following command to start Autoware.
```
$ cd ~/aichallenge2023-integration-final/scripts
$ ./run_autoware_on_vehicle.sh
```
2. (Competition participant) Complete initialization of localization.
1. Input 2D pose estimate from rViz.
2. Confirm that the `Localization` display on the `AutowareStatePanel` is `INITIALIZED`.
<img src="../../images/operation/loc_initialized.png" alt="Localization INITIALIZED State" width="300">
3. (Competiton participant) Set the goal point.
1. Open a terminal window and execute `~/aichallenge2023-integration-final/scripts/set_goal.sh` to set the goal point.
2. Confirm with rViz that the route to the goal is drawn.
4. (Safety driver) Set the golf cart mode to `automatic mode`.
5. (Competiton participant) Enable vehicle control by Autoware.
1. Click on the `Enable` button of the `AutowareControl` in the `AutowareStatePanel` after receiving the mentor’s instructions.
2. Confirm that the display of `AutowareControl` in the `AutowareStatePanel` is `Enabled`.
<img src="../../images/operation/autoware_control_enabled.png" alt="Autoware Control Enabled" width="300">
6. (Safety Driver) Check the steer behavior, confirm that the golf card is successfully accepting Autoware control, and tell the competition participant that the vehicle is ready to engage in autonomous driving.
7. (Competiton participant) Sets Autoware to autonomous driving mode.
1. Tell the safety driver, “I will start automatic operation”.
2. Click the `AUTO` button in the `OperationMode` of the `AutowareStatePanel`.
3. Confirm that the `OperationMode` display on the `AutowareStatePanel` is set to `AUTONOMOUS`.
<img src="../../images/operation/operation_mode_auto.png" alt="Operation Mode Auto" width="300">
### When the safety driver performed override
Should there be a risk of the vehicle hitting a curb or an obstacle during autonomous driving operation, the safety driver will apply the brakes and switch the vehicle control from automatic operation to manual operation. This is called override.
If the safety driver performs an override while the vehicle is engaging with Task 1 or Task 2, the current task will be forfeited, and autonomous driving will restart at the subsequent task.
1. (Safety Driver) Inform the participant of the override
2. (Safety Driver) Set the golf cart to `manual mode`.
3. (Safety Driver) Move the vehicle to the starting point of the next task.
4. Click on the `Disable` button of the `AutowareControl` in the `AutowareStatePanel`. Mentor will ask you to do so.
5. Confirm that the display of `AutowareControl` in the `AutowareStatePanel` is set to `Disable`.
6. Resume from step No.4 in [Steps to Start Autonomous Driving](#steps-to-start-autonomous-driving) **(Safety Driver)Set the golf cart mode to `automatic mode`.**
## Safety precautions
- Failure to switch to automatic operation mode may occur due to a poor HW connection or other reasons. Failure to switch to the automatic operation mode is diagnosed by the safety driver. If this event occurs, follow the mentor’s instructions and redo the procedures to start autonomous driving.
- Participants who are not riding in the vehicle should stay on the sidewalk during the autonomous driving. Please do not enter the designated area for competition or approach the vehicle.
- Please be sure to hold onto the upper handrail during the autonomous driving.
- Please secure your laptop computer used for autonomous driving with a provided band. If you have difficulty typing on the keyboard, you may use the USB wireless keyboard. Please ask to your mentor.
49 changes: 49 additions & 0 deletions documentation/docfx_project_en/finals/rules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Rules and Scoring

This page explains the rules and scoring for the finals.

Basically, the rules are the same as [the rules for the preliminary round](../rule/index.html), but since the actual golf carts will be used, some of the rules and scoring methods have been changed.

## Challenges for the Finals

- The contestants will be required to complete the following tasks.
- Task 1: Stop before a small obstacle (cardboard box) and re-start after removing the obstacle.
- Challenge 2: Driving through smoke
- Task 3: Running between S-curves (slalom) and between L-curves (crank)
- The contestants are required to start the automatic driving from the start point and aim to reach the goal point.

## Scoring Method

- Ranking is determined by distance points.
- `Distance points: min(overall distance traveled from the start point (m), distance of the entire course) * (1.0 - assignment 1 penalty - assignment 2 penalty - assignment 3 penalty)`
- If the distance points are the same, the Competitor with the shortest running time in the Task 3 area will be placed higher (if he/she runs to the end of the task).

## Competition Rules

The rules governing the entire competition are as follows

- Driving speed is 0~5km/h
- If the speed exceeds the speed limit by more than 2km/h, disqualification = 0 points
- Time limit is 5 minutes (to accommodate the case where the vehicle stops in the middle of the route)
- Time is measured from the time the vehicle starts.
- Please do not use an algorithm that sets the route in advance and drives in a deterministic manner.
- The content of the submitted code may be checked during the judging.
- If any intentional irregularities are discovered, such as codes that affect the scoring process, the contestant will be disqualified.

### Conditions for Completion of Run

If any of the following conditions are met, the automatic driving will end immediately and the distance points at that point will be recorded.

At this time, the vehicle’s automatic driving mode is automatically deactivated and the vehicle also stops immediately.

- Exceeds the speed limit of 7 km/h
- Exceeds the time limit of 5 minutes
- Any part of the vehicle body deviates from the travel lane

### Override Conditions

When any of the following conditions are met, the safety driver in the driver’s seat of the vehicle intervenes in the driving operation and switches to manual operation (implementation of override).

At this time, the distance point immediately before the override time is recorded. The safety driver manually drives the vehicle to a safe point and stops it. The participants can try to drive automatically from this point again.

- If the vehicle is too close to an obstacle and the safety driver determines that it is dangerous
7 changes: 7 additions & 0 deletions documentation/docfx_project_en/finals/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

- name: About the Finals
href: index.html
- name: Rules and Scoring
href: rules.html
- name: Operation
href: operation.html
6 changes: 5 additions & 1 deletion documentation/docfx_project_en/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,12 @@
- name: Finals
dropdown: true
items:
- name: About the Finals
href: finals/index.html
- name: Rules and Scoring
href: finals/rules.html
- name: Operation
href: operation/index.html
href: finals/operation.html
- name: Teams
href: ../teams/index.html
- name: Customizing Autoware
Expand Down

0 comments on commit 0a92f82

Please sign in to comment.