foxBMS 2
foxBMS is a free, open and flexible development environment to design battery management systems. It is the first modular open source BMS development platform.
Overview
foxBMS is an universal hardware and software platform providing a fully open source BMS development platform. foxBMS aims to control modern and complex electrical energy storage systems of any size. foxBMS is successfully used for electrical energy storage consisting of
- Lithium-Ion and Solid State Batteries
- Lithium-Sulfur Batteries
- Sodium-Ion Batteries
- Lithium-Ion Capacitors (LIC)
- Electric Double-Layer Capacitors (EDLC, supercapacitors or ultracaps)
- Redox-Flow Batteries (RFB) (e.g., Vanadium Redox-Flow), and
- Fuel Cells (FC)
or in an hybrid combination of these and in various domains.
Documentation
A current build of the documentation of this project can be found here:
Changelog
The project changelog is found in docs/general/changelog.rst.
Installation Instructions
See INSTALL.md for installation instructions.
Graphical User Interface
The GUI requires a successful installation as described in INSTALL.md.
foxBMS 2 contains a basic GUI to support BMS development tasks (e.g., building binaries, updating the BMS through the bootloader).
The GUI can either be opened by running ./fox.ps1 gui or if PowerShell is
installed available at C:\Program Files\PowerShell\7\pwsh.exe it can also
be run by double-clicking gui.lnk in the root of the repository.
Repository Structure
The repository is structured as follows:
| Directory Name | Content Description |
|---|---|
. |
The repository root contains the license information, installation instructions, a link to the changelog, the main build script |
cli |
CLI tool to interact with the repository |
conf |
Contains all high level configurations |
docs |
Documentation source files |
hardware |
Hardware schematic and layout information |
src |
Parent directory for all source files for the BMS embedded software |
tests |
Tests for embedded sources, the toolchain, and scripts |
tools |
Tools needed to build foxBMS binaries and additional tools to work with foxBMS |
These directories each have a README.md that explain the content of the
directory.
License
The license information of the project is found in LICENSE.md.
Basically, the software is covered by the BSD 3-Clause License (SPDX short identifier: BSD-3-Clause) and the hardware and documentation by the Creative Commons Attribution 4.0 International License (SPDX short identifier: CC-BY-4.0).
Open Source Hardware Certification
foxBMS 2 has been certified as open source hardware by the Open Source Hardware Association under the OSHWA UID DE000128.
Acknowledgment
For funding acknowledgements and instructions on how to acknowledge foxBMS 2 please see foxbms.org/acknowledgements.
Metadata
Release files for foxbms-fox-cli 1.12.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| foxbms_fox_cli-1.12.0.tar.gz | 167.3 kB | Without provenance | Details for foxbms_fox_cli-1.12.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| foxbms_fox_cli-1.12.0-py3-none-any.whl | Python 3 | none | any | Details for foxbms_fox_cli-1.12.0-py3-none-any.whl |
Total release size: 474.6 kB
Release files / foxbms_fox_cli-1.12.0.tar.gz
| Download URL | foxbms_fox_cli-1.12.0.tar.gz |
|---|---|
| Size | 167.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5af204064d41581fd3928a22877a6b0cc70e42dbcacdd6d0f52bf1eee5804a29
|
|
BLAKE2b-256 checksum How to use checksums |
e6cf4f1e5f01aa3adbbe01cdf127e1aba46f85c357b3428c6181760c4d29d55d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Release files / foxbms_fox_cli-1.12.0-py3-none-any.whl
| Download URL | foxbms_fox_cli-1.12.0-py3-none-any.whl |
|---|---|
| Size | 307.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4e14a58006e718031eb3aac20d92a9a4ce5d9e7dfb15a656053ffc8dd0f5a27b
|
|
BLAKE2b-256 checksum How to use checksums |
f3a34d138460bf0b31fe9f11f5562e4d7bbbb4397c8f5c041d3646659fecdb35
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Security for foxbms-fox-cli 1.12.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.