From 5d1b58f526255a39c7c25bc4114793069361272b Mon Sep 17 00:00:00 2001 From: Benedikt Menne Date: Tue, 5 Nov 2024 14:05:58 +0100 Subject: [PATCH] Fixed mixture of fmi-ls-bus and FMI-LS-BUS --- README.md | 20 ++++++++++---------- Release Checklist.md | 2 +- headers/fmi3LsBus.h | 8 ++++---- headers/fmi3LsBusCan.h | 4 ++-- headers/fmi3LsBusFlexRay.h | 4 ++-- headers/fmi3LsBusUtil.h | 4 ++-- headers/fmi3LsBusUtilCan.h | 28 ++++++++++++++-------------- headers/fmi3LsBusUtilFlexRay.h | 18 +++++++++--------- 8 files changed, 44 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 93ed1a27..9787d99e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Build Specification](https://github.com/modelica/fmi-ls-bus/actions/workflows/build-ls-bus.yml/badge.svg)](https://github.com/modelica/fmi-ls-bus/actions/workflows/build-ls-bus.yml) This repository contains a current prototype draft of the FMI Layered -Standard for Network Communication (fmi-ls-bus) based on the +Standard for Network Communication (FMI-LS-BUS) based on the [Functional Mock-up Interface][FMI] 3.0 standard for the exchange of simulation models. Note that this draft is being worked on actively, and thus are subject to change without notice. @@ -25,7 +25,7 @@ Corresponding [milestones][milestones] and a detailed roadmap have been defined for this purpose. The following graphic provides an overview of the planned sequence of supported bus systems: -![roadmap of fmi-ls-bus](roadmap_overview.svg) +![roadmap of FMI-LS-BUS](roadmap_overview.svg) A detailed roadmap showing completed, current and future work can be accessed [here][roadmap]. @@ -45,15 +45,15 @@ The following resources are currently available: ## Demos -[Demo FMUs] are available within the [FMI LS Bus Implementers' Guide] to illustrate how to use and implement the fmi-ls bus. +[Demo FMUs] are available within the [FMI-LS-BUS Implementers' Guide] to illustrate how to use and implement the FMI-LS-BUS. More demos will be added iteratively in the near future. -See also the overview pages for the demos, categorized by the different supported bus types of the fmi-ls-bus. +See also the overview pages for the demos, categorized by the different supported bus types of the FMI-LS-BUS. - [CAN, CAN FD and CAN XL Demo Overview] -## FMI LS Bus Implementers' Guide +## FMI-LS-BUS Implementers' Guide -The [FMI LS Bus Implementers' Guide] is a free resource intended to give non-normative recommendations and guidance to implementers of the Functional Mock-up Interface Layered Standard for Network Communication (FMI-LS-BUS). +The [FMI-LS-BUS Implementers' Guide] is a free resource intended to give non-normative recommendations and guidance to implementers of the Functional Mock-up Interface Layered Standard for Network Communication (FMI-LS-BUS). ## Copyright and License @@ -63,11 +63,11 @@ Docs released under [Attribution-ShareAlike 4.0 International]. ## Other FMI Layered Standards -If you are interested in the FMI Layered Standard for Network Communication, the [fmi-ls-xcp] could also be relevant to you. -The [fmi-ls-xcp] specifies an FMI extension for using the XCP protocol and A2L variable description within FMUs. +If you are interested in the FMI Layered Standard for Network Communication, the [FMI-LS-XCP] could also be relevant to you. +The [FMI-LS-XCP] specifies an FMI extension for using the XCP protocol and A2L variable description within FMUs. [FMI]: https://fmi-standard.org/ -[fmi-ls-xcp]: https://github.com/modelica/fmi-ls-xcp +[FMI-LS-XCP]: https://github.com/modelica/fmi-ls-xcp [Demo FMUs]: https://github.com/modelica/fmi-guides/tree/main/ls-bus-guide/demos [2-Clause BSD License]: https://opensource.org/licenses/BSD-2-Clause [Attribution-ShareAlike 4.0 International]: https://creativecommons.org/licenses/by-sa/4.0/ @@ -76,6 +76,6 @@ The [fmi-ls-xcp] specifies an FMI extension for using the XCP protocol and A2L v [spec]: https://modelica.github.io/fmi-ls-bus/main/ [milestones]: https://github.com/modelica/fmi-ls-bus/milestones?direction=asc&sort=title&state=open [releases]: https://github.com/modelica/fmi-ls-bus/releases -[FMI LS Bus Implementers' Guide]: https://modelica.github.io/fmi-guides/main/ls-bus-guide/ +[FMI-LS-BUS Implementers' Guide]: https://modelica.github.io/fmi-guides/main/ls-bus-guide/ [Getting started with CAN, CAN FD and CAN XL]: https://modelica.github.io/fmi-guides/main/ls-bus-guide/#low-cut-can-getting-started-with-can [CAN, CAN FD and CAN XL Demo Overview]: https://modelica.github.io/fmi-guides/main/ls-bus-guide/#low-cut-can-demos diff --git a/Release Checklist.md b/Release Checklist.md index 729521e3..40e9fc16 100644 --- a/Release Checklist.md +++ b/Release Checklist.md @@ -25,4 +25,4 @@ The removal takes place on the created side branch. * [ ] **Copyright Date:** Checking and adjusting the copyright date of the FMI-LS-BUS document and corresponding header files (see https://github.com/modelica/fmi-ls-bus/tree/main/headers); if necessary. * [ ] **Roadmap:** If the release to be created relates to a milestone within the roadmap, the roadmap (`roadmap.drawio`) must be updated accordingly. After this the `roadmap.svg` file must then also be regenerated. -* [ ] **FMI LS BUS Implementer's Guide:** Update demo FMUs (modelDescription.xml, fmi-ls-manifest.xml, PackFMU.py) of FMI LS BUS Implementer's Guide (see https://github.com/modelica/fmi-guides/tree/main/ls-bus-guide/demos) if necessary. \ No newline at end of file +* [ ] **FMI-LS-BUS Implementer's Guide:** Update demo FMUs (modelDescription.xml, fmi-ls-manifest.xml, PackFMU.py) of FMI LS BUS Implementer's Guide (see https://github.com/modelica/fmi-guides/tree/main/ls-bus-guide/demos) if necessary. \ No newline at end of file diff --git a/headers/fmi3LsBus.h b/headers/fmi3LsBus.h index 81cabd7a..b221c3f2 100644 --- a/headers/fmi3LsBus.h +++ b/headers/fmi3LsBus.h @@ -3,9 +3,9 @@ /* This header file declares bus independent constants and data types as defined by the -fmi-ls-bus layered standard specification (https://github.com/modelica/fmi-ls-bus). +FMI-LS-BUS layered standard specification (https://github.com/modelica/fmi-ls-bus). -It should be used when creating Network FMUs according to the fmi-ls-bus layered standard. +It should be used when creating Network FMUs according to the FMI-LS-BUS layered standard. Copyright (C) 2024 Modelica Association Project "FMI" All rights reserved. @@ -84,12 +84,12 @@ extern "C" typedef fmi3UInt8 fmi3LsBusBoolean; /** - * \brief Defines the value 'TRUE' of the fmi-ls-bus. + * \brief Defines the value 'TRUE' of the FMI-LS-BUS. */ #define FMI3_LS_BUS_TRUE ((fmi3UInt8)0x01) /** - * \brief Defines the value 'FALSE' of the fmi-ls-bus. + * \brief Defines the value 'FALSE' of the FMI-LS-BUS. */ #define FMI3_LS_BUS_FALSE ((fmi3UInt8)0x00) diff --git a/headers/fmi3LsBusCan.h b/headers/fmi3LsBusCan.h index f741c919..c6a98315 100644 --- a/headers/fmi3LsBusCan.h +++ b/headers/fmi3LsBusCan.h @@ -3,9 +3,9 @@ /* This header file declares CAN bus specific constants and data types as defined by the -fmi-ls-bus layered standard specification (https://github.com/modelica/fmi-ls-bus). +FMI-LS-BUS layered standard specification (https://github.com/modelica/fmi-ls-bus). -It should be used when creating CAN Network FMUs according to the fmi-ls-bus layered standard. +It should be used when creating CAN Network FMUs according to the FMI-LS-BUS layered standard. Copyright (C) 2024 Modelica Association Project "FMI" All rights reserved. diff --git a/headers/fmi3LsBusFlexRay.h b/headers/fmi3LsBusFlexRay.h index b384dac5..6ebd483c 100644 --- a/headers/fmi3LsBusFlexRay.h +++ b/headers/fmi3LsBusFlexRay.h @@ -3,9 +3,9 @@ /* This header file declares FlexRay bus specific constants and data types as defined by the -fmi-ls-bus layered standard specification (https://github.com/modelica/fmi-ls-bus). +FMI-LS-BUS layered standard specification (https://github.com/modelica/fmi-ls-bus). -It should be used when creating FlexRay Network FMUs according to the fmi-ls-bus layered standard. +It should be used when creating FlexRay Network FMUs according to the FMI-LS-BUS layered standard. Copyright (C) 2024 Modelica Association Project "FMI" All rights reserved. diff --git a/headers/fmi3LsBusUtil.h b/headers/fmi3LsBusUtil.h index 9e024844..5b538178 100644 --- a/headers/fmi3LsBusUtil.h +++ b/headers/fmi3LsBusUtil.h @@ -3,7 +3,7 @@ /* -This header file contains utility macros to read and write fmi-ls-bus +This header file contains utility macros to read and write FMI-LS-BUS bus operations from\to dedicated buffer variables. This header can be used when creating Network FMUs. @@ -72,7 +72,7 @@ typedef struct * \brief Creates a Format Error operation. * * This macro can be used to create a Format Error operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * diff --git a/headers/fmi3LsBusUtilCan.h b/headers/fmi3LsBusUtilCan.h index dd21b840..3deb4bee 100644 --- a/headers/fmi3LsBusUtilCan.h +++ b/headers/fmi3LsBusUtilCan.h @@ -2,10 +2,10 @@ #define fmi3LsBusUtilCan_h /* -This header file contains utility macros to read and write fmi-ls-bus +This header file contains utility macros to read and write FMI-LS-BUS CAN specific bus operations from\to dedicated buffer variables. -This header file can be used when creating Network fmi-ls-bus FMUs with CAN busses. +This header file can be used when creating Network FMI-LS-BUS FMUs with CAN busses. Copyright (C) 2024 Modelica Association Project "FMI" All rights reserved. @@ -50,7 +50,7 @@ extern "C" * \brief Creates a CAN transmit operation. * * This macro can be used to create a CAN transmit operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * @@ -96,7 +96,7 @@ extern "C" * \brief Creates a CAN FD transmit operation. * * This macro can be used to create a CAN FD transmit operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * @@ -141,7 +141,7 @@ extern "C" * \brief Creates a CAN XL transmit operation. * * This macro can be used to create a CAN XL transmit operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * @@ -190,7 +190,7 @@ extern "C" * \brief Creates a CAN confirm operation. * * This macro can be used to create a CAN confirm operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * @@ -223,7 +223,7 @@ extern "C" * \brief Creates a CAN configuration operation for the baud rate setting. * * This macro can be used to create a CAN configuration operation for the baud rate setting. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * @@ -258,7 +258,7 @@ extern "C" * \brief Creates a CAN configuration operation for the CAN FD baud rate setting. * * This macro can be used to create a CAN configuration operation for the CAN FD baud rate setting. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * @@ -292,7 +292,7 @@ extern "C" * \brief Creates a CAN configuration operation for the CAN XL baud rate setting. * * This macro can be used to create a CAN configuration operation for the CAN XL baud rate setting. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * @@ -326,7 +326,7 @@ extern "C" * \brief Creates a CAN configuration operation for the arbitration lost behavior setting. * * This macro can be used to create a CAN configuration operation for the arbitration lost behavior setting. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * @@ -360,7 +360,7 @@ extern "C" * \brief Creates a CAN arbitration lost operation. * * This macro can be used to create a CAN arbitration lost operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * @@ -392,7 +392,7 @@ extern "C" * \brief Creates a CAN bus error operation. * * This macro can be used to create a CAN bus error operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * @@ -432,7 +432,7 @@ extern "C" * \brief Creates a CAN status operation. * * This macro can be used to create a CAN status operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * @@ -464,7 +464,7 @@ extern "C" * \brief Creates a CAN wakeup operation. * * This macro can be used to create a CAN wakeup operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer * described by the argument 'BufferInfo'. If there is not enough buffer space available, the 'status' * variable of the argument 'BufferInfo' is set to fmi3False. * diff --git a/headers/fmi3LsBusUtilFlexRay.h b/headers/fmi3LsBusUtilFlexRay.h index fee545ba..21f4261f 100644 --- a/headers/fmi3LsBusUtilFlexRay.h +++ b/headers/fmi3LsBusUtilFlexRay.h @@ -2,10 +2,10 @@ #define fmi3LsBusUtilFlexRay_h /* -This header file contains utility macros to read and write fmi-ls-bus +This header file contains utility macros to read and write FMI-LS-BUS FlexRay specific bus operations from / to dedicated buffer variables. -This header file can be used when creating fmi-ls-bus network FMUs with FlexRay busses. +This header file can be used when creating FMI-LS-BUS network FMUs with FlexRay busses. Copyright (C) 2024 Modelica Association Project "FMI" All rights reserved. @@ -46,7 +46,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * \brief Creates a FlexRay 'Transmit' operation. * * This macro can be used to create a FlexRay 'Transmit' operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer described by the argument `BufferInfo`. + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer described by the argument `BufferInfo`. * If the operation was submitted successfully, `BufferInfo->status` is set to `fmi3True`. * If there is not enough buffer space available, `BufferInfo->status` is set to `fmi3False`. * @@ -88,7 +88,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * \brief Creates a FlexRay 'Cancel' operation. * * This macro can be used to create a FlexRay 'Cancel' operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer described by the argument `BufferInfo`. + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer described by the argument `BufferInfo`. * If the operation was submitted successfully, `BufferInfo->status` is set to `fmi3True`. * If there is not enough buffer space available, `BufferInfo->status` is set to `fmi3False`. * @@ -116,7 +116,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * \brief Creates a FlexRay 'Confirm' operation. * * This macro can be used to create a FlexRay 'Confirm' operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer described by the argument `BufferInfo`. + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer described by the argument `BufferInfo`. * If the operation was submitted successfully, `BufferInfo->status` is set to `fmi3True`. * If there is not enough buffer space available, `BufferInfo->status` is set to `fmi3False`. * @@ -144,7 +144,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * \brief Creates a FlexRay 'Bus Error' operation. * * This macro can be used to create a FlexRay 'Bus Error' operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer described by the argument `BufferInfo`. + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer described by the argument `BufferInfo`. * If the operation was submitted successfully, `BufferInfo->status` is set to `fmi3True`. * If there is not enough buffer space available, `BufferInfo->status` is set to `fmi3False`. * @@ -174,7 +174,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * \brief Creates a FlexRay 'Configuration' operation for the parameter 'FLEXRAY_CONFIG'. * * This macro can be used to create a FlexRay 'Configuration' operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer described by the argument `BufferInfo`. + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer described by the argument `BufferInfo`. * If the operation was submitted successfully, `BufferInfo->status` is set to `fmi3True`. * If there is not enough buffer space available, `BufferInfo->status` is set to `fmi3False`. * @@ -234,7 +234,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * \brief Creates a FlexRay 'Start Communication' operation. * * This macro can be used to create a FlexRay 'Start Communication' operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer described by the argument `BufferInfo`. + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer described by the argument `BufferInfo`. * If the operation was submitted successfully, `BufferInfo->status` is set to `fmi3True`. * If there is not enough buffer space available, `BufferInfo->status` is set to `fmi3False`. * @@ -258,7 +258,7 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * \brief Creates a FlexRay 'Symbol' operation. * * This macro can be used to create a FlexRay 'Symbol' operation. - * The arguments are serialized according to the fmi-ls-bus specification and written to the buffer described by the argument `BufferInfo`. + * The arguments are serialized according to the FMI-LS-BUS specification and written to the buffer described by the argument `BufferInfo`. * If the operation was submitted successfully, `BufferInfo->status` is set to `fmi3True`. * If there is not enough buffer space available, `BufferInfo->status` is set to `fmi3False`. *