afe.h File Reference

AFE driver header. More...

#include "general.h"

Include dependency graph for afe.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	AFE_ERROR_OPEN_WIRE_PERIOD_ms   (30000)

Functions
STD_RETURN_TYPE_e	AFE_TriggerIc (void)
STD_RETURN_TYPE_e	AFE_Initialize (void)
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_RequestIoWrite (uint8_t string)
	Makes the request to the AFE state machine to write to the IO port-expander. 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_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_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_RequestOpenWireCheck (uint8_t string)
	Makes the request to the AFE state machine to perform open-wire check. More...

Detailed Description

AFE driver header.

Copyright

© 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved.

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

2020-06-17 (date of last update)

Prefix

AFE

TODO

Definition in file afe.h.

Macro Definition Documentation

AFE_ERROR_OPEN_WIRE_PERIOD_ms

#define AFE_ERROR_OPEN_WIRE_PERIOD_ms   (30000)

period for open wire measurement

Definition at line 64 of file afe.h.

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 75 of file debug_default_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 83 of file debug_default_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

string

string addressed by the request

Definition at line 114 of file debug_default_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

string

string addressed by the request

Definition at line 122 of file debug_default_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

string

string addressed by the request

Definition at line 130 of file debug_default_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

string

string addressed by the request

Definition at line 98 of file debug_default_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

string

string addressed by the request

Definition at line 90 of file debug_default_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

string

string addressed by the request

Definition at line 138 of file debug_default_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

string

string addressed by the request

Definition at line 106 of file debug_default_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 79 of file debug_default_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 71 of file debug_default_afe.c.

Here is the call graph for this function: