lampConfig.hpp

Go to the documentation of this file.

#ifndef DEVMGR_DEVICE_LAMP_CONFIG_HPP
#define DEVMGR_DEVICE_LAMP_CONFIG_HPP

// System headers
#include <string>

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


#include <fcf/common/iComm.hpp>
#include <devmgr/common/deviceConfig.hpp>
#include <devmgr/common/configSet.hpp>
#include <devmgr/common/dataContext.hpp>
#include <devmgr/devices/lampRpcErrors.hpp>
#include <devmgr/devices/lampHwErrors.hpp>

namespace devmgr {
  namespace lamp {

    // Constants for internal mapping
    const std::string CI_ACTIVE_LOW_FAULT     = "low_fault";
    const std::string CI_ACTIVE_LOW_ON        = "low_on";
    const std::string CI_ACTIVE_LOW_SWITCH    = "low_switch";
    const std::string CI_IGNORE_FAULT         = "ignore_fault";
    const std::string CI_INVERT_ANALOG        = "invert_analog";
    const std::string CI_ANALOG_THRESHOLD     = "analog_threshold";
    const std::string CI_ANALOG_RANGE         = "analog_range";
    const std::string CI_COOLDDOWN            = "cooldown";
    const std::string CI_MAX_ON               = "maxon";
    const std::string CI_WARMUP               = "warmup";
    const std::string CI_INITIAL_STATE        = "initial_state";
    const std::string 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
    const short SUBSTATE_NOTREADY             =  100;
    const short SUBSTATE_INITIALISING         =  101;
    const short SUBSTATE_READY_OFF            =  102;
    const short SUBSTATE_READY_ON             =  103;
    const short SUBSTATE_STANDBY_FAILURE      =  104;

    const short SUBSTATE_OP_DISABLING         =  200;
    const short SUBSTATE_OP_OFF               =  201;
    const short SUBSTATE_OP_SWITCHING_OFF     =  202;
    const short SUBSTATE_OP_COOLING           =  203;
    const short SUBSTATE_OP_ON                =  204;
    const short SUBSTATE_OP_SWITCHING_ON      =  205;
    const short SUBSTATE_OP_WARMING           =  206;
    const short SUBSTATE_OP_FAILURE           =  207;

    const std::string SUBSTATE_NOTREADY_STR      =  "NotReady";
    const std::string SUBSTATE_INITIALISING_STR  =  "Initialising";
    const std::string SUBSTATE_READY_OFF_STR     =  "Ready/Off";
    const std::string SUBSTATE_READY_ON_STR      =  "Ready/On";
    const std::string SUBSTATE_FAILURE_STR       =  "Failure";

    const std::string SUBSTATE_OP_DISABLING_STR     =  "Disabling";
    const std::string SUBSTATE_OP_OFF_STR           =  "Off";
    const std::string SUBSTATE_OP_SWITCHING_OFF_STR =  "Switching off";
    const std::string SUBSTATE_OP_COOLING_STR       =  "Cooling down";
    const std::string SUBSTATE_OP_ON_STR            =  "On";
    const std::string SUBSTATE_OP_SWITCHING_ON_STR  =  "Switching on";
    const std::string SUBSTATE_OP_WARMING_STR       =  "Warming up";
    const std::string SUBSTATE_OP_FAILURE_STR       =  "Failure";

    const std::unordered_map<short, std::string>  SubstateMap = {
      {SUBSTATE_NOTREADY,        SUBSTATE_NOTREADY_STR},
      {SUBSTATE_INITIALISING,    SUBSTATE_INITIALISING_STR},
      {SUBSTATE_READY_OFF,       SUBSTATE_READY_OFF_STR},
      {SUBSTATE_READY_ON,        SUBSTATE_READY_ON_STR},
      {SUBSTATE_STANDBY_FAILURE, SUBSTATE_FAILURE_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},
      {SUBSTATE_OP_FAILURE,      SUBSTATE_OP_FAILURE_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 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();

      virtual void ReadConfig();

      virtual void GetConfig(fcf::common::VectorVariant& params);
      
      virtual std::string  GetMapFile();

      virtual void GetConfigList(std::vector<std::string>& cfg_list,
                                 std::string prefix);

    private:
      devmgr::common::MapCfgBool   m_map_cfg_bool; 
      devmgr::common::MapCfgInt    m_map_cfg_int;  
      devmgr::common::MapCfgUInt   m_map_cfg_uint; 
    };
  }
}


#endif //DEVMGR_DEVICE_LAMP_CONFIG_H