Skip to content

Commit 06ce8db

Browse files
committed
Add more detail to documentation
Signed-off-by: Caspar de Haes <caspar.dehaes@five.ai>
1 parent e3452d3 commit 06ce8db

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

osi_trafficcommand.proto

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -487,11 +487,19 @@ message TrafficAction
487487
//
488488
optional ActionHeader action_header = 1;
489489

490-
// The custom command given to the traffic participant.
490+
// The custom command given to the traffic participant. Used to convey a specific instruction
491+
// (for example "exit_highway"), or event (for example "left_indicator_activated").
492+
//
493+
// \note This corresponds to the content of the OpenSCENARIO 1.0 CustomCommandAction field.
491494
//
492495
optional string command = 2;
493496

494-
// The type of the custom command given to the traffic participant.
497+
// The type of the custom command given to the traffic participant. Can be used to simplify
498+
// how commands are grouped, for example the command_type could be "sensor_failure" and the
499+
// command value (above) could be "front_right_camera". This prevents needing long commands
500+
// (like "sensor_failure: front_right_camera").
501+
//
502+
// \note This corresponds to the "type" attribute of the OpenSCENARIO 1.0 CustomCommandAction.
495503
//
496504
optional string command_type = 3;
497505
}

0 commit comments

Comments
 (0)