Attention
- This is the documentation of the first generation of foxBMS (https://github.com/foxBMS/foxbms-1)
- The second generation of foxBMS (foxBMS 2) is also found on Github (https://github.com/foxBMS/foxbms-2)
Welcome to the foxBMS documentation of the first modular open source BMS development platform from the Fraunhofer IISB. is a free, open and flexible development environment to design state-of-the-art complex battery management systems.
Note
The present version of the Sphinx documentation is . It is available in HTML at https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest/. More detailed information on the version history can be found in the general_information_releases section. This documentation was generated on .
Warning
The hardware and software is under permanent development. The free and open research and development platform as presented in the documentation hereafter is not provided to be used without any adaptions (e.g., to fulfill mandatory regulations) in consumer products, electric vehicles, production environments or any similar usages: it is only intended to be used by skilled professionals trained in designing battery system prototypes.
The documentation is divided in 4 parts:
general_informationgetting_startedsoftware_documentationhardware_documentation
In the first part of the documentation, general information about can be found (general_information):
- Information about the versions and the related release notes of
- Licenses of the hardware, software and document parts of
- Motivation behind the initiative
- Overview of the hardware and software of
- Roadmap of the upcoming hardware and software components
- Team involved in the development of
In the second part of the documentation, the getting_started guide can be followed to commission rapidly. For getting desktop software, obtaining and compiling the sources, and setting up a short test of hard- and software the minium sections to be read are sections 1 to 4 of getting_started
- The location of the electronic schematic and layout files in the HTML documentation is indicated
- The hardware guide describes how the hardware is structured and works
- The software guide explains how to configure and flash the software
- The CAN documentation shows how to communicate with the system via the CAN bus
To study and modify the software, the software_documentation presents the structure of the software and of the most important modules, how the basic tasks are running and how to call user-defined functions. Further, a FAQ is provided to answers the most common questions. A detailed description of the software functions and variables can be found in the documentation.
Finally, the hardware_documentation gives the details needed to understand the hardware.
./general_information/releases/releases.rst ./general_information/changelog/changelog.rst ./general_information/overview/overview.rst ./general_information/motivation/motivation.rst ./general_information/safety/safety.rst ./general_information/licenses/licenses.rst ./general_information/team/team.rst
./getting_started/general/general.rst ./getting_started/foxconda/foxconda.rst ./getting_started/build/build.rst ./getting_started/eclipse_workspace/eclipse_workspace.rst ./getting_started/cabling/cabling.rst ./getting_started/connectors/connectors.rst ./getting_started/communicating/communicating.rst ./getting_started/checking/checking.rst
./hardware_documentation/specifications/specifications.rst ./hardware_documentation/master-unit/master-unit.rst ./hardware_documentation/slaves/slaves.rst ./hardware_documentation/design_resources/design_resources.rst ./hardware_documentation/components/components.rst ./hardware_documentation/bjb/bjb.rst ./hardware_documentation/toolchain/toolchain.rst ./hardware_documentation/casing/casing.rst
./software_documentation/components/components.rst ./software_documentation/architecture/architecture.rst ./software_documentation/overview/overview.rst ./software_documentation/parameters/monitored_parameters.rst ./software_documentation/defines/defines.rst ./software_documentation/modules/modules.rst ./software_documentation/tools/tools.rst ./software_documentation/build-process/build-process.rst ./software_documentation/styleguide/styleguide.rst ./software_documentation/faq/faq.rst