Skip to content

Commit a08cce8

Browse files
committed
chore: Update Longitudinal_control.md with additional details for requestSpeedChange API
1 parent 768f012 commit a08cce8

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/developer_guide/Longitudinal_control.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ MiscObjectEntity can not be controlled by this API.
3131
`target_speed` will be set to the target speed of the EgoEntity only before the scenario starts.
3232

3333
#### Other entity
34-
The function will append the job to change the target_speed of the npc to the job queue. If `continuous` is set to `false`, the job will be deleted after the velocity has reached the target speed. If set to `true`, the npc will keep the speed until the next longitudinal control command.
34+
The function will append the job to change the target_speed of the npc to the job queue. If `continuous` is set to `false`, the job will be deleted after the velocity has reached the target speed. If set to `true`, the npc will keep the speed until the next longitudinal control command. It will accelerate on maximum acceleration rate set previously.
3535

3636
| Value | Type | Description |
3737
| ------------ | ------------------------ | ----------------------------------------------------------- |
@@ -44,6 +44,13 @@ The function will append the job to change the target_speed of the npc to the jo
4444
`target_speed` will be set to the target speed of the EgoEntity only before the scenario starts.
4545

4646
#### Other entity
47+
The function will append the job to change the target_speed of the npc to the job queue. If `continuous` is set to `false`, the job will be deleted after the velocity has reached the target speed. If set to `true`, the npc will keep the speed until the next longitudinal control command.
48+
When `constraint` is set to `LONGITUDINAL_ACCELERATION`, the entity will accelerate to the target speed with acceleration rate you set.
49+
If `transition` is set to `LINEAR`, the entity will accelerate to the target speed linearly.
50+
If `transition` is set to `AUTO`, it will change the maximum acceleration speed of the entity and append the job to change the target speed of the npc to the job queue. After the npc reaches the target speed, it will change the maximum acceleration speed back to the original value.
51+
When `constraint` is set to `TIME`, the entity will accelerate to the target speed by the time you set.
52+
When `constraint` is set to `NONE`, is will append the job to change the target_speed of the npc to the job queue.
53+
4754

4855
| Value | Type | Description |
4956
| ------------ | --------------------------------- | ----------------------------------------------------------- |

0 commit comments

Comments
 (0)