adc.hpp

Go to the documentation of this file.

/*
 *  SatNOGS-COMMS control library
 *
 *  Copyright (C) 2022-2024, Libre Space Foundation <http://libre.space>
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  SPDX-License-Identifier: GNU General Public License v3.0 or later
 */
 
#pragma once
 
#include <cstdint>
namespace satnogs::comms::lib::bsp
{
class adc
{
public:
  adc(uint16_t resolution, float vref) : m_resolution(resolution), m_vref(vref)
  {
  }

  virtual void
  start() = 0;

  virtual void
  stop() = 0;

  virtual uint32_t
  read() = 0;

  virtual float
  voltage()
  {
    return read() * vref() / (1UL << m_resolution);
  }

  uint32_t
  resolution() const
  {
    return m_resolution;
  }

  float
  vref() const
  {
    return m_vref;
  }
 
private:
  const uint32_t m_resolution;
  const float    m_vref;
};

class dummy_adc : public adc
{
};
 
} // namespace satnogs::comms::lib::bsp