foxBMS
1.1.1
The foxBMS Battery Management System API Documentation
|
Headers for the driver for the MAX17841B ASCI and MAX1785x monitoring chip. More...
#include "database_cfg.h"
#include "mxm_cfg.h"
#include "mxm_17841b.h"
#include "mxm_1785x_tools.h"
#include "mxm_basic_defines.h"
#include "mxm_battery_management.h"
#include "mxm_crc8.h"
Go to the source code of this file.
Functions | |
void | MXM_StateMachine (MXM_MONITORING_INSTANCE_s *pInstance) |
Battery monitoring driver for MAX1785x battery monitoring ICs. More... | |
Headers for the driver for the MAX17841B ASCI and MAX1785x monitoring chip.
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:
def
Definition in file mxm_1785x.h.
void MXM_StateMachine | ( | MXM_MONITORING_INSTANCE_s * | pInstance | ) |
Battery monitoring driver for MAX1785x battery monitoring ICs.
This module supplies a driver for the Battery Monitoring ICs of the MAX1785x-family by Maxim Integrated.
Entry point for the module is the function MXM_Tick() in mxm_mic.c. It handles the measurement flow and the coordination of the underlying state-machines. Below this layer two state-machines are implemented.
The state-machine in mxm_battery_management.c is executed with the MXM_5XStateMachine()-function. This state-machine exposes commands of the Maxim Battery Management Protocol to the upper layers. Below, it translates these commands into state-changes for the underlying state-machine. This state-machine is implemented in mxm_17841b.c and executed with MXM_41BStateMachine(). It handles the register- and buffer-transactions required for the MAX17841B communication interface (Maxim calls this chip ASCI).
Main state-machine implementation
This state-machine handles the main state of the driver. It runs the self-check, initializes communication and then transitions into the operation state in which it executes the state-machine described in MXM_StateMachineOperation().
[in,out] | pInstance | used as both input and output (stores state-information, requests and intermediate values) |
Definition at line 1934 of file mxm_1785x.c.