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 }

enum	{ RPC_SUCCESS = 0, RPC_ERR_NOT_OP = -1, RPC_ERR_NOT_STANDBY_READY = -2, RPC_ERR_NOT_STANDBY_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 }

enum	{ RPC_SUCCESS = 0, RPC_ERR_NOT_OP = -1, RPC_ERR_NOT_STANDBY_READY = -2, RPC_ERR_NOT_STANDBY_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 }

enum	{ RPC_SUCCESS = 0, RPC_ERR_NOT_OP = -1, RPC_ERR_NOT_STANDBY_READY = -2, RPC_ERR_NOT_STANDBY_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
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"

const std::string	CI_STAT_INTENSITY = "intensity"

const std::string	RPC_ON = "rpcSwitchOn"

const std::string	RPC_OFF = "rpcSwitchOff"

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

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

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

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

Enumerator
RPC_SUCCESS
RPC_ERR_NOT_OP
RPC_ERR_NOT_STANDBY_READY
RPC_ERR_NOT_STANDBY_NOTREADY
RPC_ERR_SWITCHING_ON
RPC_ERR_SWITCHING_OFF
RPC_ERR_COOLING
RPC_ERR_LOCAL

anonymous enum

Enumerator
RPC_SUCCESS
RPC_ERR_NOT_OP
RPC_ERR_NOT_STANDBY_READY
RPC_ERR_NOT_STANDBY_NOTREADY
RPC_ERR_SWITCHING_ON
RPC_ERR_SWITCHING_OFF
RPC_ERR_COOLING
RPC_ERR_LOCAL

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

Enumerator
RPC_SUCCESS
RPC_ERR_NOT_OP
RPC_ERR_NOT_STANDBY_READY
RPC_ERR_NOT_STANDBY_NOTREADY
RPC_ERR_SWITCHING_ON
RPC_ERR_SWITCHING_OFF
RPC_ERR_COOLING
RPC_ERR_LOCAL

Function Documentation

devmgr::lamp::REGISTER_DEVICE ( Lamp )

Variable Documentation

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

Initial value:

= {
      CI_ACTIVE_LOW_FAULT,
      CI_ACTIVE_LOW_ON,
    }

const std::string devmgr::lamp::CI_ACTIVE_LOW_FAULT = "low_fault"

const std::string devmgr::lamp::CI_ACTIVE_LOW_ON = "low_on"

const std::string devmgr::lamp::CI_ACTIVE_LOW_SWITCH = "low_switch"

const std::string devmgr::lamp::CI_ANALOG_RANGE = "analog_range"

const std::string devmgr::lamp::CI_ANALOG_THRESHOLD = "analog_threshold"

const std::string devmgr::lamp::CI_COOLDDOWN = "cooldown"

const std::string devmgr::lamp::CI_IGNORE_FAULT = "ignore_fault"

const std::string devmgr::lamp::CI_INITIAL_STATE = "initial_state"

const std::string devmgr::lamp::CI_INVERT_ANALOG = "invert_analog"

const std::string devmgr::lamp::CI_MAX_ON = "maxon"

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

const std::string devmgr::lamp::CI_TIMEOUT = "timeout"

const std::string devmgr::lamp::CI_WARMUP = "warmup"

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

Initial value:

= {
      {HW_SUCCESS,             ""},
      {HW_ERR_HW_NOT_OP,       "not in operational state"},
      {HW_ERR_INIT_FAILURE,    "init failure"},
      {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."}
    }

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

Initial value:

= {
      {RPC_ERR_NOT_OP,               "Cannot disable lamp. Not in OP state"},
      {RPC_ERR_NOT_STANDBY_READY,    "Cannot enable lamp. Not in READY."},
      {RPC_ERR_NOT_STANDBY_NOTREADY, "Cannot init lamp. Not in NOTREADY or 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"},
    }

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

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

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

Initial value:

= {
      devmgr::common::RPC_INIT,
      devmgr::common::RPC_ENABLE,
      devmgr::common::RPC_DISABLE,
      devmgr::common::RPC_RESET,
      devmgr::common::RPC_STOP,
      RPC_OFF,
      RPC_ON
    }

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

Initial value:

= {
      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::string devmgr::lamp::SUBSTATE_FAILURE_STR = "Failure"

const short devmgr::lamp::SUBSTATE_INITIALISING = 101

const std::string devmgr::lamp::SUBSTATE_INITIALISING_STR = "Initialising"

const short devmgr::lamp::SUBSTATE_NOTREADY = 100

const std::string devmgr::lamp::SUBSTATE_NOTREADY_STR = "NotReady"

const short devmgr::lamp::SUBSTATE_OP_COOLING = 203

const std::string devmgr::lamp::SUBSTATE_OP_COOLING_STR = "Cooling down"

const short devmgr::lamp::SUBSTATE_OP_DISABLING = 200

const std::string devmgr::lamp::SUBSTATE_OP_DISABLING_STR = "Disabling"

const short devmgr::lamp::SUBSTATE_OP_FAILURE = 207

const std::string devmgr::lamp::SUBSTATE_OP_FAILURE_STR = "Failure"

const short devmgr::lamp::SUBSTATE_OP_OFF = 201

const std::string devmgr::lamp::SUBSTATE_OP_OFF_STR = "Off"

const short devmgr::lamp::SUBSTATE_OP_ON = 204

const std::string devmgr::lamp::SUBSTATE_OP_ON_STR = "On"

const short devmgr::lamp::SUBSTATE_OP_SWITCHING_OFF = 202

const std::string devmgr::lamp::SUBSTATE_OP_SWITCHING_OFF_STR = "Switching off"

const short devmgr::lamp::SUBSTATE_OP_SWITCHING_ON = 205

const std::string devmgr::lamp::SUBSTATE_OP_SWITCHING_ON_STR = "Switching on"

const short devmgr::lamp::SUBSTATE_OP_WARMING = 206

const std::string devmgr::lamp::SUBSTATE_OP_WARMING_STR = "Warming up"

const short devmgr::lamp::SUBSTATE_READY_OFF = 102

const std::string devmgr::lamp::SUBSTATE_READY_OFF_STR = "Ready/Off"

const short devmgr::lamp::SUBSTATE_READY_ON = 103

const std::string devmgr::lamp::SUBSTATE_READY_ON_STR = "Ready/On"

const short devmgr::lamp::SUBSTATE_STANDBY_FAILURE = 104

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

Initial value:

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

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

Function Documentation

Variable Documentation