adi_ades183x_voltages.h File Reference

Header file of some software. More...

#include "adi_ades183x_defs.h"
#include <stdint.h>

Include dependency graph for adi_ades183x_voltages.h:

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

Go to the source code of this file.

Data Structures
struct	ADI_COMMAND_READ_REGISTERS_s

Functions
uint16_t	ADI_GetStoredVoltageIndex (uint16_t registerVoltageIndex)
	Converts index of read voltages. More...
void	ADI_GetVoltages (ADI_STATE_s *adiState, ADI_VOLTAGE_REGISTER_TYPE_e registerType, ADI_VOLTAGE_STORE_LOCATION_e storeLocation)
	Reads and stores cell voltages. More...
void	ADI_StopContinuousCellVoltageMeasurements (ADI_STATE_s *adiState)
	Stop cell voltage measurement. More...
void	ADI_RestartContinuousCellVoltageMeasurements (ADI_STATE_s *adiState)
	Restart cell voltage measurement. More...

Detailed Description

Header file of some software.

Copyright

© 2010 - 2023, 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

2022-12-07 (date of creation)

Updated

2023-10-12 (date of last update)

Version

v1.6.0

Prefix

ADI

Definition in file adi_ades183x_voltages.h.

Function Documentation

ADI_GetStoredVoltageIndex()

uint16_t ADI_GetStoredVoltageIndex

(

uint16_t

registerVoltageIndex

)

Converts index of read voltages.

This function translates the indexes of read voltages so that if some inputs are unused, they do not appear in the final cell voltage table

Parameters

registerVoltageIndex

index of the read voltage ion the ades183x register

Returns

index where the voltage must be stored if it is used

Definition at line 391 of file adi_ades183x_voltages.c.

ADI_GetVoltages()

void ADI_GetVoltages	(	ADI_STATE_s *	adiState,
		ADI_VOLTAGE_REGISTER_TYPE_e	registerType,
		ADI_VOLTAGE_STORE_LOCATION_e	storeLocation
	)

Reads and stores cell voltages.

This function, reads the raw values from the registers, and calls ADI_SaveRxToCellVoltageBuffer() which convert them into voltages and stores them.

Parameters

adiState	state of the ADI driver
registerType	type of voltage register to read
storeLocation	location where read data has to be stored

Definition at line 352 of file adi_ades183x_voltages.c.

Here is the call graph for this function:

ADI_RestartContinuousCellVoltageMeasurements()

void ADI_RestartContinuousCellVoltageMeasurements

(

ADI_STATE_s *

adiState

)

Restart cell voltage measurement.

This function should be called after deactivation of balancing

Parameters

adiState

state of the driver

SM_VCELL_RED: Cell Voltage Measurement Redundancy Set RD bit to enable redundant cell voltage measurements

Definition at line 403 of file adi_ades183x_voltages.c.

Here is the call graph for this function:

ADI_StopContinuousCellVoltageMeasurements()

void ADI_StopContinuousCellVoltageMeasurements

(

ADI_STATE_s *

adiState

)

Stop cell voltage measurement.

This function should be called before activation of balancing

Parameters

adiState

state of the driver

Definition at line 421 of file adi_ades183x_voltages.c.

Here is the call graph for this function: