Skip to content

Commit a84a2f1

Browse files
authored
feat(ad-api): add request to intervene (RTI) (autowarefoundation#444)
* add rti api Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * simplify message Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> * move section Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp> --------- Signed-off-by: Takagi, Isamu <isamu.takagi@tier4.jp>
1 parent bb058cc commit a84a2f1

File tree

6 files changed

+48
-5
lines changed

6 files changed

+48
-5
lines changed

docs/design/autoware-interfaces/ad-api/features/fail-safe.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## Related API
44

5+
- {{ link_ad_api('/api/fail_safe/rti_state') }}
56
- {{ link_ad_api('/api/fail_safe/mrm_state') }}
67

78
## Description
@@ -15,10 +16,14 @@ The fail-safe module selects the behavior of MRM according to the abnormality an
1516

1617
![fail-safe-architecture](./fail-safe/architecture.drawio.svg)
1718

18-
## States
19+
## RTI state
1920

20-
The MRM state indicates whether MRM is operating. This state also provides success or failure.
21-
Generally, MRM will switch to another behavior if it fails.
21+
The RTI state indicates whether RTI is requested. If for some reason autonomous driving cannot continue, Autoware will request a change to manual driving. As a side note, RTI is sometimes called Take Over Request (TOR).
22+
23+
## MRM state
24+
25+
The MRM state indicates whether MRM is operating and its current behavior.
26+
This state also provides success or failure of the operation. Generally, MRM will switch to another behavior if it fails.
2227

2328
![mrm-state](./fail-safe/mrm-state.drawio.svg)
2429

@@ -29,8 +34,6 @@ Generally, MRM will switch to another behavior if it fails.
2934
| SUCCEEDED | MRM succeeded. The vehicle is in a safe condition. |
3035
| FAILED | MRM failed. The vehicle is still in an unsafe condition. |
3136

32-
## Behavior
33-
3437
There is a dependency between MRM behaviors. For example, it switches from a comfortable stop to a emergency stop, but not the other way around.
3538
This is service dependent. Autoware supports the following transitions by default.
3639

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: /api/fail_safe/rti_state
3+
status: not released
4+
method: notification
5+
type:
6+
name: autoware_adapi_v1_msgs/msg/RtiState
7+
msg:
8+
- name: request
9+
text: The flag for whether RTI is requested.
10+
- name: message
11+
text: The message such as reasons for RTI.
12+
---
13+
14+
{% extends 'design/autoware-interfaces/templates/autoware-interface.jinja2' %}
15+
{% block description %}
16+
Get the RTI state.
17+
For details, see the [fail-safe](../../../features/fail-safe.md).
18+
{% endblock %}

docs/design/autoware-interfaces/ad-api/list/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
| API | Release | Method |
44
| ------------------------------------------------------------------------------------------------ | ------------ | --------------- |
55
| [/api/fail_safe/mrm_state](./api/fail_safe/mrm_state.md) | v1.1.0 | notification |
6+
| [/api/fail_safe/rti_state](./api/fail_safe/rti_state.md) | not released | notification |
67
| [/api/interface/version](./api/interface/version.md) | v1.0.0 | function call |
78
| [/api/local/command/acceleration](./api/local/command/acceleration.md) | not released | realtime stream |
89
| [/api/local/command/gear](./api/local/command/gear.md) | not released | notification |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
# This file is generated by tools/autoware-interfaces/generate.py
3+
title: autoware_adapi_v1_msgs/msg/RtiState
4+
---
5+
6+
{% extends 'design/autoware-interfaces/templates/autoware-data-type.jinja2' %}
7+
{% block definition %}
8+
9+
```txt
10+
builtin_interfaces/Time stamp
11+
bool request
12+
string message
13+
```
14+
15+
{% endblock %}

docs/design/autoware-interfaces/ad-api/types/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
- [autoware_adapi_v1_msgs/msg/RoutePrimitive](./autoware_adapi_v1_msgs/msg/RoutePrimitive.md)
4040
- [autoware_adapi_v1_msgs/msg/RouteSegment](./autoware_adapi_v1_msgs/msg/RouteSegment.md)
4141
- [autoware_adapi_v1_msgs/msg/RouteState](./autoware_adapi_v1_msgs/msg/RouteState.md)
42+
- [autoware_adapi_v1_msgs/msg/RtiState](./autoware_adapi_v1_msgs/msg/RtiState.md)
4243
- [autoware_adapi_v1_msgs/msg/SteeringCommand](./autoware_adapi_v1_msgs/msg/SteeringCommand.md)
4344
- [autoware_adapi_v1_msgs/msg/SteeringFactor](./autoware_adapi_v1_msgs/msg/SteeringFactor.md)
4445
- [autoware_adapi_v1_msgs/msg/SteeringFactorArray](./autoware_adapi_v1_msgs/msg/SteeringFactorArray.md)

yaml/autoware-interfaces.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,11 @@ types:
169169
msg:
170170
stamp: builtin_interfaces/msg/Time
171171
state: uint16
172+
autoware_adapi_v1_msgs/msg/RtiState:
173+
msg:
174+
message: string
175+
request: bool
176+
stamp: builtin_interfaces/msg/Time
172177
autoware_adapi_v1_msgs/msg/SteeringCommand:
173178
msg:
174179
stamp: builtin_interfaces/msg/Time

0 commit comments

Comments
 (0)