fcf::devmgr::lamp Namespace Reference

Classes
class	Lamp
	The Lamp class. More...
class	LampConfig
	Lamp Configuration 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,   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 }
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,   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	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"
const std::string	CI_STAT_INTENSITY = "intensity"
const std::string	RPC_ON = "rpcSwitchOn"
const std::string	RPC_OFF = "rpcSwitchOff"
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
const std::vector< std::string >	cfgMapping
const std::vector< std::string >	statMapping
const std::vector< std::string >	rpcMapping
const std::unordered_map< short, std::string >	hw_errors
const std::unordered_map< short, std::string >	rpc_errors

Enumeration Type Documentation

anonymous enum [1/2]

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
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

anonymous enum [2/2]

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
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

cfgMapping

const std::vector<std::string> fcf::devmgr::lamp::cfgMapping

Initial value:

= {
    CI_ACTIVE_LOW_FAULT,
    CI_ACTIVE_LOW_ON,
  }

CI_ACTIVE_LOW_FAULT

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

constexpr

CI_ACTIVE_LOW_ON

constexpr auto fcf::devmgr::lamp::CI_ACTIVE_LOW_ON = "low_on"

constexpr

CI_ACTIVE_LOW_SWITCH

constexpr auto fcf::devmgr::lamp::CI_ACTIVE_LOW_SWITCH = "low_switch"

constexpr

CI_ANALOG_RANGE

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

constexpr

CI_ANALOG_THRESHOLD

constexpr auto fcf::devmgr::lamp::CI_ANALOG_THRESHOLD = "analog_threshold"

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_INITIAL_STATE

constexpr auto fcf::devmgr::lamp::CI_INITIAL_STATE = "initial_state"

constexpr

CI_INVERT_ANALOG

constexpr auto fcf::devmgr::lamp::CI_INVERT_ANALOG = "invert_analog"

constexpr

CI_MAX_ON

constexpr auto fcf::devmgr::lamp::CI_MAX_ON = "maxon"

constexpr

CI_STAT_INTENSITY

const std::string fcf::devmgr::lamp::CI_STAT_INTENSITY = "intensity"

CI_TIMEOUT

constexpr auto fcf::devmgr::lamp::CI_TIMEOUT = "timeout"

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."}
  }

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"},
  }

RPC_OFF

const std::string fcf::devmgr::lamp::RPC_OFF = "rpcSwitchOff"

RPC_ON

const std::string fcf::devmgr::lamp::RPC_ON = "rpcSwitchOn"

rpcMapping

const std::vector<std::string> fcf::devmgr::lamp::rpcMapping

Initial value:

= {
    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_OFF,
    RPC_ON
  }

statMapping

const std::vector<std::string> fcf::devmgr::lamp::statMapping

Initial value:

= {
    fcf::devmgr::common::CI_STAT_SUBSTATE,
    fcf::devmgr::common::CI_STAT_STATE,
    CI_STAT_INTENSITY,
    fcf::devmgr::common::CI_STAT_LOCAL,
    fcf::devmgr::common::CI_STAT_ERROR_CODE
  }

SUBSTATE_NOTREADY_STR

constexpr auto fcf::devmgr::lamp::SUBSTATE_NOTREADY_STR = "NotReady"

constexpr

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_DISABLING

constexpr int fcf::devmgr::lamp::SUBSTATE_OP_DISABLING = 205

constexpr

SUBSTATE_OP_DISABLING_STR

constexpr auto fcf::devmgr::lamp::SUBSTATE_OP_DISABLING_STR = "Disabling"

constexpr

SUBSTATE_OP_OFF

constexpr int fcf::devmgr::lamp::SUBSTATE_OP_OFF = 206

constexpr

SUBSTATE_OP_OFF_STR

constexpr auto fcf::devmgr::lamp::SUBSTATE_OP_OFF_STR = "Off"

constexpr

SUBSTATE_OP_ON

constexpr int fcf::devmgr::lamp::SUBSTATE_OP_ON = 209

constexpr

SUBSTATE_OP_ON_STR

constexpr auto fcf::devmgr::lamp::SUBSTATE_OP_ON_STR = "On"

constexpr

SUBSTATE_OP_SWITCHING_OFF

constexpr int fcf::devmgr::lamp::SUBSTATE_OP_SWITCHING_OFF = 207

constexpr

SUBSTATE_OP_SWITCHING_OFF_STR

constexpr auto fcf::devmgr::lamp::SUBSTATE_OP_SWITCHING_OFF_STR = "Switching off"

constexpr

SUBSTATE_OP_SWITCHING_ON

constexpr int fcf::devmgr::lamp::SUBSTATE_OP_SWITCHING_ON = 210

constexpr

SUBSTATE_OP_SWITCHING_ON_STR

constexpr auto fcf::devmgr::lamp::SUBSTATE_OP_SWITCHING_ON_STR = "Switching on"

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

SUBSTATE_READY_OFF

constexpr int fcf::devmgr::lamp::SUBSTATE_READY_OFF = 103

constexpr

SUBSTATE_READY_OFF_STR

constexpr auto fcf::devmgr::lamp::SUBSTATE_READY_OFF_STR = "Ready/Off"

constexpr

SUBSTATE_READY_ON

constexpr int fcf::devmgr::lamp::SUBSTATE_READY_ON = 104

constexpr

SUBSTATE_READY_ON_STR

constexpr auto fcf::devmgr::lamp::SUBSTATE_READY_ON_STR = "Ready/On"

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},
    {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}
  }