Skip to content

Commit

Permalink
feat(ad-api): add route change api (#592)
Browse files Browse the repository at this point in the history
Signed-off-by: Takagi, Isamu <[email protected]>
  • Loading branch information
isamu-takagi authored Jul 30, 2024
1 parent d44e5e2 commit 1200ceb
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/design/autoware-interfaces/ad-api/features/routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@

- {{ link_ad_api('/api/routing/state') }}
- {{ link_ad_api('/api/routing/route') }}
- {{ link_ad_api('/api/routing/clear_route') }}
- {{ link_ad_api('/api/routing/set_route_points') }}
- {{ link_ad_api('/api/routing/set_route') }}
- {{ link_ad_api('/api/routing/clear_route') }}
- {{ link_ad_api('/api/routing/change_route_points') }}
- {{ link_ad_api('/api/routing/change_route') }}

## Description

Expand All @@ -23,11 +25,11 @@ There are two ways to set the route. The one is a generic method that uses pose,
| UNSET | The route is not set. Waiting for a route request. |
| SET | The route is set. |
| ARRIVED | The vehicle has arrived at the destination. |
| CHANGING | Trying to change the route. Not implemented yet. |
| CHANGING | Trying to change the route. |

## Options

The `set_route_points` and `set_route` APIs have route options that allow applications to choose several behaviors regarding route planning.
The route set and change APIs have route options that allow applications to choose several behaviors regarding route planning.
See the sections below for supported options and details.

### allow_goal_modification
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: /api/routing/change_route
status: not released
method: function call
type:
name: autoware_adapi_v1_msgs/srv/SetRoute
req:
- name: header
text: header for pose transformation
- name: goal
text: goal pose
- name: segments
text: waypoint segments in lanelet format
res:
- name: status
text: response status
---

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Same as {{ link_ad_api('/api/routing/change_route') }}, but change the route while driving.
This API only accepts the route when the route state is SET.
In any other state, set the route first or wait for the route change to complete.
{% endblock %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: /api/routing/change_route_points
status: not released
method: function call
type:
name: autoware_adapi_v1_msgs/srv/SetRoutePoints
req:
- name: header
text: header for pose transformation
- name: goal
text: goal pose
- name: waypoints
text: waypoint poses
res:
- name: status
text: response status
---

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Same as {{ link_ad_api('/api/routing/change_route_points') }}, but change the route while driving.
This API only accepts the route when the route state is SET.
In any other state, set the route first or wait for the route change to complete.
{% endblock %}
2 changes: 2 additions & 0 deletions docs/design/autoware-interfaces/ad-api/list/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
| [/api/planning/cooperation/set_policies](./api/planning/cooperation/set_policies.md) | not released |
| [/api/planning/steering_factors](./api/planning/steering_factors.md) | not released |
| [/api/planning/velocity_factors](./api/planning/velocity_factors.md) | not released |
| [/api/routing/change_route](./api/routing/change_route.md) | not released |
| [/api/routing/change_route_points](./api/routing/change_route_points.md) | not released |
| [/api/routing/clear_route](./api/routing/clear_route.md) | v1.0.0 |
| [/api/routing/route](./api/routing/route.md) | v1.0.0 |
| [/api/routing/set_route](./api/routing/set_route.md) | v1.0.0 |
Expand Down

0 comments on commit 1200ceb

Please sign in to comment.