Skip to content

Commit 2093a67

Browse files
isamu-takagiisamu-takagi
authored
fix(ad-api): fix namespace of manual control (#657)
Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>
1 parent 7de491e commit 2093a67

30 files changed

Lines changed: 108 additions & 102 deletions

File tree

‎docs/design/autoware-interfaces/ad-api/features/manual-control.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,28 @@
22

33
## Related API
44

5-
- {{ link_ad_api('/api/remote/control_mode/list') }}
6-
- {{ link_ad_api('/api/remote/control_mode/select') }}
7-
- {{ link_ad_api('/api/remote/control_mode/status') }}
8-
- {{ link_ad_api('/api/remote/operator/status') }}
9-
- {{ link_ad_api('/api/remote/command/pedals') }}
10-
- {{ link_ad_api('/api/remote/command/acceleration') }}
11-
- {{ link_ad_api('/api/remote/command/velocity') }}
12-
- {{ link_ad_api('/api/remote/command/steering') }}
13-
- {{ link_ad_api('/api/remote/command/gear') }}
14-
- {{ link_ad_api('/api/remote/command/turn_indicators') }}
15-
- {{ link_ad_api('/api/remote/command/hazard_lights') }}
16-
- {{ link_ad_api('/api/local/control_mode/list') }}
17-
- {{ link_ad_api('/api/local/control_mode/select') }}
18-
- {{ link_ad_api('/api/local/control_mode/status') }}
19-
- {{ link_ad_api('/api/local/operator/status') }}
20-
- {{ link_ad_api('/api/local/command/pedals') }}
21-
- {{ link_ad_api('/api/local/command/acceleration') }}
22-
- {{ link_ad_api('/api/local/command/velocity') }}
23-
- {{ link_ad_api('/api/local/command/steering') }}
24-
- {{ link_ad_api('/api/local/command/gear') }}
25-
- {{ link_ad_api('/api/local/command/turn_indicators') }}
26-
- {{ link_ad_api('/api/local/command/hazard_lights') }}
5+
- {{ link_ad_api('/api/manual/remote/control_mode/list') }}
6+
- {{ link_ad_api('/api/manual/remote/control_mode/select') }}
7+
- {{ link_ad_api('/api/manual/remote/control_mode/status') }}
8+
- {{ link_ad_api('/api/manual/remote/operator/heartbeat') }}
9+
- {{ link_ad_api('/api/manual/remote/command/pedals') }}
10+
- {{ link_ad_api('/api/manual/remote/command/acceleration') }}
11+
- {{ link_ad_api('/api/manual/remote/command/velocity') }}
12+
- {{ link_ad_api('/api/manual/remote/command/steering') }}
13+
- {{ link_ad_api('/api/manual/remote/command/gear') }}
14+
- {{ link_ad_api('/api/manual/remote/command/turn_indicators') }}
15+
- {{ link_ad_api('/api/manual/remote/command/hazard_lights') }}
16+
- {{ link_ad_api('/api/manual/local/control_mode/list') }}
17+
- {{ link_ad_api('/api/manual/local/control_mode/select') }}
18+
- {{ link_ad_api('/api/manual/local/control_mode/status') }}
19+
- {{ link_ad_api('/api/manual/local/operator/heartbeat') }}
20+
- {{ link_ad_api('/api/manual/local/command/pedals') }}
21+
- {{ link_ad_api('/api/manual/local/command/acceleration') }}
22+
- {{ link_ad_api('/api/manual/local/command/velocity') }}
23+
- {{ link_ad_api('/api/manual/local/command/steering') }}
24+
- {{ link_ad_api('/api/manual/local/command/gear') }}
25+
- {{ link_ad_api('/api/manual/local/command/turn_indicators') }}
26+
- {{ link_ad_api('/api/manual/local/command/hazard_lights') }}
2727

2828
## Description
2929

docs/design/autoware-interfaces/ad-api/list/api/local/command/acceleration.md renamed to docs/design/autoware-interfaces/ad-api/list/api/manual/local/command/acceleration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: /api/local/command/acceleration
2+
title: /api/manual/local/command/acceleration
33
status: not released
44
method: realtime stream
55
type:
@@ -14,5 +14,5 @@ type:
1414
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
1515
{% block description %}
1616
Sends acceleration command used in local operation mode.
17-
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
17+
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
1818
{% endblock %}

docs/design/autoware-interfaces/ad-api/list/api/local/command/gear.md renamed to docs/design/autoware-interfaces/ad-api/list/api/manual/local/command/gear.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: /api/local/command/gear
2+
title: /api/manual/local/command/gear
33
status: not released
44
method: notification
55
type:
@@ -14,5 +14,5 @@ type:
1414
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
1515
{% block description %}
1616
Sends gear command used in local operation mode.
17-
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
17+
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
1818
{% endblock %}

docs/design/autoware-interfaces/ad-api/list/api/local/command/hazard_lights.md renamed to docs/design/autoware-interfaces/ad-api/list/api/manual/local/command/hazard_lights.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: /api/local/command/hazard_lights
2+
title: /api/manual/local/command/hazard_lights
33
status: not released
44
method: notification
55
type:
@@ -14,5 +14,5 @@ type:
1414
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
1515
{% block description %}
1616
Sends hazard lights command used in local operation mode.
17-
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
17+
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
1818
{% endblock %}

docs/design/autoware-interfaces/ad-api/list/api/local/command/pedals.md renamed to docs/design/autoware-interfaces/ad-api/list/api/manual/local/command/pedals.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
title: /api/local/command/pedals
2+
title: /api/manual/local/command/pedals
33
status: not released
44
method: realtime stream
55
type:
66
name: autoware_adapi_v1_msgs/msg/PedalsCommand
77
msg:
88
- name: stamp
99
text: Timestamp when this message was sent.
10-
- name: accelerator
11-
text: Target accelerator pedal ratio.
10+
- name: throttle
11+
text: Target throttle pedal ratio.
1212
- name: brake
1313
text: Target brake pedal ratio.
1414
---
1515

1616
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
1717
{% block description %}
1818
Sends pedals command used in local operation mode. The pedal value is the ratio with the maximum pedal depression being 1.0.
19-
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
19+
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
2020
{% endblock %}

docs/design/autoware-interfaces/ad-api/list/api/remote/command/steering.md renamed to docs/design/autoware-interfaces/ad-api/list/api/manual/local/command/steering.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: /api/remote/command/steering
2+
title: /api/manual/local/command/steering
33
status: not released
44
method: realtime stream
55
type:
@@ -9,10 +9,12 @@ type:
99
text: Timestamp when this message was sent.
1010
- name: steering_tire_angle
1111
text: Target steering tire angle [rad].
12+
- name: steering_tire_velocity
13+
text: Target steering tire velocity [rad/s].
1214
---
1315

1416
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
1517
{% block description %}
1618
Send steering command to this API.
17-
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
19+
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
1820
{% endblock %}

docs/design/autoware-interfaces/ad-api/list/api/local/command/turn_indicators.md renamed to docs/design/autoware-interfaces/ad-api/list/api/manual/local/command/turn_indicators.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: /api/local/command/turn_indicators
2+
title: /api/manual/local/command/turn_indicators
33
status: not released
44
method: notification
55
type:
@@ -14,5 +14,5 @@ type:
1414
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
1515
{% block description %}
1616
Sends turn indicators command used in local operation mode.
17-
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
17+
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
1818
{% endblock %}

docs/design/autoware-interfaces/ad-api/list/api/local/command/velocity.md renamed to docs/design/autoware-interfaces/ad-api/list/api/manual/local/command/velocity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: /api/local/command/velocity
2+
title: /api/manual/local/command/velocity
33
status: not released
44
method: realtime stream
55
type:
@@ -14,5 +14,5 @@ type:
1414
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
1515
{% block description %}
1616
Sends velocity command used in local operation mode.
17-
To use this API, select the corresponding mode as described in [manual control](../../../../features/manual-control.md).
17+
To use this API, select the corresponding mode as described in [manual control](../../../../../features/manual-control.md).
1818
{% endblock %}

docs/design/autoware-interfaces/ad-api/list/api/remote/control_mode/list.md renamed to docs/design/autoware-interfaces/ad-api/list/api/manual/local/control_mode/list.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: /api/remote/control_mode/list
2+
title: /api/manual/local/control_mode/list
33
status: not released
44
method: function call
55
type:
@@ -13,6 +13,6 @@ type:
1313

1414
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
1515
{% block description %}
16-
List the available manual control modes as described in [manual control](../../../../features/manual-control.md).
16+
List the available manual control modes as described in [manual control](../../../../../features/manual-control.md).
1717
The disabled mode is not included in the available modes.
1818
{% endblock %}

docs/design/autoware-interfaces/ad-api/list/api/local/control_mode/select.md renamed to docs/design/autoware-interfaces/ad-api/list/api/manual/local/control_mode/select.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: /api/local/control_mode/select
2+
title: /api/manual/local/control_mode/select
33
status: not released
44
method: function call
55
type:
@@ -14,6 +14,6 @@ type:
1414

1515
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
1616
{% block description %}
17-
Selects the manual control mode as described in [manual control](../../../../features/manual-control.md).
18-
This API fails while [operation mode](../../../../features/operation_mode.md) is local.
17+
Selects the manual control mode as described in [manual control](../../../../../features/manual-control.md).
18+
This API fails while [operation mode](../../../../../features/operation_mode.md) is local.
1919
{% endblock %}

0 commit comments

Comments
 (0)