forked from autowarefoundation/autoware-documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(ad-api): add use cases of vehicle status (autowarefoundation#381)
* init vehicle status Signed-off-by: tkhmy <[email protected]> * fix spelling error Signed-off-by: tkhmy <[email protected]> * remove old file Signed-off-by: tkhmy <[email protected]> * fix spelling error Signed-off-by: tkhmy <[email protected]> * fix dead link Signed-off-by: tkhmy <[email protected]> * update vehicle message Signed-off-by: tkhmy <[email protected]> * change vehicle motion Signed-off-by: tkhmy <[email protected]> * feat(ad-api): add vehicle information api Signed-off-by: Takagi, Isamu <[email protected]> * fix msgs Signed-off-by: tkhmy <[email protected]> * update geo position Signed-off-by: tkhmy <[email protected]> * fix typo Signed-off-by: tkhmy <[email protected]> * change naming Signed-off-by: tkhmy <[email protected]> * feat: add door group Signed-off-by: Takagi, Isamu <[email protected]> * update message Signed-off-by: tkhmy <[email protected]> * fix naming Signed-off-by: tkhmy <[email protected]> * fix typo Signed-off-by: tkhmy <[email protected]> * update geographic_msgs Signed-off-by: tkhmy <[email protected]> * docs(ad-api): add use cases of vehicle status Signed-off-by: Takagi, Isamu <[email protected]> * feat: remove old files Signed-off-by: Takagi, Isamu <[email protected]> * feat: use template Signed-off-by: Takagi, Isamu <[email protected]> * apply template Signed-off-by: Takagi, Isamu <[email protected]> * update message name Signed-off-by: Takagi, Isamu <[email protected]> * update vehicle status feature Signed-off-by: Takagi, Isamu <[email protected]> * fix link Signed-off-by: Takagi, Isamu <[email protected]> * update door layout Signed-off-by: Takagi, Isamu <[email protected]> --------- Signed-off-by: tkhmy <[email protected]> Signed-off-by: Takagi, Isamu <[email protected]> Co-authored-by: tkhmy <[email protected]> Signed-off-by: guiping meng <[email protected]>
- Loading branch information
Showing
26 changed files
with
448 additions
and
3 deletions.
There are no files selected for viewing
5 changes: 5 additions & 0 deletions
5
docs/design/autoware-interfaces/ad-api/features/planning-factors.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Planning factors | ||
|
|
||
| !!! warning | ||
|
|
||
| Under Construction |
28 changes: 28 additions & 0 deletions
28
docs/design/autoware-interfaces/ad-api/features/vehicle-status.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Vehicle status | ||
|
|
||
| ## Related API | ||
|
|
||
| - {{ link_ad_api('/api/vehicle/kinematics') }} | ||
| - {{ link_ad_api('/api/vehicle/status') }} | ||
| - {{ link_ad_api('/api/vehicle/dimensions') }} | ||
| - {{ link_ad_api('/api/vehicle/doors/layout') }} | ||
| - {{ link_ad_api('/api/vehicle/doors/status') }} | ||
|
|
||
| ## Kinematics | ||
|
|
||
| This is an estimate of the vehicle kinematics. The vehicle position is necessary for applications to schedule dispatches. | ||
| Also, using velocity and acceleration, applications can find vehicles that need operator assistance, such as stuck or brake suddenly. | ||
|
|
||
| ## Status | ||
|
|
||
| This is the status provided by the vehicle. The indicators and steering are mainly used for visualization and remote control. | ||
| The remaining energy can be also used for vehicle scheduling. | ||
|
|
||
| ## Doors | ||
|
|
||
| This feature is available if the vehicle provides a software interface for the doors. | ||
| It can be used to create user interfaces for passengers or to control sequences at bus stops. | ||
|
|
||
| ## 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. |
16 changes: 16 additions & 0 deletions
16
docs/design/autoware-interfaces/ad-api/list/api/vehicle/dimensions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: /api/vehicle/dimensions | ||
| method: function call | ||
| type: | ||
| name: autoware_adapi_v1_msgs/srv/GetVehicleDimensions | ||
| res: | ||
| - name: status | ||
| text: response status | ||
| - name: dimensions | ||
| text: vehicle dimensions | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %} | ||
| {% block description %} | ||
| Get the vehicle dimensions. See [here](../../../../components/vehicle-dimensions.md) for the definition of each value. | ||
| {% endblock %} |
18 changes: 18 additions & 0 deletions
18
docs/design/autoware-interfaces/ad-api/list/api/vehicle/doors/layout.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| title: /api/vehicle/doors/layout | ||
| method: function call | ||
| type: | ||
| name: autoware_adapi_v1_msgs/srv/GetDoorLayout | ||
| res: | ||
| - name: status | ||
| text: response status | ||
| - name: doors.roles | ||
| text: The roles of the door in the service the vehicle provides. | ||
| - name: doors.description | ||
| text: The description of the door for display in the interface. | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %} | ||
| {% block description %} | ||
| Get the door layout. It is an array of pose for each door. The array index corresponds to the door status. | ||
| {% endblock %} |
14 changes: 14 additions & 0 deletions
14
docs/design/autoware-interfaces/ad-api/list/api/vehicle/doors/status.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| title: /api/vehicle/doors/status | ||
| method: notification | ||
| type: | ||
| name: autoware_adapi_v1_msgs/msg/DoorStatusArray | ||
| msg: | ||
| - name: doors.status | ||
| text: current door status | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %} | ||
| {% block description %} | ||
| Publish door status in array according to the door location information that received from vehicle info service. | ||
| {% endblock %} |
20 changes: 20 additions & 0 deletions
20
docs/design/autoware-interfaces/ad-api/list/api/vehicle/kinematics.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| title: /api/vehicle/kinematics | ||
| method: realtime stream | ||
| type: | ||
| name: autoware_adapi_v1_msgs/msg/VehicleKinematics | ||
| msg: | ||
| - name: geographic_pose | ||
| text: The longitude and latitude of the vehicle. If the map uses local coordinates, it will not be available. | ||
| - name: pose | ||
| text: The pose with covariance from the base link. | ||
| - name: twist | ||
| text: Vehicle current twist with covariance. | ||
| - name: accel | ||
| text: Vehicle current acceleration with covariance. | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %} | ||
| {% block description %} | ||
| Publish vehicle kinematics. | ||
| {% endblock %} |
22 changes: 22 additions & 0 deletions
22
docs/design/autoware-interfaces/ad-api/list/api/vehicle/status.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| title: /api/vehicle/status | ||
| method: notification | ||
| type: | ||
| name: autoware_adapi_v1_msgs/msg/VehicleStatus | ||
| msg: | ||
| - name: gear | ||
| text: Gear status. | ||
| - name: turn_indicators | ||
| text: Turn indicators status, only either left or right will be enabled. | ||
| - name: hazard_lights | ||
| text: Hazard lights status. | ||
| - name: steering_tire_angle | ||
| text: Vehicle current tire angle in radian. | ||
| - name: energy_percentage | ||
| text: Battery percentage or fuel percentage, it will depends on the vehicle. | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %} | ||
| {% block description %} | ||
| Publish vehicle state information. | ||
| {% endblock %} |
19 changes: 19 additions & 0 deletions
19
...esign/autoware-interfaces/ad-api/types/autoware_adapi_v1_msgs/msg/DoorLayout.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| # This file is generated by tools/autoware-interfaces/generate.py | ||
| title: autoware_adapi_v1_msgs/msg/DoorLayout | ||
| used: | ||
| - autoware_adapi_v1_msgs/srv/GetDoorLayout | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %} | ||
| {% block definition %} | ||
|
|
||
| ```txt | ||
| uint8 GET_ON = 1 | ||
| uint8 GET_OFF = 2 | ||
| uint8[] roles | ||
| string description | ||
| ``` | ||
|
|
||
| {% endblock %} |
23 changes: 23 additions & 0 deletions
23
...esign/autoware-interfaces/ad-api/types/autoware_adapi_v1_msgs/msg/DoorStatus.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| # This file is generated by tools/autoware-interfaces/generate.py | ||
| title: autoware_adapi_v1_msgs/msg/DoorStatus | ||
| used: | ||
| - autoware_adapi_v1_msgs/msg/DoorStatusArray | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %} | ||
| {% block definition %} | ||
|
|
||
| ```txt | ||
| # constants for door status | ||
| uint8 UNKNOWN = 0 | ||
| uint8 NOT_AVAILABLE = 1 | ||
| uint8 OPENED = 2 | ||
| uint8 CLOSED = 3 | ||
| uint8 OPENING = 4 | ||
| uint8 CLOSING = 5 | ||
| uint8 status | ||
| ``` | ||
|
|
||
| {% endblock %} |
16 changes: 16 additions & 0 deletions
16
.../autoware-interfaces/ad-api/types/autoware_adapi_v1_msgs/msg/DoorStatusArray.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| # This file is generated by tools/autoware-interfaces/generate.py | ||
| title: autoware_adapi_v1_msgs/msg/DoorStatusArray | ||
| uses: | ||
| - autoware_adapi_v1_msgs/msg/DoorStatus | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %} | ||
| {% block definition %} | ||
|
|
||
| ```txt | ||
| builtin_interfaces/Time stamp | ||
| autoware_adapi_v1_msgs/DoorStatus[] doors | ||
| ``` | ||
|
|
||
| {% endblock %} |
23 changes: 23 additions & 0 deletions
23
docs/design/autoware-interfaces/ad-api/types/autoware_adapi_v1_msgs/msg/Gear.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| # This file is generated by tools/autoware-interfaces/generate.py | ||
| title: autoware_adapi_v1_msgs/msg/Gear | ||
| used: | ||
| - autoware_adapi_v1_msgs/msg/VehicleStatus | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %} | ||
| {% block definition %} | ||
|
|
||
| ```txt | ||
| # constants | ||
| uint8 UNKNOWN = 0 | ||
| uint8 NEUTRAL = 1 | ||
| uint8 DRIVE = 2 | ||
| uint8 REVERSE = 3 | ||
| uint8 PARK = 4 | ||
| uint8 LOW = 5 | ||
| uint8 status | ||
| ``` | ||
|
|
||
| {% endblock %} |
20 changes: 20 additions & 0 deletions
20
...ign/autoware-interfaces/ad-api/types/autoware_adapi_v1_msgs/msg/HazardLights.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| # This file is generated by tools/autoware-interfaces/generate.py | ||
| title: autoware_adapi_v1_msgs/msg/HazardLights | ||
| used: | ||
| - autoware_adapi_v1_msgs/msg/VehicleStatus | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %} | ||
| {% block definition %} | ||
|
|
||
| ```txt | ||
| # constants | ||
| uint8 UNKNOWN = 0 | ||
| uint8 DISABLE = 1 | ||
| uint8 ENABLE = 2 | ||
| uint8 status | ||
| ``` | ||
|
|
||
| {% endblock %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
21
...n/autoware-interfaces/ad-api/types/autoware_adapi_v1_msgs/msg/TurnIndicators.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| # This file is generated by tools/autoware-interfaces/generate.py | ||
| title: autoware_adapi_v1_msgs/msg/TurnIndicators | ||
| used: | ||
| - autoware_adapi_v1_msgs/msg/VehicleStatus | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %} | ||
| {% block definition %} | ||
|
|
||
| ```txt | ||
| # constants | ||
| uint8 UNKNOWN = 0 | ||
| uint8 DISABLE = 1 | ||
| uint8 LEFT = 2 | ||
| uint8 RIGHT = 3 | ||
| uint8 status | ||
| ``` | ||
|
|
||
| {% endblock %} |
24 changes: 24 additions & 0 deletions
24
...utoware-interfaces/ad-api/types/autoware_adapi_v1_msgs/msg/VehicleDimensions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| # This file is generated by tools/autoware-interfaces/generate.py | ||
| title: autoware_adapi_v1_msgs/msg/VehicleDimensions | ||
| used: | ||
| - autoware_adapi_v1_msgs/srv/GetVehicleDimensions | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %} | ||
| {% block definition %} | ||
|
|
||
| ```txt | ||
| float32 wheel_radius | ||
| float32 wheel_width | ||
| float32 wheel_base | ||
| float32 wheel_tread | ||
| float32 front_overhang | ||
| float32 rear_overhang | ||
| float32 left_overhang | ||
| float32 right_overhang | ||
| float32 height | ||
| geometry_msgs/Polygon footprint | ||
| ``` | ||
|
|
||
| {% endblock %} |
21 changes: 21 additions & 0 deletions
21
...utoware-interfaces/ad-api/types/autoware_adapi_v1_msgs/msg/VehicleKinematics.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| # This file is generated by tools/autoware-interfaces/generate.py | ||
| title: autoware_adapi_v1_msgs/msg/VehicleKinematics | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %} | ||
| {% block definition %} | ||
|
|
||
| ```txt | ||
| # Geographic point, using the WGS 84 reference ellipsoid. | ||
| # Currently only support conversion from single MGRS Grid code or UTM | ||
| # If the vector map do not contain correct MGRS Grid code or UTM, this data will be not valid | ||
| geographic_msgs/GeoPointStamped geographic_pose | ||
| # Local coordinate from the autoware | ||
| geometry_msgs/PoseWithCovarianceStamped pose | ||
| geometry_msgs/TwistWithCovarianceStamped twist | ||
| geometry_msgs/AccelWithCovarianceStamped accel | ||
| ``` | ||
|
|
||
| {% endblock %} |
22 changes: 22 additions & 0 deletions
22
...gn/autoware-interfaces/ad-api/types/autoware_adapi_v1_msgs/msg/VehicleStatus.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| # This file is generated by tools/autoware-interfaces/generate.py | ||
| title: autoware_adapi_v1_msgs/msg/VehicleStatus | ||
| uses: | ||
| - autoware_adapi_v1_msgs/msg/Gear | ||
| - autoware_adapi_v1_msgs/msg/HazardLights | ||
| - autoware_adapi_v1_msgs/msg/TurnIndicators | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %} | ||
| {% block definition %} | ||
|
|
||
| ```txt | ||
| builtin_interfaces/Time stamp | ||
| autoware_adapi_v1_msgs/Gear gear | ||
| autoware_adapi_v1_msgs/TurnIndicators turn_indicators | ||
| autoware_adapi_v1_msgs/HazardLights hazard_lights | ||
| float64 steering_tire_angle | ||
| float32 energy_percentage # Battery percentage or fuel percentage, it will depends on the vehicle. | ||
| ``` | ||
|
|
||
| {% endblock %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
...gn/autoware-interfaces/ad-api/types/autoware_adapi_v1_msgs/srv/GetDoorLayout.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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/GetDoorLayout | ||
| uses: | ||
| - autoware_adapi_v1_msgs/msg/DoorLayout | ||
| - autoware_adapi_v1_msgs/msg/ResponseStatus | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %} | ||
| {% block definition %} | ||
|
|
||
| ```txt | ||
| --- | ||
| autoware_adapi_v1_msgs/ResponseStatus status | ||
| autoware_adapi_v1_msgs/DoorLayout doors | ||
| ``` | ||
|
|
||
| {% endblock %} |
18 changes: 18 additions & 0 deletions
18
...ware-interfaces/ad-api/types/autoware_adapi_v1_msgs/srv/GetVehicleDimensions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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/GetVehicleDimensions | ||
| uses: | ||
| - autoware_adapi_v1_msgs/msg/ResponseStatus | ||
| - autoware_adapi_v1_msgs/msg/VehicleDimensions | ||
| --- | ||
|
|
||
| {% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %} | ||
| {% block definition %} | ||
|
|
||
| ```txt | ||
| --- | ||
| autoware_adapi_v1_msgs/ResponseStatus status | ||
| autoware_adapi_v1_msgs/VehicleDimensions dimensions | ||
| ``` | ||
|
|
||
| {% endblock %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.