VN100Spi.h

Go to the documentation of this file.

/* Copyright (c) 2024 Skyward Experimental Rocketry
 * Author: Fabrizio Monti
 *
 * 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 "VN100SpiData.h"
#include "VN100SpiDefs.h"
 
namespace Boardcore
{
 
class VN100Spi : public Sensor<VN100SpiData>
{
public:
    VN100Spi(SPIBus& bus, miosix::GpioPin csPin, SPIBusConfig busConfiguration,
             uint16_t syncOutSkipFactor);
 
    bool init() override;
 
    bool selfTest() override;
 
    TemperatureData getTemperature();
 
    PressureData getPressure();
 
protected:
    VN100SpiData sampleImpl() override;
 
private:
    bool checkModelNumber();
 
    void sendDummyPacket();
 
    bool setInterrupt();
 
    bool getSample(VN100SpiData& data);
 
    VN100SpiDefs::VNErrors readRegister(const uint8_t regId,
                                        uint8_t* payloadBuf,
                                        const uint32_t payloadSize);
 
    VN100SpiDefs::VNErrors writeRegister(const uint8_t regId,
                                         const uint8_t* payloadBuf,
                                         const uint32_t payloadSize);
 
    bool isInit = false;
 
    SPISlave spiSlave;
 
    const uint16_t syncOutSkipFactor = 0;
 
    PrintLogger logger = Logging::getLogger("vn100-spi");
};
 
}  // namespace Boardcore