Skip to content

Commit 935d1f4

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

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

docs/developer_guide/Longitudinal_control.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@ MiscObjectEntity can not be controlled by this API.
2828
| target_speed | double | Target speed of the npc. |
2929
| continuous | bool | If true the npc will keep the speed until the next command. |
3030
#### EgoEntity
31-
`target_speed` will be set to the target speed of the EgoEntity only before the scenario starts.
31+
`target_speed` will be set as initial 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. It will accelerate on maximum acceleration rate set previously.
34+
The function will change the target speed of entity to `target_speed` immediately.
35+
If `continuous` is set to `false`, job to accelerate to target speed 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 ordered. It will accelerate on maximum acceleration rate set previously.
3536

3637
| Value | Type | Description |
3738
| ------------ | ------------------------ | ----------------------------------------------------------- |
@@ -41,16 +42,22 @@ The function will append the job to change the target_speed of the npc to the jo
4142
| constraint | speed_change::Constraint | Constraint type. |
4243
| continuous | bool | If true the npc will keep the speed until the next command. |
4344
#### EgoEntity
44-
`target_speed` will be set to the target speed of the EgoEntity only before the scenario starts.
45+
`target_speed` will be set as initial target speed of the EgoEntity only before the scenario starts.
4546

4647
#### 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+
If `continuous` is set to `false`, job to accelerate to target speed 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 ordered.
49+
4850
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+
- If `transition` is set to `LINEAR`, the entity will accelerate to the target speed linearly.
52+
- 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.
53+
- If `transition` is set to `STEP`, it
54+
55+
5156
When `constraint` is set to `TIME`, the entity will accelerate to the target speed by the time you set.
5257
When `constraint` is set to `NONE`, is will append the job to change the target_speed of the npc to the job queue.
5358

59+
![requestSpeedChange](../images/Longitudinal_control/requestSpeedChange.png)
60+
5461

5562
| Value | Type | Description |
5663
| ------------ | --------------------------------- | ----------------------------------------------------------- |
325 KB
Loading

0 commit comments

Comments
 (0)