ADS131M04.h

Go to the documentation of this file.

/* Copyright (c) 2023 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 <diagnostic/PrintLogger.h>
#include <drivers/spi/SPIDriver.h>
#include <sensors/Sensor.h>
 
#include "ADS131M04Data.h"
#include "ADS131M04Defs.h"
 
namespace Boardcore
{
 
class ADS131M04 : public Sensor<ADS131M04Data>
{
public:
    struct Config
    {
        struct ChannelConfig
        {
            bool enabled           = true;
            ADS131M04Defs::PGA pga = ADS131M04Defs::PGA::PGA_1;
            int32_t offset         = 0;
            double gain            = 1.0;
        };
 
        ChannelConfig channelsConfig[ADS131M04Defs::CHANNELS_NUM];
 
        ADS131M04Defs::OversamplingRatio oversamplingRatio =
            ADS131M04Defs::OversamplingRatio::OSR_16256;
        bool globalChopModeEnabled = false;
    };
 
    ADS131M04(SPIBusInterface& bus, miosix::GpioPin cs, SPIBusConfig spiConfig,
              const Config& config);
 
    bool init() override;
 
    bool reset();
 
    void applyConfig(Config config);
 
    void calibrateOffset(ADS131M04Defs::Channel channel);
 
    bool selfTest() override;
 
protected:
    ADS131M04Data sampleImpl() override;
 
private:
    void applyChannelConfig(ADS131M04Defs::Channel channel,
                            Config::ChannelConfig config);
 
    void setOversamplingRatio(ADS131M04Defs::OversamplingRatio ratio);
 
    void setChannelPGA(ADS131M04Defs::Channel channel, ADS131M04Defs::PGA gain);
 
    void setChannelOffset(ADS131M04Defs::Channel channel, uint32_t offset);
 
    void setChannelGain(ADS131M04Defs::Channel channel, double gain);
 
    void enableChannel(ADS131M04Defs::Channel channel);
 
    void disableChannel(ADS131M04Defs::Channel channel);
 
    void enableGlobalChopMode();
 
    void disableGlobalChopMode();
 
    void setChannelInput(ADS131M04Defs::Channel channel,
                         ADS131M04Defs::Input input);
 
    ADS131M04Defs::Register getChannelConfigRegister(
        ADS131M04Defs::Channel channel);
 
    ADS131M04Defs::Register getChannelOffsetRegisterMSB(
        ADS131M04Defs::Channel channel);
 
    ADS131M04Defs::Register getChannelOffsetRegisterLSB(
        ADS131M04Defs::Channel channel);
 
    ADS131M04Defs::Register getChannelGainRegisterMSB(
        ADS131M04Defs::Channel channel);
 
    ADS131M04Defs::Register getChannelGainRegisterLSB(
        ADS131M04Defs::Channel channel);
 
    bool readSamples(int32_t rawValues[ADS131M04Defs::CHANNELS_NUM]);
 
    uint16_t readRegister(ADS131M04Defs::Register reg);
 
    void writeRegister(ADS131M04Defs::Register reg, uint16_t data);
 
    void changeRegister(ADS131M04Defs::Register reg, uint16_t newValue,
                        uint16_t mask);
 
    void sendCommand(SPITransaction& transaction, ADS131M04Defs::Command cmd,
                     uint8_t data[ADS131M04Defs::FULL_FRAME_SIZE]);
 
    float getLSBSizeFromGain(ADS131M04Defs::PGA gain);
 
    SPISlave spiSlave;
 
    // Current device configuration
    Config config;
 
    PrintLogger logger = Logging::getLogger("ads131m04");
};
 
}  // namespace Boardcore