LED.h

Go to the documentation of this file.

 
 
 
#pragma once
 
#include <Arduino.h>
 
#include "MiscConstants.h"
 
constexpr unsigned BLINK_FAST_PERIOD_MS = 500;
constexpr unsigned BLINK_SLOW_PERIOD_MS = 1000;
constexpr unsigned PULSE_FAST_PERIOD_MS = 250;
constexpr unsigned PULSE_SLOW_PERIOD_MS = 500;
 
constexpr unsigned char PWM_MIN_BRIGHTNESS = 64;
constexpr unsigned char PWM_MAX_BRIGHTNESS = 255;
 
constexpr unsigned PERIODDIVISOR = 16;
 
class LED {
 public:
  enum class LEDPattern {
    SOLID = 0,
    BLINK_FAST,
    BLINK_SLOW,
    PULSE_FAST,
    PULSE_SLOW,
  };
 
  explicit LED(uint8_t controlPin);
  LED(uint8_t controlPin, bool pwmEnable);
  LED(uint8_t controlPin, uint8_t groundPin, bool pwmEnable = false);
 
  void Initialize();
  void Update();
 
  void On();
  void Off();
 
  bool GetIlluminated() const;
 
  void SetPattern(LEDPattern newPattern);
  LEDPattern GetPattern() const;
 
  bool IsPWM() const;
 
 private:
  const uint8_t m_controlPin;
  const uint8_t m_groundPin;
  const bool m_pwmEnable;
 
  bool m_initialized;
  LEDPattern m_pattern;
  bool m_illuminate;
 
  static uint8_t GAMMA[256];
  static bool GAMMA_INITIALIZED;
 
  void SetPulse();
  void SetFlash();
  void SetSolid();
 
  uint8_t CalcPulseBrightness(uint8_t brightness, uint16_t period, bool smooth = false, uint8_t offBrightness = 0);
};