Skip to content

Commit

Permalink
rename pedal to pedals
Browse files Browse the repository at this point in the history
Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>
  • Loading branch information
isamu-takagi committed Mar 7, 2025
1 parent 0081dbd commit 8405cc6
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- {{ link_ad_api('/api/remote/control_mode/select') }}
- {{ link_ad_api('/api/remote/control_mode/status') }}
- {{ link_ad_api('/api/remote/operator/status') }}
- {{ link_ad_api('/api/remote/command/pedal') }}
- {{ link_ad_api('/api/remote/command/pedals') }}
- {{ link_ad_api('/api/remote/command/acceleration') }}
- {{ link_ad_api('/api/remote/command/velocity') }}
- {{ link_ad_api('/api/remote/command/steering') }}
Expand All @@ -17,7 +17,7 @@
- {{ link_ad_api('/api/local/control_mode/select') }}
- {{ link_ad_api('/api/local/control_mode/status') }}
- {{ link_ad_api('/api/local/operator/status') }}
- {{ link_ad_api('/api/local/command/pedal') }}
- {{ link_ad_api('/api/local/command/pedals') }}
- {{ link_ad_api('/api/local/command/acceleration') }}
- {{ link_ad_api('/api/local/command/velocity') }}
- {{ link_ad_api('/api/local/command/steering') }}
Expand All @@ -44,17 +44,17 @@ Since there are multiple ways to control a vehicle, such as pedals or accelerati
| Mode | Description |
| ------------ | -------------------------------------------------------------------------- |
| disabled | This is the initial mode. When selected, all command APIs are unavailable. |
| pedal | This mode provides longitudinal control using the pedals. |
| pedals | This mode provides longitudinal control using the pedals. |
| acceleration | This mode provides longitudinal control using the target acceleration. |
| velocity | This mode provides longitudinal control using the target velocity. |

## Commands

The commands available in each mode are as follows.

| Command | disabled | pedal | acceleration | velocity |
| Command | disabled | pedals | acceleration | velocity |
| --------------- | :------: | :-----: | :----------: | :------: |
| pedal | - | &check; | - | - |
| pedals | - | &check; | - | - |
| acceleration | - | - | &check; | - |
| velocity | - | - | - | &check; |
| steering | - | &check; | &check; | &check; |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: /api/remote/command/pedal
title: /api/local/command/pedals
status: not released
method: realtime stream
type:
name: autoware_adapi_v1_msgs/msg/PedalCommand
name: autoware_adapi_v1_msgs/msg/PedalsCommand
msg:
- name: stamp
text: Timestamp when this message was sent.
Expand All @@ -15,6 +15,6 @@ type:

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Sends pedal command used in remote operation mode. The pedal value is the ratio with the maximum pedal depression being 1.0.
Sends pedals command used in local operation mode. The pedal value is the ratio with the maximum pedal depression being 1.0.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
{% endblock %}
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: /api/local/command/pedal
title: /api/remote/command/pedals
status: not released
method: realtime stream
type:
name: autoware_adapi_v1_msgs/msg/PedalCommand
name: autoware_adapi_v1_msgs/msg/PedalsCommand
msg:
- name: stamp
text: Timestamp when this message was sent.
Expand All @@ -15,6 +15,6 @@ type:

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Sends pedal command used in local operation mode. The pedal value is the ratio with the maximum pedal depression being 1.0.
Sends pedals command used in remote operation mode. The pedal value is the ratio with the maximum pedal depression being 1.0.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
{% endblock %}
4 changes: 2 additions & 2 deletions docs/design/autoware-interfaces/ad-api/list/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
| [/api/local/command/acceleration](./api/local/command/acceleration.md) | not released | realtime stream |
| [/api/local/command/gear](./api/local/command/gear.md) | not released | notification |
| [/api/local/command/hazard_lights](./api/local/command/hazard_lights.md) | not released | notification |
| [/api/local/command/pedal](./api/local/command/pedal.md) | not released | realtime stream |
| [/api/local/command/pedals](./api/local/command/pedals.md) | not released | realtime stream |
| [/api/local/command/steering](./api/local/command/steering.md) | not released | realtime stream |
| [/api/local/command/turn_indicators](./api/local/command/turn_indicators.md) | not released | notification |
| [/api/local/command/velocity](./api/local/command/velocity.md) | not released | realtime stream |
Expand Down Expand Up @@ -35,7 +35,7 @@
| [/api/remote/command/acceleration](./api/remote/command/acceleration.md) | not released | realtime stream |
| [/api/remote/command/gear](./api/remote/command/gear.md) | not released | notification |
| [/api/remote/command/hazard_lights](./api/remote/command/hazard_lights.md) | not released | notification |
| [/api/remote/command/pedal](./api/remote/command/pedal.md) | not released | realtime stream |
| [/api/remote/command/pedals](./api/remote/command/pedals.md) | not released | realtime stream |
| [/api/remote/command/steering](./api/remote/command/steering.md) | not released | realtime stream |
| [/api/remote/command/turn_indicators](./api/remote/command/turn_indicators.md) | not released | notification |
| [/api/remote/command/velocity](./api/remote/command/velocity.md) | not released | realtime stream |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ used:

```txt
uint8 DISABLED = 1
uint8 PEDAL = 2
uint8 PEDALS = 2
uint8 ACCELERATION = 3
uint8 VELOCITY = 4
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
# This file is generated by tools/autoware-interfaces/generate.py
title: autoware_adapi_v1_msgs/msg/PedalCommand
title: autoware_adapi_v1_msgs/msg/PedalsCommand
---

{% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %}
Expand Down
2 changes: 1 addition & 1 deletion docs/design/autoware-interfaces/ad-api/types/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
- [autoware_adapi_v1_msgs/msg/MrmState](./autoware_adapi_v1_msgs/msg/MrmState.md)
- [autoware_adapi_v1_msgs/msg/ObjectClassification](./autoware_adapi_v1_msgs/msg/ObjectClassification.md)
- [autoware_adapi_v1_msgs/msg/OperationModeState](./autoware_adapi_v1_msgs/msg/OperationModeState.md)
- [autoware_adapi_v1_msgs/msg/PedalCommand](./autoware_adapi_v1_msgs/msg/PedalCommand.md)
- [autoware_adapi_v1_msgs/msg/PedalsCommand](./autoware_adapi_v1_msgs/msg/PedalsCommand.md)
- [autoware_adapi_v1_msgs/msg/ResponseStatus](./autoware_adapi_v1_msgs/msg/ResponseStatus.md)
- [autoware_adapi_v1_msgs/msg/Route](./autoware_adapi_v1_msgs/msg/Route.md)
- [autoware_adapi_v1_msgs/msg/RouteData](./autoware_adapi_v1_msgs/msg/RouteData.md)
Expand Down
2 changes: 1 addition & 1 deletion yaml/autoware-interfaces.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ types:
is_stop_mode_available: bool
mode: uint8
stamp: builtin_interfaces/msg/Time
autoware_adapi_v1_msgs/msg/PedalCommand:
autoware_adapi_v1_msgs/msg/PedalsCommand:
msg:
accelerator: float32
brake: float32
Expand Down

0 comments on commit 8405cc6

Please sign in to comment.