Skip to content

Commit 4b7f543

Browse files
authored
docs: add unit and range documentation to message fields (#107)
* docs: add unit and range documentation to message fields Add inline comments to clarify units and valid ranges for: - PedalsCommand.msg: throttle/brake range (0.0-1.0) - SteeringCommand.msg: steering_tire_angle [rad], velocity [rad/s] - VelocityFactor.msg: distance [m], field descriptions Related to #106 * docs: clarify behavior field accepts user-defined values * Update autoware_adapi_v1_msgs/planning/msg/VelocityFactor.msg
1 parent 6c3faf2 commit 4b7f543

3 files changed

Lines changed: 14 additions & 3 deletions

File tree

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
builtin_interfaces/Time stamp
2+
# Throttle pedal position. Range: 0.0 to 1.0 (normalized)
23
float32 throttle
4+
# Brake pedal position. Range: 0.0 to 1.0 (normalized)
35
float32 brake
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
builtin_interfaces/Time stamp
2+
# Steering tire angle [rad]. Positive: left, Negative: right
23
float32 steering_tire_angle
4+
# Steering tire angular velocity [rad/s]
35
float32 steering_tire_velocity

autoware_adapi_v1_msgs/planning/msg/VelocityFactor.msg

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,21 @@
22
uint16 UNKNOWN = 0
33

44
# constants for status
5-
uint16 APPROACHING = 1
6-
uint16 STOPPED = 2
5+
uint16 APPROACHING = 1 # Vehicle is approaching the factor
6+
uint16 STOPPED = 2 # Vehicle has stopped due to the factor
77

8-
# variables
8+
# fields
9+
# Pose of the velocity factor in VelocityFactorArray.header.frame_id
910
geometry_msgs/Pose pose
11+
# Distance to the velocity factor [m]
1012
float32 distance
13+
# Current status (use status constants above)
1114
uint16 status
15+
# Behavior type (see PlanningBehavior.msg for typical values, any name is available for user extensions)
1216
string behavior
17+
# Planning sequence identifier
1318
string sequence
19+
# Detailed description of the factor
1420
string detail
21+
# Cooperation status (optional, max 1 element)
1522
autoware_adapi_v1_msgs/CooperationStatus[<=1] cooperation

0 commit comments

Comments
 (0)