Skip to content

Commit 421f02b

Browse files
author
Daniel Becker
committed
add documentation for motion request input and output
Signed-off-by: Daniel Becker <daniel.becker@ika.rwth-aachen.de>
1 parent 5221d33 commit 421f02b

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
ifndef::include-only-once[]
2+
:root-path: ../
3+
include::{root-path}_config.adoc[]
4+
endif::[]
5+
= Motion request inputs
6+
7+
This message is intended as an interface between a behavior model (e.g. driver model or HAD function) and the actuator management.
8+
Either a desired future trajectory or a desired future state may be sent.
9+
10+
**Prefix**
11+
12+
Motion request inputs shall be named with the following prefix:
13+
14+
[source,protobuf]
15+
----
16+
OSMPMotionRequestIn
17+
----
18+
19+
**Rules**
20+
21+
* If only one motion request input is configured, the prefix shall only be `OSMPMotionRequestIn`.
22+
* If more than one motion request input is configured, the prefix shall be extended by an array index, for example, `OSMPMotionRequestIn[1]` and `OSMPMotionRequestIn[2]`.
23+
* Array indices shall start at 1 and shall be consecutive.
24+
* Each motion request input shall be defined as a notional discrete binary input variable with `@causality="input"` and `@variability="discrete"`.
25+
* The MIME type of the variable shall specify the `type=MotionRequest` as part of the MIME type parameters.
26+
* Motion request data shall be encoded as `osi3::MotionRequest`.
27+
* The motion request passed to the FMU must contain one of the available ``OutputOptions``. In addition to the enumerator, the corresponding ``DesiredState`` or ``Trajectory`` has to be set, respectively.
28+
* The guaranteed lifetime of the motion request protocol-buffer pointer provided as input to the FMU shall be from the time of the call to `fmi2SetInteger` that provides those values until the end of the following `fmi2DoStep` call.
29+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
ifndef::include-only-once[]
2+
:root-path: ../
3+
include::{root-path}_config.adoc[]
4+
endif::[]
5+
= Motion request outputs
6+
7+
This message is intended as an interface between a behavior model (e.g. driver model or HAD function) and the actuator management.
8+
Either a desired future trajectory or a desired future state may be sent.
9+
10+
**Prefix**
11+
12+
Motion request outputs shall be named with the following prefix:
13+
14+
[source,protobuf]
15+
----
16+
OSMPMotionRequestOut
17+
----
18+
19+
**Rules**
20+
21+
* If only one motion request input is configured, the prefix shall only be `OSMPMotionRequestOut`.
22+
* If more than one motion request input is configured, the prefix shall be extended by an array index, for example, `OSMPMotionRequestOut[1]` and `OSMPMotionRequestOut[2]`.
23+
* Array indices shall start at 1 and shall be consecutive.
24+
* Each motion request input shall be defined as a notional discrete binary input variable with `@causality="input"` and `@variability="discrete"`.
25+
* The MIME type of the variable shall specify the `type=MotionRequest` as part of the MIME type parameters.
26+
* Motion request data shall be encoded as `osi3::MotionRequest`.
27+
* The motion request passed to the FMU must contain one of the available ``OutputOptions``. In addition to the enumerator, the corresponding ``DesiredState`` or ``Trajectory`` has to be set, respectively.
28+
* The guaranteed lifetime of the motion request protocol-buffer pointer provided as input to the FMU shall be from the time of the call to `fmi2SetInteger` that provides those values until the end of the following `fmi2DoStep` call.
29+

0 commit comments

Comments
 (0)