Skip to content

Commit

Permalink
docs(autoware_v2x_msgs): add readme
Browse files Browse the repository at this point in the history
Signed-off-by: Takagi, Isamu <[email protected]>
  • Loading branch information
isamu-takagi committed Dec 13, 2023
1 parent b8ebf5e commit 9493752
Show file tree
Hide file tree
Showing 2 changed files with 241 additions and 1 deletion.
24 changes: 23 additions & 1 deletion autoware_v2x_msgs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,26 @@

## Virtual gate messages

WIP
### Overview

This message represents the status of the virtual gate for passing through the area managed by the facility.
The virtual gate treats area entry permission as a shared resource and controls vehicles by acquiring and releasing locks.
Each facility may support different protocols, but Autoware V2X component converts each protocol and this message.
This allows Autoware to handle facilities with different protocols with a unified message.

![virtual-gate-nodes](./doc/virtual-gate-nodes.drawio.svg)

### Sequence

Because there is a time lag before commands are reflected, the vehicle must wait until it receives the status of the same sequence as the command it sent.
Until the vehicle receives the status, plsease treat it as if it were unlocked.

Check warning on line 17 in autoware_v2x_msgs/README.md

View workflow job for this annotation

GitHub Actions / spell-check-differential

Unknown word (plsease)

### Gates

Specify the entrance and exit gate IDs. This is used to check if vehicles can pass simultaneously when multiple routes are possible within an area.
If omitted, it is treated as a lock for the entire area.

### Vehicle ID

This message does not include the vehicle ID, so add it in the V2X component if required by the communication protocol.
And if facilities publish multiple vehicle statuses, filter to only status for own vehicle.
Loading

0 comments on commit 9493752

Please sign in to comment.