The foxBMS secondary mcu API documentation
adc.h File Reference

Header for the driver for the analog to digital converter. More...

#include "adc_cfg.h"
Include dependency graph for adc.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void ADC_Init (ADC_HandleTypeDef *AdcHandle)
 initializes the different ADC devices by enabling their corresponding clocks. It is called during startup. More...
 
void ADC_Convert (ADC_HandleTypeDef *AdcHandle)
 
void ADC_Ctrl (void)
 determines which kind of measurements are made by the ADCs and stores result in database. More...
 
void HAL_ADC_ConvCpltCallback (ADC_HandleTypeDef *AdcHandle)
 callback function to the ADC conversion. More...
 
float ADC_GetVBAT_mV (void)
 get coin cell battery voltage More...
 
float ADC_GetMCUTemp_C (void)
 get MCU temperature More...
 
uint16_t ADC_GetValue (uint32_t value)
 get voltage in mV More...
 

Detailed Description

Header for the driver for the analog to digital converter.

BSD 3-Clause License 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
26.08.2015 (date of creation)
Module-prefix ADC

This adc module provides support for analog/digital conversion. It must be initialized during startup.

Function Documentation

◆ ADC_Convert()

void ADC_Convert ( ADC_HandleTypeDef *  AdcHandle)

starts the ADC conversion.

Parameters
AdcHandlepointer to ADC hardware handle

◆ ADC_Ctrl()

void ADC_Ctrl ( void  )

determines which kind of measurements are made by the ADCs and stores result in database.

It alternates between measurement of the voltage of the backup battery and the voltage of the internal temperature sensor. It starts the conversion with ADC_Convert(). If the conversion is completed, the result is stored in the database.

Here is the call graph for this function:

◆ ADC_GetMCUTemp_C()

float ADC_GetMCUTemp_C ( void  )

get MCU temperature

◆ ADC_GetValue()

uint16_t ADC_GetValue ( uint32_t  value)

get voltage in mV

◆ ADC_GetVBAT_mV()

float ADC_GetVBAT_mV ( void  )

get coin cell battery voltage

◆ ADC_Init()

void ADC_Init ( ADC_HandleTypeDef *  AdcHandle)

initializes the different ADC devices by enabling their corresponding clocks. It is called during startup.

Parameters
AdcHandlepointer to ADC hardware handle

◆ HAL_ADC_ConvCpltCallback()

void HAL_ADC_ConvCpltCallback ( ADC_HandleTypeDef *  AdcHandle)

callback function to the ADC conversion.

It is called automatically when an ADC conversion is complete. Before getting the converted value, it stops the ADC with HAL_ADC_Stop_IT(). Then it gets the converted raw value with HAL_ADC_GetValue(). The raw value is then scaled.

Parameters
AdcHandlepointer to ADC hardware handle