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. ------------------------------------------------------------------------------
foxBMS · Apr 1, 2021 · 29002ee · 29002ee
1 parent afeac72
commit 29002ee
Show file tree

Hide file tree

Showing 20 changed files with 118 additions and 65 deletions.
diff --git 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
@@ -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
@@ -1,16 +1,22 @@
 # 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.
 
 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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 <https://github.com/foxBMS/foxbms/tree/master/tools/gui>`_
+        `GUI <https://github.com/foxBMS/foxbms-1/tree/master/tools/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 <https://github.com/foxBMS/foxbms/tree/master/embedded-software/mcu-hal/CMSIS>`_
+.. [7]  see `HAL source files <https://github.com/foxBMS/foxbms-1/tree/master/embedded-software/mcu-hal/CMSIS>`_
 
-.. [8]  see `waf <https://github.com/foxBMS/foxbms/blob/master/tools/waf>`_ and
-        `waftools <https://github.com/foxBMS/foxbms/tree/master/tools/waftools>`_
+.. [8]  see `waf <https://github.com/foxBMS/foxbms-1/blob/master/tools/waf>`_ and
+        `waftools <https://github.com/foxBMS/foxbms-1/tree/master/tools/waftools>`_
diff --git 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 <https://github.com/ContinuumIO/menuinst/blob/1.4.14/LICENSE.txt>`__;                              `Website <https://github.com/ContinuumIO/menuinst>`__;                                                                  `Dev <https://github.com/ContinuumIO/menuinst>`__
 openssl;                    1.0.2p;                 OpenSSL License/SSLeay license; `License <https://www.openssl.org/source/license-openssl-ssleay.txt>`__;                                    `Website <https://www.openssl.org>`__;                                                                                  `Dev <https://github.com/openssl/openssl>`__
 packaging;                  17.1;                   Apache-2.0;                     `License <https://github.com/pypa/packaging/blob/17.1/LICENSE>`__;                                          `Website <https://packaging.python.org>`__;                                                                             `Dev <https://github.com/pypa/packaging>`__
-PCAN library;               4.3.2.161;              custom license;                 `License <https://github.com/foxBMS/foxbms/blob/master/tools/gui/readme.txt>`__;                            `Website <https://www.peak-system.com/PCAN-Basic.239.0.html>`__;                                                        N/A
+PCAN library;               4.3.2.161;              custom license;                 `License <https://github.com/foxBMS/foxbms-1/blob/master/tools/gui/readme.txt>`__;                            `Website <https://www.peak-system.com/PCAN-Basic.239.0.html>`__;                                                        N/A
 pefile;                     05.11.2017;             MIT;                            `License <https://github.com/erocarrera/pefile/blob/v2017.11.5/LICENSE>`__;                                 `Website <https://github.com/erocarrera/pefile>`__;                                                                     `Dev <https://github.com/erocarrera/pefile>`__
 pip;                        10.0.1;                 MIT;                            `License <https://github.com/pypa/pip/blob/10.0.1/LICENSE.txt>`__;                                          `Website <https://github.com/pypa/pip>`__;                                                                              `Dev <https://github.com/pypa/pip>`__
 pkginfo;                    01.04.2002;             MIT;                            `License <https://pypi.org/project/pkginfo/>`__;                                                            `Website <https://launchpad.net/pkginfo>`__;                                                                            `Dev <https://code.launchpad.net/~tseaver/pkginfo/trunk>`__

diff --git 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
@@ -23,7 +23,7 @@ Obtaining the Sources
 ---------------------
 
 Download or clone the |foxbms| repository from
-`github.com/foxBMS/ <https://github.com/foxBMS/foxbms>`_.
+`github.com/foxBMS/ <https://github.com/foxBMS/foxbms-1>`_.
 
 ..  warning::
 

diff --git 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 <https://github.com/foxBMS/foxbms/tree/v1.6.6/tools/vscode>`_.
+    `here <https://github.com/foxBMS/foxbms-1/tree/v1.6.7/tools/vscode>`_.
 
     **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
@@ -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 <https://iisb-foxbms.iisb.fraunhofer.de/foxbms/>`_ 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 <https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/>`_
+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
@@ -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 <https://github.com/foxBMS/foxbms>`_. 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 <https://github.com/foxBMS/foxbms-1>`_. The packages include:
 
 * Altium Designer Source Files
 

diff --git 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 <https://www.foxbms.org/>`_ documentation of the first
 modular open source BMS development platform from the `Fraunhofer IISB
 <http://www.iisb.fraunhofer.de/>`_. |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 <https://foxbms.readthedocs.io>`_. 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
@@ -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
@@ -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
-        <https://iisb-foxbms.iisb.fraunhofer.de/foxbms/documentation/primary/html/CONFIG_PAGE.html>`_
+        <https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/doxygen/primary/html/CONFIG_PAGE.html>`_
     -   `Online documentation: Secondary switches
-        <https://iisb-foxbms.iisb.fraunhofer.de/foxbms/documentation/secondary/html/CONFIG_PAGE.html>`_
+        <https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/doxygen/secondary/html/CONFIG_PAGE.html>`_
 
 -   If the project was compiled locally, this documentation can be accesed here: