Battery Management System

Documentation

More detailed documentation is $\rightarrow$ here.

We are also working on integrating Doxygen so the BMS can become and remain a multi-year, evolving project.

Getting Started

Clone with git clone https://github.com/DallasFormulaRacing/battery-management-system.git

Tools

Make sure you have the following utilities:

• make
• CMake
• gcc-arm-none-eabi
• openocd

DO NOT USE CUBE-CMAKE

[Add more here]

How to run

Firmware Instructions

cwd = bms

1. mkdir build && cd build
2. cmake ..
3. cmake --build build

If you get compiler detection errors make sure the CMake GNU ARM toolchain flag is being detected!

Recommended VS Code Extensions

cschlosser.doxdocgen
dan-c-underwood.arm
marus25.cortex-debug
mcu-debug.debug-tracker-vscode
mcu-debug.memory-view
mcu-debug.peripheral-viewer
mcu-debug.rtos-views
ms-vscode.cmake-tools
ms-vscode.cpptools-extension-pack
ms-vscode.cpptools-themes
ms-vscode.hexeditor
ms-vscode.makefile-tools
ms-vscode.vscode-serial-monitor
pkief.material-icon-theme
trond-snekvik.gnu-mapfiles
twxs.cmake
usernamehw.errorlens
zixuanwang.linkerscript

Other extensions

To read the documentation in the docs/ directory, you may need

goessner.mdmath

How to Contribute:

New features will be developed on a branch separate from production master and will be merged by pull request. All contributions will undergo review at the pull request level.

Your pull request will be automatically blocked from merging if it does not pass a compile check!

Please see branch naming conventions and pull request naming conventions and name them appropriately. Bad naming is bad documentation and bad documentation is bad code. Refer to previous PRs or old branch names for inspiration/clarification.

If applicable, please tie your pull request to one or more issues. Try to find an issue to solve with your PR, or just make one. Duplicate issues will be filtered.

---

Authors: DALLAS FORMULA RACING EV TEAM