foxBMS 2 - 1.8.0

General Information

1. Releases
2. Changelog
3. Motivation
4. Safety
5. License
6. Team

Introduction

1. Abbreviations and Definitions
2. Naming Conventions
3. The foxBMS 2 Platform
4. Use Case

Getting Started

1. Getting Started with foxBMS 2
2. Repository Structure
3. Software Installation
4. fox CLI
5. Creating a Workspace
6. First Steps on Hardware

Software Documentation

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

Hardware Documentation

1. Hardware
2. Design Resources
3. Connectors
4. Master Overview
5. Slaves Overview
6. Interfaces Overview

System Documentation

1. System Introduction
2. Conditions that lead to a transition to ERROR state
3. System Voltage And Current Monitoring
4. Precharging
5. IMD Testing

Tools Documentation

1. fox.py
- 1.1. cli
2. DBC File
3. Waf Tools
4. Debugging the Application
5. HALCoGen tool documentation
6. Axivion Bauhaus Suite

Developer Manual

1. Preface
2. Style Guide
3. Software Developer Manual
4. Hardware Developer Manual
5. Public Release Process

Miscellaneous Information

1. Acknowledgements
2. Indices and Tables
3. Bibliography

foxBMS 2 - 1.8.0

1. fox.py
1.1. cli
1.1.11. cli.cmd_misc
1.1.11.3. cli.cmd_misc.doc_example
View page source

1.1.11.3. cli.cmd_misc.doc_example

Uses waf to build the documentation example

Functions

run_doc_build()

build the documentation example source code in docs/software/unit-tests.

Fork me on GitHub

Previous Next

© Copyright 2010 - 2024, 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.