Metadata-Version: 2.4
Name: foxbms-fox-cli
Version: 1.11.0
Summary: CLI tools for foxBMS 2
Project-URL: Homepage, https://foxbms.org/
Project-URL: Documentation, https://docs.foxbms.org/
Project-URL: Repository, https://github.com/foxBMS/foxbms-2
Author-email: foxBMS Team <info@foxbms.org>
License-Expression: BSD-3-Clause
License-File: BSD-3-Clause.txt
License-File: CC-BY-4.0.txt
License-File: LICENSE.md
Keywords: battery,foxBMS
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Embedded Systems
Requires-Python: >=3.12
Requires-Dist: alabaster==1.0.0
Requires-Dist: argparse-addons==0.12.0
Requires-Dist: astroid==3.3.11
Requires-Dist: attrs==25.3.0
Requires-Dist: babel==2.17.0
Requires-Dist: bitstruct==8.21.0
Requires-Dist: build==1.3.0
Requires-Dist: cantools==40.6.0
Requires-Dist: certifi==2025.8.3
Requires-Dist: cfgv==3.4.0
Requires-Dist: charset-normalizer==3.4.3
Requires-Dist: clang-format==21.1.1
Requires-Dist: click==8.3.0
Requires-Dist: colorama==0.4.6
Requires-Dist: colorlog==6.9.0
Requires-Dist: contourpy==1.3.3
Requires-Dist: coverage==7.10.7
Requires-Dist: crccheck==1.3.1
Requires-Dist: cycler==0.12.1
Requires-Dist: dill==0.4.0
Requires-Dist: diskcache==5.6.3
Requires-Dist: distlib==0.4.0
Requires-Dist: docopt==0.6.2
Requires-Dist: docutils==0.21.2
Requires-Dist: filelock==3.19.1
Requires-Dist: fonttools==4.60.0
Requires-Dist: gcovr==8.4
Requires-Dist: gitdb==4.0.12
Requires-Dist: gitpython==3.1.45
Requires-Dist: hatchling==1.27.0
Requires-Dist: identify==2.6.14
Requires-Dist: idna==3.10
Requires-Dist: imagesize==1.4.1
Requires-Dist: isort==6.0.1
Requires-Dist: jinja2==3.1.6
Requires-Dist: joblib==1.5.2
Requires-Dist: jsonschema-specifications==2025.9.1
Requires-Dist: jsonschema==4.25.1
Requires-Dist: kiwisolver==1.4.9
Requires-Dist: latexcodec==3.0.1
Requires-Dist: lauterbach-trace32-rcl==1.1.4
Requires-Dist: lxml==6.0.2
Requires-Dist: markupsafe==3.0.2
Requires-Dist: matplotlib==3.10.6
Requires-Dist: mccabe==0.7.0
Requires-Dist: mypy-extensions==1.1.0
Requires-Dist: mypy==1.18.2
Requires-Dist: nodeenv==1.9.1
Requires-Dist: numpy==2.3.3
Requires-Dist: packaging==25.0
Requires-Dist: paho-mqtt==2.1.0
Requires-Dist: pandas-stubs==2.3.2.250827
Requires-Dist: pandas==2.3.2
Requires-Dist: pathspec==0.12.1
Requires-Dist: pillow==11.3.0
Requires-Dist: pipdeptree==2.28.0
Requires-Dist: platformdirs==4.4.0
Requires-Dist: pre-commit==4.3.0
Requires-Dist: pyarrow==21.0.0
Requires-Dist: pybtex-docutils==1.0.3
Requires-Dist: pybtex==0.25.1
Requires-Dist: pygments==2.19.2
Requires-Dist: pykwalify==1.8.0
Requires-Dist: pylint==3.3.8
Requires-Dist: pymodbus==3.4.0
Requires-Dist: pyparsing==3.2.5
Requires-Dist: pyproject-hooks==1.2.0
Requires-Dist: pyright==1.1.405
Requires-Dist: pyrsistent==0.20.0
Requires-Dist: pyserial==3.5
Requires-Dist: python-can==4.6.1
Requires-Dist: python-dateutil==2.9.0.post0
Requires-Dist: pytz==2025.2
Requires-Dist: pyvisa==1.15.0
Requires-Dist: pywin32==311; platform_system == 'Windows'
Requires-Dist: pyyaml==6.0.2
Requires-Dist: referencing==0.36.2
Requires-Dist: requests==2.32.5
Requires-Dist: roman-numerals-py==3.1.0
Requires-Dist: rpds-py==0.27.1
Requires-Dist: rsinstrument==1.102.0
Requires-Dist: ruamel-yaml-clib==0.2.14
Requires-Dist: ruamel-yaml==0.18.15
Requires-Dist: ruff==0.13.2
Requires-Dist: scienceplots==2.1.1
Requires-Dist: scipy==1.16.2
Requires-Dist: setuptools==80.9.0
Requires-Dist: six==1.17.0
Requires-Dist: smmap==5.0.2
Requires-Dist: snowballstemmer==3.0.1
Requires-Dist: sphinx-rtd-theme==3.0.2
Requires-Dist: sphinx-tabs==3.4.7
Requires-Dist: sphinx==8.2.3
Requires-Dist: sphinxcontrib-applehelp==2.0.0
Requires-Dist: sphinxcontrib-bibtex==2.6.5
Requires-Dist: sphinxcontrib-devhelp==2.0.0
Requires-Dist: sphinxcontrib-drawio==0.0.17
Requires-Dist: sphinxcontrib-htmlhelp==2.1.0
Requires-Dist: sphinxcontrib-jquery==4.1
Requires-Dist: sphinxcontrib-jsmath==1.0.1
Requires-Dist: sphinxcontrib-qthelp==2.0.0
Requires-Dist: sphinxcontrib-serializinghtml==2.0.0
Requires-Dist: textparser==0.24.0
Requires-Dist: tomlkit==0.13.3
Requires-Dist: types-colorama==0.4.15.20250801
Requires-Dist: types-jsonschema==4.25.1.20250822
Requires-Dist: types-pytz==2025.2.0.20250809
Requires-Dist: types-pyyaml==6.0.12.20250915
Requires-Dist: typing-extensions==4.15.0
Requires-Dist: tzdata==2025.2
Requires-Dist: uptime==3.0.1
Requires-Dist: urllib3==2.5.0
Requires-Dist: virtualenv==20.34.0
Requires-Dist: wrapt==1.17.3
Description-Content-Type: text/markdown

# 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:

- [latest documentation build (of the most recent release)](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen2/docs/html/latest/)
- [list of all available documentation builds](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen2/docs/html/)

## Changelog

The project changelog is found in
[docs/general/changelog.rst](./docs/general/changelog.rst).

## Installation Instructions

See [INSTALL.md](./INSTALL.md) for installation instructions.

## 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)            | CLI tool to interact with the repository                                                                                        |
| [`conf`](./conf)          | Contains all high level configurations                                                                                          |
| [`docs`](./docs)          | Documentation source files                                                                                                      |
| [`hardware`](./hardware)  | Hardware schematic and layout information                                                                                       |
| [`src`](./src)            | Parent directory for all source files for the BMS embedded software                                                             |
| [`tests`](./tests)        | Tests for embedded sources, the tool chain, and scripts                                                                         |
| [`tools`](./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](./LICENSE.md).

Basically, the software is covered by the
[**BSD 3-Clause License (SPDX short identifier: BSD-3-Clause)**](https://opensource.org/licenses/BSD-3-Clause)
and the hardware and documentation by the
[**Creative Commons Attribution 4.0 International License (SPDX short identifier: CC-BY-4.0)**](https://creativecommons.org/licenses/by/4.0/legalcode).

## Open Source Hardware Certification

foxBMS 2 has been certified as open source hardware by the
Open Source Hardware Association under the OSHWA UID
[DE000128](https://certification.oshwa.org/de000128.html).

## Acknowledgment

For funding acknowledgements and instructions on how to acknowledge foxBMS 2
please see [foxbms.org/acknowledgements](https://foxbms.org/acknowledgements/).
