Skip to content
This repository was archived by the owner on Apr 5, 2024. It is now read-only.

Commit 29002ee

Browse files
foxBMSfoxBMS
committed
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. ------------------------------------------------------------------------------
1 parent afeac72 commit 29002ee

File tree

20 files changed

+118
-65
lines changed

20 files changed

+118
-65
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ We therefore release foxBMS with permissive licenses:
1414
- Software: **BSD 3-Clause License**
1515

1616
For details see the [LICENSE](../LICENSE) file and the
17-
[license documentation](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/docs/latest/general_information/licenses/licenses.html).
17+
[license documentation](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest/general_information/licenses/licenses.html).
1818

1919
However foxBMS is not openly developed on GitHub (or any other platform). The
2020
main development on this project is done by members of the Fraunhofer IISB and

‎CHANGELOG.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,44 @@
22
Changelog
33
=========
44

5+
**Release 1.6.7**
6+
7+
Software:
8+
9+
* Toolchain:
10+
11+
* none
12+
13+
* Bugfixes:
14+
15+
* none
16+
17+
* Enhancements:
18+
19+
* none
20+
21+
Hardware:
22+
23+
* none
24+
25+
Documentation:
26+
27+
* Added permanent links to documentation of |foxbms| 1. The base URL for
28+
|foxbms| 1 related downloads and documentation is
29+
https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/.
30+
The latest version of the |foxbms| 1 documentation is now found at
31+
https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest. Previous
32+
versions of the project documnetation can be found at
33+
https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html. The doxygen
34+
documentation of the latest version is found at
35+
https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/doxygen/primary/html/
36+
for the primary MCU and at
37+
https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/doxygen/secondary/html/
38+
for the secondary MCU. Previous versions of the doxygen documentation can be
39+
found at https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/doxygen.
40+
41+
------------------------------------------------------------------------------
42+
543
**Release 1.6.6**
644

745
Software:

‎README.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
# foxBMS
22

3+
> **_NOTE:_**
4+
> - This is the repository of the **first generation** of foxBMS
5+
> (https://github.com/foxBMS/foxbms-1)
6+
> - The **second generation** of foxBMS (foxBMS 2) is also found on Github
7+
> (https://github.com/foxBMS/foxbms-2)
8+
39
foxBMS is a free, open and flexible development environment to design battery
410
management systems. It is the first modular open source BMS development
511
platform.
612

713
The foxconda environment: This environment provides all the tools necessary
814
to generate the documentation, compile the code for the MCUs and flash the
915
generated binaries on the MCUs (e.g., ``Python``, ``git``, ``GCC``). foxconda
10-
can be downloaded [here](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/).
16+
can be downloaded [here](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/).
1117

1218
The starting point to get foxBMS is the foxBMS repository at
13-
[https://github.com/foxBMS/foxbms](https://github.com/foxBMS/foxbms), which
19+
[https://github.com/foxBMS/foxbms-1](https://github.com/foxBMS/foxbms-1), which
1420
contains all files for the foxBMS project.
1521

1622
## foxBMS Repository
@@ -26,9 +32,9 @@ contains all files for the foxBMS project.
2632
`foxbms\tools`.
2733

2834
A generated version of the Sphinx documentation can be found at
29-
[docs.foxbms.org](https://docs.foxbms.org). It explains the structure of the
30-
foxBMS hardware, how to install the foxconda environment and how to use
31-
foxconda to compile and flash the sources.
35+
[iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest).
36+
It explains the structure of the foxBMS hardware, how to install the foxconda
37+
environment and how to use foxconda to compile and flash the sources.
3238

3339
## Building the Sources
3440

‎documentation/doxygen/doxygen-primary.conf‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = ""
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = 1.6.6
41+
PROJECT_NUMBER = 1.6.7
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

‎documentation/doxygen/doxygen-primary_bare.conf‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = ""
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = 1.6.6
41+
PROJECT_NUMBER = 1.6.7
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

‎documentation/doxygen/doxygen-secondary.conf‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = ""
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = 1.6.6
41+
PROJECT_NUMBER = 1.6.7
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

‎documentation/doxygen/doxygen-secondary_bare.conf‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = ""
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = 1.6.6
41+
PROJECT_NUMBER = 1.6.7
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

‎documentation/sphinx/general_information/licenses/licenses.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ This is a summary of the third party tools used by foxBMS and their licenses.
9696
9797
.. [4] ``matplotlib`` is not distributed with the |foxconda3| installer.
9898
However the
99-
`GUI <https://github.com/foxBMS/foxbms/tree/master/tools/gui>`_
99+
`GUI <https://github.com/foxBMS/foxbms-1/tree/master/tools/gui>`_
100100
requires ``matplotlib``. As the package needs to be installed
101101
manually by the user, no version information can be given here.
102102
@@ -108,7 +108,7 @@ This is a summary of the third party tools used by foxBMS and their licenses.
108108
installed by the user. Therefore the |foxbms| team does cannot provide
109109
version information.
110110
111-
.. [7] see `HAL source files <https://github.com/foxBMS/foxbms/tree/master/embedded-software/mcu-hal/CMSIS>`_
111+
.. [7] see `HAL source files <https://github.com/foxBMS/foxbms-1/tree/master/embedded-software/mcu-hal/CMSIS>`_
112112
113-
.. [8] see `waf <https://github.com/foxBMS/foxbms/blob/master/tools/waf>`_ and
114-
`waftools <https://github.com/foxBMS/foxbms/tree/master/tools/waftools>`_
113+
.. [8] see `waf <https://github.com/foxBMS/foxbms-1/blob/master/tools/waf>`_ and
114+
`waftools <https://github.com/foxBMS/foxbms-1/tree/master/tools/waftools>`_

‎documentation/sphinx/general_information/licenses/third-party-licenses.csv‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ mccabe; 0.6.1; MIT;
4040
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>`__
4141
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>`__
4242
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>`__
43-
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
43+
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
4444
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>`__
4545
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>`__
4646
pkginfo; 01.04.2002; MIT; `License <https://pypi.org/project/pkginfo/>`__; `Website <https://launchpad.net/pkginfo>`__; `Dev <https://code.launchpad.net/~tseaver/pkginfo/trunk>`__

‎documentation/sphinx/general_information/releases/releases.rst‎

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The latest **hardware release** versions are:
2424
.. note::
2525

2626
foxBMS uses now python3. The foxconda3 installer is found at
27-
https://iisb-foxbms.iisb.fraunhofer.de/foxbms/. foxconda3 must be installed
27+
https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/. foxconda3 must be installed
2828
to C:\\foxconda3!
2929

3030
.. note::
@@ -39,35 +39,37 @@ released. The first line is the most recent one, the last one the oldest one.
3939

4040
**Versions 1.5.0 and higher:**
4141

42-
+--------+----------+--------------+
43-
| foxbms | foxconda | Release date |
44-
+========+==========+==============+
45-
| v1.6.6 | 3.0.3 | 2021-02-05 |
46-
+--------+----------+--------------+
47-
| v1.6.5 | 3.0.3 | 2021-01-15 |
48-
+--------+----------+--------------+
49-
| v1.6.4 | 3.0.3 | 2020-03-04 |
50-
+--------+----------+--------------+
51-
| v1.6.3 | 3.0.3 | 2019-09-03 |
52-
+--------+----------+--------------+
53-
| v1.6.2 | 3.0.3 | 2019-07-05 |
54-
+--------+----------+--------------+
55-
| v1.6.1 | 3.0.3 | 2019-06-19 |
56-
+--------+----------+--------------+
57-
| v1.6.0 | 3.0.3 | 2019-06-19 |
58-
+--------+----------+--------------+
59-
| v1.5.5 | 3.0.3 | 2019-01-25 |
60-
+--------+----------+--------------+
61-
| v1.5.4 | 3.0.3 | 2018-12-14 |
62-
+--------+----------+--------------+
63-
| v1.5.3 | 3.0.3 | 2018-12-07 |
64-
+--------+----------+--------------+
65-
| v1.5.2 | 3.0.3 | 2018-10-26 |
66-
+--------+----------+--------------+
67-
| v1.5.1 | 3.0.3 | 2018-10-09 |
68-
+--------+----------+--------------+
69-
| v1.5.0 | 3.0.3 | 2018-09-25 |
70-
+--------+----------+--------------+
42+
+--------+----------+--------------+------------------------------------------------------------------------+
43+
| foxbms | foxconda | Release date | Documentation Permament Link |
44+
+========+==========+==============+========================================================================+
45+
| v1.6.7 | 3.0.3 | 2021-04-01 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.7/ |
46+
+--------+----------+--------------+------------------------------------------------------------------------+
47+
| v1.6.6 | 3.0.3 | 2021-02-05 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.6/ |
48+
+--------+----------+--------------+------------------------------------------------------------------------+
49+
| v1.6.5 | 3.0.3 | 2021-01-15 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.5/ |
50+
+--------+----------+--------------+------------------------------------------------------------------------+
51+
| v1.6.4 | 3.0.3 | 2020-03-04 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.4/ |
52+
+--------+----------+--------------+------------------------------------------------------------------------+
53+
| v1.6.3 | 3.0.3 | 2019-09-03 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.3/ |
54+
+--------+----------+--------------+------------------------------------------------------------------------+
55+
| v1.6.2 | 3.0.3 | 2019-07-05 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.2/ |
56+
+--------+----------+--------------+------------------------------------------------------------------------+
57+
| v1.6.1 | 3.0.3 | 2019-06-19 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.1/ |
58+
+--------+----------+--------------+------------------------------------------------------------------------+
59+
| v1.6.0 | 3.0.3 | 2019-06-19 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.6.0/ |
60+
+--------+----------+--------------+------------------------------------------------------------------------+
61+
| v1.5.5 | 3.0.3 | 2019-01-25 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.5.5/ |
62+
+--------+----------+--------------+------------------------------------------------------------------------+
63+
| v1.5.4 | 3.0.3 | 2018-12-14 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.5.4/ |
64+
+--------+----------+--------------+------------------------------------------------------------------------+
65+
| v1.5.3 | 3.0.3 | 2018-12-07 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.5.3/ |
66+
+--------+----------+--------------+------------------------------------------------------------------------+
67+
| v1.5.2 | 3.0.3 | 2018-10-26 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.5.2/ |
68+
+--------+----------+--------------+------------------------------------------------------------------------+
69+
| v1.5.1 | 3.0.3 | 2018-10-09 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.5.1/ |
70+
+--------+----------+--------------+------------------------------------------------------------------------+
71+
| v1.5.0 | 3.0.3 | 2018-09-25 | https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/v1.5.0/ |
72+
+--------+----------+--------------+------------------------------------------------------------------------+
7173

7274
**Versions before 1.5.0:**
7375

0 commit comments

Comments
 (0)