foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
algorithm.c File Reference

Main module to handle the execution of algorithms. More...

#include "algorithm.h"
#include "os.h"
Include dependency graph for algorithm.c:

Go to the source code of this file.

Functions

static void ALGO_Initialization (void)
 initializes local variables and module internals needed to use the algorithm module More...
 
void ALGO_UnlockInitialization (void)
 Calling this function sets a signal that lets ALGO_Initialization() know that the initialization has to be run. More...
 
void ALGO_MainFunction (void)
 handles the call of different algorithm functions when cycle time has expired More...
 
void ALGO_MonitorExecutionTime (void)
 monitors the calculation duration of the different algorithms More...
 
void TEST_ALGO_ResetInitializationRequest ()
 

Variables

static bool algo_initializationRequested = false
 

Detailed Description

Main module to handle the execution of algorithms.

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
2017-12-18 (date of creation)
Updated
2020-06-30 (date of last update)
Prefix
ALGO

Definition in file algorithm.c.

Function Documentation

◆ ALGO_Initialization()

static void ALGO_Initialization ( void  )
static

initializes local variables and module internals needed to use the algorithm module

Definition at line 79 of file algorithm.c.

◆ ALGO_MainFunction()

void ALGO_MainFunction ( void  )

handles the call of different algorithm functions when cycle time has expired

Definition at line 111 of file algorithm.c.

Here is the call graph for this function:

◆ ALGO_MonitorExecutionTime()

void ALGO_MonitorExecutionTime ( void  )

monitors the calculation duration of the different algorithms

Definition at line 143 of file algorithm.c.

Here is the call graph for this function:

◆ ALGO_UnlockInitialization()

void ALGO_UnlockInitialization ( void  )

Calling this function sets a signal that lets ALGO_Initialization() know that the initialization has to be run.

Definition at line 105 of file algorithm.c.

Here is the call graph for this function:

◆ TEST_ALGO_ResetInitializationRequest()

void TEST_ALGO_ResetInitializationRequest ( void  )

Definition at line 159 of file algorithm.c.

Variable Documentation

◆ algo_initializationRequested

bool algo_initializationRequested = false
static

This is a signal that skips initialization of ALGO_Initialization() until it has been requested.

Definition at line 67 of file algorithm.c.