foxBMS - Unit Tests  1.3.0
The foxBMS Unit Tests API Documentation
bal_strategy_none.c File Reference

WEAK Driver for the Balancing module for ICs that to not support balancing. More...

#include "bal.h"
Include dependency graph for bal_strategy_none.c:

Go to the source code of this file.

Functions

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...
 

Detailed Description

WEAK Driver for the Balancing module for ICs that to not support 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-07-02 (date of creation)
Updated
2022-05-30 (date of last update)
Version
v1.3.0
Prefix
BAL

Definition in file bal_strategy_none.c.

Function Documentation

◆ 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 70 of file bal_strategy_none.c.

◆ 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 75 of file bal_strategy_none.c.

◆ 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 81 of file bal_strategy_none.c.