Header for the driver of the fake AFE driver. More...

#include "database_cfg.h"
#include "fstd_types.h"
#include <stdbool.h>
#include <stdint.h>

Include dependency graph for debug_default.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	FAKE_DATABASE_ENTRIES_s

struct	FAKE_STATE_s

Enumerations
enum	FAKE_FSM_STATES_e { FAKE_FSM_STATE_DUMMY , FAKE_FSM_STATE_HAS_NEVER_RUN , FAKE_FSM_STATE_UNINITIALIZED , FAKE_FSM_STATE_INITIALIZATION , FAKE_FSM_STATE_RUNNING , FAKE_FSM_STATE_ERROR }

enum	FAKE_FSM_SUBSTATES_e { FAKE_FSM_SUBSTATE_DUMMY , FAKE_FSM_SUBSTATE_ENTRY , FAKE_FSM_SUBSTATE_INITIALIZATION_FINISH_FIRST_MEASUREMENT , FAKE_FSM_SUBSTATE_INITIALIZATION_FIRST_MEASUREMENT_FINISHED , FAKE_FSM_SUBSTATE_INITIALIZATION_EXIT , FAKE_FSM_SUBSTATE_RUNNING_SAVE_VOLTAGE_MEASUREMENT_DATA , FAKE_FSM_SUBSTATE_RUNNING_SAVE_TEMPERATURE_MEASUREMENT_DATA }

Functions
STD_RETURN_TYPE_e	FAKE_Initialize (void)
	initialize driver More...

bool	FAKE_IsFirstMeasurementCycleFinished (FAKE_STATE_s *pFakeState)
	return whether the first measurement cycle is finished More...

STD_RETURN_TYPE_e	FAKE_TriggerAfe (FAKE_STATE_s *pFakeState)
	Trigger function for the driver, called to advance the state machine. More...

bool	TEST_FAKE_CheckMultipleCalls (FAKE_STATE_s *pFakeState)

void	TEST_FAKE_SetFirstMeasurementCycleFinished (FAKE_STATE_s *pFakeState)

void	TEST_FAKE_SetState (FAKE_STATE_s *pFakeState, FAKE_FSM_STATES_e nextState, FAKE_FSM_SUBSTATES_e nextSubstate, uint16_t idleTime)

STD_RETURN_TYPE_e	TEST_FAKE_SaveFakeVoltageMeasurementData (FAKE_STATE_s *pFakeState)

STD_RETURN_TYPE_e	TEST_FAKE_SaveFakeTemperatureMeasurementData (FAKE_STATE_s *pFakeState)

Variables
FAKE_STATE_s	fake_state

Detailed Description

Header for the driver of the fake AFE driver.

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:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.
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-09-17 (date of creation)

Updated: 2023-02-03 (date of last update)

Version: v1.5.0

Prefix: FAKE

Definition in file debug_default.h.

Enumeration Type Documentation

◆ FAKE_FSM_STATES_e

enum FAKE_FSM_STATES_e

States of the state machine

Enumerator
FAKE_FSM_STATE_DUMMY	dummy state - always the first state
FAKE_FSM_STATE_HAS_NEVER_RUN	never run state - always the second state
FAKE_FSM_STATE_UNINITIALIZED	uninitialized state
FAKE_FSM_STATE_INITIALIZATION	initializing the state machine
FAKE_FSM_STATE_RUNNING	operational mode of the state machine
FAKE_FSM_STATE_ERROR	state for error processing

Definition at line 70 of file debug_default.h.

◆ FAKE_FSM_SUBSTATES_e

enum FAKE_FSM_SUBSTATES_e

Substates of the state machine

Enumerator
FAKE_FSM_SUBSTATE_DUMMY	dummy state - always the first substate
FAKE_FSM_SUBSTATE_ENTRY	entry state - always the second substate
FAKE_FSM_SUBSTATE_INITIALIZATION_FINISH_FIRST_MEASUREMENT	finish the first fake measurement
FAKE_FSM_SUBSTATE_INITIALIZATION_FIRST_MEASUREMENT_FINISHED	cleanup substate after the first fake measurement
FAKE_FSM_SUBSTATE_INITIALIZATION_EXIT	last initialization substate
FAKE_FSM_SUBSTATE_RUNNING_SAVE_VOLTAGE_MEASUREMENT_DATA	state to continuously save the measurement data
FAKE_FSM_SUBSTATE_RUNNING_SAVE_TEMPERATURE_MEASUREMENT_DATA	state to continuously save the measurement data

Definition at line 80 of file debug_default.h.

Function Documentation

◆ FAKE_Initialize()

STD_RETURN_TYPE_e FAKE_Initialize ( void )

initialize driver

Definition at line 520 of file debug_default.c.

◆ FAKE_IsFirstMeasurementCycleFinished()

bool FAKE_IsFirstMeasurementCycleFinished ( FAKE_STATE_s * pFakeState )

return whether the first measurement cycle is finished

Parameters

pFakeState current state of the fake driver

Returns: true if the first measurement cycle was successfully finished, false otherwise

Definition at line 524 of file debug_default.c.

Here is the call graph for this function:

◆ FAKE_TriggerAfe()

STD_RETURN_TYPE_e FAKE_TriggerAfe ( FAKE_STATE_s * pFakeState )

Trigger function for the driver, called to advance the state machine.

Parameters

pFakeState current state of the fake driver

Returns: returns always STD_OK

Definition at line 533 of file debug_default.c.

Here is the call graph for this function:

◆ TEST_FAKE_CheckMultipleCalls()

bool TEST_FAKE_CheckMultipleCalls ( FAKE_STATE_s * pFakeState )

Definition at line 564 of file debug_default.c.

Here is the call graph for this function:

◆ TEST_FAKE_SaveFakeTemperatureMeasurementData()

STD_RETURN_TYPE_e TEST_FAKE_SaveFakeTemperatureMeasurementData ( FAKE_STATE_s * pFakeState )

Definition at line 584 of file debug_default.c.

Here is the call graph for this function:

◆ TEST_FAKE_SaveFakeVoltageMeasurementData()

STD_RETURN_TYPE_e TEST_FAKE_SaveFakeVoltageMeasurementData ( FAKE_STATE_s * pFakeState )

Definition at line 580 of file debug_default.c.

Here is the call graph for this function:

◆ TEST_FAKE_SetFirstMeasurementCycleFinished()

void TEST_FAKE_SetFirstMeasurementCycleFinished ( FAKE_STATE_s * pFakeState )

Definition at line 568 of file debug_default.c.

Here is the call graph for this function:

◆ TEST_FAKE_SetState()

void TEST_FAKE_SetState	(	FAKE_STATE_s *	pFakeState,
		FAKE_FSM_STATES_e	nextState,
		FAKE_FSM_SUBSTATES_e	nextSubstate,
		uint16_t	idleTime
	)

Definition at line 572 of file debug_default.c.

Here is the call graph for this function:

Variable Documentation

◆ fake_state

FAKE_STATE_s fake_state

extern

state of the fake state machine

local instance of the driver-state

Definition at line 117 of file debug_default.c.

Data Structures

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ FAKE_FSM_STATES_e

◆ FAKE_FSM_SUBSTATES_e

Function Documentation

◆ FAKE_Initialize()

◆ FAKE_IsFirstMeasurementCycleFinished()

◆ FAKE_TriggerAfe()

◆ TEST_FAKE_CheckMultipleCalls()

◆ TEST_FAKE_SaveFakeTemperatureMeasurementData()

◆ TEST_FAKE_SaveFakeVoltageMeasurementData()

◆ TEST_FAKE_SetFirstMeasurementCycleFinished()

◆ TEST_FAKE_SetState()

Variable Documentation

◆ fake_state