InternalADC.h

Go to the documentation of this file.

/* Copyright (c) 2015-2020 Skyward Experimental Rocketry
 * Authors: Matteo Piazzolla, Luca Erbetta, Alberto Nidasio
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#pragma once
 
#include <miosix.h>
#include <sensors/Sensor.h>
 
#include "InternalADCData.h"
 
#if not defined(STM32F407xx) && not defined(STM32F429xx) && \
    not defined(STM32F767xx) && not defined(STM32F769xx)
#define INTERNAL_ADC_WITHOUT_CALIBRATION
#endif
 
namespace Boardcore
{
 
class InternalADC : public Sensor<InternalADCData>
{
public:
    enum Channel : uint8_t
    {
        CH0 = 0,
        CH1,
        CH2,
        CH3,
        CH4,
        CH5,
        CH6,
        CH7,
        CH8,
        CH9,
        CH10,
        CH11,
        CH12,
        CH13,
        CH14,
        CH15,
        CH16,
        CH17,
        CH18,
        CH_NUM
    };
 
    enum SampleTime : uint8_t
    {
        // CYCLES_3   = 0x0,
        CYCLES_15  = 0x1,
        CYCLES_28  = 0x2,
        CYCLES_56  = 0x3,
        CYCLES_84  = 0x4,
        CYCLES_112 = 0x5,
        CYCLES_144 = 0x6,
        CYCLES_480 = 0x7
    };
 
    explicit InternalADC(ADC_TypeDef* adc);
 
    ~InternalADC();
 
    bool init() override;
 
    bool selfTest() override;
 
    InternalADCData sampleImpl() override;
 
    void enableChannel(Channel channel, SampleTime sampleTime = CYCLES_480);
 
    void disableChannel(Channel channel);
 
    void enableTemperature(SampleTime sampleTime = CYCLES_480);
 
    void disableTemperature();
 
    void enableVbat(SampleTime sampleTime = CYCLES_480);
 
    void disableVbat();
 
    ADCData getVoltage(Channel channel);
 
    TemperatureData getTemperature();
 
    ADCData getVbatVoltage();
 
private:
    void resetRegisters();
 
    void setChannelSampleTime(Channel channel, SampleTime sampleTime);
 
    uint16_t readChannel(Channel channel);
 
    ADC_TypeDef* adc;
 
    bool channelsEnabled[CH_NUM];
    bool tempEnabled = false;
    bool vbatEnabled = false;
 
#ifndef INTERNAL_ADC_WITHOUT_CALIBRATION
    void loadCalibrationValues();
 
    // Factory calibration values
    // Read "Temperature sensor characteristics" chapter in the datasheet
    float calPt1Voltage;
    float calPt2Voltage;
    float calSlope;
#endif
};
 
}  // namespace Boardcore