Bugfix release of foxBMS 2 (v1.4.1)

* The BMS Master hardware has been updated to v1.1.5. * CAN: * The implementation of the CAN driver has been changed to simplify adding new messages. * Endianness definition throughout the CAN signals was inconsistent. Not all signals were correctly defined as big-endian. * Updated the version of .sym file for the definition of the CAN messages to format version 6.0. * Fixed equation that does the conversion from raw ADC reading to voltage (mV). * Fixed the address for reading two diagnostic registers in the Smart Power Switch driver. * Maintenance: * TI CCS version 12.0.0, including TI ARM CGT 20.2.6, are now the defaults. * Update the Axivion static code analysis to version 7.4.6. For a detailed list of changes, please refer to the documentation at https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen2/docs/html/v1.4.1/general/changelog.html.
foxBMS · Oct 27, 2022 · a2b632f · a2b632f
1 parent 2525c1f
commit a2b632f
Show file tree

Hide file tree

Showing 618 changed files with 9,350 additions and 5,818 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -12,3 +12,6 @@ tools/waf linguist-vendored
 
 # files tracked with Git LFS
 *.zip filter=lfs diff=lfs merge=lfs -text
+
+tests/axivion/qualification-test/qualification-kit/**/*.json -diff -merge -text
+tests/axivion/qualification-test/qualification-kit/**/*.py -diff -merge -text
diff --git a/.gitignore b/.gitignore
@@ -23,6 +23,8 @@ __pycache__
 /qa-chain/*
 
 *.log
+*log*.txt
+*log/*
 
 *.patch
 *.diff
@@ -51,3 +53,6 @@ __pycache__
 *.exe
 
 /races.txt
+
+# CAN log files
+*.asc
diff --git a/CITATION.cff b/CITATION.cff
@@ -46,5 +46,5 @@ keywords:
   - "BMS"
 message: "If the foxBMS project contributes to a project that leads to a scientific publication, please acknowledge this fact by citing."
 title: "foxBMS - The Most Advanced Open Source BMS Platform: foxBMS 2"
-version: "1.4.0"
-date-released: 2022-07-29
+version: "1.4.1"
+date-released: 2022-10-27
diff --git a/conf/bms/schema/slave.schema.json b/conf/bms/schema/slave.schema.json
@@ -132,6 +132,7 @@
                     "type": "string",
                     "enum": [
                         "epcos",
+                        "murata",
                         "vishay",
                         "fake"
                     ]
@@ -175,7 +176,7 @@
                     "properties": {
                         "manufacturer": {
                             "enum": [
-                                "vishay"
+                                "murata"
                             ]
                         }
                     }
@@ -184,8 +185,7 @@
                     "properties": {
                         "model": {
                             "enum": [
-                                "ntcalug01a103g",
-                                "ntcle317e4103sba"
+                                "ncu15xh103f6sxx"
                             ]
                         }
                     }
@@ -195,7 +195,7 @@
                         "properties": {
                             "manufacturer": {
                                 "enum": [
-                                    "fake"
+                                    "vishay"
                                 ]
                             }
                         }
@@ -204,10 +204,31 @@
                         "properties": {
                             "model": {
                                 "enum": [
-                                    "none"
+                                    "ntcalug01a103g",
+                                    "ntcle317e4103sba"
                                 ]
                             }
                         }
+                    },
+                    "else": {
+                        "if": {
+                            "properties": {
+                                "manufacturer": {
+                                    "enum": [
+                                        "fake"
+                                    ]
+                                }
+                            }
+                        },
+                        "then": {
+                            "properties": {
+                                "model": {
+                                    "enum": [
+                                        "none"
+                                    ]
+                                }
+                            }
+                        }
                     }
                 }
             }

diff --git a/conf/cc/cc-options.yaml b/conf/cc/cc-options.yaml
@@ -35,7 +35,7 @@
 # - "This product includes parts of foxBMS®"
 # - "This product is derived from foxBMS®"
 
-FOXBMS_2_CCS_VERSION_STRICT: "v20.2.5.LTS"
+FOXBMS_2_CCS_VERSION_STRICT: "v20.2.6.LTS"
 
 INCLUDE_PATHS:
   win32:

diff --git a/conf/env/paths_linux.txt b/conf/env/paths_linux.txt
@@ -1,4 +1,4 @@
-/opt/ti/ccs1100/ccs/tools/compiler/ti-cgt-arm_20.2.5.LTS/bin
-/opt/ti/ccs1100/ccs/tools/compiler/ti-cgt-arm_20.2.5.LTS/lib
-/opt/ti/ccs1100/ccs/utils/bin
-/opt/ti/ccs1100/ccs/utils/tiobj2bin
+/opt/ti/ccs1200/ccs/tools/compiler/ti-cgt-arm_20.2.6.LTS/bin
+/opt/ti/ccs1200/ccs/tools/compiler/ti-cgt-arm_20.2.6.LTS/lib
+/opt/ti/ccs1200/ccs/utils/bin
+/opt/ti/ccs1200/ccs/utils/tiobj2bin
diff --git a/conf/env/paths_win32.txt b/conf/env/paths_win32.txt
@@ -1,10 +1,10 @@
-C:\ti\ccs1100\ccs\tools\compiler\ti-cgt-arm_20.2.5.LTS\bin
-C:\ti\ccs1100\ccs\tools\compiler\ti-cgt-arm_20.2.5.LTS\lib
-C:\ti\ccs1100\ccs\utils\bin
-C:\ti\ccs1100\ccs\utils\cygwin
-C:\ti\ccs1100\ccs\utils\tiobj2bin
+C:\ti\ccs1200\ccs\tools\compiler\ti-cgt-arm_20.2.6.LTS\bin
+C:\ti\ccs1200\ccs\tools\compiler\ti-cgt-arm_20.2.6.LTS\lib
+C:\ti\ccs1200\ccs\utils\bin
+C:\ti\ccs1200\ccs\utils\cygwin
+C:\ti\ccs1200\ccs\utils\tiobj2bin
 C:\ti\Hercules\HALCoGen\v04.07.01
 C:\Program Files\LLVM\13.0.0\bin
 C:\Ruby\Ruby272-x64\bin
 C:\MinGW64\x86_64-8.1.0-release-posix-seh-rt_v6-rev0\mingw64\bin
-C:\Bauhaus\7.4.0\bin
+C:\Bauhaus\7.4.6\bin
diff --git a/conf/guidelines/rules.json b/conf/guidelines/rules.json
@@ -22,6 +22,7 @@
     "**/*~",
     "**/__pycache__/**",
     "**/foxbms-2_axivion_report.json",
+    "**/*.asc",
     ".git/**",
     ".lock-waf_*_build",
     ".mypy_cache/**",
@@ -49,6 +50,7 @@
     "src/os/safertos/**/*.asm",
     "src/os/safertos/**/*.c",
     "src/os/safertos/**/*.h",
+    "tests/axivion/qualification-test/qualification-kit/**",
     "tests/scripts/waf-core/general/**",
     "tests/scripts/waf-core/init/**",
     "tests/scripts/waf-core/install/**",
@@ -125,19 +127,15 @@
   "posix_3.206": {
     "name": "GENERAL:004",
     "exclude": [
-      "**/*.dbc",
       "**/*.patch",
-      "**/*.sym",
       "tools/utils/git-hooks/pre-commit"
     ]
   },
   "trailing_whitespace": {
     "name": "GENERAL:005",
     "exclude": [
-      "**/*.dbc",
       "**/*.dil",
       "**/*.patch",
-      "**/*.sym",
       "tools/gui/data/pcan_view_v2.0.trc"
     ]
   },
@@ -374,6 +372,7 @@
             "docs/developer-manual/style-guide/examples/c-028*.c",
             "docs/developer-manual/style-guide/state-machine-example/state-machine.c",
             "docs/software/build-process/misc/libproject-example.c",
+            "docs/software/modules/driver/can/can_how-to_tx.c",
             "docs/software/modules/engine/database/database_how-to.c",
             "docs/software/modules/task/ftask/ftask_how-to.c",
             "src/**",

diff --git a/conf/tpl/c.c b/conf/tpl/c.c
@@ -43,8 +43,8 @@
  * @file    c.c
  * @author  foxBMS Team
  * @date    2019-08-27 (date of creation)
- * @updated 2022-07-28 (date of last update)
- * @version v1.4.0
+ * @updated 2022-10-27 (date of last update)
+ * @version v1.4.1
  * @ingroup SOME_GROUP
  * @prefix  ABC
  *

diff --git a/conf/tpl/c.h b/conf/tpl/c.h
@@ -43,8 +43,8 @@
  * @file    c.h
  * @author  foxBMS Team
  * @date    2019-08-27 (date of creation)
- * @updated 2022-07-28 (date of last update)
- * @version v1.4.0
+ * @updated 2022-10-27 (date of last update)
+ * @version v1.4.1
  * @ingroup SOME_GROUP
  * @prefix  ABC
  *

diff --git a/conf/tpl/test_c.c b/conf/tpl/test_c.c
@@ -43,8 +43,8 @@
  * @file    test_c.c
  * @author  foxBMS Team
  * @date    2020-08-10 (date of creation)
- * @updated 2022-07-28 (date of last update)
- * @version v1.4.0
+ * @updated 2022-10-27 (date of last update)
+ * @version v1.4.1
  * @ingroup UNIT_TEST_IMPLEMENTATION
  * @prefix  TEST
  *

diff --git a/conf/tpl/test_c.h b/conf/tpl/test_c.h
@@ -43,8 +43,8 @@
  * @file    test_c.h
  * @author  foxBMS Team
  * @date    2020-08-10 (date of creation)
- * @updated 2022-07-28 (date of last update)
- * @version v1.4.0
+ * @updated 2022-10-27 (date of last update)
+ * @version v1.4.1
  * @ingroup UNIT_TEST_IMPLEMENTATION
  * @prefix  TEST
  *

diff --git a/docs/developer-manual/hardware/dummy → docs/developer-manual/hardware/.dummy b/docs/developer-manual/hardware/dummy → docs/developer-manual/hardware/.dummy
diff --git a/docs/developer-manual/style-guide/examples/c-004.c b/docs/developer-manual/style-guide/examples/c-004.c
@@ -43,8 +43,8 @@
  * @file    c-004.c
  * @author  foxBMS Team
  * @date    2021-04-06 (date of creation)
- * @updated 2022-07-28 (date of last update)
- * @version v1.4.0
+ * @updated 2022-10-27 (date of last update)
+ * @version v1.4.1
  * @ingroup SOME_GROUP
  * @prefix  ABC
  *

diff --git a/docs/developer-manual/style-guide/guidelines_rst.rst b/docs/developer-manual/style-guide/guidelines_rst.rst
@@ -96,8 +96,8 @@ Examples:
 Headings (``RST:005``)
 ----------------------
 
-We follow the convention of the Python Developer's Guide for
-`reStructuredText Markup <https://devguide.python.org/documentation/markup/#sections>`_.
+We follow the convention of the
+*Python Developer's Guide for reStructuredText Markup*.
 Use the following rules to create headings:
 
 - # with overline, for parts

diff --git a/docs/developer-manual/style-guide/state-machine-example/state-machine.c b/docs/developer-manual/style-guide/state-machine-example/state-machine.c
@@ -43,8 +43,8 @@
  * @file    state-machine.c
  * @author  foxBMS Team
  * @date    2020-10-29 (date of creation)
- * @updated 2022-07-28 (date of last update)
- * @version v1.4.0
+ * @updated 2022-10-27 (date of last update)
+ * @version v1.4.1
  * @ingroup STATE_MACHINE
  * @prefix  EG
  *

diff --git a/docs/developer-manual/style-guide/state-machine-example/state-machine.h b/docs/developer-manual/style-guide/state-machine-example/state-machine.h
@@ -43,8 +43,8 @@
  * @file    state-machine.h
  * @author  foxBMS Team
  * @date    2020-10-29 (date of creation)
- * @updated 2022-07-28 (date of last update)
- * @version v1.4.0
+ * @updated 2022-10-27 (date of last update)
+ * @version v1.4.1
  * @ingroup STATE_MACHINE
  * @prefix  EG
  *

diff --git a/docs/general/changelog.rst b/docs/general/changelog.rst
@@ -41,6 +41,57 @@ Versioning follows then these rules:
 - increasing ``MINOR`` adds functionality in a backwards compatible manner
 - increasing ``PATCH`` fixes bugs in a backwards compatible manner
 
+********************
+[1.4.1] - 2022-10-27
+********************
+
+|foxbms| updated to TI ARM CGT 20.2.6.LTS.
+Installation instructions are found at :numref:`css_install`.
+
+Added
+=====
+
+- The new default compiler set in ``conf/env/paths_win32.txt`` and
+  ``conf/env/paths_linux.txt`` is now TI ARM CGT v20.2.6.LTS (shipped with CCS
+  ``12.0.0``).
+- Added driver for *Murata NCU15XH103F6Sxx* temperature sensor
+
+Changed
+=======
+
+- Updated the hardware design files (e.g., schematics, layout, BOM and STEP
+  file etc.) of the |bms-master|  to ``v1.1.5`` (see
+  :ref:`CHANGELOG_FOR_MASTER_TMS570_V1_1_5`).
+- Updated documentation of the interface using the |max17841b| transceiver
+  chip.
+- The implementation of the CAN driver has been changed to simplify adding
+  new messages.
+  Furthermore it is now possible to force a certain style on how CAN messages
+  are defined in the symbol/dbc files as well as in the source code.
+  For further information see :ref:`HOW_TO_USE_THE_CAN_MODULE`.
+- Updated version of ``.sym`` file for the definition of the CAN messages and
+  signals to v6.0 (from 5.0).
+- Update the static code analysis to Axivion 7.4.6 (from 7.4.0).
+
+Deprecated
+==========
+
+Removed
+=======
+
+- Unused calculation of MOL, RSL and MSL curves for trapezoid algorithm in
+  ``SOF`` module.
+
+Fixed
+=====
+
+- In ``ADC`` module, corrected formula making the conversion from raw ADC
+  reading to voltage in mV.
+- The address of two diagnostic registers in the Smart Power Switch driver
+  was wrong.
+- Endianness definition throughout the CAN signals was inconsistent. Not all
+  signals were correctly defined as big-endian.
+
 ********************
 [1.4.0] - 2022-07-29
 ********************
@@ -127,11 +178,11 @@ Fixed
 [1.3.0] - 2022-05-30
 ********************
 
-|foxbms| updated to TI ARM CGT 20.2.5.LTS. Installation instructions are found
-at :numref:`css_install`.
+|foxbms| updated to TI ARM CGT 20.2.5.LTS.
+Installation instructions are found at :numref:`css_install`.
 
-|foxbms| updated to LLVM 13.0.0. Installation instructions are found at
-:numref:`llvm_install`.
+|foxbms| updated to LLVM 13.0.0.
+Installation instructions are found at :numref:`llvm_install`.
 
 Added
 =====

diff --git a/docs/general/commit-msgs/next-release.txt b/docs/general/commit-msgs/next-release.txt
@@ -0,0 +1,6 @@
+<Major/Minor/Bugfix> release of foxBMS 2 (vx.y.z)
+
+* <add text here>
+
+For a detailed list of changes, please refer to the documentation at
+https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen2/docs/html/vx.y.z/general/changelog.html.
diff --git a/docs/general/commit-msgs/release-v1.0.0.txt b/docs/general/commit-msgs/release-v1.0.0.txt
@@ -0,0 +1 @@
+Initial commit of foxBMS 2 (v1.0.0)
diff --git a/docs/general/commit-msgs/release-v1.0.1.txt b/docs/general/commit-msgs/release-v1.0.1.txt
@@ -0,0 +1,9 @@
+Bugfix release of foxBMS 2 (v1.0.1)
+
+* updated the documentation
+* updated master board
+* 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.1/general/changelog.html
diff --git a/docs/general/commit-msgs/release-v1.0.2.txt b/docs/general/commit-msgs/release-v1.0.2.txt
@@ -0,0 +1,8 @@
+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
diff --git a/docs/general/commit-msgs/release-v1.1.0.txt b/docs/general/commit-msgs/release-v1.1.0.txt
@@ -0,0 +1,8 @@
+Minor release of foxBMS 2 (v1.1.0)
+
+* Release of new master schematic
+* Implementation of CAN messages
+
+For a detailed list of changes, please refer to the documentation
+at
+https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen2/docs/html/v1.1.0/general/changelog.html
diff --git a/docs/general/commit-msgs/release-v1.1.1.txt b/docs/general/commit-msgs/release-v1.1.1.txt
@@ -0,0 +1,8 @@
+Bugfix release of foxBMS 2 (v1.1.1)
+
+fixed a CAN message decoding bug
+added missing CAN messages
+
+For a detailed list of changes, please refer to the documentation
+at
+https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen2/docs/html/v1.1.1/general/changelog.html
diff --git a/docs/general/commit-msgs/release-v1.1.2.txt b/docs/general/commit-msgs/release-v1.1.2.txt
@@ -0,0 +1,4 @@
+Bugfix release of foxBMS 2 (v1.1.2)
+
+added Axivion configuration
+added system block diagram