Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions docs/design/autoware-interfaces/ad-api/features/vehicle-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@
- {{ link_ad_api('/api/vehicle/status') }}
- {{ link_ad_api('/api/vehicle/metrics') }}
- {{ link_ad_api('/api/vehicle/dimensions') }}
- {{ link_ad_api('/api/vehicle/specs') }}
- {{ link_ad_api('/api/vehicle/command/acceleration') }}
- {{ link_ad_api('/api/vehicle/command/pedals') }}
- {{ link_ad_api('/api/vehicle/command/steering') }}
- {{ link_ad_api('/api/vehicle/command/velocity') }}

## Kinematics

Expand All @@ -25,3 +30,8 @@ The remaining energy can be used for vehicle dispatch scheduling.
## Dimensions

The vehicle dimensions are used to know the actual distance between the vehicle and objects because the vehicle position in kinematics is the coordinates of the base link. This is necessary for visualization when supporting vehicles remotely.

## Commands

The vehicle commands are target values that Autoware is sending to the vehicle. Note that unlike vehicle status, this does not represent the actual vehicle status.
Some commands may not be supported depending on the vehicle control method.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: /api/vehicle/command/acceleration
status: not released
method: realtime stream
type:
name: autoware_adapi_v1_msgs/msg/AccelerationCommand
msg:
- name: stamp
text: Timestamp when this message was sent.
- name: acceleration
text: Target acceleration [m/s^2].
---

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
This is the target acceleration that Autoware is sending to the vehicle.
{% endblock %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: /api/vehicle/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: brake
text: Target brake pedal ratio.
---

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
This is the target pedals that Autoware is sending to the vehicle.
The pedal value is the ratio with the maximum pedal depression being 1.0.
This API is not supported if the vehicle is not controlled by pedals.
{% endblock %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: /api/vehicle/command/steering
status: not released
method: realtime stream
type:
name: autoware_adapi_v1_msgs/msg/SteeringCommand
msg:
- name: stamp
text: Timestamp when this message was sent.
- name: steering_tire_angle
text: Target steering tire angle [rad].
---

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
This is the target steering that Autoware is sending to the vehicle.
{% endblock %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: /api/vehicle/command/velocity
status: not released
method: realtime stream
type:
name: autoware_adapi_v1_msgs/msg/VelocityCommand
msg:
- name: stamp
text: Timestamp when this message was sent.
- name: velocity
text: Target velocity [m/s].
---

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
This is the target velocity that Autoware is sending to the vehicle.
{% endblock %}
17 changes: 17 additions & 0 deletions docs/design/autoware-interfaces/ad-api/list/api/vehicle/specs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: /api/vehicle/specs
status: not released
method: function call
type:
name: autoware_adapi_v1_msgs/srv/GetVehicleSpecs
res:
- name: status
text: response status
- name: specs
text: vehicle specifications
---

{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
{% block description %}
Get the vehicle specifications.
{% endblock %}
5 changes: 5 additions & 0 deletions docs/design/autoware-interfaces/ad-api/list/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,15 @@
| [/api/system/diagnostics/status](./api/system/diagnostics/status.md) | v1.3.0 | realtime stream |
| [/api/system/diagnostics/struct](./api/system/diagnostics/struct.md) | v1.3.0 | notification |
| [/api/system/heartbeat](./api/system/heartbeat.md) | v1.3.0 | realtime stream |
| [/api/vehicle/command/acceleration](./api/vehicle/command/acceleration.md) | not released | realtime stream |
| [/api/vehicle/command/pedals](./api/vehicle/command/pedals.md) | not released | realtime stream |
| [/api/vehicle/command/steering](./api/vehicle/command/steering.md) | not released | realtime stream |
| [/api/vehicle/command/velocity](./api/vehicle/command/velocity.md) | not released | realtime stream |
| [/api/vehicle/dimensions](./api/vehicle/dimensions.md) | v1.1.0 | function call |
| [/api/vehicle/doors/command](./api/vehicle/doors/command.md) | v1.2.0 | function call |
| [/api/vehicle/doors/layout](./api/vehicle/doors/layout.md) | v1.2.0 | function call |
| [/api/vehicle/doors/status](./api/vehicle/doors/status.md) | v1.2.0 | notification |
| [/api/vehicle/kinematics](./api/vehicle/kinematics.md) | v1.1.0 | realtime stream |
| [/api/vehicle/metrics](./api/vehicle/metrics.md) | not released | reliable stream |
| [/api/vehicle/specs](./api/vehicle/specs.md) | not released | function call |
| [/api/vehicle/status](./api/vehicle/status.md) | v1.4.0 | realtime stream |
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ used:
- autoware_adapi_v1_msgs/srv/GetCooperationPolicies
- autoware_adapi_v1_msgs/srv/GetDoorLayout
- autoware_adapi_v1_msgs/srv/GetVehicleDimensions
- autoware_adapi_v1_msgs/srv/GetVehicleSpecs
- autoware_adapi_v1_msgs/srv/InitializeLocalization
- autoware_adapi_v1_msgs/srv/ListManualControlMode
- autoware_adapi_v1_msgs/srv/SelectManualControlMode
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
# This file is generated by tools/autoware-interfaces/generate.py
title: autoware_adapi_v1_msgs/msg/VehicleSpecs
used:
- autoware_adapi_v1_msgs/srv/GetVehicleSpecs
---

{% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %}
{% block definition %}

```txt
float32 max_steering_tire_angle
```

{% endblock %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
# This file is generated by tools/autoware-interfaces/generate.py
title: autoware_adapi_v1_msgs/srv/GetVehicleSpecs
uses:
- autoware_adapi_v1_msgs/msg/ResponseStatus
- autoware_adapi_v1_msgs/msg/VehicleSpecs
---

{% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %}
{% block definition %}

```txt
---
autoware_adapi_v1_msgs/ResponseStatus status
autoware_adapi_v1_msgs/VehicleSpecs specs
```

{% endblock %}
2 changes: 2 additions & 0 deletions docs/design/autoware-interfaces/ad-api/types/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
- [autoware_adapi_v1_msgs/msg/VehicleDimensions](./autoware_adapi_v1_msgs/msg/VehicleDimensions.md)
- [autoware_adapi_v1_msgs/msg/VehicleKinematics](./autoware_adapi_v1_msgs/msg/VehicleKinematics.md)
- [autoware_adapi_v1_msgs/msg/VehicleMetrics](./autoware_adapi_v1_msgs/msg/VehicleMetrics.md)
- [autoware_adapi_v1_msgs/msg/VehicleSpecs](./autoware_adapi_v1_msgs/msg/VehicleSpecs.md)
- [autoware_adapi_v1_msgs/msg/VehicleStatus](./autoware_adapi_v1_msgs/msg/VehicleStatus.md)
- [autoware_adapi_v1_msgs/msg/VelocityCommand](./autoware_adapi_v1_msgs/msg/VelocityCommand.md)
- [autoware_adapi_v1_msgs/msg/VelocityFactor](./autoware_adapi_v1_msgs/msg/VelocityFactor.md)
Expand All @@ -58,6 +59,7 @@
- [autoware_adapi_v1_msgs/srv/GetCooperationPolicies](./autoware_adapi_v1_msgs/srv/GetCooperationPolicies.md)
- [autoware_adapi_v1_msgs/srv/GetDoorLayout](./autoware_adapi_v1_msgs/srv/GetDoorLayout.md)
- [autoware_adapi_v1_msgs/srv/GetVehicleDimensions](./autoware_adapi_v1_msgs/srv/GetVehicleDimensions.md)
- [autoware_adapi_v1_msgs/srv/GetVehicleSpecs](./autoware_adapi_v1_msgs/srv/GetVehicleSpecs.md)
- [autoware_adapi_v1_msgs/srv/InitializeLocalization](./autoware_adapi_v1_msgs/srv/InitializeLocalization.md)
- [autoware_adapi_v1_msgs/srv/ListManualControlMode](./autoware_adapi_v1_msgs/srv/ListManualControlMode.md)
- [autoware_adapi_v1_msgs/srv/SelectManualControlMode](./autoware_adapi_v1_msgs/srv/SelectManualControlMode.md)
Expand Down
7 changes: 7 additions & 0 deletions yaml/autoware-interfaces.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,9 @@ types:
msg:
energy: float32
stamp: builtin_interfaces/msg/Time
autoware_adapi_v1_msgs/msg/VehicleSpecs:
msg:
max_steering_tire_angle: float32
autoware_adapi_v1_msgs/msg/VehicleStatus:
msg:
gear: autoware_adapi_v1_msgs/msg/Gear
Expand Down Expand Up @@ -267,6 +270,10 @@ types:
res:
dimensions: autoware_adapi_v1_msgs/msg/VehicleDimensions
status: autoware_adapi_v1_msgs/msg/ResponseStatus
autoware_adapi_v1_msgs/srv/GetVehicleSpecs:
res:
specs: autoware_adapi_v1_msgs/msg/VehicleSpecs
status: autoware_adapi_v1_msgs/msg/ResponseStatus
autoware_adapi_v1_msgs/srv/InitializeLocalization:
req:
pose: geometry_msgs/msg/PoseWithCovarianceStamped[<=1]
Expand Down
Loading