Skip to content

Commit

Permalink
164 better clarification and description of development and released …
Browse files Browse the repository at this point in the history
…versions of the fmi ls bus on the fmi ls bus landing page (#168)

* Save work

* Reworking of fmi-ls-bus landing page and adding of roadmap stuff

* Remove arrow description within detailed roadmap

* Saving work

* Adjust roadmap depending on review comments

* Fixed roadmap

* Add "tests" folder to Repository Structure within landing page

* Adjust position of "Version 1.0.0" within roadmap

* Regenerate roadmap.svg

---------

Co-authored-by: Benedikt Menne <[email protected]>
  • Loading branch information
bmenne-dspace and Benedikt Menne committed Jun 4, 2024
1 parent 0c18fde commit 3865d57
Show file tree
Hide file tree
Showing 5 changed files with 530 additions and 4 deletions.
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,26 @@ officially endorsed by the Modelica Association or other involved
organisations prior to official adoption.

The [FMI 3.0 Layered Standard Network Communication][spec] is currently
maintained on [GitHub][githubspec] and is published [here][spec]. It is
based on the [FMI][] standard.
maintained on [GitHub][githubspec] and is based on the [FMI][] standard.
The current state of development is published [here][spec] and
contains all bus types that are currently in development or are already final.
[Official releases][releases] are directly published via GitHub.

## Roadmap
Different abstraction layers and types of buses are developed in different versions that build on each other.
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)

A detailed roadmap showing completed, current and future work can be accessed [here][roadmap].

## Repository Structure
- `docs` -- Sources of the specification document
- `headers` -- Header files of the C-API
- `schema` -- XSD schema for this FMI Layered
Standard
- `tests` -- Contains unit tests for the provided header files

## Getting Started
To help you get started, we provide introductory chapters.
Expand All @@ -36,19 +48,27 @@ See also the overview pages for the demos, categorized by the different supporte
* [CAN, CAN FD and CAN XL Demo Overview]

## 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 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 Network Communication (FMI-LS-BUS).

## Copyright and License
Code and documentation copyright (C) 2008-2011 the MODELISAR consortium and 2012-2024 the Modelica Association Project FMI.
Code released under the [2-Clause BSD License].
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.

[FMI]: https://fmi-standard.org/
[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/
[githubspec]: docs/index.adoc
[roadmap]: https://raw.githubusercontent.com/bmenne-dspace/fmi-ls-bus/main/roadmap.svg
[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/
[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
Loading

0 comments on commit 3865d57

Please sign in to comment.