Bugfix release of foxBMS 2 (v1.0.2)

* updated the documentation * minor toolchain improvements For a detailed list of changes, please refer to the documentation at https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen2/docs/html/v1.0.2/general/changelog.html
foxBMS · Apr 30, 2021 · 9fff1ab · 9fff1ab
1 parent adcaf20
commit 9fff1ab
Show file tree

Hide file tree

Showing 49 changed files with 909 additions and 201 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,7 +9,7 @@
 
 *c4che*
 /foxbms*/
-tools/waf3-*/
+tools/*waf3-*/
 tools/waf-sig*
 .lock-waf*
 *.bz2

diff --git a/conf/guidelines/rules.json b/conf/guidelines/rules.json
@@ -458,7 +458,8 @@
             "macros.txt": {
               "exclude": [
                 "docs/general/team-ad-sc.rst",
-                "docs/general/team-dev.rst"
+                "docs/general/team-dev.rst",
+                "docs/general/team-former.rst"
               ],
               "regex": ".. include:: .{1,2}(/(..|\\w+))*/macros.txt"
             }
@@ -468,7 +469,8 @@
               "exclude": [
                 "docs/general/team.rst",
                 "docs/general/team-ad-sc.rst",
-                "docs/general/team-dev.rst"
+                "docs/general/team-dev.rst",
+                "docs/general/team-former.rst"
               ],
               "regex": ".. include:: .{1,2}(/(..|\\w+))*/units.txt"
             }
@@ -479,7 +481,8 @@
         "name": "RST:005",
         "exclude": [
           "docs/general/team-ad-sc.rst",
-          "docs/general/team-dev.rst"
+          "docs/general/team-dev.rst",
+          "docs/general/team-former.rst"
         ]
       },
       "orphan": {

diff --git a/conf/spa/.pylintrc b/conf/spa/.pylintrc
@@ -16,7 +16,7 @@ ignore-patterns=
 
 # Python code to execute, usually for sys.path manipulation such as
 # pygtk.require().
-init-hook='import sys; sys.path.append("tools/waf3-2.0.22-1241519b19b496207abef1f72bbf61c2")'
+init-hook='import sys; sys.path.extend(["tools/waf3-2.0.22-1241519b19b496207abef1f72bbf61c2", "tools/gui"])'
 
 # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
 # number of processors available to use.
@@ -528,7 +528,7 @@ max-locals=100
 max-parents=7
 
 # Maximum number of public methods for a class (see R0904).
-max-public-methods=20
+max-public-methods=30
 
 # Maximum number of return / yield for function / method body.
 max-returns=6

diff --git a/docs/conf.py b/docs/conf.py
@@ -103,6 +103,7 @@
     "general/team.rst",
     "general/team-ad-sc.rst",
     "general/team-dev.rst",
+    "general/team-former.rst",
 ]
 # disable git contributor scanning in spelling module if no git repository
 try:

diff --git a/docs/developer-manual/hardware-developer-manual.rst b/docs/developer-manual/hardware-developer-manual.rst
@@ -39,15 +39,15 @@ Release process
 
 The release process has the following steps:
 
-    #.  Create the necessary footprints and components in a versioned DBLib.
-    #.  Derive a new project from a project template and put it under version
-        control.
-    #.  Define the schematic of the project and the design of the printed
-        circuit board.
-    #.  Review the project together with a team member.
-    #.  Create a release with the predefined set of output jobs.
-    #.  Store the release in a pre-defined location so that it can be found.
-    #.  Mark the released version in version control with a tag.
+#. Create the necessary footprints and components in a versioned DBLib.
+#. Derive a new project from a project template and put it under version
+   control.
+#. Define the schematic of the project and the design of the printed
+   circuit board.
+#. Review the project together with a team member.
+#. Create a release with the predefined set of output jobs.
+#. Store the release in a pre-defined location so that it can be found.
+#. Mark the released version in version control with a tag.
 
 
 Modification process
@@ -56,12 +56,12 @@ Modification process
 If modifications to the hardware are necessary, the following process has to
 be followed:
 
-    #.  Create an issue in the GitLab project of the hardware component.
-    #.  Describe the necessary changes as precise as possible.
-    #.  Describe the impact of the changes to the software.
-    #.  Describe the impact of the changes to the tests.
-    #.  Enter the hardware release process :numref:`RELEASE_PROCESS` with
-        these changes.
+#. Create an issue in the issue tracker of the hardware component project.
+#. Describe the necessary changes as precise as possible.
+#. Describe the impact of the changes to the software.
+#. Describe the impact of the changes to the tests.
+#. Enter the hardware release process :numref:`RELEASE_PROCESS` with
+   these changes.
 
 
 Checklist for releases

diff --git a/docs/developer-manual/style-guide/guidelines_c.rst b/docs/developer-manual/style-guide/guidelines_c.rst
@@ -441,7 +441,7 @@ Function calls (``C:013``)
 
     - Multiple arguments **SHOULD** be put on a single line to reduce the
       number of lines necessary for calling a function unless there is a
-      specific readability problem. Some styleguides require formatting
+      specific readability problem. Some style guides require formatting
       strictly one argument on each line for simplifying editing the arguments.
       However, we prioritize readability over the ease of editing arguments,
       and most readability problems are better addressed with the

diff --git a/docs/general/changelog.rst b/docs/general/changelog.rst
@@ -9,10 +9,12 @@ Changelog
 
 ..
     Comments:
+    Axivion is the company that builds the Axivion Bauhaus suite
     slaveplausibility is the old name of a plausibility module
     JUnit is a test system (originally for Java)
 
 .. spelling::
+    Axivion
     slaveplausibility
     JUnit
 
@@ -31,6 +33,46 @@ Versioning follows then these rules:
 - increasing ``MINOR`` adds functionality in a backwards compatible manner
 - increasing ``PATCH`` fixes bugs in a backwards compatible manner
 
+********************
+[1.0.2] - 2021-04-30
+********************
+
+Added
+=====
+
+- Added number of valid cell voltages and temperatures used for calculating
+  minimum, maximum and average values to database entry
+  ``DATA_BLOCK_ID_MIN_MAX``.
+- Added the build option ``--skip-doxygen`` to enable faster documentation
+  builds, if an API documentation is not required/does not need to be updated.
+
+Changed
+=======
+
+- Do no longer hard code the EOL for the files in the VS Code settings, instead
+  just use the system EOL instead.
+
+Deprecated
+==========
+
+Removed
+=======
+
+Fixed
+=====
+
+- Fixed typo in changelog. The LTC 6804-1 is basically an older version of the
+  LTC 6811-1 (previously it stated wrongly LTC 6812-1).
+- ``linkcheck`` and ``spelling`` were not run when the documentation was built.
+- The GUI searched for the wrong license file during startup routine and
+  therefore failed to start successfully.
+- Improved the readability of the engine block schematic in the general
+  software documentation.
+- Fixed an issue where the ``waf.sh``-wrapper would not print the error message
+  when the conda environment could not be found.
+- Removed unused variables in build scripts.
+- Fixed readmes in the tools directory and its subdirectories.
+
 ********************
 [1.0.1] - 2021-04-16
 ********************
@@ -42,7 +84,7 @@ Added
 - Added testing for different versions of TI ARM CGT (versions 10.0.0 and
   10.1.1).
 - Added a readme to the hardware directory.
-- Added support for LTC 6804-1 (basically an older version of the LTC 6812-1).
+- Added support for LTC 6804-1 (basically an older version of the LTC 6811-1).
 - Added the updated design files of the foxBMS 2 master v1.0.1.
 
 Changed
@@ -90,7 +132,6 @@ Fixed
   ``CC-BY-4.0``. For more information see :ref:`LICENSE`.
 - Fixed the names of variables in bash scripts on Windows.
 
-
 ********************
 [1.0.0] - 2021-04-01
 ********************

diff --git a/docs/general/releases.csv b/docs/general/releases.csv
@@ -1,4 +1,5 @@
 foxBMS 2;   Release Date;   Permanent link to documentation
+v1.0.2;     2021-04-30;     https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen2/docs/html/v1.0.2/
 v1.0.1;     2021-04-16;     https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen2/docs/html/v1.0.1/
 v1.0.0;     2021-04-01;     https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen2/docs/html/v1.0.0/
 v0.3.0;     2021-03-16;     \-

diff --git a/docs/general/team-ad-sc.rst b/docs/general/team-ad-sc.rst
@@ -1,4 +1,3 @@
 - Jürgen Lorenz
-- Lothar Frey
 - Martin März
 - Vincent Lorentz
diff --git a/docs/general/team-dev.rst b/docs/general/team-dev.rst
@@ -1,20 +1,11 @@
-- Christian Freund
-- Christian Thomas
-- Georg Kordowich
+- Andreas Ochs
 - Johannes Wachtler
-- Joshua Grosch
-- Lucas Grunenberg
-- Müsfik Akdere
 - Markus Gepp
 - Martin Wenger
-- Martin Giegerich
 - Patrick Kanzler
-- Pauline Thierauf
 - Radu Schwarz
 - Reinhold Waller
-- Robin Heim
 - Sebastian Wacker
 - Stéphane Koffel
 - Stefan Waldhör
-- Tim Fühner
 - Tobias Huf
diff --git a/docs/general/team-former.rst b/docs/general/team-former.rst
@@ -0,0 +1,12 @@
+- Lothar Frey
+
+- Christian Freund
+- Christian Thomas
+- Georg Kordowich
+- Joshua Grosch
+- Lucas Grunenberg
+- Müsfik Akdere
+- Martin Giegerich
+- Pauline Thierauf
+- Robin Heim
+- Tim Fühner
diff --git a/docs/general/team.rst b/docs/general/team.rst
@@ -27,6 +27,12 @@ Development Team Fraunhofer IISB
 
 .. include:: ./team-dev.rst
 
+***********************************
+Former Team Members Fraunhofer IISB
+***********************************
+
+.. include:: ./team-former.rst
+
 ************
 Contribution
 ************

diff --git a/docs/getting-started/software-installation.rst b/docs/getting-started/software-installation.rst
@@ -70,9 +70,9 @@ later steps of this manual.
    :caption: Downloading a release
    :name: download-foxbms-2
 
-   C:\Users\vulpes\Documents>curl -Ss -L -o foxbms-2-v1.0.1.zip https://github.com/foxBMS/foxbms-2/archive/v1.0.1.zip
-   C:\Users\vulpes\Documents>tar -x -f foxbms-2-v1.0.1.zip
-   C:\Users\vulpes\Documents>ren foxbms-2-v1.0.1 foxbms-2
+   C:\Users\vulpes\Documents>curl -Ss -L -o foxbms-2-v1.0.2.zip https://github.com/foxBMS/foxbms-2/archive/v1.0.2.zip
+   C:\Users\vulpes\Documents>tar -x -f foxbms-2-v1.0.2.zip
+   C:\Users\vulpes\Documents>ren foxbms-2-1.0.2 foxbms-2
    C:\Users\vulpes\Documents>cd foxbms-2
 
 .. note::

diff --git a/docs/macros.txt b/docs/macros.txt
@@ -3,7 +3,7 @@
 .. |timestamp| date:: %Y-%m-%d %H:%M:%S
 
 .. |foxbms| replace:: foxBMS 2
-.. |version_foxbms| replace:: ``1.0.1``
+.. |version_foxbms| replace:: ``1.0.2``
 .. |github_foxbms| replace:: https://github.com/foxBMS/
 .. |foxbms_repository| replace:: https://github.com/foxBMS/foxbms-2
 .. _Fraunhofer IISB: https://www.iisb.fraunhofer.de

diff --git a/docs/software/modules/driver/mic/ltc/6804-1.rst b/docs/software/modules/driver/mic/ltc/6804-1.rst
@@ -8,6 +8,6 @@ LTC 6804-1
 
 The *LTC 6804-1* is the third generation measurement IC by Analog Devices
 (formerly Linear Technology). A *LTC 6804-1* compatible driver is implemented
-in |foxbms| for the fourth generation *LTC 6812-1*.
+in |foxbms| for the fourth generation *LTC 6811-1*.
 
 See :ref:`LTC_6812_1`.
diff --git a/docs/software/overview/img/database_engine.vsdx b/docs/software/overview/img/database_engine.vsdx
diff --git a/docs/software/overview/img/engine.png b/docs/software/overview/img/engine.png
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -78,6 +78,8 @@ preprocess
 preprocessor
 programmatically
 pylint
+readme
+readmes
 redox
 reStructuredText
 roadmap
@@ -107,6 +109,7 @@ suppressions
 teardown
 throughs
 toolchain
+toolchains
 toolset
 TX
 txt

diff --git a/docs/tools/debugger/debugger-lauterbach.rst b/docs/tools/debugger/debugger-lauterbach.rst
@@ -6,6 +6,13 @@
 Lauterbach Trace32 debugger
 ===========================
 
+..
+    Comments:
+    Mictor is a connector
+
+.. spelling::
+    Mictor
+
 Some information can be found in ``tools/debugger/lauterbach/commands.md``.
 Please carefully read the
 `basic manual <https://www2.lauterbach.com/pdf/training_debugger.pdf>`_
@@ -37,6 +44,6 @@ TMS570LC4357 target. Please refer to their customer support for details.
 
 The setup of `Fraunhofer IISB`_ consists of a LA-3505 debugger connected to a
 LA-3500 trace probe. |foxbms| features a compliant Mictor-38 connector in order
-to be able to connect trace ports with up to 8 bit. If you need more bandwith,
+to be able to connect trace ports with up to 8 bit. If you need more bandwidth,
 please contact us. The standard design can be adapted to up to 32 bit trace
-bandwith.
+bandwidth.
diff --git a/src/app/application/redundancy/redundancy.c b/src/app/application/redundancy/redundancy.c
@@ -803,6 +803,7 @@ static STD_RETURN_TYPE_e MRC_CalculateCellVoltageMinMaxAverage(
         pMinMaxAverageValues->maximumCellVoltage_mV[s]      = max;
         pMinMaxAverageValues->nrCellMaximumCellVoltage[s]   = cellNumberMaximum;
         pMinMaxAverageValues->nrModuleMaximumCellVoltage[s] = moduleNumberMaximum;
+        pMinMaxAverageValues->validMeasuredCellVoltages[s]  = nrValidCellvoltages;
 
         /* Prevent division by 0, if all cell voltages are invalid */
         if (nrValidCellvoltages > 0u) {
@@ -859,12 +860,13 @@ static STD_RETURN_TYPE_e MRC_CalculateCellTemperatureMinMaxAverage(
                 }
             }
         }
-        pMinMaxAverageValues->minimumTemperature_ddegC[s]   = min;
-        pMinMaxAverageValues->nrSensorMinimumTemperature[s] = sensorNumberMinimum;
-        pMinMaxAverageValues->nrModuleMinimumTemperature[s] = moduleNumberMinimum;
-        pMinMaxAverageValues->maximumTemperature_ddegC[s]   = max;
-        pMinMaxAverageValues->nrSensorMaximumTemperature[s] = sensorNumberMaximum;
-        pMinMaxAverageValues->nrModuleMaximumTemperature[s] = moduleNumberMaximum;
+        pMinMaxAverageValues->minimumTemperature_ddegC[s]      = min;
+        pMinMaxAverageValues->nrSensorMinimumTemperature[s]    = sensorNumberMinimum;
+        pMinMaxAverageValues->nrModuleMinimumTemperature[s]    = moduleNumberMinimum;
+        pMinMaxAverageValues->maximumTemperature_ddegC[s]      = max;
+        pMinMaxAverageValues->nrSensorMaximumTemperature[s]    = sensorNumberMaximum;
+        pMinMaxAverageValues->nrModuleMaximumTemperature[s]    = moduleNumberMaximum;
+        pMinMaxAverageValues->validMeasuredCellTemperatures[s] = nrValidCelltemperatures;
 
         /* Prevent division by 0, if all cell voltages are invalid */
         if (nrValidCelltemperatures > 0u) {

diff --git a/src/app/driver/mic/ltc/6804-1/wscript b/src/app/driver/mic/ltc/6804-1/wscript
@@ -46,7 +46,7 @@ import os
 
 
 def build(bld):
-    """6804-1 is a build variant of 6812-1 (it mostly is an older version of
+    """6804-1 is a build variant of 6811-1 (it mostly is an older version of
     that IC)
     """
     bld.recurse(os.path.join("..", "6813-1"))
diff --git a/src/app/driver/mic/ltc/6813-1/config/ltc_6813-1_cfg.h b/src/app/driver/mic/ltc/6813-1/config/ltc_6813-1_cfg.h
@@ -47,8 +47,8 @@
  * @ingroup DRIVERS_CONFIGURATION
  * @prefix  LTC
  *
- * @brief   Header for the configuration for the LTC 6811-1, 6812-1, 6813-1
- *          monitoring IC.
+ * @brief   Header for the configuration for the LTC 6804-1 6811-1, 6812-1,
+ *          and 6813-1 monitoring IC.
  *
  */