dac.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>
#include <etl/algorithm.h>
 
namespace satnogs::comms::lib::bsp
{
class dac
{
public:
  dac(uint16_t resolution, float vref)
      : m_res(resolution), m_vref(vref), m_volts(0.0f)
  {
  }

  virtual void
  start() = 0;

  virtual void
  stop() = 0;

  virtual float
  voltage() const
  {
    return m_volts;
  }

  virtual void
  set_voltage(float volts)
  {
    m_volts    = etl::clamp(volts, 0.0f, m_vref);
    uint32_t x = m_volts / (vref() / (1UL << m_res));
    write(x);
  }

  virtual float
  vref() const
  {
    return m_vref;
  }
 
protected:
  virtual void
  write(uint32_t x) = 0;
 
private:
  const uint16_t m_res;
  const float    m_vref;
  float          m_volts;
};
 
} // namespace satnogs::comms::lib::bsp