MAX31856.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 "MAX31856Data.h"
 
namespace Boardcore
{
 
class MAX31856 : public Sensor<MAX31856Data>
{
public:
    enum class ThermocoupleType : uint8_t
    {
        B_TYPE  = 0x0,
        E_TYPE  = 0x1,
        J_TYPE  = 0x2,
        K_TYPE  = 0x3,
        N_TYPE  = 0x4,
        R_TYPE  = 0x5,
        S_TYPE  = 0x6,
        T_TYPE  = 0x7,
        GAIN_8  = 0x8,
        GAIN_32 = 0x9,
    };
 
    MAX31856(SPIBusInterface& bus, miosix::GpioPin cs,
             SPIBusConfig config   = getDefaultSPIConfig(),
             ThermocoupleType type = ThermocoupleType::K_TYPE);
 
    static SPIBusConfig getDefaultSPIConfig();
 
    bool init();
 
    bool selfTest();
 
    bool checkConnected();
 
    void setThermocoupleType(ThermocoupleType type);
 
    void setColdJunctionOffset(float offset);
 
protected:
    MAX31856Data sampleImpl() override;
 
private:
    SPISlave slave;
    ThermocoupleType type;
 
    PrintLogger logger = Logging::getLogger("max31856");
 
    enum Registers : uint8_t
    {
        CR0    = 0x0,  
        CR1    = 0x1,  
        MASK   = 0x2,  
        CJHF   = 0x3,  
        CJLF   = 0x4,  
        LTHFTH = 0x5,  
        LTHFTL = 0x6,  
        LTLFTH = 0x7,  
        LTLFTL = 0x8,  
        CJTO   = 0x9,  
        CJTH   = 0xa,  
        CJTL   = 0xb,  
        LTCBH  = 0xc,  
        LTCBM  = 0xd,  
        LTCBL  = 0xe,  
        SR     = 0xf,  
    };
 
    static constexpr uint8_t CR0_CMODE     = 0x1 << 7;
    static constexpr uint8_t CR0_OCFAULT_0 = 0x1 << 4;
    static constexpr uint8_t SR_OPEN       = 0x1 << 0;
 
    static constexpr float TC_TEMP_LSB_VALUE = 0.007812;  // [°C]
    static constexpr float CJ_TEMP_LSB_VALUE = 0.0625;    // [°C]
};
 
}  // namespace Boardcore