foxBMS  1.1.0
The foxBMS Battery Management System API Documentation
state-machine.h File Reference

Header file of some software. More...

#include "general.h"
Include dependency graph for state-machine.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  EG_INFORMATION
 
struct  EG_STATE
 

Typedefs

typedef enum EG_FSM_STATES EG_FSM_STATES_e
 
typedef enum EG_FSM_SUBSTATES EG_FSM_SUBSTATES_e
 
typedef struct EG_INFORMATION EG_INFORMATION_s
 
typedef struct EG_STATE EG_STATE_s
 

Enumerations

enum  EG_FSM_STATES {
  EG_FSM_STATE_DUMMY , EG_FSM_STATE_HAS_NEVER_RUN , EG_FSM_STATE_UNINITIALIZED , EG_FSM_STATE_INITIALIZATION ,
  EG_FSM_STATE_RUNNING , EG_FSM_STATE_ERROR
}
 
enum  EG_FSM_SUBSTATES {
  EG_FSM_SUBSTATE_DUMMY , EG_FSM_SUBSTATE_ENTRY , EG_FSM_SUBSTATE_INITIALIZATION_0 , EG_FSM_SUBSTATE_INITIALIZATION_1 ,
  EG_FSM_SUBSTATE_INITIALIZATION_EXIT , EG_FSM_SUBSTATE_RUNNING_0 , EG_FSM_SUBSTATE_RUNNING_1 , EG_FSM_SUBSTATE_RUNNING_2
}
 

Functions

STD_RETURN_TYPE_e EG_Trigger (EG_STATE_s *pEgState)
 tick function, call this to advance the state machine More...
 

Variables

EG_STATE_s eg_state
 

Detailed Description

Header file of some software.

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-29 (date of creation)
Updated
2020-11-09 (date of last update)
Prefix
EG

Definition in file state-machine.h.

Typedef Documentation

◆ EG_FSM_STATES_e

States of the state machine

◆ EG_FSM_SUBSTATES_e

Substates of the state machine

◆ EG_INFORMATION_s

some struct with some information

◆ EG_STATE_s

typedef struct EG_STATE EG_STATE_s

This struct describes the state of the monitoring instance

Enumeration Type Documentation

◆ EG_FSM_STATES

States of the state machine

Enumerator
EG_FSM_STATE_DUMMY 

dummy state - always the first state

EG_FSM_STATE_HAS_NEVER_RUN 

never run state - always the second state

EG_FSM_STATE_UNINITIALIZED 

uninitialized state

EG_FSM_STATE_INITIALIZATION 

initializing the state machine

EG_FSM_STATE_RUNNING 

operational mode of the state machine

EG_FSM_STATE_ERROR 

state for error processing

Definition at line 62 of file state-machine.h.

◆ EG_FSM_SUBSTATES

Substates of the state machine

Enumerator
EG_FSM_SUBSTATE_DUMMY 

dummy state - always the first substate

EG_FSM_SUBSTATE_ENTRY 

entry state - always the second substate

EG_FSM_SUBSTATE_INITIALIZATION_0 

fist initialization substate

EG_FSM_SUBSTATE_INITIALIZATION_1 

second initialization substate

EG_FSM_SUBSTATE_INITIALIZATION_EXIT 

last initialization substate

EG_FSM_SUBSTATE_RUNNING_0 

fist running substate

EG_FSM_SUBSTATE_RUNNING_1 

second running substate

EG_FSM_SUBSTATE_RUNNING_2 

third running substate

Definition at line 72 of file state-machine.h.

Function Documentation

◆ EG_Trigger()

STD_RETURN_TYPE_e EG_Trigger ( EG_STATE_s pEgState)

tick function, call this to advance the state machine

Parameters
pEgStatecurrent state of the state machine
Returns
returns always STD_OK

Definition at line 435 of file state-machine.c.

Here is the call graph for this function:

Variable Documentation

◆ eg_state

EG_STATE_s eg_state
extern

state of the example state machine

local instance of the driver-state

Definition at line 87 of file state-machine.c.