actuatorConfig.hpp

Go to the documentation of this file.

#ifndef FCF_DEVMGR_DEVICE_ACTUATOR_CONFIG_HPP
#define FCF_DEVMGR_DEVICE_ACTUATOR_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/actuatorRpcErrors.hpp"
#include "fcf/devmgr/devices/actuatorHwErrors.hpp"

namespace fcf {
  namespace devmgr {
    namespace actuator {

      // Constants for internal mapping
      constexpr auto CI_ACTIVE_LOW_ON               = "low_on";
      constexpr auto CI_ACTIVE_LOW_SWITCH           = "low_switch";
      constexpr auto CI_INVERT_ANALOG               = "invert_analog";
      constexpr auto CI_ANALOG_THRESHOLD            = "analog_threshold";
      constexpr auto CI_MAX_ON                      = "maxon";
      constexpr auto CI_INITIAL_STATE               = "initial_state";
      constexpr auto CI_AUTO_OP                     = "auto_operational";
      constexpr auto CI_TIMEOUT                     = "timeout";
      constexpr auto CI_SIG_STABLE_PERIOD           = "signal_stable_period";

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

      // Specific constant values for actuator device state/substate
      constexpr int SUBSTATE_READY_OFF            =  103;
      constexpr int SUBSTATE_READY_ON             =  104;
      constexpr int SUBSTATE_SWITCHING_OFF        =  109;
      constexpr int SUBSTATE_SWITCHING_ON         =  110;

      constexpr int SUBSTATE_OP_DISABLING         =  205;
      constexpr int SUBSTATE_OP_OFF               =  206;
      constexpr int SUBSTATE_OP_SWITCHING_OFF     =  207;
      constexpr int SUBSTATE_OP_ON                =  209;
      constexpr int SUBSTATE_OP_SWITCHING_ON      =  210;

      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_SWITCHING_OFF_STR     =  "Ready/Swit_off";
      constexpr auto SUBSTATE_SWITCHING_ON_STR      =  "Ready/Swit_on";
      constexpr auto SUBSTATE_OP_OFF_STR            =  "Off";
      constexpr auto SUBSTATE_OP_SWITCHING_OFF_STR  =  "Switching_off";
      constexpr auto SUBSTATE_OP_ON_STR             =  "On";
      constexpr auto SUBSTATE_OP_SWITCHING_ON_STR   =  "Switching_on";


      const std::unordered_map<short, std::string>  SubstateMap = {
        {devmgr::common::SUBSTATE_NOTREADY,       devmgr::common::SUBSTATE_NOTREADY_STR},
        {devmgr::common::SUBSTATE_INITIALISING,   devmgr::common::SUBSTATE_INITIALISING_STR},
        {SUBSTATE_READY_OFF,       SUBSTATE_READY_OFF_STR},
        {SUBSTATE_READY_ON,        SUBSTATE_READY_ON_STR},
        {SUBSTATE_SWITCHING_OFF,   SUBSTATE_SWITCHING_OFF_STR},
        {SUBSTATE_SWITCHING_ON,    SUBSTATE_SWITCHING_ON_STR},
        {fcf::devmgr::common::SUBSTATE_ERROR,           fcf::devmgr::common::SUBSTATE_ERROR_STR},
        {SUBSTATE_OP_OFF,          SUBSTATE_OP_OFF_STR},
        {SUBSTATE_OP_SWITCHING_OFF,SUBSTATE_OP_SWITCHING_OFF_STR},
        {SUBSTATE_OP_ON,           SUBSTATE_OP_ON_STR},
        {SUBSTATE_OP_SWITCHING_ON, SUBSTATE_OP_SWITCHING_ON_STR},
        {fcf::devmgr::common::SUBSTATE_OP_ERROR,        fcf::devmgr::common::SUBSTATE_OP_ERROR_STR}
      };


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

      const std::vector<std::string> statMapping = {
        fcf::devmgr::common::CI_STAT_SUBSTATE,
        devmgr::common::CI_STAT_STATE,
        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 ActuatorConfig : public fcf::devmgr::common::DeviceConfig
      {

        // Enumerations of configuration paramters
        enum {
          CFG_LOWON       = 1,
          CFG_LOWSWITCH,
          CFG_AUTO_OP,
          CFG_INANALOG,
          CFG_ANTHRES,
          CFG_MAXON,
          CFG_SIG_STABLE_PERIOD,
          CFG_INITSTATE,
          CFG_TIMEOUT
        };

      public:

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

        virtual ~ActuatorConfig();


      private:

      };
    }
  }
}


#endif //FCF_DEVMGR_DEVICE_ACTUATOR_CONFIG_H