2. Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog.

foxBMS 2 uses the following versioning pattern MAJOR.MINOR.PATCH where MAJOR, MINOR and PATCH are numbers.

Versioning follows then these rules:

  • increasing MAJOR introduces incompatible changes

  • increasing MINOR adds functionality in a backwards compatible manner

  • increasing PATCH fixes bugs in a backwards compatible manner

2.1. [1.1.0] - 2021-07-29

foxBMS 2 now defaults to Code Composer Studio 10.3.1 in order to build the binaries. If an older version of the compiler should be used, it can be configured in conf/env/paths_win32.txt. For installation instructions see Section 3.2.1.

foxBMS 2 now ships with a new conda environment 2021-08-arctic-fox and the local conda environments need to updated (see Section 3.3).

2.1.1. Added

  • Diagnosis entries can now be configured specifically for each LTC6813-1 instance.

  • Endianness is now configurable in CAN module.

  • Add number of balanced cells in each string to database entry DATA_BLOCK_ID_BALANCING_CONTROL.

  • Added a built-in self-test for the database module that writes and reads an entry during startup of the system.

  • Added a helper tool for the maintenance of the list of licenses in the conda environment.

  • Added a helper macro for the generation of array initializers (REPEAT_U()).

  • Documented how to use Ozone to show the location of a failed assertion.

  • Cell voltages and temperatures are each stored in one array containing all values. Added database helper functions to get string, module or cell/sensor number from index in the global array.

  • Added a block diagram of the foxBMS 2 master hardware.

  • Added a SPI API function that allows to switch the functional state (GIO or SPI) of a SPI pin of the MCU.

  • Added testing for different versions of TI CCS (versions 10.2.1, 10.3.0, 10.3.1 and 10.4.0).

  • Add fallback compiler detection.

  • Added a link to foxBMS project website with acknowledgment information:

    • List of funded projects foxBMS has received funding from

    • Instructions on how to reference to foxBMS 2

  • Added handling of I2C multiplexers to the Maxim monitoring IC driver.

  • Added a flash tool to the waf toolchain. It is based on SEGGER J-Flash and can be invoked by calling waf install_bin or running the Flash:Binary task in code.

  • Added a short note on the installation of PEAK-Drivers (for CAN communication) to the installation manual.

  • Added a section on testing the setup of the toolchain.

  • Added configurable reaction type, delay and severity for each diagnosis entry.

  • Configuration of failures, that lead to a transition to the error state is now done by configuring the severity of the respective diagnosis entry to DIAG_FATAL_ERROR. The handling of the timing delay to transition into error state is done by the BMS module.

  • Implemented CAN messages defined in .dbc file. Only stubs are implemented for some CAN messages respectively some signals.

  • Documented workarounds that have to be applied to HALCoGen.

2.1.2. Changed

  • The schematic of the BMS-Master Board has been updated (v1.0.2).

  • The new default compiler set in conf/env/paths_win32.txt is now TI ARM CGT v20.2.4.LTS (shipped with CCS 10.3.1).

  • Reorganized the compiler tests in tests/ccs/*.

  • Updated the development conda environment to 2021-06-arctic-fox. Please run the conda-update-env.bat script in order to update your local environment (see Section 3.3).

  • CAN callback functions are now defined in separate files to increase readability.

  • Ring buffer for CAN RX was replaced by a FreeRTOS queue. A DIAG entry was added that detects if the queue is full when trying to add an element.

  • Updated the black configuration to match the new python version (Python 3.9.5).

  • Improved the Ozone configuration so that an data breakpoint is set automatically on the symbol fas_assertLocation.pc.

  • Run VS Code build tasks as process.

  • Use posix paths in VS Code configuration on all host platforms.

  • Improved the MISRA compliance of the monitoring driver for the family of Maxim ICs.

  • Pause the terminal when running ide.bat, waf.bat and waf.sh in case the conda base or development environment could not be found. This is done to clearly point the user to the error message.

  • Moved the struct storing the version of the software to a fixed location (address 0x003FFF40) in flash memory.

  • Replace all access to registers through the IO_ functions with an access that keeps the volatile keyword on the register.

  • Dropped the requirement for an internal library (pyhameg) in the HIL test.

  • Updated the unit test framework ceedling to version 0.31.1.

  • Simplified the configuration of the cppcheck tool.

  • Improved several function names in the ftask module.

  • All required Queues are now created in one function (FTSK_CreateQueues) before the scheduler starts.

  • Split the waf compiler tool into smaller sub-tools to simplify maintenance and tests.

2.1.3. Deprecated

2.1.4. Removed

  • Completely removed dynamic allocation from FreeRTOS and reduced the (unused) heap size to 0.

  • Removed deprecated option COLS_IN_ALPHA_INDEX from the doxygen configurations.

  • Disabled FEE driver in the HALCoGen project as it is currently unused.

  • Removed the hardware design files from the hardware directory and provided a URL under which the files can be found.

2.1.5. Fixed

  • The implementation of DIAG_ErrorCurrentOnOpenString() had an error where the wrong enum has been used leading to an assertion.

  • Fixed bug in SOC/SOE counting module that extrapolated for cell voltages below lookup-table range

  • Fixed bug that caused current sensor scaling values to be only recalibrated after startup and not while recalibrating SOC/SOE values via LUT when BMS is at rest.

  • A race condition between the SOC and SOE calculation lead to a mutual overwriting of the state estimation values.

  • Added documentation for the CAN module.

  • The regex to parse the linkcheck output in case of a broken URL did not match and raised an exception. The regex is now simpler and has a fallback option.

  • void functions used unnecessary return; at the end of the function. These returns have been removed.

  • Sometimes black would fail to write to the cache pickle due to concurrent write processes of multiple black processes. This issue has been fixed by passing all files, that should be checked, at once to black.

  • Fixed comparison error in SOF module that compared mA with A.

  • Some C-language guideline checks did not properly take C language global excludes into account.

  • Updated links in Section 5.

  • Fixed construction of the path variable in batch scripts.

2.2. [1.0.2] - 2021-04-30

2.2.1. 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.

2.2.2. Changed

  • Do no longer hard code the EOL for the files in the VS Code settings, instead just use the system EOL instead.

2.2.3. Deprecated

2.2.4. Removed

2.2.5. 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.

2.3. [1.0.1] - 2021-04-16

2.3.1. Added

  • Added links to built versions of the documentation to the project README.

  • Added testing for different versions of TI CSS (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 6811-1).

  • Added the updated design files of the foxBMS 2 master v1.0.1.

2.3.2. Changed

  • Activated URL availability checking for https://github.com/foxBMS/foxbms-2 when building the documentation.

  • Moved code examples in developer manual to separate source files.

  • The shebang in Python files has been updated from python to python3.

  • Updated waf to version 2.0.22 (from 2.0.21).

  • Updated database documentation.

  • Updated information on tracing with Segger J-Trace probes.

2.3.3. Deprecated

2.3.4. Removed

  • Removed external quality check in CI. This functionality has been replaced by the “guidelines” feature that is shipped with this repository.

2.3.5. Fixed

  • Use code page 850 as default when using the waf.sh/waf.bat wrappers.

  • without-halcogen_diff-includes.diff was unintentionally excluded by the regex in .gitignore.

  • Fixed repository name in the documentation.

  • Fixed available waf commands and put the table in a separate csv file.

  • Fixed comments in LTC driver build scripts

  • Includes directories were not correctly set for the drivers LTC 6811-1 and LTC 6812-1.

  • Clarification and correction of the license namings (no changes in the licenses themselves). The license of the foxBMS 2 software is the BSD 3-Clause License. This license is also formally known as BSD 3-Clause “New” or “Revised” License. As of this release foxBMS 2 added the SPDX short identifier to the software sources (SPDX-License-Identifier: BSD-3-Clause) according to SPDX Specification Version 2.2. The license text of the Creative Commons Attribution 4.0 International License has been added to the repository. The SPDX short name of this license is CC-BY-4.0. For more information see License.

  • Fixed the names of variables in bash scripts on Windows.

2.4. [1.0.0] - 2021-04-01

2.4.1. Added

  • Added automated installer script for miniconda3.

  • Added automated installer script for MinGW64.

  • Added automated installer script for LLVM.

2.4.2. Changed

  • Finalize red-fox conda environment 2021-04-red-fox based on red-fox-devel-020. No packages are updated, just finalized the name.

  • Removed dependency of configured power lines from overcurrent check in SOA module. The overcurrent is now checked against allowed cell, string and pack current limits.

  • C source files, that are not vendored, are now ASCII encoded.

  • Improved the code quality by adding assertions in various locations and removing unused code.

  • Base decisions in bms on pack value database entry as this entry contains only validated values. Do not directly use current sensor measurements anymore.

  • Fixed function names in the system monitoring module.

  • Replace remaining TRUE and FALSE in embedded sources with true and false respectively from stdbool.h.

  • Updated LLVM to version 11.0.1

  • Only compile foxBMS 2 source and operating system sources in strict_ansi mode

2.4.3. Deprecated

2.4.4. Removed

  • Removed several unused defines.

2.4.5. Fixed

  • Style guide check did not properly exclude files when checking *.rst files.

  • Fix @prefix check in Doxygen comments.

  • Fix @prefix for modules epcos_b57251v5103j060, epcos_b57861s0103f045 and vishay_ntcalug01a103g.

  • Do not add __TIME__ and __DATE__ macros to list of predefined defines in VS Code.

  • Create all build-time created include directories VS Code knows about in c_cpp_properties.json to remove workspace warnings.

  • Add back Previous and Next buttons back in rendered documentation.

  • Updated getting started information.

  • Fixed function names and variable names of database structs in the bms module.

  • Fixed function names and variable names of database structs in the adc module.

  • Fixed CAN driver problem when cache is enabled.

  • conda-init.bat used a wrong path to write the .condarc file if the user name contained whitespace.

2.5. [0.3.0] - 2021-03-16

2.5.1. Added

  • Added coverage reports for the unit tests of the waf-tools.

  • Added general safety information.

  • Added a rudimentary hardware change process to the hardware developer manual.

  • Added information on the criticality of used tools.

  • Added the calculation of pack values (current, power, high voltage) to the redundancy module.

  • Added a manual on using debugger by Segger or Lauterbach in conjunction with the platform.

  • Added a problem matcher to the build_docs task in Visual Studio Code so that the IDE can parse warnings printed from Doxygen

  • Added documentation stubs for all embedded software modules

  • Added interface description for CAN communication (.dbc and .sym)

2.5.2. Changed

  • SBC no longer monitors input on FCCU pins as usage of these pins is currently not supported

  • The MIC modules are now able to define their own threshold values for plausible cell voltage measurements. In order to implement this, the MIC has to declare a struct of type MIC_PLAUSIBILITY_VALUES_s and pass it to the plausibility-functions of the MIC.

  • Improves deployment speed with the internal deployment script.

  • Simplifies the macro that records the program counter in fassert.h with input from static analysis.

  • Disables the static analysis finding for dead branches in the expansion of the FAS_ASSERT assertion macro as the assertion should not be hit by normal operating code.

  • Clarified the internal merge request template.

  • Asserts that the SPI function SPI_TransmitReceiveDataDma() does not receive null pointer as parameter.

  • Improved minor code quality issues in the DIAG_Initialize() function.

  • Improved the documentation on installing dependencies.

  • Removed function DIAG_configAssert() as it is replaced by FAS_ASSERT.

  • The diagnosis module has been restructured. The callbacks for each type of diagnosis event are now implemented in type specific files, e.g., for the current sensor in diag_cbs_current-sensor.c. These files are in src/app/engine/diag/cbs/. Unit tests have been added.

  • Fixed typos related to battery cell and battery system.

  • Enhanced the documentation section on the build process.

  • Improved the documentation of the temperature sensor interface (TSI).

  • Some structs in the database did not conform to the naming conventions.

  • Renamed the hardware directory from hw to hardware.

  • clang-format, black and pylint tools have been moved into the guidelines tool. Configuration is now done via rules.json as all other guidelines.

2.5.3. Deprecated

2.5.4. Removed

2.5.5. Fixed

  • Corrected the function LTC_I2CCheckACK() that did not check the acknowledge signal of multiplexer over I2C communication.

  • Corrected the function LTC_SetMUXChCommand() because message content for I2C communication with multiplexers was wrong.

  • Corrected several instances in the LTC6813-1-driver where the loop-counter variable has been declared outside of the loop.

  • Renamed function names in redundancy module to adhere to style guide rules.

  • Fixed wording and replaced isolation by insulation.

  • Replaced references to LG INR18650MJ1 by generic battery cell configuration.

  • Tasks were not initialized correctly. The IDLE task never run.

2.6. [0.2.0] - 2021-02-02

2.6.1. Added

  • A parser to validate the linker output was added. The parser analyzes the output of the linking process to validate that symbols were pulled from the specified source. If the symbol is pulled from another source the build process throws an error.

  • A parser to validate the style guide rules was added. The parser analyzes the files in the repository for style guide rule compliance. If a rule is violated the check guidelines and style guide process throws an error.

  • Updated the development conda environment to red-fox-devel-020 with Python version 3.8, updated packages and new packages: mypy, rope, seaborn, statsmodels, scikit-learn, filterpy, dask and scipy.

  • Documentation of the development workflow has been added as a draft.

  • Discard return value of memcpy() in DATA_Task() as the return value is not further used.

  • Added first draft of state estimation module. This module is located within the algorithm module and responsible for calculating state of charge SOC, state of energy SOF, state of health SOH and state of function SOF. Different calculation methods for each state estimation algorithm can be selected via configuration file bms.json.

  • Added a dummy insulation monitoring device driver. Non-functional Bender iso165c drivers have been added (driver fail to build).

  • Added a driver for Smart Power Switches that is encapsulated by the contactor module. The contactor module handles the communication with the Smart Power Switch driver and manages the ICs.

  • Added a state of energy SOE estimation implementation based on counting energy.

  • Added documentation of the hardware development flow.

  • Enabled the FreeRTOS idle hook in user code. That means that the function FTSK_UserCode_Idle() will be called every time the OS goes into idle state.

  • Extended the conda environment with a sphinx-plugin that provides BiBTeX-capabilities. Added this plugin to the documentation build in order to generate bibliographies.

  • Extended the API of the Temperature Sensor Interface (TSI) in order to return maximum and minimum limits for plausible measurement values.

  • Extended the documentation with a manual for writing unit tests and a reference to the C coding standard the we use.

  • Added an initialization function to sys_mon module to detect possible configuration errors

  • Added more files to the unit test coverage analysis in order to have a more complete image of the project and its unit test coverage.

  • The conda environment configuration that is distributed within the has now an option to validate that it is working as intended. The conda environment can be tested by running tools\utils\cmd\run-python-script.bat tests\env\packages_test.py -f tests\env\conda_env_win32.json from the repository root.

2.6.2. Changed

  • The algorithm-implementation is now able to handle calling a function cyclically and calling an additional initialization function. The implementation of the algorithm does not need to interact with the algorithm-API anymore as this is now handled by the module. In order to not block the rest of the system with an algorithm that might take longer for computation, the algorithm module has been moved into its own task with a lower priority.

  • Updated FreeRTOS to version 10.4.3 (from 10.3.0).

  • Updated waf to version 2.0.21 (from 2.0.20).

  • Consequently uses deci degree Celsius as integer-value (instead of degree Celsius floats) in the Temperature Sensor Interface (TSI).

  • Moved the slaveplausibility-modules into one central module in the MIC and renamed it to MIC plausibility.

  • Initialize runner variables in loops correctly as unsigned.

  • Renamed directory measurement-ic to mic.

  • Renamed directory temperature-sensors to ts.

  • Changed linker script prefix from ldscript_ to linker_script_.

  • Renamed all references in the build toolchain and documentation from linkerscript to linker_script.

  • Source files are no longer needed to be added manually to the documentation, instead sources are linked into the documentation based on the Doxygen generated documentation.

  • Sets UNITY_INCLUDE_EXEC_TIME in the ceedling configuration in order to tell unity to track the time that a single test takes. This information is aggregated in the JUnit test report that is generated.

  • Updated the unit test framework ceedling to version 0.31.0 and vendored the ceedling release with the repository in order to have more control over the executed version. Simplified the installation of Ruby in order to to reflect these changes. Simplified the f_unit_test waf-tool.

2.6.3. Deprecated

2.6.4. Removed

  • Removed the deprecated Anaconda extension from the list of recommended Visual Studio Code plugins that is shipped with the project.

2.6.5. Fixed

  • If the runtime support library was missing on a machine, the configure step failed, although the runtime support library was successfully built by the compiler. Now a warning is printed that the runtime support library is missing and that it will be built. An error is no longer generated when the build succeeds.

  • The Maxim driver did not properly map multiple modules onto internal data structures for multi-string systems. This has been fixed.

  • Fixes various comparisons between incompatible enum types.

  • Fixed erroneous behavior of the GUI. The GUI implementation is now black and pylint compliant.

  • Fixes erroneous hard-coded PEC-values in the LTC driver. A regression is prevented by added unit tests.

  • The project version number was missing in the documentation build. The version information is now properly passed to the documentation build.

  • The top of every documentation page began with orphan:.

  • Fixed implicitly defined functions.

  • Fixed the unit test documentation on how to use ceedling directly. The old version mentioned a wrong path for the project.yml used by ceedling.

2.7. [0.1.0] - 2020-11-17

Initial version