Skip to content

Commit

Permalink
docs(side_shift): update side shift document (#6123)
Browse files Browse the repository at this point in the history
* update side shift document

Signed-off-by: kyoichi-sugahara <[email protected]>

---------

Signed-off-by: kyoichi-sugahara <[email protected]>
  • Loading branch information
kyoichi-sugahara authored Jan 22, 2024
1 parent 704f509 commit 378bf3a
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 1 deletion.
25 changes: 24 additions & 1 deletion planning/behavior_path_side_shift_module/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,29 @@

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

## Overview of the Side Shift Module Process

1. Receive the required lateral offset input.
2. Update the `requested_lateral_offset_` under the following conditions:
a. Verify if the last update time has elapsed.
b. Ensure the required lateral offset value is different from the previous one.
3. Insert the shift points into the path if the side shift module's status is not in the SHIFTING status.

Please be aware that `requested_lateral_offset_` is continuously updated with the latest values and is not queued.

## Statuses of the Side Shift

The side shift has three distinct statuses. Note that during the SHIFTING status, the path cannot be updated:

1. BEFORE_SHIFT: Preparing for shift.
2. SHIFTING: Currently in the process of shifting.
3. AFTER_SHIFT: Shift completed.

<figure markdown>
![case1](images/side_shift_status.drawio.svg){width=1000}
<figcaption>side shift status</figcaption>
</figure>

## Flowchart

```plantuml
Expand All @@ -27,7 +50,7 @@ stop
@enduml
```

```plantuml -->
```plantuml
@startuml
skinparam monochrome true
skinparam defaultTextAlignment center
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 378bf3a

Please sign in to comment.