lampConfig.hpp

Go to the documentation of this file.

#ifndef FCF_DEVMGR_DEVICE_LAMP_CONFIG_HPP
#define FCF_DEVMGR_DEVICE_LAMP_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/lampRpcErrors.hpp>
#include <fcf/devmgr/devices/lampHwErrors.hpp>

namespace fcf::devmgr::lamp {


  // Constants for internal mapping
  constexpr auto CI_ACTIVE_LOW_FAULT            = "low_fault";
  constexpr auto CI_ACTIVE_LOW_ON               = "low_on";
  constexpr auto CI_ACTIVE_LOW_SWITCH           = "low_switch";
  constexpr auto CI_IGNORE_FAULT                = "ignore_fault";
  constexpr auto CI_INVERT_ANALOG               = "invert_analog";
  constexpr auto CI_ANALOG_THRESHOLD            = "analog_threshold";
  constexpr auto CI_ANALOG_RANGE                = "analog_range";
  constexpr auto CI_COOLDDOWN                   = "cooldown";
  constexpr auto CI_MAX_ON                      = "maxon";
  constexpr auto CI_WARMUP                      = "warmup";
  constexpr auto CI_INITIAL_STATE               = "initial_state";
  constexpr auto CI_TIMEOUT                     = "timeout";

  // Specifics lamp status values
  const std::string CI_STAT_INTENSITY           = "intensity";

  // Specific lamp RPC
  const std::string RPC_ON                      = "rpcSwitchOn";
  const std::string RPC_OFF                     = "rpcSwitchOff";

  // Specific constant values for lamp device state/substate
  constexpr int SUBSTATE_READY_OFF            =  103;
  constexpr int SUBSTATE_READY_ON             =  104;

  constexpr int SUBSTATE_OP_DISABLING         =  205;
  constexpr int SUBSTATE_OP_OFF               =  206;
  constexpr int SUBSTATE_OP_SWITCHING_OFF     =  207;
  constexpr int SUBSTATE_OP_COOLING           =  208;
  constexpr int SUBSTATE_OP_ON                =  209;
  constexpr int SUBSTATE_OP_SWITCHING_ON      =  210;
  constexpr int SUBSTATE_OP_WARMING           =  211;

  constexpr auto SUBSTATE_NOTREADY_STR          =  "NotReady";
  constexpr auto SUBSTATE_READY_OFF_STR         =  "Ready/Off";
  constexpr auto SUBSTATE_READY_ON_STR          =  "Ready/On";
  constexpr auto SUBSTATE_OP_DISABLING_STR      =  "Disabling";
  constexpr auto SUBSTATE_OP_OFF_STR            =  "Off";
  constexpr auto SUBSTATE_OP_SWITCHING_OFF_STR  =  "Switching off";
  constexpr auto SUBSTATE_OP_COOLING_STR        =  "Cooling down";
  constexpr auto SUBSTATE_OP_ON_STR             =  "On";
  constexpr auto SUBSTATE_OP_SWITCHING_ON_STR   =  "Switching on";
  constexpr auto SUBSTATE_OP_WARMING_STR        =  "Warming up";


  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_OFF,       SUBSTATE_READY_OFF_STR},
    {SUBSTATE_READY_ON,        SUBSTATE_READY_ON_STR},
    {fcf::devmgr::common::SUBSTATE_ERROR,           fcf::devmgr::common::SUBSTATE_ERROR_STR},
    {SUBSTATE_OP_DISABLING,    SUBSTATE_OP_DISABLING_STR},
    {SUBSTATE_OP_OFF,          SUBSTATE_OP_OFF_STR},
    {SUBSTATE_OP_SWITCHING_OFF,SUBSTATE_OP_SWITCHING_OFF_STR},
    {SUBSTATE_OP_COOLING,      SUBSTATE_OP_COOLING_STR},
    {SUBSTATE_OP_ON,           SUBSTATE_OP_ON_STR},
    {SUBSTATE_OP_SWITCHING_ON, SUBSTATE_OP_SWITCHING_ON_STR},
    {SUBSTATE_OP_WARMING,      SUBSTATE_OP_WARMING_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_ON,
  };

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

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

  class LampConfig : public fcf::devmgr::common::DeviceConfig
  {

    // Enumerations of configuration paramters
    enum {
      CFG_LOWFAULT    = 1,
      CFG_LOWON       = 2,
      CFG_LOWSWITCH   = 3,
      CFG_IGFAULT     = 4,
      CFG_INANALOG    = 5,
      CFG_ANTHRES     = 6,
      CFG_ANRANGE     = 7,
      CFG_COOLDOWN    = 8,
      CFG_MAXON       = 9,
      CFG_WARMUP      = 10,
      CFG_INITSTATE   = 11,
      CFG_TIMEOUT     = 12,
      END_ENUM_LAMP // WARNING: This should be always last enumerator.
    };

  public:

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

    virtual ~LampConfig();




  };

}  // fcf::devmgr::lamp


#endif //FCF_DEVMGR_DEVICE_LAMP_CONFIG_H