foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
adi_ades183x_voltages.c File Reference

Implementation of some software. More...

#include "adi_ades183x_voltages.h"
#include "adi_ades183x_cfg.h"
#include "adi_ades183x_buffers.h"
#include "adi_ades183x_commands.h"
#include "adi_ades183x_commands_voltages.h"
#include "adi_ades183x_diagnostic.h"
#include "adi_ades183x_helpers.h"
#include "fassert.h"
#include <math.h>
#include <stdbool.h>
#include <stdint.h>
Include dependency graph for adi_ades183x_voltages.c:

Go to the source code of this file.

Functions

static void ADI_CopyCommandBytesAverageCellVoltageRegisters (ADI_COMMAND_READ_REGISTERS_s *commandBytesToReadVoltageRegisters)
 Copies the related command bytes to read the average voltage registers. More...
 
static void ADI_CopyCommandBytesCellVoltageRegister (ADI_COMMAND_READ_REGISTERS_s *commandBytesToReadVoltageRegisters)
 Copies the related command bytes to read the voltage registers. More...
 
static void ADI_CopyCommandBytesFilteredCellVoltageRegisters (ADI_COMMAND_READ_REGISTERS_s *commandBytesToReadVoltageRegisters)
 Copies the related command bytes to read the filtered voltage registers. More...
 
static void ADI_CopyCommandBytesRedundantCellVoltageRegisters (ADI_COMMAND_READ_REGISTERS_s *commandBytesToReadVoltageRegisters)
 Copies the related command bytes to read the redundant voltage registers. More...
 
static void ADI_ReadAndStoreVoltages (ADI_STATE_s *adiState, ADI_COMMAND_READ_REGISTERS_s *commandBytesToReadVoltageRegisters, ADI_VOLTAGE_STORE_LOCATION_e storeLocation)
 Copies the related command bytes to read the average voltage registers. More...
 
static void ADI_SaveRxToCellVoltageBuffer (ADI_STATE_s *adiState, uint8_t *data, uint8_t registerSet, ADI_VOLTAGE_STORE_LOCATION_e storeLocation)
 Saves the cell voltage values read from the daisy-chain. 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...
 
uint16_t ADI_GetStoredVoltageIndex (uint16_t registerVoltageIndex)
 Converts index of read voltages. More...
 
void ADI_RestartContinuousCellVoltageMeasurements (ADI_STATE_s *adiState)
 Restart cell voltage measurement. More...
 
void ADI_StopContinuousCellVoltageMeasurements (ADI_STATE_s *adiState)
 Stop cell voltage measurement. More...
 

Detailed Description

Implementation of some software.

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
2019-08-27 (date of creation)
Updated
2023-10-12 (date of last update)
Version
v1.6.0
Prefix
ADI

Definition in file adi_ades183x_voltages.c.

Function Documentation

◆ ADI_CopyCommandBytesAverageCellVoltageRegisters()

static void ADI_CopyCommandBytesAverageCellVoltageRegisters ( ADI_COMMAND_READ_REGISTERS_s commandBytesToReadVoltageRegisters)
static

Copies the related command bytes to read the average voltage registers.

Parameters
commandBytesToReadVoltageRegisterscommand bytes to be copied

Definition at line 152 of file adi_ades183x_voltages.c.

Here is the call graph for this function:

◆ ADI_CopyCommandBytesCellVoltageRegister()

static void ADI_CopyCommandBytesCellVoltageRegister ( ADI_COMMAND_READ_REGISTERS_s commandBytesToReadVoltageRegisters)
static

Copies the related command bytes to read the voltage registers.

Parameters
commandBytesToReadVoltageRegisterscommand bytes to be copied

Definition at line 142 of file adi_ades183x_voltages.c.

Here is the call graph for this function:

◆ ADI_CopyCommandBytesFilteredCellVoltageRegisters()

static void ADI_CopyCommandBytesFilteredCellVoltageRegisters ( ADI_COMMAND_READ_REGISTERS_s commandBytesToReadVoltageRegisters)
static

Copies the related command bytes to read the filtered voltage registers.

Parameters
commandBytesToReadVoltageRegisterscommand bytes to be copied

Definition at line 163 of file adi_ades183x_voltages.c.

Here is the call graph for this function:

◆ ADI_CopyCommandBytesRedundantCellVoltageRegisters()

static void ADI_CopyCommandBytesRedundantCellVoltageRegisters ( ADI_COMMAND_READ_REGISTERS_s commandBytesToReadVoltageRegisters)
static

Copies the related command bytes to read the redundant voltage registers.

Parameters
commandBytesToReadVoltageRegisterscommand bytes to be copied

Definition at line 174 of file adi_ades183x_voltages.c.

Here is the call graph for this function:

◆ 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
registerVoltageIndexindex 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
adiStatestate of the ADI driver
registerTypetype of voltage register to read
storeLocationlocation 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_ReadAndStoreVoltages()

static void ADI_ReadAndStoreVoltages ( ADI_STATE_s adiState,
ADI_COMMAND_READ_REGISTERS_s commandBytesToReadVoltageRegisters,
ADI_VOLTAGE_STORE_LOCATION_e  storeLocation 
)
static

Copies the related command bytes to read the average voltage registers.

Parameters
adiStatestate of the ADI driver
commandBytesToReadVoltageRegisterscommand bytes to be copied
storeLocationlocation where read data has to be stored

Definition at line 185 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
adiStatestate 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_SaveRxToCellVoltageBuffer()

static void ADI_SaveRxToCellVoltageBuffer ( ADI_STATE_s adiState,
uint8_t *  data,
uint8_t  registerSet,
ADI_VOLTAGE_STORE_LOCATION_e  storeLocation 
)
static

Saves the cell voltage values read from the daisy-chain.

There are 6 register to read _(A, B, C, D, E, F) to get all cell voltages. This function is called to store the result from the transmission buffer to the appropriate location in the driver.

Parameters
adiStatestate of the ADI driver
datareceive buffer
registerSetvoltage register that was read (voltage register A, B, C, D, E or F)
storeLocationlocation where read data has to be stored

Definition at line 213 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
adiStatestate of the driver

Definition at line 421 of file adi_ades183x_voltages.c.

Here is the call graph for this function: