foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
Macros | Functions
sys_cfg.h File Reference
Engine configuration

Sys driver configuration header. More...

#include <stdint.h>
Include dependency graph for sys_cfg.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define SYS_TASK_CYCLE_CONTEXT_MS   (10u)
 
#define SYS_FSM_SHORT_TIME   (1u)
 
#define SYS_FSM_MEDIUM_TIME   (5u)
 
#define SYS_FSM_LONG_TIME   (10u)
 
#define SYS_STATEMACH_INITIALIZATION_REQUEST_RETRY_COUNTER   (3u)
 
#define SYS_STATEMACH_INITIALIZATION_TIMEOUT_MS   (200u)
 
#define SYS_STATEMACH_IMD_INITIALIZATION_TIMEOUT_MS   (500u)
 
#define SYS_STATEMACH_BAL_INITIALIZATION_TIMEOUT_MS   (500u)
 
#define SYS_STATEMACHINE_SBC_INIT_TIMEOUT_MS   (1000u)
 

Functions

void SYS_SendBootMessage (void)
 Function to send out boot message with SW version. More...
 

Detailed Description

Sys driver configuration header.

Copyright
© 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved.

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-02-24 (date of creation)
Updated
2023-10-12 (date of last update)
Version
v1.6.0
Prefix
SYS

Definition in file sys_cfg.h.

Macro Definition Documentation

◆ SYS_FSM_LONG_TIME

#define SYS_FSM_LONG_TIME   (10u)

SYS state machine long time definition in SYS_Trigger() calls until next state/substate is processed

Definition at line 88 of file sys_cfg.h.

◆ SYS_FSM_MEDIUM_TIME

#define SYS_FSM_MEDIUM_TIME   (5u)

SYS state machine medium time definition in SYS_Trigger() calls until next state/substate is processed

Definition at line 82 of file sys_cfg.h.

◆ SYS_FSM_SHORT_TIME

#define SYS_FSM_SHORT_TIME   (1u)

SYS state machine short time definition in SYS_Trigger() calls until next state/substate is processed

Definition at line 76 of file sys_cfg.h.

◆ SYS_STATEMACH_BAL_INITIALIZATION_TIMEOUT_MS

#define SYS_STATEMACH_BAL_INITIALIZATION_TIMEOUT_MS   (500u)

SYS state machine BAL initialization timeout

Definition at line 100 of file sys_cfg.h.

◆ SYS_STATEMACH_IMD_INITIALIZATION_TIMEOUT_MS

#define SYS_STATEMACH_IMD_INITIALIZATION_TIMEOUT_MS   (500u)

SYS state machine IMD initialization timeout

Definition at line 97 of file sys_cfg.h.

◆ SYS_STATEMACH_INITIALIZATION_REQUEST_RETRY_COUNTER

#define SYS_STATEMACH_INITIALIZATION_REQUEST_RETRY_COUNTER   (3u)

SYS state machine initialization request retry counter

Definition at line 91 of file sys_cfg.h.

◆ SYS_STATEMACH_INITIALIZATION_TIMEOUT_MS

#define SYS_STATEMACH_INITIALIZATION_TIMEOUT_MS   (200u)

SYS state machine initialization timeout

Definition at line 94 of file sys_cfg.h.

◆ SYS_STATEMACHINE_SBC_INIT_TIMEOUT_MS

#define SYS_STATEMACHINE_SBC_INIT_TIMEOUT_MS   (1000u)

SYS state machine SBC initialization timeout

Definition at line 103 of file sys_cfg.h.

◆ SYS_TASK_CYCLE_CONTEXT_MS

#define SYS_TASK_CYCLE_CONTEXT_MS   (10u)

This define MUST represent the cycle time of the task in which context the functions run, e.g., if the SYS_Trigger() is running in the 10 ms task then the define must be set to 10.

This define also sets the minimum time.

Definition at line 70 of file sys_cfg.h.

Function Documentation

◆ SYS_SendBootMessage()

void SYS_SendBootMessage ( void  )

Function to send out boot message with SW version.

Definition at line 74 of file sys_cfg.c.

Here is the call graph for this function: