beeper.h

Go to the documentation of this file.

 
#ifndef BEEPER_H_
#define BEEPER_H_
 
#include <Arduino.h>
 
enum class BeepState : unsigned char {Idle, Wait, On, Off};
 
constexpr unsigned int BEEP_DELAY = 50U; // ms
 
constexpr uint8_t BEEP_NUM_READY = 5U;
constexpr uint8_t BEEP_NUM_FINISHEDLINE = 3U;
constexpr uint8_t BEEP_NUM_ENDWORK = 10U;
constexpr uint8_t BEEP_NUM_ERROR = 15U;
 
constexpr uint8_t BEEP_ON_DUTY = 0U;
constexpr uint8_t BEEP_OFF_DUTY = 20U;
constexpr uint8_t BEEP_NO_DUTY = 255U;
 
class BeeperInterface {
public:
  virtual ~BeeperInterface() = default;
 
  // any methods that need to be mocked should go here
  virtual void init(bool enabled) = 0;
  virtual bool enabled() = 0;
  virtual BeepState getState() = 0;
  virtual void ready() = 0;
  virtual void finishedLine() = 0;
  virtual void endWork() = 0;
  virtual void error() = 0;
  virtual void schedule() = 0;
};
 
// Container class for the static methods that control the beeper.
// Dependency injection is enabled using a pointer to a global instance of
// either `Beeper` or `BeeperMock`, both of which classes implement the
// pure virtual methods of `BeeperInterface`.
 
class GlobalBeeper final {
private:
  // singleton class so private constructor is appropriate
  GlobalBeeper() = default;
 
public:
  // pointer to global instance whose methods are implemented
  static BeeperInterface *m_instance;
 
  static void init(bool enabled);
  static bool enabled();
  static BeepState getState();
  static void ready();
  static void finishedLine();
  static void endWork();
  static void error();
  static void schedule();
};
 
class Beeper : public BeeperInterface {
public:
  void init(bool enabled) final;
  bool enabled() final;
  BeepState getState() final;
  void ready() final;
  void finishedLine() final;
  void endWork() final;
  void error() final;
  void schedule() final;
 
private:
  void beep(uint8_t repeats);
 
  BeepState m_currentState;
  BeepState m_nextState;
  unsigned long m_nextTime;
  uint8_t m_repeat;
  bool m_enabled;
};
 
#endif // BEEPER_H_