HX711.h

Go to the documentation of this file.

/* Copyright (c) 2022 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 "HX711Data.h"
 
namespace Boardcore
{
 
class HX711 : public Sensor<HX711Data>
{
public:
    HX711(SPIBusInterface& bus, miosix::GpioPin sckPin,
          SPIBusConfig config                = getDefaultSPIConfig(),
          unsigned char sckAlternateFunction = 5);
 
    static SPIBusConfig getDefaultSPIConfig();
 
    bool init() override;
 
    bool selfTest() override;
 
    void computeScale(float value, float sample);
 
    void computeScale(float value);
 
    void setScale(float scale);
 
    float getScale();
 
    void setOffset(float offset);
 
    void updateOffset(float offset);
 
    float getOffset();
 
protected:
    HX711Data sampleImpl() override;
 
private:
    SPIBusInterface& bus;
    miosix::GpioPin sckPin;
    const SPIBusConfig config;
    unsigned char sckAlternateFunction;
 
    float scale    = 1;
    int32_t offset = 0;
};
 
}  // namespace Boardcore