shutterConfig.hpp

Go to the documentation of this file.

#ifndef FCF_DEVMGR_DEVICE_SHUTTER_CONFIG_HPP
#define FCF_DEVMGR_DEVICE_SHUTTER_CONFIG_HPP

// System headers
#include <string>

// Third party headers
#include <yaml-cpp/yaml.h>

#include <fcf/common/iComm.hpp>
#include <fcf/devmgr/common/deviceConfig.hpp>
#include <fcf/devmgr/common/configSet.hpp>
#include <fcf/devmgr/common/dataContext.hpp>
#include <fcf/devmgr/devices/shutterRpcErrors.hpp>
#include <fcf/devmgr/devices/shutterHwErrors.hpp>

namespace fcf::devmgr::shutter {

  // Constants for internal mapping
  constexpr auto CI_ACTIVE_LOW_CLOSED       = "low_closed";
  constexpr auto CI_ACTIVE_LOW_FAULT        = "low_fault";
  constexpr auto CI_ACTIVE_LOW_OPEN         = "low_open";
  constexpr auto CI_ACTIVE_LOW_SWITCH       = "low_switch";
  constexpr auto CI_IGNORE_CLOSED           = "ignore_closed";
  constexpr auto CI_IGNORE_FAULT            = "ignore_fault";
  constexpr auto CI_IGNORE_OPEN             = "ignore_open";
  constexpr auto CI_INITIAL_STATE           = "initial_state";
  constexpr auto CI_TIMEOUT                 = "timeout";

  constexpr bool DEFAULT_ACTIVE_LOW_CLOSE   = false;
  constexpr bool DEFAULT_ACTIVE_LOW_FAULT   = false;
  constexpr bool DEFAULT_ACTIVE_LOW_OPEN    = false;
  constexpr bool DEFAULT_ACTIVE_LOW_SWITCH  = false;
  constexpr bool DEFAULT_IGNORE_CLOSED      = false;
  constexpr bool DEFAULT_IGNORE_FAULT       = false;
  constexpr bool DEFAULT_IGNORE_OPEN        = false;
  constexpr bool DEFAULT_INITIAL_STATE      = false;
  constexpr unsigned int DEFAULT_TIMEOUT    = 10000;

  // Specific shutter RPC
  constexpr auto RPC_OPEN                   = "rpcOpen";
  constexpr auto RPC_CLOSE                  = "rpcClose";

  // Specific constant values for shutter device state/substate

  constexpr short SUBSTATE_READY_CLOSE      =  105;
  constexpr short SUBSTATE_READY_OPEN       =  106;
  constexpr short SUBSTATE_OP_CLOSE         =  212;
  constexpr short SUBSTATE_OP_CLOSING       =  213;
  constexpr short SUBSTATE_OP_OPEN          =  214;
  constexpr short SUBSTATE_OP_OPENING       =  215;

  constexpr auto SUBSTATE_READY_CLOSE_STR   =  "Ready/Close";
  constexpr auto SUBSTATE_READY_OPEN_STR    =  "Ready/Open";
  constexpr auto SUBSTATE_OP_CLOSE_STR      =  "Close";
  constexpr auto SUBSTATE_OP_CLOSING_STR    =  "Closing";
  constexpr auto SUBSTATE_OP_OPEN_STR       =  "Open";
  constexpr auto SUBSTATE_OP_OPENING_STR    =  "Opening";


  const std::unordered_map<short, std::string>  SubstateMap = {
    {fcf::devmgr::common::SUBSTATE_NOTREADY,       fcf::devmgr::common::SUBSTATE_NOTREADY_STR},
    {fcf::devmgr::common::SUBSTATE_INITIALISING,   fcf::devmgr::common::SUBSTATE_INITIALISING_STR},
    {SUBSTATE_READY_CLOSE,    SUBSTATE_READY_CLOSE_STR},
    {SUBSTATE_READY_OPEN,     SUBSTATE_READY_OPEN_STR},
    {fcf::devmgr::common::SUBSTATE_ERROR,          fcf::devmgr::common::SUBSTATE_ERROR_STR},
    {fcf::devmgr::common::SUBSTATE_OP_DISABLING,   fcf::devmgr::common::SUBSTATE_OP_DISABLING_STR},
    {SUBSTATE_OP_CLOSE,       SUBSTATE_OP_CLOSE_STR},
    {SUBSTATE_OP_CLOSING,     SUBSTATE_OP_CLOSING_STR},
    {SUBSTATE_OP_OPEN,        SUBSTATE_OP_OPEN_STR},
    {SUBSTATE_OP_OPENING,     SUBSTATE_OP_OPENING_STR},
    {fcf::devmgr::common::SUBSTATE_OP_ERROR,       fcf::devmgr::common::SUBSTATE_OP_ERROR_STR}
  };

  const std::vector<std::string> cfgMapping = {
    CI_ACTIVE_LOW_FAULT,
    CI_ACTIVE_LOW_OPEN,
  };

  const std::vector<std::string> statMapping = {
    fcf::devmgr::common::CI_STAT_SUBSTATE,
    fcf::devmgr::common::CI_STAT_STATE,
    fcf::devmgr::common::CI_STAT_LOCAL,
    fcf::devmgr::common::CI_STAT_ERROR_CODE
  };

  const std::vector<std::string> rpcMapping = {
    fcf::devmgr::common::RPC_INIT,
    fcf::devmgr::common::RPC_ENABLE,
    fcf::devmgr::common::RPC_DISABLE,
    fcf::devmgr::common::RPC_RESET,
    fcf::devmgr::common::RPC_STOP,
    RPC_CLOSE,
    RPC_OPEN
  };

  class ShutterConfig : public fcf::devmgr::common::DeviceConfig {
   protected:
    // Enumerations of configuration paramters
    enum {
      CFG_IGCLOSED    = 0,
      CFG_IGFAULT     = 1,
      CFG_IGOPEN      = 2,
      CFG_LOWCLOSED   = 3,
      CFG_LOWFAULT    = 4,
      CFG_LOWOPEN     = 5,
      CFG_LOWSWITCH   = 6,
      CFG_INITSTATE   = 7,
      CFG_TIMEOUT     = 8,
      END_ENUM_SHUTTER // WARNING: This should be always last enumerator.
    };

  public:

    ShutterConfig(const std::string filename,
                  const std::string name);

    virtual ~ShutterConfig();


  };
}


#endif //FCF_DEVMGR_DEVICE_SHUTTER_CONFIG_HPP