Skip to content

fix(ad-api): fix namespace of manual control #657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 3, 2025
Merged

fix(ad-api): fix namespace of manual control #657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions docs/design/autoware-interfaces/ad-api/features/manual-control.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,28 @@

## Related API

- {{ link_ad_api('/api/remote/control_mode/list') }}
- {{ 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/pedals') }}
- {{ link_ad_api('/api/remote/command/acceleration') }}
- {{ link_ad_api('/api/remote/command/velocity') }}
- {{ link_ad_api('/api/remote/command/steering') }}
- {{ link_ad_api('/api/remote/command/gear') }}
- {{ link_ad_api('/api/remote/command/turn_indicators') }}
- {{ link_ad_api('/api/remote/command/hazard_lights') }}
- {{ link_ad_api('/api/local/control_mode/list') }}
- {{ 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/pedals') }}
- {{ link_ad_api('/api/local/command/acceleration') }}
- {{ link_ad_api('/api/local/command/velocity') }}
- {{ link_ad_api('/api/local/command/steering') }}
- {{ link_ad_api('/api/local/command/gear') }}
- {{ link_ad_api('/api/local/command/turn_indicators') }}
- {{ link_ad_api('/api/local/command/hazard_lights') }}
- {{ link_ad_api('/api/manual/remote/control_mode/list') }}
- {{ link_ad_api('/api/manual/remote/control_mode/select') }}
- {{ link_ad_api('/api/manual/remote/control_mode/status') }}
- {{ link_ad_api('/api/manual/remote/operator/heartbeat') }}
- {{ link_ad_api('/api/manual/remote/command/pedals') }}
- {{ link_ad_api('/api/manual/remote/command/acceleration') }}
- {{ link_ad_api('/api/manual/remote/command/velocity') }}
- {{ link_ad_api('/api/manual/remote/command/steering') }}
- {{ link_ad_api('/api/manual/remote/command/gear') }}
- {{ link_ad_api('/api/manual/remote/command/turn_indicators') }}
- {{ link_ad_api('/api/manual/remote/command/hazard_lights') }}
- {{ link_ad_api('/api/manual/local/control_mode/list') }}
- {{ link_ad_api('/api/manual/local/control_mode/select') }}
- {{ link_ad_api('/api/manual/local/control_mode/status') }}
- {{ link_ad_api('/api/manual/local/operator/heartbeat') }}
- {{ link_ad_api('/api/manual/local/command/pedals') }}
- {{ link_ad_api('/api/manual/local/command/acceleration') }}
- {{ link_ad_api('/api/manual/local/command/velocity') }}
- {{ link_ad_api('/api/manual/local/command/steering') }}
- {{ link_ad_api('/api/manual/local/command/gear') }}
- {{ link_ad_api('/api/manual/local/command/turn_indicators') }}
- {{ link_ad_api('/api/manual/local/command/hazard_lights') }}

## Description

Expand Down
4 changes: 2 additions & 2 deletions ...pi/list/api/local/command/acceleration.md → .../api/manual/local/command/acceleration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/local/command/acceleration
title: /api/manual/local/command/acceleration
status: not released
method: realtime stream
type:
Expand All @@ -14,5 +14,5 @@ type:
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Sends acceleration command used in local operation mode.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
4 changes: 2 additions & 2 deletions ...ces/ad-api/list/api/local/command/gear.md → ...api/list/api/manual/local/command/gear.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/local/command/gear
title: /api/manual/local/command/gear
status: not released
method: notification
type:
Expand All @@ -14,5 +14,5 @@ type:
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Sends gear command used in local operation mode.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
4 changes: 2 additions & 2 deletions ...i/list/api/local/command/hazard_lights.md → ...api/manual/local/command/hazard_lights.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/local/command/hazard_lights
title: /api/manual/local/command/hazard_lights
status: not released
method: notification
type:
Expand All @@ -14,5 +14,5 @@ type:
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Sends hazard lights command used in local operation mode.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
8 changes: 4 additions & 4 deletions ...s/ad-api/list/api/local/command/pedals.md → ...i/list/api/manual/local/command/pedals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: /api/local/command/pedals
title: /api/manual/local/command/pedals
status: not released
method: realtime stream
type:
name: autoware_adapi_v1_msgs/msg/PedalsCommand
msg:
- name: stamp
text: Timestamp when this message was sent.
- name: accelerator
text: Target accelerator pedal ratio.
- name: throttle
text: Target throttle pedal ratio.
- name: brake
text: Target brake pedal ratio.
---

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
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).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
6 changes: 4 additions & 2 deletions ...d-api/list/api/remote/command/steering.md → ...list/api/manual/local/command/steering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/remote/command/steering
title: /api/manual/local/command/steering
status: not released
method: realtime stream
type:
Expand All @@ -9,10 +9,12 @@ type:
text: Timestamp when this message was sent.
- name: steering_tire_angle
text: Target steering tire angle [rad].
- name: steering_tire_velocity
text: Target steering tire velocity [rad/s].
---

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Send steering command to this API.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
4 changes: 2 additions & 2 deletions ...list/api/local/command/turn_indicators.md → ...i/manual/local/command/turn_indicators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/local/command/turn_indicators
title: /api/manual/local/command/turn_indicators
status: not released
method: notification
type:
Expand All @@ -14,5 +14,5 @@ type:
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Sends turn indicators command used in local operation mode.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
4 changes: 2 additions & 2 deletions ...ad-api/list/api/local/command/velocity.md → ...list/api/manual/local/command/velocity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/local/command/velocity
title: /api/manual/local/command/velocity
status: not released
method: realtime stream
type:
Expand All @@ -14,5 +14,5 @@ type:
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Sends velocity command used in local operation mode.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
4 changes: 2 additions & 2 deletions ...-api/list/api/remote/control_mode/list.md → ...ist/api/manual/local/control_mode/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/remote/control_mode/list
title: /api/manual/local/control_mode/list
status: not released
method: function call
type:
Expand All @@ -13,6 +13,6 @@ type:

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
List the available manual control modes as described in [manual control](../../../../features/manual-control.md).
List the available manual control modes as described in [manual control](../../../../../features/manual-control.md).
The disabled mode is not included in the available modes.
{% endblock %}
6 changes: 3 additions & 3 deletions ...api/list/api/local/control_mode/select.md → ...t/api/manual/local/control_mode/select.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/local/control_mode/select
title: /api/manual/local/control_mode/select
status: not released
method: function call
type:
Expand All @@ -14,6 +14,6 @@ type:

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Selects the manual control mode as described in [manual control](../../../../features/manual-control.md).
This API fails while [operation mode](../../../../features/operation_mode.md) is local.
Selects the manual control mode as described in [manual control](../../../../../features/manual-control.md).
This API fails while [operation mode](../../../../../features/operation_mode.md) is local.
{% endblock %}
2 changes: 1 addition & 1 deletion ...pi/list/api/remote/control_mode/status.md → ...t/api/manual/local/control_mode/status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/remote/control_mode/status
title: /api/manual/local/control_mode/status
status: not released
method: notification
type:
Expand Down
6 changes: 3 additions & 3 deletions ...ad-api/list/api/remote/operator/status.md → ...st/api/manual/local/operator/heartbeat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: /api/remote/operator/status
title: /api/manual/local/operator/heartbeat
status: not released
method: realtime stream
type:
name: autoware_adapi_v1_msgs/msg/ManualOperatorStatus
name: autoware_adapi_v1_msgs/msg/ManualOperatorHeartbeat
msg:
- name: stamp
text: Timestamp when this message was sent.
Expand All @@ -14,5 +14,5 @@ type:
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
The application needs to determine whether the operator is able to drive and send that information via this API.
For details, see the [manual control](../../../../features/manual-control.md).
For details, see the [manual control](../../../../../features/manual-control.md).
{% endblock %}
4 changes: 2 additions & 2 deletions ...i/list/api/remote/command/acceleration.md → ...api/manual/remote/command/acceleration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/remote/command/acceleration
title: /api/manual/remote/command/acceleration
status: not released
method: realtime stream
type:
Expand All @@ -14,5 +14,5 @@ type:
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Sends acceleration command used in remote operation mode.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
4 changes: 2 additions & 2 deletions ...es/ad-api/list/api/remote/command/gear.md → ...pi/list/api/manual/remote/command/gear.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/remote/command/gear
title: /api/manual/remote/command/gear
status: not released
method: notification
type:
Expand All @@ -14,5 +14,5 @@ type:
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Sends gear command used in remote operation mode.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
4 changes: 2 additions & 2 deletions .../list/api/remote/command/hazard_lights.md → ...pi/manual/remote/command/hazard_lights.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/remote/command/hazard_lights
title: /api/manual/remote/command/hazard_lights
status: not released
method: notification
type:
Expand All @@ -14,5 +14,5 @@ type:
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Sends hazard lights command used in remote operation mode.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
8 changes: 4 additions & 4 deletions .../ad-api/list/api/remote/command/pedals.md → .../list/api/manual/remote/command/pedals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: /api/remote/command/pedals
title: /api/manual/remote/command/pedals
status: not released
method: realtime stream
type:
name: autoware_adapi_v1_msgs/msg/PedalsCommand
msg:
- name: stamp
text: Timestamp when this message was sent.
- name: accelerator
text: Target accelerator pedal ratio.
- name: throttle
text: Target throttle pedal ratio.
- name: brake
text: Target brake pedal ratio.
---

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
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).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
6 changes: 4 additions & 2 deletions ...ad-api/list/api/local/command/steering.md → ...ist/api/manual/remote/command/steering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/local/command/steering
title: /api/manual/remote/command/steering
status: not released
method: realtime stream
type:
Expand All @@ -9,10 +9,12 @@ type:
text: Timestamp when this message was sent.
- name: steering_tire_angle
text: Target steering tire angle [rad].
- name: steering_tire_velocity
text: Target steering tire velocity [rad/s].
---

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Send steering command to this API.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
4 changes: 2 additions & 2 deletions ...ist/api/remote/command/turn_indicators.md → .../manual/remote/command/turn_indicators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/remote/command/turn_indicators
title: /api/manual/remote/command/turn_indicators
status: not released
method: notification
type:
Expand All @@ -14,5 +14,5 @@ type:
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Sends turn indicators command used in remote operation mode.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
4 changes: 2 additions & 2 deletions ...d-api/list/api/remote/command/velocity.md → ...ist/api/manual/remote/command/velocity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/remote/command/velocity
title: /api/manual/remote/command/velocity
status: not released
method: realtime stream
type:
Expand All @@ -14,5 +14,5 @@ type:
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Sends velocity command used in remote operation mode.
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
{% endblock %}
4 changes: 2 additions & 2 deletions ...d-api/list/api/local/control_mode/list.md → ...st/api/manual/remote/control_mode/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/local/control_mode/list
title: /api/manual/remote/control_mode/list
status: not released
method: function call
type:
Expand All @@ -13,6 +13,6 @@ type:

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
List the available manual control modes as described in [manual control](../../../../features/manual-control.md).
List the available manual control modes as described in [manual control](../../../../../features/manual-control.md).
The disabled mode is not included in the available modes.
{% endblock %}
6 changes: 3 additions & 3 deletions ...pi/list/api/remote/control_mode/select.md → .../api/manual/remote/control_mode/select.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/remote/control_mode/select
title: /api/manual/remote/control_mode/select
status: not released
method: function call
type:
Expand All @@ -14,6 +14,6 @@ type:

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Selects the manual control mode as described in [manual control](../../../../features/manual-control.md).
This API fails while [operation mode](../../../../features/operation_mode.md) is remote.
Selects the manual control mode as described in [manual control](../../../../../features/manual-control.md).
This API fails while [operation mode](../../../../../features/operation_mode.md) is remote.
{% endblock %}
2 changes: 1 addition & 1 deletion ...api/list/api/local/control_mode/status.md → .../api/manual/remote/control_mode/status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: /api/local/control_mode/status
title: /api/manual/remote/control_mode/status
status: not released
method: notification
type:
Expand Down
6 changes: 3 additions & 3 deletions .../ad-api/list/api/local/operator/status.md → ...t/api/manual/remote/operator/heartbeat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: /api/local/operator/status
title: /api/manual/remote/operator/heartbeat
status: not released
method: realtime stream
type:
name: autoware_adapi_v1_msgs/msg/ManualOperatorStatus
name: autoware_adapi_v1_msgs/msg/ManualOperatorHeartbeat
msg:
- name: stamp
text: Timestamp when this message was sent.
Expand All @@ -14,5 +14,5 @@ type:
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
The application needs to determine whether the operator is able to drive and send that information via this API.
For details, see the [manual control](../../../../features/manual-control.md).
For details, see the [manual control](../../../../../features/manual-control.md).
{% endblock %}
Loading
Loading