mcp3008_driver.h

Go to the documentation of this file.

#pragma once
 
#include <driver/spi_master.h>
#include <vector>
 
namespace mcp3008 {
 
class Driver {
public:
    static constexpr int CHANNELS = 8; 
    static constexpr uint16_t MAX_VAL = 1023; 
 
    struct Config {
        Config(gpio_num_t pin_cs = GPIO_NUM_25, gpio_num_t pin_mosi = GPIO_NUM_33,
            gpio_num_t pin_miso = GPIO_NUM_32, gpio_num_t pin_sck = GPIO_NUM_26,
            uint8_t channels_mask = 0xFF, int freq = 1350000, spi_host_device_t spi_dev = HSPI_HOST) {
            this->freq = freq;
            this->spi_dev = spi_dev;
            this->channels_mask = channels_mask;
 
            this->pin_cs = pin_cs;
            this->pin_mosi = pin_mosi;
            this->pin_miso = pin_miso;
            this->pin_sck = pin_sck;
        }
 
        int freq; 
        spi_host_device_t spi_dev; 
        uint8_t channels_mask; 
 
        gpio_num_t pin_cs;
        gpio_num_t pin_mosi;
        gpio_num_t pin_miso;
        gpio_num_t pin_sck;
    };
 
    Driver();
    virtual ~Driver(); 
 
    esp_err_t install(const Config& cfg = Config());
 
    esp_err_t uninstall();
 
    uint8_t getChannelsMask() const { return m_channels_mask; } 
 
    esp_err_t read(std::vector<uint16_t>& results, bool differential = false) const;
 
    esp_err_t read(uint16_t* dest, bool differential = false) const;
 
    uint16_t readChannel(uint8_t channel, bool differential = false, esp_err_t* result = nullptr) const;
 
protected:
    int requestToChannel(int request) const;
 
private:
    Driver(const Driver&) = delete;
 
    spi_device_handle_t m_spi;
    spi_host_device_t m_spi_dev;
    bool m_installed;
    uint8_t m_channels_mask;
};
 
}; // namespace mcp3008