# foxbms-1

**Repository Path**: yeatech/foxbms-1

## Basic Information

- **Project Name**: foxbms-1
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-27
- **Last Updated**: 2024-07-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# foxBMS

> **_NOTE:_**
> - This is the repository 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)

foxBMS is a free, open and flexible development environment to design battery
management systems. It is the first modular open source BMS development
platform.

The foxconda environment: This environment provides all the tools necessary
to generate the documentation, compile the code for the MCUs and flash the
generated binaries on the MCUs (e.g., ``Python``, ``git``, ``GCC``). foxconda
can be downloaded [here](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/).

The starting point to get foxBMS is the foxBMS repository at
[https://github.com/foxBMS/foxbms-1](https://github.com/foxBMS/foxbms-1), which
contains all files for the foxBMS project.

## foxBMS Repository

- In `foxbms\documentation` the configuration of the doxygen documentation for
  the primary and secondary MCU can be found.
- The software for the MCUs is found in `foxbms\embedded-software`. This
  includes the Hardware Abstraction Layer (HAL), the real-time operating system
  FreeRTOS and the BMS application itself.
- The layout and schematic files for the foxBMS hardware are found in the
  `foxbms\hardware`.
- The build toolchain and other tools related to foxBMS are found in
  `foxbms\tools`.

A generated version of the Sphinx documentation can be found at
[iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest](https://iisb-foxbms.iisb.fraunhofer.de/foxbms/gen1/docs/html/latest).
It explains the structure of the foxBMS hardware, how to install the foxconda
environment and how to use foxconda to compile and flash the sources.

## Building the Sources

For building the software, open a shell and type ``python tools\waf --help``.
All available build options will be displayed. The top build directory is
``foxbms\build``.

[foxbms.org/](https://foxbms.org/)