foxBMS
1.5.1
The foxBMS Battery Management System API Documentation
|
Sys driver header. More...
Go to the source code of this file.
Data Structures | |
struct | SYS_STATE_s |
Functions | |
SYS_RETURN_TYPE_e | SYS_SetStateRequest (SYS_STATE_REQUEST_e stateRequest) |
sets the current state request of the state variable sys_state. More... | |
STD_RETURN_TYPE_e | SYS_Trigger (SYS_STATE_s *pSystemState) |
tick function, call this to advance the state machine More... | |
void | SYS_GeneralMacroBist (void) |
Variables | |
SYS_STATE_s | sys_state |
Sys driver header.
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:
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:
Definition in file sys.h.
enum SYS_CHECK_e |
enum SYS_FSM_STATES_e |
States of the state machine
enum SYS_FSM_SUBSTATES_e |
Substates of the state machine
enum SYS_RETURN_TYPE_e |
Possible return values when state requests are made to the SYS statemachine
enum SYS_STATE_REQUEST_e |
enum SYS_STATEMACH_e |
States of the SYS state machine
enum SYS_STATEMACH_SUB_e |
Substates of the SYS state machine
void SYS_GeneralMacroBist | ( | void | ) |
SYS_RETURN_TYPE_e SYS_SetStateRequest | ( | SYS_STATE_REQUEST_e | stateRequest | ) |
sets the current state request of the state variable sys_state.
This function is used to make a state request to the state machine, e.g., start voltage measurement, read result of voltage measurement, re-initialization. It calls SYS_CheckStateRequest() to check if the request is valid. The state request is rejected if is not valid. The result of the check is returned immediately, so that the requester can act in case it made a non-valid state request.
stateRequest | state requested to set |
Definition at line 614 of file sys.c.
STD_RETURN_TYPE_e SYS_Trigger | ( | SYS_STATE_s * | pSystemState | ) |
|
extern |