The foxBMS secondary mcu API documentation
General user configuration

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
 

Detailed Description

Contains the general software user configuration, e.g. what security features to include.

Macro Definition Documentation

◆ BUILD_ALLOW_DIRTY_STARTUP

#define BUILD_ALLOW_DIRTY_STARTUP   1

allows the MCU to startup altough the binary is from a dirty repository (no remote or git status was not clean)

Type:
select(2)
Default:
1

◆ BUILD_MODULE_DEBUGPRINTF

#define BUILD_MODULE_DEBUGPRINTF   1

enables printf debugging with serial interface

Type:
select(2)
Default:
0

◆ BUILD_MODULE_ENABLE_COM

#define BUILD_MODULE_ENABLE_COM   1

enables COM module.

Type:
select(2)
Default:
0

◆ BUILD_MODULE_ENABLE_CONTACTOR

#define BUILD_MODULE_ENABLE_CONTACTOR   0

enables CONTACTOR module

Type:
select(2)
Default:
0

◆ BUILD_MODULE_ENABLE_FLASHCHECKSUM

#define BUILD_MODULE_ENABLE_FLASHCHECKSUM   1

enables checking of flash checksum at startup.

Type:
select(2)
Default:
0

◆ BUILD_MODULE_ENABLE_ILCK

#define BUILD_MODULE_ENABLE_ILCK   1

enables INTERLOCK module

Type:
select(2)
Default:
0

◆ BUILD_MODULE_ENABLE_ISOGUARD

#define BUILD_MODULE_ENABLE_ISOGUARD   0

enables ISOGUARD module.

Type:
select(2)
Default:
0

◆ BUILD_MODULE_ENABLE_NVRAM

#define BUILD_MODULE_ENABLE_NVRAM   0

enables NVRAM

Type:
select(2)
Default:
0

◆ BUILD_MODULE_ENABLE_RS485

#define BUILD_MODULE_ENABLE_RS485   1

enables RS485: USART2 peripheral (serial interface)

Type:
select(2)
Default:
0

◆ BUILD_MODULE_ENABLE_RTC

#define BUILD_MODULE_ENABLE_RTC   1

enables RTC peripheral (Real Time Clock)

Type:
select(2)
Default:
0

◆ BUILD_MODULE_ENABLE_RUNTIMESTATS

#define BUILD_MODULE_ENABLE_RUNTIMESTATS   0

enables the generation of FreeRTOS runtime statistics at the expense of (maybe) slightly reduced system performance

◆ BUILD_MODULE_ENABLE_UART

#define BUILD_MODULE_ENABLE_UART   1

enables Mini-USB: USART3 peripheral (serial interface)

Type:
select(2)
Default:
0

◆ BUILD_MODULE_ENABLE_WATCHDOG

#define BUILD_MODULE_ENABLE_WATCHDOG   1

enables MCU Watchdog

Type:
select(2)
Default:
1