foxBMS 2 - 1.11.0

Introduction

1. Motivation
2. Naming Conventions
3. The foxBMS 2 Platform
4. Use Case

Getting Started

1. Repository Structure
2. Software Installation
3. fox CLI Basics
4. Creating a Workspace
5. First Steps on Hardware

Software Documentation

1. Configuration
2. Building the Application
3. Software Structure
4. Software Modules
5. Unit Tests
6. Build Process
7. Build Environment
8. How-to
9. Linker Script
10. Bootloader

Hardware Documentation

1. Hardware
2. Design Resources
3. Connectors
4. BMS-Masters Overview
5. BMS-Slaves Overview
6. BMS-Interfaces Overview

System Documentation

1. System Introduction
2. System Voltage And Current Monitoring
3. Precharging
4. IMD Testing
5. Communication

Tools Documentation

1. fox CLI Usage
2. Waf Tools
3. Debugging the Application
4. TI HALCoGen Tool

Developer Manual

1. Preface
2. Style Guide
3. Software Developer Manual
4. Hardware Developer Manual
5. Developing fox CLI
6. Dependency Management
7. Release Management

General Information

1. License
2. Changelog
3. Releases
4. Safety
5. Abbreviations and Definitions
6. Acknowledgements
7. Bibliography
8. Team

foxBMS 2 - 1.11.0

5. Developing fox CLI
5.3. fox CLI API
5.3.1. cli
5.3.1.24. cli.helpers
5.3.1.24.6. cli.helpers.config
View page source

5.3.1.24.6. cli.helpers.config

Utilities for loading YAML-based configuration files.

Functions

read_config(config)

Read a YAML configuration file.

Fork me on GitHub

Previous Next

© Copyright 2010 - 2026, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved. See license section for further information..

Built with Sphinx using a theme provided by Read the Docs.