ads7952.hpp

Go to the documentation of this file.

 
#pragma once
 
#define ADS7952_HEADER_INCLUDED
 
#include <cstdint>
#include <cstddef>
#include <algorithm>
 
#include "ads7952_config.hpp"
#include "ads7952_registers.hpp"
#include "ads7952_spi_interface.hpp"
#include "ads7952_types.hpp"
 
namespace ads7952 {
 
template <typename SpiType>
class ADS7952 {
public:
  // ===========================================================================
  // Construction
  // ===========================================================================
 
  explicit ADS7952(SpiType &spi,
                   float vref = ADS7952_CFG::DEFAULT_VREF,
               float va   = ADS7952_CFG::DEFAULT_VA,
               Range initial_range = ADS7952_CFG::DEFAULT_RANGE) noexcept;
 
  ADS7952(const ADS7952 &) = delete;
  ADS7952 &operator=(const ADS7952 &) = delete;
 
  // ===========================================================================
  // Initialization
  // ===========================================================================
 
  bool EnsureInitialized(bool force = false) noexcept;
 
  bool IsInitialized() const noexcept { return initialized_; }
 
  // ===========================================================================
  // Channel Reading
  // ===========================================================================
 
  ReadResult ReadChannel(uint8_t channel) noexcept;
 
  ChannelReadings ReadAllChannels() noexcept;
 
  // ===========================================================================
  // Voltage Conversion
  // ===========================================================================
 
  float CountToVoltage(uint16_t count) const noexcept;
 
  static constexpr float CountToVoltage(uint16_t count, float vref) noexcept {
    return (static_cast<float>(count) * vref) / static_cast<float>(reg::MAX_COUNT);
  }
 
  uint16_t VoltageToCount(float voltage) const noexcept;
 
  // ===========================================================================
  // Mode Control
  // ===========================================================================
 
  bool EnterManualMode(uint8_t channel = 0) noexcept;
 
  bool EnterAuto1Mode(bool reset_counter = true) noexcept;
 
  bool EnterAuto2Mode(bool reset_counter = true) noexcept;
 
  Mode GetMode() const noexcept { return mode_; }
 
  // ===========================================================================
  // Programming
  // ===========================================================================
 
  bool ProgramAuto1Channels(uint16_t channel_mask) noexcept;
 
  bool ProgramAuto2LastChannel(uint8_t last_channel) noexcept;
 
  bool ProgramGPIO(const GPIOConfig &config) noexcept;
 
  bool ProgramAlarm(uint8_t channel, AlarmBound bound,
                    uint16_t threshold_12bit) noexcept;
 
  bool ProgramAlarmVoltage(uint8_t channel, AlarmBound bound,
                           float voltage) noexcept;
 
  // ===========================================================================
  // Range & Power
  // ===========================================================================
 
  bool SetRange(Range range) noexcept;
 
  Range GetRange() const noexcept { return range_; }
 
  bool SetPowerDown(PowerDown pd) noexcept;
 
  PowerDown GetPowerDown() const noexcept {
    return power_down_;
  }
 
  // ===========================================================================
  // GPIO Output Control
  // ===========================================================================
 
  bool SetGPIOOutputs(uint8_t gpio_state) noexcept;
 
  uint8_t GetGPIOOutputs() const noexcept {
    return gpio_output_state_;
  }
 
  // ===========================================================================
  // Diagnostics
  // ===========================================================================
 
  float GetActiveVref() const noexcept { return active_vref_; }
 
  float GetVref() const noexcept { return vref_; }
 
  float GetVA() const noexcept { return va_; }
 
  void SetVref(float vref) noexcept;
 
  void SetVA(float va) noexcept;
 
  uint16_t GetAuto1ChannelMask() const noexcept { return auto1_mask_; }
 
  uint8_t GetAuto2LastChannel() const noexcept { return auto2_last_ch_; }
 
  // ===========================================================================
  // Raw frame trace (bring-up)
  // ===========================================================================
  uint8_t RawManualFrames(uint8_t channel, uint16_t* out, uint8_t n) noexcept;
 
  // ===========================================================================
  // Version
  // ===========================================================================
  static constexpr uint8_t GetDriverVersionMajor() noexcept { return 1; }
  static constexpr uint8_t GetDriverVersionMinor() noexcept { return 0; }
  static constexpr uint8_t GetDriverVersionPatch() noexcept { return 0; }
 
private:
  // ===========================================================================
  // Internal Helpers
  // ===========================================================================
 
  bool spiTransfer16(uint16_t command, uint16_t* response = nullptr) noexcept;
 
  bool Initialize() noexcept;
 
  uint16_t commonControlBits() const noexcept;
 
  template <typename Commit>
  bool programControlBits(uint16_t ctrl, Commit commit) noexcept;
 
  static constexpr uint8_t popcount16(uint16_t x) noexcept;
 
  // ===========================================================================
  // State
  // ===========================================================================
  SpiType &spi_;
 
  // Voltage references
  float vref_;          
  float va_;            
  float two_vref_;      
  float active_vref_;   
 
  // Device state tracking
  bool     initialized_       = false;
  Mode     mode_              = Mode::Manual;
  Range    range_             = ADS7952_CFG::DEFAULT_RANGE;
  PowerDown power_down_       = PowerDown::Normal;
 
  // Programming state tracking
  uint16_t auto1_mask_        = ADS7952_CFG::DEFAULT_AUTO1_MASK;
  uint8_t  auto2_last_ch_     = ADS7952_CFG::DEFAULT_AUTO2_LAST_CH;
  uint8_t  gpio_output_state_ = 0;
  uint8_t manual_channel_ = 0; 
};
 
} // namespace ads7952
 
// Template implementation — included only at end of this header
#include "ads7952.ipp"