foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
bal_strategy_voltage.c File Reference

Driver for the Balancing module. More...

#include "bal_strategy_voltage.h"
#include "battery_cell_cfg.h"
#include "bms.h"
#include "database.h"
#include "os.h"
Include dependency graph for bal_strategy_voltage.c:

Go to the source code of this file.

Functions

static bool BAL_ActivateBalancing (void)
 Activates voltage based balancing. More...
 
static void BAL_Deactivate (void)
 Deactivates voltage based balancing. More...
 
static void BAL_ProcessStateCheckBalancing (BAL_STATE_REQUEST_e state_request)
 State machine subfunction to check if balancing is allowed. More...
 
static void BAL_ProcessStateBalancing (BAL_STATE_REQUEST_e state_request)
 State machine subfunction to balance the battery cell. More...
 
STD_RETURN_TYPE_e BAL_GetInitializationState (void)
 gets the initialization state. More...
 
BAL_RETURN_TYPE_e BAL_SetStateRequest (BAL_STATE_REQUEST_e stateRequest)
 sets the current state request of the state variable bal_state. More...
 
void BAL_Trigger (void)
 trigger function for the BAL driver state machine. More...
 

Variables

static DATA_BLOCK_BALANCING_CONTROL_s bal_balancing = {.header.uniqueId = DATA_BLOCK_ID_BALANCING_CONTROL}
 
static BAL_STATE_s bal_state
 contains the state of the contactor state machine More...
 

Detailed Description

Driver for the Balancing module.

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-05-29 (date of creation)
Updated
2020-07-31 (date of last update)
Prefix
BAL

Definition in file bal_strategy_voltage.c.

Function Documentation

◆ BAL_ActivateBalancing()

static bool BAL_ActivateBalancing ( void  )
static

Activates voltage based balancing.

TODO

Definition at line 119 of file bal_strategy_voltage.c.

◆ BAL_Deactivate()

static void BAL_Deactivate ( void  )
static

Deactivates voltage based balancing.

The balancing state of all cells in all strings set to inactivate (that is 0) and the delta charge is set to 0 As. The balancing enable bit is deactivate (that is 0).

Definition at line 148 of file bal_strategy_voltage.c.

◆ BAL_GetInitializationState()

STD_RETURN_TYPE_e BAL_GetInitializationState ( void  )

gets the initialization state.

This function is used for getting the balancing initialization state

Returns
STD_OK if initialized, otherwise STD_NOT_OK

Definition at line 269 of file bal_strategy_voltage.c.

◆ BAL_ProcessStateBalancing()

static void BAL_ProcessStateBalancing ( BAL_STATE_REQUEST_e  state_request)
static

State machine subfunction to balance the battery cell.

TODO

Definition at line 183 of file bal_strategy_voltage.c.

Here is the call graph for this function:

◆ BAL_ProcessStateCheckBalancing()

static void BAL_ProcessStateCheckBalancing ( BAL_STATE_REQUEST_e  state_request)
static

State machine subfunction to check if balancing is allowed.

Checks if balancing is allowed. If it is it transfers in the actual balancing state.

Definition at line 162 of file bal_strategy_voltage.c.

Here is the call graph for this function:

◆ BAL_SetStateRequest()

BAL_RETURN_TYPE_e BAL_SetStateRequest ( BAL_STATE_REQUEST_e  stateRequest)

sets the current state request of the state variable bal_state.

This function is used to make a state request to the state machine, e.g, start voltage measurement, read result of voltage measurement, re-initialization. It calls BAL_CheckStateRequest() to check if the request is valid. The state request is rejected if is not valid. The result of the check is returned immediately, so that the requester can act in case it made a non-valid state request.

Parameters
stateRequeststate request to set
Returns
current state request

Definition at line 273 of file bal_strategy_voltage.c.

Here is the call graph for this function:

◆ BAL_Trigger()

void BAL_Trigger ( void  )

trigger function for the BAL driver state machine.

This function contains the sequence of events in the BAL state machine. It must be called time-triggered, every 100 milliseconds.

Definition at line 287 of file bal_strategy_voltage.c.

Here is the call graph for this function:

Variable Documentation

◆ bal_balancing

DATA_BLOCK_BALANCING_CONTROL_s bal_balancing = {.header.uniqueId = DATA_BLOCK_ID_BALANCING_CONTROL}
static

local storage of the DATA_BLOCK_BALANCING_CONTROL_s table

Definition at line 67 of file bal_strategy_voltage.c.

◆ bal_state

BAL_STATE_s bal_state
static
Initial value:
= {
.timer = 0,
.stateRequest = BAL_STATE_NO_REQUEST,
.substate = BAL_ENTRY,
.lastSubstate = 0,
.triggerEntry = 0,
.errorRequestCounter = 0,
.initializationFinished = STD_NOT_OK,
.active = false,
.balancingThreshold = BAL_THRESHOLD_mV + BAL_HYSTERESIS_mV,
.balancingAllowed = true,
.balancingGlobalAllowed = false,
}
@ BAL_STATEMACH_UNINITIALIZED
Definition: bal.h:70
@ BAL_ENTRY
Definition: bal.h:88
@ BAL_STATE_NO_REQUEST
Definition: bal.h:106
#define BAL_THRESHOLD_mV
Definition: bal_cfg.h:73
#define BAL_HYSTERESIS_mV
Definition: bal_cfg.h:76
@ STD_NOT_OK
Definition: fstd_types.h:73

contains the state of the contactor state machine

Definition at line 72 of file bal_strategy_voltage.c.