GY-63_MS5611/libraries/MCP_ADC/MCP_ADC.h

#pragma once
//
//    FILE: MCP_ADC.h
//  AUTHOR: Rob Tillaart
// VERSION: 0.1.8
//    DATE: 2019-10-24
// PURPOSE: Arduino library for MCP_ADC
//     URL: https://github.com/RobTillaart/MCP_ADC
//


#include "Arduino.h"
#include "SPI.h"


#define MCP_ADC_LIB_VERSION       (F("0.1.8"))


class MCP_ADC
{
public:
  MCP_ADC(uint8_t dataIn = 255, uint8_t dataOut = 255, uint8_t clock = 255);
  void     begin(uint8_t select);

  uint8_t  channels() { return _channels; };
  int16_t  maxValue() { return _maxValue; };
  int16_t  analogRead(uint8_t channel);
  int16_t  differentialRead(uint8_t channel);
  int16_t  deltaRead(uint8_t channel);

  //       speed in Hz
  void     setSPIspeed(uint32_t speed);
  uint32_t getSPIspeed()               { return _SPIspeed; };

  // debugging
  bool     usesHWSPI() { return _hwSPI; };

  // ESP32 specific
  #if defined(ESP32)
  void     selectHSPI() { _useHSPI = true;  };
  void     selectVSPI() { _useHSPI = false; };
  bool     usesHSPI()   { return _useHSPI;  };
  bool     usesVSPI()   { return !_useHSPI; };

  // to overrule ESP32 default hardware pins
  void     setGPIOpins(uint8_t clk, uint8_t miso, uint8_t mosi, uint8_t select);
  #endif

  uint32_t count();


protected:
  uint8_t  _dataIn;
  uint8_t  _dataOut;
  uint8_t  _clock;
  uint8_t  _select;
  bool     _hwSPI;
  uint8_t  _channels;
  int16_t  _maxValue;
  uint32_t _SPIspeed = 1000000;   // 1MHz is a safe value (datasheet); in a test 4 MHz worked.

  // derived classes must implement this one
  virtual uint8_t  buildRequest(uint8_t channel, bool single, uint8_t * data) = 0;

  int16_t  readADC(uint8_t channel, bool single);
  uint8_t  swSPI_transfer(uint8_t d);

  SPIClass    * mySPI;
  SPISettings _spi_settings;

  #if defined(ESP32)
  bool        _useHSPI = true;
  #endif

  uint32_t _count;
};

/////////////////////////////////////////////////////////////////////////////


class MCP3002 : public MCP_ADC
{
public:
  MCP3002(uint8_t dataIn = 255, uint8_t dataOut = 255, uint8_t clock = 255);
  uint8_t  buildRequest(uint8_t channel, bool single, uint8_t * data);
};

class MCP3004 : public MCP_ADC
{
public:
  MCP3004(uint8_t dataIn = 255, uint8_t dataOut = 255, uint8_t clock = 255);
  uint8_t  buildRequest(uint8_t channel, bool single, uint8_t * data);
};

class MCP3008 : public MCP_ADC
{
public:
  MCP3008(uint8_t dataIn = 255, uint8_t dataOut = 255, uint8_t clock = 255);
  uint8_t  buildRequest(uint8_t channel, bool single, uint8_t * data);
};


class MCP3202 : public MCP_ADC
{
public:
  MCP3202(uint8_t dataIn = 255, uint8_t dataOut = 255, uint8_t clock = 255);
  uint8_t  buildRequest(uint8_t channel, bool single, uint8_t * data);
};


class MCP3204 : public MCP_ADC
{
public:
  MCP3204(uint8_t dataIn = 255, uint8_t dataOut = 255, uint8_t clock = 255);
  uint8_t  buildRequest(uint8_t channel, bool single, uint8_t * data);
};


class MCP3208 : public MCP_ADC
{
public:
  MCP3208(uint8_t dataIn = 255, uint8_t dataOut = 255, uint8_t clock = 255);
  uint8_t  buildRequest(uint8_t channel, bool single, uint8_t * data);
};


// -- END OF FILE --