Add initial FlexRay section for fmi-ls-bus (#161)

* Add content, operations, header files and tests for FlexRay section --------- Co-authored-by: Benedikt Menne <[email protected]> Co-authored-by: Clemens Boos <[email protected]> Co-authored-by: Jan Ribbe <[email protected]>
modelica · Oct 22, 2024 · 9798b57 · 9798b57
1 parent e141aae
commit 9798b57
Show file tree

Hide file tree

Showing 37 changed files with 4,783 additions and 17 deletions.
diff --git a/docs/1____introduction.adoc b/docs/1____introduction.adoc
@@ -79,7 +79,7 @@ This layered standard defines requires the use of a layered standard manifest fi
 
 |`fmi-ls-version`
 | `\http://fmi-standard.org/fmi-ls-manifest`
-| `1.0.0-beta.1`
+| `1.1.0-alpha.1`
 | Version of the layered standard. This layered standard uses semantic versioning, as defined in <<PW13>>.
 
 |`fmi-ls-description`

diff --git a/docs/2____common_concepts.adoc b/docs/2____common_concepts.adoc
@@ -116,13 +116,13 @@ The usage of this architecture type allows the integration of this layered stand
 In this case, it may also be possible to integrate other, for example manufacturer-specific, formats into a bus simulation.
 
 ===  Provided C-API [[common-concepts-provided-c-api]]
-Besides the textual specification for FMUs with bus support, this layered standard also provides a C header files to simplify the creation of FMUs with bus support.
+Besides the textual specification for FMUs with bus support, this layered standard also provides C header files to simplify the creation of FMUs with bus support.
 The following header files are provided:
 
-* https://github.com/modelica/fmi-ls-bus/blob/main/headers/fmi3LsBus.h[fmi3LsBus.h] provides general macros, types and structures of common Bus Operations.
+* https://github.com/modelica/fmi-ls-bus/blob/main/headers/fmi3LsBus.h[fmi3LsBus.h] provides general macros, types and structures for common Bus Operations.
 These header file applies to all supported bus types of the layered standard.
-* https://github.com/modelica/fmi-ls-bus/blob/main/headers/fmi3LsBusCan.h[fmi3LsBusCan.h] provides macros, types and structures of Bus Operations explicit for CAN, CAN FD and CAN XL.
-Primarily, structures are included here that allow the Bus Operations specified by the layered standard to be easily created and used.
 * https://github.com/modelica/fmi-ls-bus/blob/main/headers/fmi3LsBusUtil.h[fmi3LsBusUtil.h] provides common utility macros and structures for all supported bus types.
+* https://github.com/modelica/fmi-ls-bus/blob/main/headers/fmi3LsBusCan.h[fmi3LsBusCan.h] provides macros, types and structures of Bus Operations for CAN, CAN FD and CAN XL.
 * https://github.com/modelica/fmi-ls-bus/blob/main/headers/fmi3LsBusUtilCan.h[fmi3LsBusUtilCan.h] provides CAN, CAN FD and CAN XL explicit utility macros.
-
+* https://github.com/modelica/fmi-ls-bus/blob/main/headers/fmi3LsBusFlexRay.h[fmi3LsBusFlexRay.h] provides macros, types and structures of Bus Operations for FlexRay.
+* https://github.com/modelica/fmi-ls-bus/blob/main/headers/fmi3LsBusUtilFlexRay.h[fmi3LsBusUtilFlexRay.h] provides FlexRay explicit utility macros.
diff --git a/docs/4_4_1_can.adoc b/docs/4_4_1_can.adoc
@@ -38,7 +38,7 @@ h|Length
 |0x01
 |:= 10 + n +
 (4 byte)
-|DL +
+|DL footnote:[DL is used as an abbreviation for Data Length throughout the document] +
 (2 byte)
 7+|Data +
 (n byte)