fcf::devmgr::lamp Namespace Reference

Classes
class	Lamp
	The Lamp class. More...
struct	LampControllerData
	The LampControllerData struct. More...
class	LampLcsIf
	Lamp Local Control System (LCS) Interface (IF) class. More...

Enumerations
enum	{   HW_SUCCESS = 0 , HW_ERR_HW_NOT_OP = 1 , HW_ERR_INIT_FAILURE = 2 , HW_ERR_UNEXPECTED_OFF = 3 ,   HW_ERR_UNEXPECTED_ON = 4 , HW_ERR_FAULT_SIG = 5 , HW_ERR_MAXON = 6 , HW_ERR_STILL_COOLING = 7 ,   HW_ERR_TIMEOUT_DISABLE = 8 , HW_ERR_TIMEOUT_INIT = 9 , HW_ERR_TIMEOUT_OFF = 10 , HW_ERR_TIMEOUT_ON = 11 }
enum	{   RPC_SUCCESS = 0 , RPC_ERR_NOT_OP = -1 , RPC_ERR_NOT_OP_READY = -2 , RPC_ERR_NOT_OP_NOTREADY = -3 ,   RPC_ERR_SWITCHING_ON = -4 , RPC_ERR_SWITCHING_OFF = -5 , RPC_ERR_COOLING = -6 , RPC_ERR_LOCAL = -7 }

Functions
	REGISTER_DEVICE (Lamp)

Variables
constexpr auto	LOGGER_NAME = "lamp"
constexpr auto	CI_ACTIVE_LOW_FAULT = "low_fault"
constexpr auto	CI_IGNORE_FAULT = "ignore_fault"
constexpr auto	CI_ANALOG_RANGE = "analog_range"
constexpr auto	CI_COOLDDOWN = "cooldown"
constexpr auto	CI_WARMUP = "warmup"
constexpr auto	CI_STAT_INTENSITY = "intensity"
constexpr auto	CI_STAT_TIME_LEFT = "time_left"
constexpr auto	CI_STAT_ON_ANALOG = "on_analog"
constexpr auto	CI_STAT_ON_DIGITAL = "on_digital"
constexpr auto	CI_STAT_ANALOG_FEEDBACK = "analog_feedback"
constexpr int	SUBSTATE_OP_COOLING = 208
constexpr int	SUBSTATE_OP_WARMING = 211
constexpr auto	SUBSTATE_OP_COOLING_STR = "Cooling down"
constexpr auto	SUBSTATE_OP_WARMING_STR = "Warming up"
const std::unordered_map< short, std::string >	SubstateMap
const std::unordered_map< short, std::string >	hw_errors
const std::unordered_map< short, std::string >	rpc_errors

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
HW_SUCCESS
HW_ERR_HW_NOT_OP
HW_ERR_INIT_FAILURE
HW_ERR_UNEXPECTED_OFF
HW_ERR_UNEXPECTED_ON
HW_ERR_FAULT_SIG
HW_ERR_MAXON
HW_ERR_STILL_COOLING
HW_ERR_TIMEOUT_DISABLE
HW_ERR_TIMEOUT_INIT
HW_ERR_TIMEOUT_OFF
HW_ERR_TIMEOUT_ON

anonymous enum

anonymous enum

Enumerator
RPC_SUCCESS
RPC_ERR_NOT_OP
RPC_ERR_NOT_OP_READY
RPC_ERR_NOT_OP_NOTREADY
RPC_ERR_SWITCHING_ON
RPC_ERR_SWITCHING_OFF
RPC_ERR_COOLING
RPC_ERR_LOCAL

Function Documentation

REGISTER_DEVICE()

fcf::devmgr::lamp::REGISTER_DEVICE

(

Lamp

)

Variable Documentation

CI_ACTIVE_LOW_FAULT

constexpr auto fcf::devmgr::lamp::CI_ACTIVE_LOW_FAULT = "low_fault"

constexpr

CI_ANALOG_RANGE

constexpr auto fcf::devmgr::lamp::CI_ANALOG_RANGE = "analog_range"

constexpr

CI_COOLDDOWN

constexpr auto fcf::devmgr::lamp::CI_COOLDDOWN = "cooldown"

constexpr

CI_IGNORE_FAULT

constexpr auto fcf::devmgr::lamp::CI_IGNORE_FAULT = "ignore_fault"

constexpr

CI_STAT_ANALOG_FEEDBACK

constexpr auto fcf::devmgr::lamp::CI_STAT_ANALOG_FEEDBACK = "analog_feedback"

constexpr

CI_STAT_INTENSITY

constexpr auto fcf::devmgr::lamp::CI_STAT_INTENSITY = "intensity"

constexpr

CI_STAT_ON_ANALOG

constexpr auto fcf::devmgr::lamp::CI_STAT_ON_ANALOG = "on_analog"

constexpr

CI_STAT_ON_DIGITAL

constexpr auto fcf::devmgr::lamp::CI_STAT_ON_DIGITAL = "on_digital"

constexpr

CI_STAT_TIME_LEFT

constexpr auto fcf::devmgr::lamp::CI_STAT_TIME_LEFT = "time_left"

constexpr

CI_WARMUP

constexpr auto fcf::devmgr::lamp::CI_WARMUP = "warmup"

constexpr

hw_errors

const std::unordered_map<short, std::string> fcf::devmgr::lamp::hw_errors

Initial value:

= {
    {HW_SUCCESS,             ""},
    {HW_ERR_HW_NOT_OP,       "TwinCAT not in OP state or CouplerState not mapped"},
    {HW_ERR_INIT_FAILURE,    "INIT command aborted due to STOP or RESET"},
    {HW_ERR_UNEXPECTED_OFF,  "unexpectedly switched off."},
    {HW_ERR_UNEXPECTED_ON,   "unexpectedly switched on."},
    {HW_ERR_FAULT_SIG,       "fault signal active."},
    {HW_ERR_MAXON,           "maximum on time exceeded."},
    {HW_ERR_STILL_COOLING,   "on command not allowed while cooling."},
    {HW_ERR_TIMEOUT_DISABLE, "disable timed out."},
    {HW_ERR_TIMEOUT_INIT,    "init timed out."},
    {HW_ERR_TIMEOUT_OFF,     "switching off timed out."},
    {HW_ERR_TIMEOUT_ON,      "switching on timed out."}
  }

LOGGER_NAME

constexpr auto fcf::devmgr::lamp::LOGGER_NAME = "lamp"

constexpr

rpc_errors

const std::unordered_map<short, std::string> fcf::devmgr::lamp::rpc_errors

Initial value:

= {
    {RPC_ERR_NOT_OP,               "Cannot disable lamp. Not in OP state"},
    {RPC_ERR_NOT_OP_READY,    "Cannot enable lamp. Not in READY."},
    {RPC_ERR_NOT_OP_NOTREADY, "Cannot init lamp. Not in NOTREADY or hardware FAILURE."},
    {RPC_ERR_SWITCHING_ON ,        "Not allowed to turn Lamp ON while turning it OFF"},
    {RPC_ERR_SWITCHING_OFF,        "Not allowed to turn Lamp OFF while turning it ON"},
    {RPC_ERR_COOLING,              "Cannot switch lamp ON. Still cooling down."},
    {RPC_ERR_LOCAL,                "RPC calls are not allowed in Local mode"},
  }

SUBSTATE_OP_COOLING

constexpr int fcf::devmgr::lamp::SUBSTATE_OP_COOLING = 208

constexpr

SUBSTATE_OP_COOLING_STR

constexpr auto fcf::devmgr::lamp::SUBSTATE_OP_COOLING_STR = "Cooling down"

constexpr

SUBSTATE_OP_WARMING

constexpr int fcf::devmgr::lamp::SUBSTATE_OP_WARMING = 211

constexpr

SUBSTATE_OP_WARMING_STR

constexpr auto fcf::devmgr::lamp::SUBSTATE_OP_WARMING_STR = "Warming up"

constexpr

SubstateMap

const std::unordered_map<short, std::string> fcf::devmgr::lamp::SubstateMap

Initial value:

= {
    {fcf::devmgr::common::SUBSTATE_NOTREADY,        fcf::devmgr::common::SUBSTATE_NOTREADY_STR},
    {fcf::devmgr::common::SUBSTATE_INITIALISING,    fcf::devmgr::common::SUBSTATE_INITIALISING_STR},
    {fcf::devmgr::actuator::SUBSTATE_READY_OFF,       fcf::devmgr::actuator::SUBSTATE_READY_OFF_STR},
    {fcf::devmgr::actuator::SUBSTATE_READY_ON,        fcf::devmgr::actuator::SUBSTATE_READY_ON_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},
    {fcf::devmgr::actuator::SUBSTATE_OP_OFF,          fcf::devmgr::actuator::SUBSTATE_OP_OFF_STR},
    {fcf::devmgr::actuator::SUBSTATE_OP_SWITCHING_OFF,fcf::devmgr::actuator::SUBSTATE_OP_SWITCHING_OFF_STR},
    {SUBSTATE_OP_COOLING,      SUBSTATE_OP_COOLING_STR},
    {fcf::devmgr::actuator::SUBSTATE_OP_ON,           fcf::devmgr::actuator::SUBSTATE_OP_ON_STR},
    {fcf::devmgr::actuator::SUBSTATE_OP_SWITCHING_ON, fcf::devmgr::actuator::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}
  }