foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
bal_cfg.h File Reference

Header for the configuration for the driver for balancing. More...

#include <stdint.h>
Include dependency graph for bal_cfg.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define BAL_STATEMACH_SHORTTIME_100ms   (1u)
 
#define BAL_STATEMACH_LONGTIME_100ms   (50u)
 
#define BAL_STATEMACH_BALANCINGTIME_100ms   (10u)
 
#define BAL_DEFAULT_THRESHOLD_mV   (200)
 
#define BAL_MAXIMUM_THRESHOLD_mV   (5000)
 
#define BAL_MINIMUM_THRESHOLD_mV   (0)
 
#define BAL_HYSTERESIS_mV   (200)
 
#define BAL_LOWER_VOLTAGE_LIMIT_mV   (2000)
 
#define BAL_UPPER_TEMPERATURE_LIMIT_ddegC   (700)
 

Functions

void BAL_SetBalancingThreshold (int32_t threshold_mV)
 set balancing threshold More...
 
int32_t BAL_GetBalancingThreshold_mV (void)
 get balancing threshold More...
 

Detailed Description

Header for the configuration for the driver for balancing.

SPDX-License-Identifier: BSD-3-Clause

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
2020-02-24 (date of creation)
Updated
2023-10-12 (date of last update)
Version
v1.6.0
Prefix
BAL

Definition in file bal_cfg.h.

Macro Definition Documentation

◆ BAL_DEFAULT_THRESHOLD_mV

#define BAL_DEFAULT_THRESHOLD_mV   (200)

default value for the BAL voltage threshold

Definition at line 75 of file bal_cfg.h.

◆ BAL_HYSTERESIS_mV

#define BAL_HYSTERESIS_mV   (200)

BAL hysteresis for voltage threshold when balancing was finished in mV

Definition at line 84 of file bal_cfg.h.

◆ BAL_LOWER_VOLTAGE_LIMIT_mV

#define BAL_LOWER_VOLTAGE_LIMIT_mV   (2000)

BAL lower voltage limit in MV

Definition at line 87 of file bal_cfg.h.

◆ BAL_MAXIMUM_THRESHOLD_mV

#define BAL_MAXIMUM_THRESHOLD_mV   (5000)

maximum value that BAL voltage threshold may take

Definition at line 78 of file bal_cfg.h.

◆ BAL_MINIMUM_THRESHOLD_mV

#define BAL_MINIMUM_THRESHOLD_mV   (0)

minimum value that BAL voltage threshold may take

Definition at line 81 of file bal_cfg.h.

◆ BAL_STATEMACH_BALANCINGTIME_100ms

#define BAL_STATEMACH_BALANCINGTIME_100ms   (10u)

BAL state machine balancing time in 100*ms

Definition at line 72 of file bal_cfg.h.

◆ BAL_STATEMACH_LONGTIME_100ms

#define BAL_STATEMACH_LONGTIME_100ms   (50u)

BAL state machine long time definition in 100*ms

Definition at line 69 of file bal_cfg.h.

◆ BAL_STATEMACH_SHORTTIME_100ms

#define BAL_STATEMACH_SHORTTIME_100ms   (1u)

BAL state machine short time definition in 100*ms

Definition at line 65 of file bal_cfg.h.

◆ BAL_UPPER_TEMPERATURE_LIMIT_ddegC

#define BAL_UPPER_TEMPERATURE_LIMIT_ddegC   (700)

BAL upper temperature limit in deci °C

Definition at line 90 of file bal_cfg.h.

Function Documentation

◆ BAL_GetBalancingThreshold_mV()

int32_t BAL_GetBalancingThreshold_mV ( void  )

get balancing threshold

Returns
balancing threshold in mV

Definition at line 88 of file bal_cfg.c.

◆ BAL_SetBalancingThreshold()

void BAL_SetBalancingThreshold ( int32_t  threshold_mV)

set balancing threshold

Parameters
[in]threshold_mVthreshold in mV

Definition at line 75 of file bal_cfg.c.

Here is the call graph for this function: