Skip to content

Commit 378bf3a

Browse files
authoredJan 22, 2024
docs(side_shift): update side shift document (#6123)
* update side shift document Signed-off-by: kyoichi-sugahara <kyoichi.sugahara@tier4.jp> --------- Signed-off-by: kyoichi-sugahara <kyoichi.sugahara@tier4.jp>
1 parent 704f509 commit 378bf3a

File tree

2 files changed

+125
-1
lines changed

2 files changed

+125
-1
lines changed
 

‎planning/behavior_path_side_shift_module/README.md

+24-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,29 @@
22

33
(For remote control) Shift the path to left or right according to an external instruction.
44

5+
## Overview of the Side Shift Module Process
6+
7+
1. Receive the required lateral offset input.
8+
2. Update the `requested_lateral_offset_` under the following conditions:
9+
a. Verify if the last update time has elapsed.
10+
b. Ensure the required lateral offset value is different from the previous one.
11+
3. Insert the shift points into the path if the side shift module's status is not in the SHIFTING status.
12+
13+
Please be aware that `requested_lateral_offset_` is continuously updated with the latest values and is not queued.
14+
15+
## Statuses of the Side Shift
16+
17+
The side shift has three distinct statuses. Note that during the SHIFTING status, the path cannot be updated:
18+
19+
1. BEFORE_SHIFT: Preparing for shift.
20+
2. SHIFTING: Currently in the process of shifting.
21+
3. AFTER_SHIFT: Shift completed.
22+
23+
<figure markdown>
24+
![case1](images/side_shift_status.drawio.svg){width=1000}
25+
<figcaption>side shift status</figcaption>
26+
</figure>
27+
528
## Flowchart
629

730
```plantuml
@@ -27,7 +50,7 @@ stop
2750
@enduml
2851
```
2952

30-
```plantuml -->
53+
```plantuml
3154
@startuml
3255
skinparam monochrome true
3356
skinparam defaultTextAlignment center
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.