foxBMS  1.2.0
The foxBMS Battery Management System API Documentation
soe_debug.c File Reference

SOE module responsible for calculation of state-of-energy (SOE) More...

#include "soe_debug.h"
Include dependency graph for soe_debug.c:

Go to the source code of this file.

Functions

void SOE_Init (DATA_BLOCK_SOX_s *pSoeValues, bool ec_present, uint8_t stringNumber)
 initializes startup state-of-energy (SOE) related values More...
 
void SOE_Calculation (DATA_BLOCK_SOX_s *pSoeValues)
 periodically called algorithm to calculate state-of-energy (SOE) More...
 

Detailed Description

SOE module responsible for calculation of state-of-energy (SOE)

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-10-14 (date of creation)
Updated
2020-10-14 (date of last update)
Prefix
SOE

Definition in file soe_debug.c.

Function Documentation

◆ SOE_Calculation()

void SOE_Calculation ( DATA_BLOCK_SOX_s pSoeValues)

periodically called algorithm to calculate state-of-energy (SOE)

Parameters
[out]pSoeValuespointer to SOE database entry

Definition at line 73 of file soe_debug.c.

◆ SOE_Init()

void SOE_Init ( DATA_BLOCK_SOX_s pSoeValues,
bool  ec_present,
uint8_t  stringNumber 
)

initializes startup state-of-energy (SOE) related values

Parameters
[out]pSoeValuespointer to SOE database entry
[in]ec_presenttrue if current sensor EC message received, false otherwise
[in]stringNumberstring addressed

Definition at line 68 of file soe_debug.c.