ADS1118.h

Go to the documentation of this file.

/* Copyright (c) 2020 Skyward Experimental Rocketry
 * Author: 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 <drivers/spi/SPIDriver.h>
#include <sensors/Sensor.h>
 
#include "ADS1118Data.h"
 
namespace Boardcore
{
 
class ADS1118 : public Sensor<ADS1118Data>
{
public:
    enum ADS1118Mux
    {
        MUX_AIN0_AIN1 = 0x0,  
        MUX_AIN0_AIN3 = 0x1,  
        MUX_AIN1_AIN3 = 0x2,  
        MUX_AIN2_AIN3 = 0x3,  
        MUX_AIN0_GND  = 0x4,  
        MUX_AIN1_GND  = 0x5,  
        MUX_AIN2_GND  = 0x6,  
        MUX_AIN3_GND  = 0x7   
    };  
 
    enum ADS1118Pga
    {
        FSR_6_144 = 0x0,  
        FSR_4_096 = 0x1,  
        FSR_2_048 = 0x2,  
        FSR_1_024 = 0x3,  
        FSR_0_512 = 0x4,  
        FSR_0_256 = 0x5   
    };  
 
    enum ADS1118Mode
    {
        CONTINUOUS_CONV_MODE = 0x0,  
        SINGLE_SHOT_MODE = 0x1  
    };  
 
    enum ADS1118DataRate
    {
        DR_8   = 0x0,  
        DR_16  = 0x1,  
        DR_32  = 0x2,  
        DR_64  = 0x3,  
        DR_128 = 0x4,  
        DR_250 = 0x5,  
        DR_475 = 0x6,  
        DR_860 = 0x7   
    };  
 
    enum ADS1118TempMode
    {
        ADC_MODE         = 0x0,  
        TEMP_SENSOR_MODE = 0x1   
    };  
 
    enum ADS1118PullUp
    {
        PULL_UP_DIS = 0x0,  
        PULL_UP_EN  = 0x1   
    };  
 
    union ADS1118Config
    {
        struct
        {
            ADS1118Mode mode : 1;  
            ADS1118Pga pga : 3;  
            ADS1118Mux mux : 3;  
            uint8_t singleShot : 1;        
            uint8_t reserved : 1;          
            uint8_t noOp : 2;              
            ADS1118PullUp pullUp : 1;      
            ADS1118TempMode tempMode : 1;  
            ADS1118DataRate rate : 3;      
        } bits;  
 
        struct
        {
            uint8_t msb;  
            uint8_t lsb;  
        } byte;           
 
        uint16_t word;  
    };  
 
    struct ADS1118InputConfig
    {
        ADS1118Mux mux       = MUX_AIN0_AIN1;  
        ADS1118DataRate rate = DR_128;  
    };  
 
    static constexpr uint8_t VALID_OPERATION =
        0x1;  
 
    static const ADS1118Config
        ADS1118_DEFAULT_CONFIG;  
 
    static constexpr int8_t TEMP_CHANNEL = 8;  
 
    static constexpr int8_t NUM_OF_CHANNELS = 9;
 
    static constexpr int8_t INVALID_CHANNEL = -1;
 
    ADS1118(SPIBusInterface& bus, miosix::GpioPin cs, ADS1118Config config_,
            SPIBusConfig spiConfig = getDefaultSPIConfig());
 
    explicit ADS1118(SPISlave spiSlave_,
                     ADS1118Config config_ = ADS1118_DEFAULT_CONFIG,
                     bool busyWait_ = false, int16_t tempDivider_ = 100);
 
    static SPIBusConfig getDefaultSPIConfig();
 
    bool init() override;
 
    void enableInput(ADS1118Mux mux);
 
    void enableInput(ADS1118Mux mux, ADS1118DataRate rate, ADS1118Pga pga);
 
    void disableInput(ADS1118Mux mux);
 
    void disableAllInputs();
 
    void enableTemperature();
 
    void disableTemperature();
 
    void enablePullUpResistor();
 
    void disablePullUpResistor();
 
    void enableConfigCheck();
 
    void disableConfigCheck();
 
    ADS1118Data readInputAndWait(ADS1118Mux mux);
 
    TemperatureData readTemperatureAndWait();
 
    ADS1118Data getVoltage(ADS1118Mux mux);
 
    TemperatureData getTemperature();
 
    int getConversionTime(int8_t channel);
 
    bool selfTest() override;
 
protected:
    ADS1118Data sampleImpl() override;
 
private:
    void readChannel(int8_t nextChannel, int8_t prevChannel);
 
    void readChannel(int8_t channel);
 
    int8_t findNextEnabledChannel(int8_t startChannel);
 
    const SPISlave spiSlave;
    ADS1118Config baseConfig;
 
    bool configCheck = false;
 
    const bool busyWait;
 
    ADS1118Config channelsConfig[NUM_OF_CHANNELS];  
    ADS1118Data values[NUM_OF_CHANNELS];            
 
    ADS1118Config lastConfig;     
    uint8_t lastConfigIndex = 0;  
 
    const uint16_t tempDivider;
 
    uint16_t sampleCounter = 0;  
 
    const float PGA_LSB_SIZE[6] = {0.187,   0.125,    0.0625,
                                   0.03125, 0.015625, 0.0078125};
 
    const int CONV_TIME[8] = {125000, 62500, 31250, 15625,
                              7813,   4000,  2106,  1163};
 
    static constexpr float TEMP_LSB_SIZE  = 0.03125;
    static constexpr uint16_t TEMP_CONFIG = 0xF281;
 
    static constexpr uint16_t CONFIG_MASK = 0xFE7F;
};
 
}  // namespace Boardcore