foxBMS  1.5.0
The foxBMS Battery Management System API Documentation
nxp_afe.h File Reference

AFE driver wrapper layer for NXP ICs. More...

#include "fstd_types.h"
#include "afe.h"
#include <stdbool.h>
#include <stdint.h>
Include dependency graph for nxp_afe.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

STD_RETURN_TYPE_e NXP_Measure (void)
 
STD_RETURN_TYPE_e NXP_Initialize (void)
 
STD_RETURN_TYPE_e NXP_RequestEepromRead (uint8_t string)
 
STD_RETURN_TYPE_e NXP_RequestEepromWrite (uint8_t string)
 
STD_RETURN_TYPE_e NXP_RequestTemperatureRead (uint8_t string)
 
STD_RETURN_TYPE_e NXP_RequestBalancingFeedbackRead (uint8_t string)
 
STD_RETURN_TYPE_e NXP_RequestOpenWireCheck (uint8_t string)
 
STD_RETURN_TYPE_e NXP_StartMeasurement (void)
 
bool NXP_IsFirstMeasurementCycleFinished (void)
 
STD_RETURN_TYPE_e NXP_RequestIoRead (uint8_t string)
 
STD_RETURN_TYPE_e NXP_RequestIoWrite (uint8_t string)
 

Detailed Description

AFE driver wrapper layer for NXP ICs.

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
2021-06-04 (date of creation)
Updated
2023-02-03 (date of last update)
Version
v1.5.0
Prefix
NXP

Definition in file nxp_afe.h.

Function Documentation

◆ NXP_Initialize()

STD_RETURN_TYPE_e NXP_Initialize ( void  )

Function setting the pins of the port expander

Definition at line 83 of file nxp_mc33775a_afe.c.

Here is the call graph for this function:

◆ NXP_IsFirstMeasurementCycleFinished()

bool NXP_IsFirstMeasurementCycleFinished ( void  )

Function to check if at least one measurement cycle has been made

Definition at line 102 of file nxp_mc33775a_afe.c.

Here is the call graph for this function:

◆ NXP_Measure()

STD_RETURN_TYPE_e NXP_Measure ( void  )

Function called to run the AFE driver

Definition at line 78 of file nxp_mc33775a_afe.c.

Here is the call graph for this function:

◆ NXP_RequestBalancingFeedbackRead()

STD_RETURN_TYPE_e NXP_RequestBalancingFeedbackRead ( uint8_t  string)

Function to request a read of the balancing feedback on the slaves

Definition at line 121 of file nxp_mc33775a_afe.c.

◆ NXP_RequestEepromRead()

STD_RETURN_TYPE_e NXP_RequestEepromRead ( uint8_t  string)

Function to request a read of the I2C EEPROM on the slaves

Definition at line 126 of file nxp_mc33775a_afe.c.

◆ NXP_RequestEepromWrite()

STD_RETURN_TYPE_e NXP_RequestEepromWrite ( uint8_t  string)

Function to request a write to the I2C EEPROM on the slaves

Definition at line 131 of file nxp_mc33775a_afe.c.

◆ NXP_RequestIoRead()

STD_RETURN_TYPE_e NXP_RequestIoRead ( uint8_t  string)

Function to request a read of the I2C port expnader on the slaves

Definition at line 111 of file nxp_mc33775a_afe.c.

◆ NXP_RequestIoWrite()

STD_RETURN_TYPE_e NXP_RequestIoWrite ( uint8_t  string)

Function to request a write to the I2C port expnader on the slaves

Definition at line 106 of file nxp_mc33775a_afe.c.

◆ NXP_RequestOpenWireCheck()

STD_RETURN_TYPE_e NXP_RequestOpenWireCheck ( uint8_t  string)

Function to request an openWire check on the slaves

Definition at line 136 of file nxp_mc33775a_afe.c.

◆ NXP_RequestTemperatureRead()

STD_RETURN_TYPE_e NXP_RequestTemperatureRead ( uint8_t  string)

Function to request a read of the I2C temperature sensor on the slaves

Definition at line 116 of file nxp_mc33775a_afe.c.

◆ NXP_StartMeasurement()

STD_RETURN_TYPE_e NXP_StartMeasurement ( void  )

Function to request a start of the AFE driver, deprecated with the continuously running task

Definition at line 92 of file nxp_mc33775a_afe.c.