AnalogShield.h

Go to the documentation of this file.

#pragma once
 
#include <Arduino.h>

#define ANALOG_SHIELD_VERSION "0.1.2"  
#define ANALOG_SHIELD_VERSION_MAJOR 0  
#define ANALOG_SHIELD_VERSION_MINOR 1  
#define ANALOG_SHIELD_VERSION_PATCH 2  

namespace AnalogShieldPins {

constexpr uint8_t TEMP_SIG_MCU = A0;  
constexpr uint8_t SENSOR_IN = A1;     
constexpr uint8_t TEMP_SIG_EXT = A3;  
constexpr uint8_t IR_VOUT = A4;       
constexpr uint8_t POT = A5;           

constexpr uint8_t ENC_SW = 2;  
constexpr uint8_t ENC_A = 3;   
constexpr uint8_t ENC_B = 4;   
constexpr uint8_t LED2 = 5;    
constexpr uint8_t LED1 = 6;    
 
}  // namespace AnalogShieldPins

enum class TempSource : uint8_t {
  SENSOR,  
  MCU,     
  EXT,     
};

class AnalogShield {
 public:
  using EncoderCallback = void (*)(int32_t count, int8_t step);

  using SwitchCallback = void (*)(bool pressed);

  void begin();

  void end();

  static constexpr int32_t COUNTS_PER_DETENT = 2;  
  static constexpr int32_t DETENTS_PER_REV = 30;   

  [[nodiscard]] int32_t EncoderCount() const noexcept;

  [[nodiscard]] int32_t EncoderDetents() const noexcept;

  void SetEncoderCount(int32_t count = 0) noexcept;

  void SetEncoderCallback(EncoderCallback callback) noexcept;

  [[nodiscard]] bool SwitchPressed() const noexcept;

  void SetSwitchCallback(SwitchCallback callback) noexcept;

  bool SetAdcResolution(uint8_t bits);

  [[nodiscard]] uint8_t AdcResolution() const noexcept;


  [[nodiscard]] int TempRaw(TempSource source, uint8_t samples = 1) const;

  [[nodiscard]] int32_t TempMillivolts(TempSource source, uint8_t samples = 1) const;

  [[nodiscard]] float TempCelsius(TempSource source, uint8_t samples = 1) const;

  [[nodiscard]] float TempFahrenheit(TempSource source, uint8_t samples = 1) const;

  [[nodiscard]] float TempKelvin(TempSource source, uint8_t samples = 1) const;

  [[nodiscard]] int PotRaw(uint8_t samples = 1) const;

  [[nodiscard]] int32_t PotMillivolts(uint8_t samples = 1) const;

  [[nodiscard]] float PotPercent(uint8_t samples = 1) const;


  void LedON(uint8_t index, bool on = true) noexcept;

  void LedToggle(uint8_t index) noexcept;
 
 private:
  static void OnEncoderA();
  static void OnEncoderB();
  static void EncoderStep(int8_t step);
  static void OnSwitch();
  [[nodiscard]] static float ReadAverage(uint8_t pin, uint8_t samples);
  [[nodiscard]] float CountsToMillivolts(float counts, uint8_t pin) const noexcept;
  [[nodiscard]] static float MillivoltsToCelsius(float mv, TempSource source) noexcept;

  static AnalogShield* instance;
 
  uint8_t adc_bits = 10;  
 
  volatile int32_t count = 0;                         
  volatile EncoderCallback callback = nullptr;        
  volatile SwitchCallback switch_callback = nullptr;  
  volatile bool switch_pressed = false;               
};