Minor release of foxBMS 2 (v1.3.0)

* Added master and slave hardware documentation
* Added CRC checks in the FRAM driver
* Enhanced insulation monitoring driver
* Added Bender IR155 driver

For a detailed list of changes, please refer to the documentation at https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen2/docs/html/v1.3.0/general/changelog.html.

Author: foxBMS

.clang-format

@@ -1,11 +1,13 @@
 Language: Cpp
 AccessModifierOffset: -2
 AlignAfterOpenBracket: AlwaysBreak
+AlignArrayOfStructures: None # clang-bug
+AlignConsecutiveMacros: Consecutive
 AlignConsecutiveAssignments: true
+AlignConsecutiveBitFields: None # TODO: !573
 AlignConsecutiveDeclarations: false
-AlignConsecutiveMacros: true
 AlignEscapedNewlines: Left
-AlignOperands: true
+AlignOperands: Align
 AlignTrailingComments: true
 AllowAllArgumentsOnNextLine: true
 AllowAllConstructorInitializersOnNextLine: true
@@ -20,12 +22,13 @@ AlwaysBreakAfterDefinitionReturnType: None
 AlwaysBreakAfterReturnType: None
 AlwaysBreakBeforeMultilineStrings: false
 AlwaysBreakTemplateDeclarations: MultiLine
+AttributeMacros: []
 BinPackArguments: false
 BinPackParameters: false
 BraceWrapping:
   AfterCaseLabel: false
   AfterClass: false
-  AfterControlStatement: false
+  AfterControlStatement: Never
   AfterEnum: false
   AfterFunction: false
   AfterNamespace: false
@@ -35,11 +38,14 @@ BraceWrapping:
   AfterExternBlock: false
   BeforeCatch: false
   BeforeElse: false
+  BeforeLambdaBody: false
+  BeforeWhile: false
   IndentBraces: false
   SplitEmptyFunction: true
   SplitEmptyRecord: true
   SplitEmptyNamespace: true
 BreakBeforeBinaryOperators: None
+BreakBeforeConceptDeclarations: true
 BreakBeforeBraces: Attach
 BreakBeforeInheritanceComma: false
 BreakInheritanceList: BeforeColon
@@ -58,12 +64,12 @@ Cpp11BracedListStyle: true
 DeriveLineEnding: true
 DerivePointerAlignment: false
 DisableFormat: false
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: LogicalBlock
 ExperimentalAutoDetectBinPacking: false
 FixNamespaceComments: true
-ForEachMacros:
-  - foreach
-  - Q_FOREACH
-  - BOOST_FOREACH
+ForEachMacros: []
+IfMacros: []
 IncludeBlocks: Regroup
 IncludeCategories:
   - Regex: '^"(general\.h)"$'
@@ -98,20 +104,27 @@ IncludeCategories:
     SortPriority: 20
 IncludeIsMainRegex: "(_cfg)?$"
 IncludeIsMainSourceRegex: ""
+IndentAccessModifiers: false
 IndentCaseLabels: true
+IndentCaseBlocks: false
 IndentGotoLabels: true
 IndentPPDirectives: None
+IndentExternBlock: AfterExternBlock
+IndentRequires: false
 IndentWidth: 4
 IndentWrappedFunctionNames: true
+InsertTrailingCommas: None
 JavaScriptQuotes: Leave
 JavaScriptWrapImports: true
 KeepEmptyLinesAtTheStartOfBlocks: false
+LambdaBodyIndentation: Signature
 MacroBlockBegin: ""
 MacroBlockEnd: ""
 MaxEmptyLinesToKeep: 1
 NamespaceIndentation: None
 ObjCBinPackProtocolList: Auto
 ObjCBlockIndentWidth: 2
+ObjCBreakBeforeNestedBlockParam: true
 ObjCSpaceAfterProperty: false
 ObjCSpaceBeforeProtocolList: true
 PenaltyBreakAssignment: 20
@@ -122,33 +135,44 @@ PenaltyBreakString: 1000
 PenaltyBreakTemplateDeclaration: 10
 PenaltyExcessCharacter: 1000000
 PenaltyReturnTypeOnItsOwnLine: 100000
+PenaltyIndentedWhitespace: 0
 PointerAlignment: Right
+PPIndentWidth: -1
+ReferenceAlignment: Pointer
 ReflowComments: false
-SortIncludes: true
+ShortNamespaceLines: 1
+SortIncludes: CaseSensitive
+SortJavaStaticImport: Before
 SortUsingDeclarations: true
 SpaceAfterCStyleCast: false
 SpaceAfterLogicalNot: false
 SpaceAfterTemplateKeyword: true
 SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
 SpaceBeforeCpp11BracedList: false
 SpaceBeforeCtorInitializerColon: true
 SpaceBeforeInheritanceColon: true
 SpaceBeforeParens: ControlStatements
+SpaceAroundPointerQualifiers: Default
 SpaceBeforeRangeBasedForLoopColon: true
 SpaceInEmptyBlock: false
 SpaceInEmptyParentheses: false
 SpacesBeforeTrailingComments: 2
-SpacesInAngles: false
+SpacesInAngles: Never
 SpacesInConditionalStatement: false
 SpacesInContainerLiterals: true
 SpacesInCStyleCastParentheses: false
+SpacesInLineCommentPrefix:
+  Minimum: 1
+  Maximum: -1
 SpacesInParentheses: false
 SpacesInSquareBrackets: false
 SpaceBeforeSquareBrackets: false
+BitFieldColonSpacing: Both
 Standard: Latest
-StatementMacros:
-  - Q_UNUSED
-  - QT_REQUIRE_VERSION
+StatementAttributeLikeMacros: []
+StatementMacros: []
 TabWidth: 4
 UseCRLF: true
 UseTab: Never
+WhitespaceSensitiveMacros: []

.gitignore

@@ -47,3 +47,7 @@ __pycache__
 *.~$*
 
 **/foxbms-2_axivion_report.json
+
+*.exe
+
+/races.txt

BSD-3-Clause.txt

@@ -1,6 +1,6 @@
 BSD 3-Clause License (BSD 3-Clause "New" or "Revised" License)
 
-Copyright (c) 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
+Copyright (c) 2010 - 2022, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

CITATION.cff

@@ -37,11 +37,14 @@ authors:
   - family-names: "Bockrath"
     given-names: "Steffen"
     orcid: "https://orcid.org/0000-0003-4452-532X"
+  - family-names: "Seebeck"
+    given-names: "Rolf"
+    orcid: "https://orcid.org/0000-0002-5981-8128"
 cff-version: "1.1.0"
 doi: "10.5281/zenodo.4727562"
 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.2.1"
-date-released: 2021-12-08
+version: "1.3.0"
+date-released: 2022-05-30

conf/bms/schema/application.schema.json

@@ -0,0 +1,124 @@
+{
+    "$id": "/properties/application",
+    "title": "Configuration of the application",
+    "required": [
+        "algorithm",
+        "insulation-monitoring-device"
+    ],
+    "additionalProperties": false,
+    "properties": {
+        "algorithm": {
+            "$id": "/properties/application/algorithm",
+            "title": "Configuration of the algorithm module",
+            "required": [
+                "state-estimation"
+            ],
+            "properties": {
+                "state-estimation": {
+                    "$id": "/properties/application/algorithm/state-estimation",
+                    "title": "State estimators (must correspond to the directory name)",
+                    "required": [
+                        "soc",
+                        "soe",
+                        "soh"
+                    ],
+                    "properties": {
+                        "soc": {
+                            "$id": "/properties/application/algorithm/state-estimation/soc",
+                            "title": "State-of-Charge algorithm (must correspond to the directory name)",
+                            "type": "string",
+                            "enum": [
+                                "counting",
+                                "debug",
+                                "none"
+                            ]
+                        },
+                        "soe": {
+                            "$id": "/properties/application/algorithm/state-estimation/soe",
+                            "title": "State-of-Energy algorithm (must correspond to the directory name)",
+                            "type": "string",
+                            "enum": [
+                                "counting",
+                                "debug",
+                                "none"
+                            ]
+                        },
+                        "soh": {
+                            "$id": "/properties/application/algorithm/state-estimation/soh",
+                            "title": "State-of-Health algorithm (must correspond to the directory name)",
+                            "type": "string",
+                            "enum": [
+                                "debug",
+                                "none"
+                            ]
+                        }
+                    }
+                }
+            }
+        },
+        "insulation-monitoring-device": {
+            "$id": "/properties/application/insulation-monitoring-device",
+            "title": "Configuration of the used insulation measurement device",
+            "required": [
+                "manufacturer",
+                "model"
+            ],
+            "additionalProperties": false,
+            "properties": {
+                "manufacturer": {
+                    "$id": "/properties/application/insulation-monitoring-device/manufacturer",
+                    "title": "Manufacturer of the insulation monitoring device (must correspond to the directory name)",
+                    "type": "string",
+                    "enum": [
+                        "none",
+                        "bender"
+                    ]
+                },
+                "model": {
+                    "$id": "/properties/application/insulation-monitoring-device/model",
+                    "title": "Name of the insulation monitoring device (must correspond to the directory name)",
+                    "type": "string"
+                }
+            },
+            "if": {
+                "properties": {
+                    "manufacturer": {
+                        "enum": [
+                            "none"
+                        ]
+                    }
+                }
+            },
+            "then": {
+                "properties": {
+                    "model": {
+                        "enum": [
+                            ""
+                        ]
+                    }
+                }
+            },
+            "else": {
+                "if": {
+                    "properties": {
+                        "manufacturer": {
+                            "enum": [
+                                "bender"
+                            ]
+                        }
+                    }
+                },
+                "then": {
+                    "properties": {
+                        "model": {
+                            "enum": [
+                                "ir155",
+                                "iso165c"
+                            ]
+                        }
+                    }
+                }
+            }
+        }
+    }
+}