Skip to content

Commit c9106cf

Browse files
committed
docs(autoware_v2x_msgs): add readme
Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>
1 parent b8ebf5e commit c9106cf

File tree

2 files changed

+241
-1
lines changed

2 files changed

+241
-1
lines changed

autoware_v2x_msgs/README.md

+23-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,26 @@
22

33
## Virtual gate messages
44

5-
WIP
5+
### Overview
6+
7+
This message represents the status of the virtual gate for passing through the area managed by the facility.
8+
The virtual gate treats area entry permission as a shared resource and controls vehicles by acquiring and releasing locks.
9+
Each facility may support different protocols, but Autoware V2X component converts each protocol and this message.
10+
This allows Autoware to handle facilities with different protocols with a unified message.
11+
12+
![virtual-gate-nodes](./doc/virtual-gate-nodes.drawio.svg)
13+
14+
### Sequence
15+
16+
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.
17+
Until the vehicle receives the status, treat it as if it were unlocked.
18+
19+
### Gates
20+
21+
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.
22+
If omitted, it is treated as a lock for the entire area.
23+
24+
### Vehicle ID
25+
26+
This message does not include the vehicle ID, so add it in the V2X component if required by the communication protocol.
27+
And if facilities publish multiple vehicle statuses, filter to only status for own vehicle.

0 commit comments

Comments
 (0)