foxBMS  1.2.0
The foxBMS Battery Management System API Documentation
ltc_afe.c File Reference

AFE driver implementation for LTC ICs. More...

#include "general.h"
#include "afe.h"
#include "ltc.h"
Include dependency graph for ltc_afe.c:

Go to the source code of this file.

Functions

STD_RETURN_TYPE_e AFE_TriggerIc (void)
 
STD_RETURN_TYPE_e AFE_Initialize (void)
 
STD_RETURN_TYPE_e AFE_RequestEepromRead (uint8_t string)
 Makes the request to the AFE state machine to read from the external EEPROM on slaves. More...
 
STD_RETURN_TYPE_e AFE_RequestEepromWrite (uint8_t string)
 Makes the request to the AFE state machine to write to the external EEPROM on slaves. More...
 
STD_RETURN_TYPE_e AFE_RequestTemperatureRead (uint8_t string)
 Makes the request to the AFE state machine to read from the external temperature sensor on slaves. More...
 
STD_RETURN_TYPE_e AFE_RequestBalancingFeedbackRead (uint8_t string)
 Makes the request to the AFE state machine to read balancing feedback from the slaves. More...
 
STD_RETURN_TYPE_e AFE_RequestOpenWireCheck (uint8_t string)
 Makes the request to the AFE state machine to perform open-wire check. More...
 
STD_RETURN_TYPE_e AFE_StartMeasurement (void)
 Makes the initialization request to the AFE state machine. More...
 
bool AFE_IsFirstMeasurementCycleFinished (void)
 Checks if the first AFE measurement cycle was made. More...
 
STD_RETURN_TYPE_e AFE_RequestIoRead (uint8_t string)
 Makes the request to the AFE state machine to read from the IO port-expander. More...
 
STD_RETURN_TYPE_e AFE_RequestIoWrite (uint8_t string)
 Makes the request to the AFE state machine to write to the IO port-expander. More...
 

Detailed Description

AFE driver implementation for LTC 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
2020-05-08 (date of creation)
Updated
2021-03-24 (date of last update)
Prefix
AFE

Definition in file ltc_afe.c.

Function Documentation

◆ AFE_Initialize()

STD_RETURN_TYPE_e AFE_Initialize ( void  )

initializer, this function is called in order to initialize the AFE

Definition at line 77 of file ltc_afe.c.

Here is the call graph for this function:

◆ AFE_IsFirstMeasurementCycleFinished()

bool AFE_IsFirstMeasurementCycleFinished ( void  )

Checks if the first AFE measurement cycle was made.

this function returns whether the first measurement cycle has finished

Returns
true is the first measurement cycle was made, false otherwise

Definition at line 148 of file ltc_afe.c.

Here is the call graph for this function:

◆ AFE_RequestBalancingFeedbackRead()

STD_RETURN_TYPE_e AFE_RequestBalancingFeedbackRead ( uint8_t  string)

Makes the request to the AFE state machine to read balancing feedback from the slaves.

Parameters
stringstring addressed by the request

Definition at line 115 of file ltc_afe.c.

Here is the call graph for this function:

◆ AFE_RequestEepromRead()

STD_RETURN_TYPE_e AFE_RequestEepromRead ( uint8_t  string)

Makes the request to the AFE state machine to read from the external EEPROM on slaves.

Parameters
stringstring addressed by the request

Definition at line 82 of file ltc_afe.c.

Here is the call graph for this function:

◆ AFE_RequestEepromWrite()

STD_RETURN_TYPE_e AFE_RequestEepromWrite ( uint8_t  string)

Makes the request to the AFE state machine to write to the external EEPROM on slaves.

Parameters
stringstring addressed by the request

Definition at line 93 of file ltc_afe.c.

Here is the call graph for this function:

◆ AFE_RequestIoRead()

STD_RETURN_TYPE_e AFE_RequestIoRead ( uint8_t  string)

Makes the request to the AFE state machine to read from the IO port-expander.

Parameters
stringstring addressed by the request

Definition at line 152 of file ltc_afe.c.

◆ AFE_RequestIoWrite()

STD_RETURN_TYPE_e AFE_RequestIoWrite ( uint8_t  string)

Makes the request to the AFE state machine to write to the IO port-expander.

Parameters
stringstring addressed by the request

Definition at line 160 of file ltc_afe.c.

◆ AFE_RequestOpenWireCheck()

STD_RETURN_TYPE_e AFE_RequestOpenWireCheck ( uint8_t  string)

Makes the request to the AFE state machine to perform open-wire check.

Parameters
stringstring addressed by the request

Definition at line 127 of file ltc_afe.c.

Here is the call graph for this function:

◆ AFE_RequestTemperatureRead()

STD_RETURN_TYPE_e AFE_RequestTemperatureRead ( uint8_t  string)

Makes the request to the AFE state machine to read from the external temperature sensor on slaves.

Parameters
stringstring addressed by the request

Definition at line 104 of file ltc_afe.c.

Here is the call graph for this function:

◆ AFE_StartMeasurement()

STD_RETURN_TYPE_e AFE_StartMeasurement ( void  )

Makes the initialization request to the AFE state machine.

this function should tell the AFE that it should start measuring

Returns
true or false

Definition at line 138 of file ltc_afe.c.

Here is the call graph for this function:

◆ AFE_TriggerIc()

STD_RETURN_TYPE_e AFE_TriggerIc ( void  )

tick function, this function is called to advance the state machine

Definition at line 72 of file ltc_afe.c.

Here is the call graph for this function: