solenoids.h

Go to the documentation of this file.

 
#ifndef SOLENOIDS_H_
#define SOLENOIDS_H_
 
#include "board.h"
#include "encoders.h"
#include <Arduino.h>
#include <Adafruit_MCP23008.h>
#include <Wire.h>
 
// Different machines have a different number of solenoids.
//                                              {910, 930, 270}
constexpr uint8_t SOLENOIDS_NUM[NUM_MACHINES] = {16U, 16U, 12U};
constexpr uint8_t HALF_SOLENOIDS_NUM[NUM_MACHINES] = {8U, 8U, 6U};
constexpr uint8_t SOLENOIDS_I2C_ADDRESS_MASK = 0x20U;
constexpr uint8_t SOLENOID_BUFFER_SIZE = 16U;
 
class SolenoidsInterface {
public:
  virtual ~SolenoidsInterface() = default;
 
  // any methods that need to be mocked should go here
  virtual void init() = 0;
  virtual void setSolenoid(uint8_t solenoid, bool state) = 0;
  virtual void setSolenoids(uint16_t state) = 0;
};
 
// Container class for the static methods that control the solenoids.
// Dependency injection is enabled using a pointer to a global instance of
// either `Solenoids` or `SolenoidsMock`, both of which classes implement
// the pure virtual methods of `SolenoidsInterface`.
 
class GlobalSolenoids final {
private:
  // singleton class so private constructor is appropriate
  GlobalSolenoids() = default;
 
public:
  // pointer to global instance whose methods are implemented
  static SolenoidsInterface *m_instance;
 
  static void init();
  static void setSolenoid(uint8_t solenoid, bool state);
  static void setSolenoids(uint16_t state);
};
 
class Solenoids : public SolenoidsInterface {
#ifdef AYAB_TESTS
  FRIEND_TEST(SolenoidsTest, test_init);
  FRIEND_TEST(SolenoidsTest, test_setSolenoid1);
  FRIEND_TEST(SolenoidsTest, test_setSolenoid2);
  FRIEND_TEST(SolenoidsTest, test_setSolenoid3);
#endif
public:
  Solenoids() = default;
 
  void init() final;
  void setSolenoid(uint8_t solenoid, bool state) final;
  void setSolenoids(uint16_t state) final;
 
private:
  uint16_t solenoidState = 0x0000U;
  void write(uint16_t state);
 
  Adafruit_MCP23008 mcp_0 = Adafruit_MCP23008();
  Adafruit_MCP23008 mcp_1 = Adafruit_MCP23008();
};
 
#endif // SOLENOIDS_H_