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

Configuration for the algorithm module. More...

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

Go to the source code of this file.

Functions

void ALGO_MarkAsDone (uint32_t algorithmIndex)
 Mark the current algorithm as done (will reset to ALGO_READY if possible) More...
 

Variables

ALGO_TASKS_s algo_algorithms []
 
const uint16_t algo_length = sizeof(algo_algorithms) / sizeof(algo_algorithms[0])
 

Detailed Description

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

Definition in file algorithm_cfg.c.

Function Documentation

◆ ALGO_MarkAsDone()

void ALGO_MarkAsDone ( uint32_t  algorithmIndex)

Mark the current algorithm as done (will reset to ALGO_READY if possible)

Parameters
[in]algorithmIndexindex entry of the algorithm

Definition at line 78 of file algorithm_cfg.c.

Variable Documentation

◆ algo_algorithms

ALGO_TASKS_s algo_algorithms[]
Initial value:
= {
}
@ ALGO_UNINITIALIZED
Definition: algorithm_cfg.h:81
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:66
void ALGO_MovAverage()

array of algorithms that should be executed

Definition at line 66 of file algorithm_cfg.c.

◆ algo_length

const uint16_t algo_length = sizeof(algo_algorithms) / sizeof(algo_algorithms[0])

number of executed algorithms

Definition at line 70 of file algorithm_cfg.c.