From 29002ee5cf465d323b93376bfa6e137b79a4fb6a Mon Sep 17 00:00:00 2001 From: The foxBMS ReleaseBot Date: Thu, 1 Apr 2021 21:22:49 +0200 Subject: [PATCH] Software: * Toolchain: * none * Bugfixes: * none * Enhancements: * none Hardware: * none Documentation: * Added permanent links to documentation of |foxbms| 1. The base URL for |foxbms| 1 related downloads and documentation is https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/. The latest version of the |foxbms| 1 documentation is now found at https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest. Previous versions of the project documnetation can be found at https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html. The doxygen documentation of the latest version is found at https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/doxygen/primary/html/ for the primary MCU and at https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/doxygen/secondary/html/ for the secondary MCU. Previous versions of the doxygen documentation can be found at https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/doxygen. ------------------------------------------------------------------------------ --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CHANGELOG.rst | 38 ++++++++++++ README.md | 16 +++-- documentation/doxygen/doxygen-primary.conf | 2 +- .../doxygen/doxygen-primary_bare.conf | 2 +- documentation/doxygen/doxygen-secondary.conf | 2 +- .../doxygen/doxygen-secondary_bare.conf | 2 +- .../general_information/licenses/licenses.rst | 8 +-- .../licenses/third-party-licenses.csv | 2 +- .../general_information/releases/releases.rst | 62 ++++++++++--------- .../sphinx/getting_started/build/build.rst | 2 +- .../eclipse_workspace/eclipse_workspace.rst | 2 +- .../getting_started/foxconda/foxconda.rst | 8 +-- .../design_resources/design_resources.rst | 2 +- documentation/sphinx/index.rst | 13 +++- documentation/sphinx/macros.rst | 2 +- .../defines/defines.rst | 4 +- embedded-software/mcu-primary/src/doxygen.h | 6 +- embedded-software/mcu-secondary/src/doxygen.h | 6 +- tools/dbc/foxbms.dbc | 2 +- 20 files changed, 118 insertions(+), 65 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e044c1f..1ee0650 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,7 +14,7 @@ We therefore release foxBMS with permissive licenses: - Software: **BSD 3-Clause License** For details see the [LICENSE](../LICENSE) file and the -[license documentation](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/docs/latest/general_information/licenses/licenses.html). +[license documentation](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest/general_information/licenses/licenses.html). However foxBMS is not openly developed on GitHub (or any other platform). The main development on this project is done by members of the Fraunhofer IISB and diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 69179a6..4dcec09 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,44 @@ Changelog ========= +**Release 1.6.7** + +Software: + +* Toolchain: + + * none + +* Bugfixes: + + * none + +* Enhancements: + + * none + +Hardware: + +* none + +Documentation: + +* Added permanent links to documentation of |foxbms| 1. The base URL for + |foxbms| 1 related downloads and documentation is + https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/. + The latest version of the |foxbms| 1 documentation is now found at + https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest. Previous + versions of the project documnetation can be found at + https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html. The doxygen + documentation of the latest version is found at + https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/doxygen/primary/html/ + for the primary MCU and at + https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/doxygen/secondary/html/ + for the secondary MCU. Previous versions of the doxygen documentation can be + found at https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/doxygen. + +------------------------------------------------------------------------------ + **Release 1.6.6** Software: diff --git a/README.md b/README.md index 0e15700..909b633 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # foxBMS +> **_NOTE:_** +> - This is the repository of the **first generation** of foxBMS +> (https://github.com/foxBMS/foxbms-1) +> - The **second generation** of foxBMS (foxBMS 2) is also found on Github +> (https://github.com/foxBMS/foxbms-2) + foxBMS is a free, open and flexible development environment to design battery management systems. It is the first modular open source BMS development platform. @@ -7,10 +13,10 @@ platform. The foxconda environment: This environment provides all the tools necessary to generate the documentation, compile the code for the MCUs and flash the generated binaries on the MCUs (e.g., ``Python``, ``git``, ``GCC``). foxconda -can be downloaded [here](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/). +can be downloaded [here](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/). The starting point to get foxBMS is the foxBMS repository at -[https://github.com/foxBMS/foxbms](https://github.com/foxBMS/foxbms), which +[https://github.com/foxBMS/foxbms-1](https://github.com/foxBMS/foxbms-1), which contains all files for the foxBMS project. ## foxBMS Repository @@ -26,9 +32,9 @@ contains all files for the foxBMS project. `foxbms\tools`. A generated version of the Sphinx documentation can be found at -[docs.foxbms.org](https://docs.foxbms.org). It explains the structure of the -foxBMS hardware, how to install the foxconda environment and how to use -foxconda to compile and flash the sources. +[iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest). +It explains the structure of the foxBMS hardware, how to install the foxconda +environment and how to use foxconda to compile and flash the sources. ## Building the Sources diff --git a/documentation/doxygen/doxygen-primary.conf b/documentation/doxygen/doxygen-primary.conf index 6064e4d..a0f3847 100644 --- a/documentation/doxygen/doxygen-primary.conf +++ b/documentation/doxygen/doxygen-primary.conf @@ -38,7 +38,7 @@ PROJECT_NAME = "" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.6.6 +PROJECT_NUMBER = 1.6.7 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/documentation/doxygen/doxygen-primary_bare.conf b/documentation/doxygen/doxygen-primary_bare.conf index 3918fb8..0dd2aaf 100644 --- a/documentation/doxygen/doxygen-primary_bare.conf +++ b/documentation/doxygen/doxygen-primary_bare.conf @@ -38,7 +38,7 @@ PROJECT_NAME = "" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.6.6 +PROJECT_NUMBER = 1.6.7 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/documentation/doxygen/doxygen-secondary.conf b/documentation/doxygen/doxygen-secondary.conf index 2e00540..76cbe02 100644 --- a/documentation/doxygen/doxygen-secondary.conf +++ b/documentation/doxygen/doxygen-secondary.conf @@ -38,7 +38,7 @@ PROJECT_NAME = "" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.6.6 +PROJECT_NUMBER = 1.6.7 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/documentation/doxygen/doxygen-secondary_bare.conf b/documentation/doxygen/doxygen-secondary_bare.conf index 358f332..a601792 100644 --- a/documentation/doxygen/doxygen-secondary_bare.conf +++ b/documentation/doxygen/doxygen-secondary_bare.conf @@ -38,7 +38,7 @@ PROJECT_NAME = "" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.6.6 +PROJECT_NUMBER = 1.6.7 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/documentation/sphinx/general_information/licenses/licenses.rst b/documentation/sphinx/general_information/licenses/licenses.rst index 41b645e..d1478d1 100644 --- a/documentation/sphinx/general_information/licenses/licenses.rst +++ b/documentation/sphinx/general_information/licenses/licenses.rst @@ -96,7 +96,7 @@ This is a summary of the third party tools used by foxBMS and their licenses. .. [4] ``matplotlib`` is not distributed with the |foxconda3| installer. However the - `GUI `_ + `GUI `_ requires ``matplotlib``. As the package needs to be installed manually by the user, no version information can be given here. @@ -108,7 +108,7 @@ This is a summary of the third party tools used by foxBMS and their licenses. installed by the user. Therefore the |foxbms| team does cannot provide version information. -.. [7] see `HAL source files `_ +.. [7] see `HAL source files `_ -.. [8] see `waf `_ and - `waftools `_ +.. [8] see `waf `_ and + `waftools `_ diff --git a/documentation/sphinx/general_information/licenses/third-party-licenses.csv b/documentation/sphinx/general_information/licenses/third-party-licenses.csv index 083e543..326c295 100644 --- a/documentation/sphinx/general_information/licenses/third-party-licenses.csv +++ b/documentation/sphinx/general_information/licenses/third-party-licenses.csv @@ -40,7 +40,7 @@ mccabe; 0.6.1; MIT; menuinst; 01.04.2014; BSD-3-Clause; `License `__; `Website `__; `Dev `__ openssl; 1.0.2p; OpenSSL License/SSLeay license; `License `__; `Website `__; `Dev `__ packaging; 17.1; Apache-2.0; `License `__; `Website `__; `Dev `__ -PCAN library; 4.3.2.161; custom license; `License `__; `Website `__; N/A +PCAN library; 4.3.2.161; custom license; `License `__; `Website `__; N/A pefile; 05.11.2017; MIT; `License `__; `Website `__; `Dev `__ pip; 10.0.1; MIT; `License `__; `Website `__; `Dev `__ pkginfo; 01.04.2002; MIT; `License `__; `Website `__; `Dev `__ diff --git a/documentation/sphinx/general_information/releases/releases.rst b/documentation/sphinx/general_information/releases/releases.rst index 39e533e..a107794 100644 --- a/documentation/sphinx/general_information/releases/releases.rst +++ b/documentation/sphinx/general_information/releases/releases.rst @@ -24,7 +24,7 @@ The latest **hardware release** versions are: .. note:: foxBMS uses now python3. The foxconda3 installer is found at - https://iisb-foxbms.iisb.fraunhofer.de/foxbms/. foxconda3 must be installed + https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/. foxconda3 must be installed to C:\\foxconda3! .. note:: @@ -39,35 +39,37 @@ released. The first line is the most recent one, the last one the oldest one. **Versions 1.5.0 and higher:** -+--------+----------+--------------+ -| foxbms | foxconda | Release date | -+========+==========+==============+ -| v1.6.6 | 3.0.3 | 2021-02-05 | -+--------+----------+--------------+ -| v1.6.5 | 3.0.3 | 2021-01-15 | -+--------+----------+--------------+ -| v1.6.4 | 3.0.3 | 2020-03-04 | -+--------+----------+--------------+ -| v1.6.3 | 3.0.3 | 2019-09-03 | -+--------+----------+--------------+ -| v1.6.2 | 3.0.3 | 2019-07-05 | -+--------+----------+--------------+ -| v1.6.1 | 3.0.3 | 2019-06-19 | -+--------+----------+--------------+ -| v1.6.0 | 3.0.3 | 2019-06-19 | -+--------+----------+--------------+ -| v1.5.5 | 3.0.3 | 2019-01-25 | -+--------+----------+--------------+ -| v1.5.4 | 3.0.3 | 2018-12-14 | -+--------+----------+--------------+ -| v1.5.3 | 3.0.3 | 2018-12-07 | -+--------+----------+--------------+ -| v1.5.2 | 3.0.3 | 2018-10-26 | -+--------+----------+--------------+ -| v1.5.1 | 3.0.3 | 2018-10-09 | -+--------+----------+--------------+ -| v1.5.0 | 3.0.3 | 2018-09-25 | -+--------+----------+--------------+ ++--------+----------+--------------+------------------------------------------------------------------------+ +| foxbms | foxconda | Release date | Documentation Permament Link | ++========+==========+==============+========================================================================+ +| v1.6.7 | 3.0.3 | 2021-04-01 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.7/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.6.6 | 3.0.3 | 2021-02-05 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.6/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.6.5 | 3.0.3 | 2021-01-15 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.5/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.6.4 | 3.0.3 | 2020-03-04 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.4/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.6.3 | 3.0.3 | 2019-09-03 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.3/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.6.2 | 3.0.3 | 2019-07-05 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.2/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.6.1 | 3.0.3 | 2019-06-19 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.1/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.6.0 | 3.0.3 | 2019-06-19 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.0/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.5.5 | 3.0.3 | 2019-01-25 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.5.5/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.5.4 | 3.0.3 | 2018-12-14 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.5.4/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.5.3 | 3.0.3 | 2018-12-07 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.5.3/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.5.2 | 3.0.3 | 2018-10-26 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.5.2/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.5.1 | 3.0.3 | 2018-10-09 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.5.1/ | ++--------+----------+--------------+------------------------------------------------------------------------+ +| v1.5.0 | 3.0.3 | 2018-09-25 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.5.0/ | ++--------+----------+--------------+------------------------------------------------------------------------+ **Versions before 1.5.0:** diff --git a/documentation/sphinx/getting_started/build/build.rst b/documentation/sphinx/getting_started/build/build.rst index bf1c51e..202ed73 100644 --- a/documentation/sphinx/getting_started/build/build.rst +++ b/documentation/sphinx/getting_started/build/build.rst @@ -23,7 +23,7 @@ Obtaining the Sources --------------------- Download or clone the |foxbms| repository from -`github.com/foxBMS/ `_. +`github.com/foxBMS/ `_. .. warning:: diff --git a/documentation/sphinx/getting_started/eclipse_workspace/eclipse_workspace.rst b/documentation/sphinx/getting_started/eclipse_workspace/eclipse_workspace.rst index 6013367..9067749 100644 --- a/documentation/sphinx/getting_started/eclipse_workspace/eclipse_workspace.rst +++ b/documentation/sphinx/getting_started/eclipse_workspace/eclipse_workspace.rst @@ -425,7 +425,7 @@ Testing the Project Setup If problems occur while using the Eclipse workspace, it is possible to use a VS Code setup. For details on |foxbms| and VS Code see - `here `_. + `here `_. **However, VS Code is not actively supported and should only be used in** **cases where the Eclipse setup does not work.** diff --git a/documentation/sphinx/getting_started/foxconda/foxconda.rst b/documentation/sphinx/getting_started/foxconda/foxconda.rst index e226217..d89ef50 100644 --- a/documentation/sphinx/getting_started/foxconda/foxconda.rst +++ b/documentation/sphinx/getting_started/foxconda/foxconda.rst @@ -28,10 +28,10 @@ Installation of the Needed Software via the |foxconda3| Distribution The first step is to install the software environment needed to compile and flash the |foxbms| sources. First, the |foxconda3| installer must be downloaded -from the `server `_ containing -the |foxconda3| installers. For Windows, the installer is run by executing -|installer archive|. The installer version with the highest version and build -number must always be used. +from the `server `_ +containing the |foxconda3| installers. For Windows, the installer is run by +executing |installer archive|. The installer version with the highest version +and build number must always be used. .. warning:: - Setting the installation directory from ``C:\foxconda3`` to diff --git a/documentation/sphinx/hardware_documentation/design_resources/design_resources.rst b/documentation/sphinx/hardware_documentation/design_resources/design_resources.rst index 434be52..70f6de3 100644 --- a/documentation/sphinx/hardware_documentation/design_resources/design_resources.rst +++ b/documentation/sphinx/hardware_documentation/design_resources/design_resources.rst @@ -6,7 +6,7 @@ Design Resources ================ -The hardware design packages for the |BMS-Master|, the |BMS-Extension|, the |BMS-Interface| and the |BMS-Slaves| are available in the common `GitHub repository `_. The packages include: +The hardware design packages for the |BMS-Master|, the |BMS-Extension|, the |BMS-Interface| and the |BMS-Slaves| are available in the common `GitHub repository `_. The packages include: * Altium Designer Source Files diff --git a/documentation/sphinx/index.rst b/documentation/sphinx/index.rst index b7ef18c..0c64825 100644 --- a/documentation/sphinx/index.rst +++ b/documentation/sphinx/index.rst @@ -6,6 +6,13 @@ The |foxbms| Documentation ========================== +.. attention:: + + - This is the documentation of the **first generation** of foxBMS + (https://github.com/foxBMS/foxbms-1) + - The **second generation** of foxBMS (foxBMS 2) is also found on Github + (https://github.com/foxBMS/foxbms-2) + Welcome to the `foxBMS `_ documentation of the first modular open source BMS development platform from the `Fraunhofer IISB `_. |foxBMS| is a free, open and flexible @@ -14,9 +21,9 @@ systems. .. note:: The present version of the |foxbms| Sphinx documentation is |version|. It - is available in HTML, PDF and EPUB formats through the bottom left menu on - `Read the Docs `_. More detailed information - on the version history can be found in the + is available in HTML + at https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest/. + More detailed information on the version history can be found in the :ref:`general_information_releases` section. This documentation was generated on |timestamp|. diff --git a/documentation/sphinx/macros.rst b/documentation/sphinx/macros.rst index 3b4a403..17c3f47 100644 --- a/documentation/sphinx/macros.rst +++ b/documentation/sphinx/macros.rst @@ -3,7 +3,7 @@ .. ----------------------------------------------- .. General Documentation Macros .. ----------------------------------------------- -.. |version| replace:: ``1.6.6`` +.. |version| replace:: ``1.6.7`` .. |version-hal| replace:: ``V1.7.4`` .. |version-cmsis| replace:: ``V2.6.2`` .. |version-freertos| replace:: ``V10.1.1`` diff --git a/documentation/sphinx/software_documentation/defines/defines.rst b/documentation/sphinx/software_documentation/defines/defines.rst index 9ef6ec9..ffb3180 100644 --- a/documentation/sphinx/software_documentation/defines/defines.rst +++ b/documentation/sphinx/software_documentation/defines/defines.rst @@ -161,9 +161,9 @@ A complete list of switches can be found here: and the local changes can not be found in that online version. - `Online documentation: Primary switches - `_ + `_ - `Online documentation: Secondary switches - `_ + `_ - If the project was compiled locally, this documentation can be accesed here: diff --git a/embedded-software/mcu-primary/src/doxygen.h b/embedded-software/mcu-primary/src/doxygen.h index 939eeb3..f9364c2 100644 --- a/embedded-software/mcu-primary/src/doxygen.h +++ b/embedded-software/mcu-primary/src/doxygen.h @@ -73,9 +73,9 @@ * *
Latest online available documentation Version available if the documentation was locally build *
@warning The links to documentaions in this column always points to the latest realsed version on GitHub and your local changes can not be found in that online version. @warning The links to documentaions in this column only exist after building the documentation locally. If this was not done, the link will not work. - *
Online foxBMS General Documentation Local foxBMS General Documentation - *
Online Primary MCU Source Code Documentation Local Primary MCU Source Code Documentation - *
Online Secondary MCU Source Code Documentation Local Secondary MCU Source Code Documentation + *
Online foxBMS General Documentation Local foxBMS General Documentation + *
Online Primary MCU Source Code Documentation Local Primary MCU Source Code Documentation + *
Online Secondary MCU Source Code Documentation Local Secondary MCU Source Code Documentation *
* *

User Configurable Options

diff --git a/embedded-software/mcu-secondary/src/doxygen.h b/embedded-software/mcu-secondary/src/doxygen.h index 0695b40..e567527 100644 --- a/embedded-software/mcu-secondary/src/doxygen.h +++ b/embedded-software/mcu-secondary/src/doxygen.h @@ -73,9 +73,9 @@ * *
Latest online available documentation Version available if the documentation was locally build *
@warning The links to documentaions in this column always points to the latest realsed version on GitHub and your local changes can not be found in that online version. @warning The links to documentaions in this column only exist after building the documentation locally. If this was not done, the link will not work. - *
Online foxBMS General Documentation Local foxBMS General Documentation - *
Online Primary MCU Source Code Documentation Local Primary MCU Source Code Documentation - *
Online Secondary MCU Source Code Documentation Local Secondary MCU Source Code Documentation + *
Online foxBMS General Documentation Local foxBMS General Documentation + *
Online Primary MCU Source Code Documentation Local Primary MCU Source Code Documentation + *
Online Secondary MCU Source Code Documentation Local Secondary MCU Source Code Documentation *
* *

User Configurable Options

diff --git a/tools/dbc/foxbms.dbc b/tools/dbc/foxbms.dbc index b039ed7..fa5d479 100644 --- a/tools/dbc/foxbms.dbc +++ b/tools/dbc/foxbms.dbc @@ -1,4 +1,4 @@ -VERSION "foxBMS-1.6.6" +VERSION "foxBMS-1.6.7" NS_ :