The foxBMS secondary mcu API documentation
general.h File Reference

Settings for the system. More...

#include <stdint.h>
#include <std_types.h>
#include "matlab_types.h"
#include "foxbmsconfig.h"
Include dependency graph for general.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define BUILD_MODULE_ENABLE_FLASHCHECKSUM   1
 
#define BUILD_MODULE_ENABLE_UART   1
 
#define BUILD_MODULE_ENABLE_RS485   1
 
#define BUILD_MODULE_ENABLE_NVRAM   0
 
#define BUILD_MODULE_ENABLE_COM   1
 
#define BUILD_MODULE_ENABLE_CONTACTOR   0
 
#define BUILD_MODULE_ENABLE_ILCK   1
 
#define BUILD_MODULE_ENABLE_ISOGUARD   0
 
#define BUILD_MODULE_DEBUGPRINTF   1
 
#define BUILD_MODULE_ENABLE_RTC   1
 
#define BUILD_MODULE_ENABLE_RUNTIMESTATS   0
 
#define BUILD_MODULE_ENABLE_WATCHDOG   1
 
#define BUILD_ALLOW_DIRTY_STARTUP   1
 
#define BUILD_MODULE_IMPORT_CELL_DATASHEET   0
 
#define BUILD_DIAG_ENABLE_TASK_STATISTICS   1
 Enable task statistics. More...
 
#define MEM_BKP_SRAM   __attribute__((section (".BKP_RAMSection")))
 

Detailed Description

Settings for the system.

BSD 3-Clause License Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

″This product uses parts of foxBMS®″

″This product includes parts of foxBMS®″

″This product is derived from foxBMS®″

Author
foxBMS Team
Date
25.02.2015 (date of creation)
Module-prefix none

e.g., enable modules, set software version

Macro Definition Documentation

◆ BUILD_DIAG_ENABLE_TASK_STATISTICS

#define BUILD_DIAG_ENABLE_TASK_STATISTICS   1

Enable task statistics.

If this define is set to 1, task statistics will be computed during runtime with diag_calc_runtime_stats().

◆ BUILD_MODULE_IMPORT_CELL_DATASHEET

#define BUILD_MODULE_IMPORT_CELL_DATASHEET   0

◆ MEM_BKP_SRAM

#define MEM_BKP_SRAM   __attribute__((section (".BKP_RAMSection")))

A variable defined as (type) MEM_BKP_SRAM (name) will be stored in the RAM which is backuped by a button cell. Therefore as long as the power supply is not disconnected, the variable value will be stored during e.g. restarts.