foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
adc.h File Reference

Headers for the driver for the ADC module. More...

#include "general.h"
#include "battery_system_cfg.h"
#include "HL_adc.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.

Macros

#define ADC_VREFHIGH_mV   (5000.0f)
 
#define ADC_VREFLOW_mV   (0.0f)
 
#define ADC_CONV_FACTOR_12BIT   (4096.0f)
 
#define ADC_CONV_FACTOR_10BIT   (1024.0f)
 
#define ADC_CONVERSION_ENDDBIT   (8U)
 

Enumerations

enum  ADC_STATE_e { ADC_START_CONVERSION , ADC_WAIT_CONVERSION_FINISHED , ADC_CONVERSION_FINISHED }
 

Functions

void ADC_Control (void)
 controls ADC measurement sequence. More...
 

Detailed Description

Headers for the driver for the ADC module.

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-01-07 (date of creation)
Updated
2021-03-24 (date of last update)
Prefix
ADC

Definition in file adc.h.

Macro Definition Documentation

◆ ADC_CONV_FACTOR_10BIT

#define ADC_CONV_FACTOR_10BIT   (1024.0f)

ADC conversion factor, 10 bit conversion

Definition at line 73 of file adc.h.

◆ ADC_CONV_FACTOR_12BIT

#define ADC_CONV_FACTOR_12BIT   (4096.0f)

ADC conversion factor, 12 bit conversion

Definition at line 71 of file adc.h.

◆ ADC_CONVERSION_ENDDBIT

#define ADC_CONVERSION_ENDDBIT   (8U)

End bit position in ADC Groupx Interrupt Flag Register

Definition at line 76 of file adc.h.

◆ ADC_VREFHIGH_mV

#define ADC_VREFHIGH_mV   (5000.0f)

ADC voltage reference, high

Definition at line 67 of file adc.h.

◆ ADC_VREFLOW_mV

#define ADC_VREFLOW_mV   (0.0f)

ADC voltage reference, low

Definition at line 69 of file adc.h.

Enumeration Type Documentation

◆ ADC_STATE_e

State for the ADC conversion

Enumerator
ADC_START_CONVERSION 
ADC_WAIT_CONVERSION_FINISHED 
ADC_CONVERSION_FINISHED 

Definition at line 81 of file adc.h.

Function Documentation

◆ ADC_Control()

void ADC_Control ( void  )

controls ADC measurement sequence.

Definition at line 97 of file adc.c.

Here is the call graph for this function: