ATWhiteLight

Note

This page is generated by python script generate_cet.py.

Back to table

Commands

closeShutter

Description: Close the shutter.

EFDB_Topic

ATWhiteLight_command_closeShutter

openShutter

Description: Open the shutter.

EFDB_Topic

ATWhiteLight_command_openShutter

setChillerTemperature

Description: Set the chiller control temperature.

EFDB_Topic

ATWhiteLight_command_setChillerTemperature

temperature

IDL_Type

float

Units

deg_C

Description: Desired temperature.

startChiller

Description: Command the chiller to start cooling at the current set temperature.

EFDB_Topic

ATWhiteLight_command_startChiller

stopChiller

Description: Command the chiller to stop cooling. Rejected if the lamp is on.

EFDB_Topic

ATWhiteLight_command_stopChiller

turnLampOff

Description: Turn off the lamp. Unless you specify force=True this will be rejected if the lamp is warming up.

EFDB_Topic

ATWhiteLight_command_turnLampOff

force

IDL_Type

boolean

Units

unitless

Description: If True then turn it off even if the lamp is warming up. This may shorten the bulb life.

turnLampOn

Description: Turn the lamp on, or change the lamp power if the lamp is already on. Rejected if the chiller is off or the lamp is cooling down.

EFDB_Topic

ATWhiteLight_command_turnLampOn

power

IDL_Type

float

Units

W

Description: Desired power. Specify 0 to use the CSC’s configured default power. If not zero then must be between 800 and 1200 Watts (inclusive).

disable

Description: Transition from state Enabled to Disabled.

EFDB_Topic

SALGeneric_command_disable

Category

csc

enable

Description: Transition from state Disabled to Enabled.

EFDB_Topic

SALGeneric_command_enable

Category

csc

exitControl

Description: Transition from state Standby to Offline. For CSCs that start in Standby state this makes the CSC quit. CSCs that start in Offline state, they remain active.

EFDB_Topic

SALGeneric_command_exitControl

Category

csc

setAuthList

EFDB_Topic

SALGeneric_command_setAuthList

Category

csc

authorizedUsers

IDL_Type

string

Units

unitless

Description: Comma seperated list of authorized users currently allowed to command this CSC,

in the form user@host. If the first character is +/- then the specified users are added/removed. Duplicates are silently ignored. The CSC’s own user@host is silently ignored, because it is always authorized. For removal, CSCs that are not in the list are silently ignored. Whitespace is allowed after the optional initial +/- and after each comma.

nonAuthorizedCSCs

IDL_Type

string

Units

unitless

Description: Comma seperated list of CSC’s not currently allowed to command this CSC,

in the form name[:index]. An index of 0 is stripped (name:0 becomes name). If the first character is +/- then the specified CSCs are added/removed. Duplicates are silently ignored. For removal, CSCs that are not in the list are silently ignored. Whitespace is allowed after the optional initial +/- and after each comma.

setLogLevel

Description: Set the logging level.

EFDB_Topic

SALGeneric_command_setLogLevel

Category

csc

level

IDL_Type

int

Units

unitless

Description: Logging level, as a Python logging level: error=40, warning=30, info=20, debug=10.

subsystem

IDL_Type

string

Units

unitless

Description: If the CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to the CSC itself.

standby

Description: Transition from state Offline, Disabled or Fault to Standby.

EFDB_Topic

SALGeneric_command_standby

Category

csc

start

Description: Transition from state Standby to Disable, in a specified configuration.

EFDB_Topic

SALGeneric_command_start

Category

csc

configurationOverride

IDL_Type

string

Units

unitless

Description:

Configuration override in the form [{name}][:{version}]. For salobj-based CSCs: name is a filename with “.yaml” suffix and version is a git hash; for example:

• “foo.yaml” specifies just a file. Two or three config files are loaded: “_init.yaml”, “_{site}.yaml” (if present), and “foo.yaml”.

• “:37bf936” specifies just a git hash. One or two config files are loaded from the specified git commit: “_init.yaml” and “_{site}.yaml” (if present.

• “bar.yaml:HEAD~2” specifies both a file and a git hash. Two or three config files are read from the specified git commit: “_init.yaml”, “_{site}.yaml” (if present), and “bar.yaml”.

Enumerations

ChillerL1Alarms

• AMBIENT_TEMP_SENSOR = 0x01

• HIGH_CONTROL_TEMP = 0x02

• PT7_HIGH_TEMP = 0x04

• LOW_CONTROL_TEMP = 0x08

• SUPPLY_TEMP_SENSOR = 0x10

• EXTERNAL_RTD_SENSOR = 0x20

• RETURN_TEMP_SENSOR = 0x40

• EXTERNAL_THERMISTOR_SENSOR = 0x80

• LOW_COOLANT_LEVEL = 0x100

• LOW_COOLANT_FLOW = 0x200

• LOW_PLANT_FLOW = 0x400

• CURRENT_SENSOR_1 = 0x800

• PT7_LOW_TEMP = 0x1000

• HIGH_AMBIENT_TEMP = 0x2000

• LOW_AMBIENT_TEMP = 0x4000

• EXTERNAL_CONNECTOR_NOT_INSTALLED = 0x8000

• DEFAULT_HIGH_TEMP = 0x10000

• DEFAULT_LOW_TEMP = 0x20000

• NO_COOLANT_FLOW = 0x40000

• FAN_FAILURE = 0x80000

• CURRENT_SENSOR_2 = 0x100000

• INTERNAL_2_5V_REFERENCE = 0x200000

• INTERNAL_5V_REFERENCE = 0x400000

• SYSTEM_ERROR = 0x800000

ChillerL21Alarms

• ADC_SYSTEM_ERROR = 0x10

• I2C_SYSTEM_ERROR = 0x20

• EEPROM_SYSTEM_ERROR = 0x40

• WATCHDOG_SYSTEM_ERROR = 0x80

• ADC_RESET_ERROR = 0x1000

• ADC_CALIBRATION_ERROR = 0x2000

• ADC_CONVERSION_ERROR = 0x4000

• IO_EXPENDER_ACKNOWLEDGE_ERROR = 0x10000

• PSA_EXPENDER_ACKNOWLEDGE_ERROR = 0x20000

• RTC_ACKNOWLEDGE_ERROR = 40000

• I2C_SCL_LOW_ERROR = 0x100000

• I2C_SDA_LOW_ERROR = 0x200000

• EEPROM_1_ACKNOWLEDGE = 0x400000

• EEPROM_2_ACKNOWLEDGE = 0x800000

• EEPROM_1_READ_ERROR = 0x1000000

• EEPROM_1_WRITE_ERROR = 0x2000000

• EEPROM_2_READ_ERROR = 0x4000000

• EEPROM_2_WRITE_ERROR = 0x8000000

ChillerL22Alarms

• EXTERNAL_RTD_SENSOR_OPEN = 0x1

• EXTERNAL_RTD_SENSOR_SHORT = 0x2

• RETURN_TEMP_SENSOR_OPEN = 0x4

• RETURN_TEMP_SENSOR_SHORT = 0x8

• GLOBAL_TEMP_SENSOR = 0x10

• SUPPLY_TEMP_SENSOR_LOCKED = 0x20

• SUPPLY_TEMP_SENSOR_OPEN = 0x40

• SUPPLY_TEMEPRATURE_SENSOR_SHORT = 0x80

• INTERNAL_2_5V_REFERENCE_HIGH = 0x100

• INTERNAL_2_5V_REFERENCE_LOW = 0x200

• INTERNAL_5V_REFERENCE_HIGH = 0x400

• INTERNAL_5V_REFERENCE_LOW = 0x800

• EXTERNAL_THERMAL_SENSOR_OPEN = 0x1000

• EXTERNAL_THERMAL_SENSOR_SHORT = 0x2000

• AMBIENT_THERMAL_SENSOR_OPEN = 0x4000

• AMBIENT_THERMAL_SENSOR_SHORT = 0x8000

• CURRENT_SENSOR_1_OPEN = 0x100000

• CURRENT_SENSOR_1_SHORT = 0x200000

• CURRENT_SENSOR_2_OPEN = 0x400000

• CURRENT_SENSOR_2_SHORT = 0x800000

• REAR_LEFT_FAN_NOISE = 0x1000000

• REAR_RIGHT_FAN_NOISE = 0x2000000

• FRONT_LEFT_FAN_NOISE = 0x4000000

• FRONT_RIGHT_FAN_NOISE = 0x8000000

• REAR_LEFT_FAN_OPEN = 0x10000000

• REAR_RIGHT_FAN_OPEN = 0x20000000

• FRONT_LEFT_FAN_OPEN = 0x40000000

ChillerControllerState

• Unknown = -1

• Autostart = 0

• Standby = 1

• Run = 2

• Safety = 3

• Test = 4

ChillerWarnings

• LOW_COOLANT_FLOW = 0x01

• COOLANT_FLUID_LEVEL = 0x02

• SWITCH_TO_SUPPLY_TEMP_AS_CONTROL_TEMP = 0x04

• HIGH_CONTROL_TEMP = 0x10

• LOW_CONTROL_TEMP = 0x20

• HIGH_AMBIENT_TEMP = 0x40

• LOW_AMBIENT_TEMP = 0x80

LampBasicState

• Unknown=0

• Off=1

• On=2

• Cooldown=4

• Warmup=5

LampControllerError

• NoError=-1

• Unknown=0

• KillSwitch=1

• ChassisOverheating=2

• AccessDoor=3

• BallastOverheating=4

• USBDisconnected=5

• AirflowInadequate=6

• LampStuckOn=7

• AirflowMalfunction=8

LampControllerState

• Unknown=0

• Off=1

• StandbyOrOn=2

• Cooldown=3

• Error=4

ShutterState

• Unknown=0

• Closed=1

• Open=2

• Invalid=3

Events

chillerAlarms

Description: Chiller alarms, as a set of bit masks.

EFDB_Topic

ATWhiteLight_logevent_chillerAlarms

level1

IDL_Type

unsigned int

Units

unitless

Description: Level 1 alarms as a bit mask of ChillerL1Alarms enum values.

level21

IDL_Type

unsigned int

Units

unitless

Description: Level 2 set 1 alarms, as a bit mask of ChillerL21Alarms enum values.

level22

IDL_Type

unsigned int

Units

unitless

Description: Level 2 set 2 alarms, as a bit mask of ChillerL22Alarms enum values.

chillerConnected

Description: Is the CSC connected to the chiller?

EFDB_Topic

ATWhiteLight_logevent_chillerConnected

connected

IDL_Type

boolean

Units

unitless

Description: Connected if true, else disconnected

chillerWarnings

Description: Chiller warnings, as a bit mask.

EFDB_Topic

ATWhiteLight_logevent_chillerWarnings

warnings

IDL_Type

unsigned int

Units

unitless

Description: Warnings, as a bit mask of ChillerWarnings enum values.

chillerWatchdog

Description: Chiller state reported by the watchdog command.

EFDB_Topic

ATWhiteLight_logevent_chillerWatchdog

controllerState

IDL_Type

int

Units

unitless

Description: Chiller state, as a ChillerControllerState enum value.

pumpRunning

IDL_Type

boolean

Units

unitless

Description: Is the pump running?

alarmsPresent

IDL_Type

boolean

Units

unitless

Description: Are any alarm conditions present? Note that this is read separately than the data used for the chillerAlarms topic.

warningsPresent

IDL_Type

boolean

Units

unitless

Description: Are any warning conditions present? Note that this is read separately than the data used for the chillerWarnings topic.

lampConnected

Description: Is the CSC connected to the lamp controller (actually to the LabJack that interfaces to the lamp controller)?

EFDB_Topic

ATWhiteLight_logevent_lampConnected

connected

IDL_Type

boolean

Units

unitless

Description: Connected if true, else disconnected

lampOnHours

Description: Estimated time the lamp was on

EFDB_Topic

ATWhiteLight_logevent_lampOnHours

hours

IDL_Type

double

Units

hour

Description: Estimated lamp on time

lampState

Description: Lamp status

EFDB_Topic

ATWhiteLight_logevent_lampState

basicState

IDL_Type

int

Units

unitless

Description: Basic lamp state; a LampBasicState enum.

controllerError

IDL_Type

int

Units

unitless

Description: Error code reported by the lamp controller. A LampControllerError enum. Warning: if the reported value is anything except None, it may be stale by up to 10 seconds. The reason is that the controller reports errors using a slowly blinking error signal (and LED) that can take up to 10 seconds to decode. If the signal starts blinking while there is no error then the value reported in this field will be GENERIC_ERROR, with a delay of less than a second. Once the error signal is decoded the reported value will change to the decoded value, and remain that value until a different error signal is decoded or the error goes away.

controllerState

IDL_Type

int

Units

unitless

Description: Lamp controller state; a LampControllerState enum.

setPower

IDL_Type

float

Units

W

Description: Commanded lamp power.

cooldownEndTime

IDL_Type

float

Units

second

Description: Time when lamp will be fully cooled down (TAI unix seconds; 0 if unknown). Until the lamp is fully cooled down you cannot turn it back on or turn off the chiller.

warmupEndTime

IDL_Type

float

Units

second

Description: Time when lamp will be fully warmed up (TAI unix seconds; 0 if unknown). Until then you cannot turn off the lamp (unless you specify force=True).

shutterState

Description: Shutter state

EFDB_Topic

ATWhiteLight_logevent_shutterState

commandedState

IDL_Type

int

Units

unitless

Description: Commanded state. A ShutterState enum. It will be UNKNOWN when the CSC begins running. Once the CSC receives a shutter command this state should always be OPEN or CLOSED.

actualState

IDL_Type

int

Units

unitless

Description: Actual state based on open and closed sensing switches. A ShutterState enum. INVALID indicates that both switches are active at the same time, which probably indicates a broken connection. UNKNOWN indicates that neither switch is active; this is the expected value while the shutter is moving.

enabled

IDL_Type

boolean

Units

unitless

Description: Is the shutter motor enabled? True for yes.

authList

EFDB_Topic

SALGeneric_logevent_authList

Category

csc

authorizedUsers

IDL_Type

string

Units

unitless

Description: Comma seperated list of authorized users currently allowed to command this CSC.

nonAuthorizedCSCs

IDL_Type

string

Units

unitless

Description: Comma seperated list of CSC’s not currently allowed to command this CSC.

configurationApplied

Description: Information about CSC’s configuration.

EFDB_Topic

SALGeneric_logevent_configurationApplied

Category

configurable

configurations

IDL_Type

string

Units

unitless

Description: A comma-separated list of configurations applied. If configuration comes from a clone of a git repo, or similar directory, then it will be a list of file names, without the file extension. Ignore whitespace after commas.

version

IDL_Type

string

Units

unitless

Description: Version of the configuration source. For a clone of a git repo it will be a git hash.

url

IDL_Type

string

Units

unitless

Description: URL of the configuration source. For a clone of a git repo this will be a file URL. For a database it will be a standard database URL. This should always match the same-named field in configurationsAvailable.

schemaVersion

IDL_Type

string

Units

unitless

Description: Version of config schema used by the CSC. For a configuration git repo, this is the name of a folder in the config package, and is typically something like “v1”. This should always match the same-named field in configurationsAvailable.

otherInfo

IDL_Type

string

Units

unitless

Description: A comma-separated list of event topics (without the logevent prefix) used to publish the entire set of configuration parameters loaded by the CSC, and any other pertinent information. Ignore whitespace after commas.

configurationsAvailable

Description: Information about the source of configuration information for the CSC.

EFDB_Topic

SALGeneric_logevent_configurationsAvailable

Category

configurable

overrides

IDL_Type

string

Units

unitless

Description: Available overrides as a comma-separated list. Each entry is a possible value of the configurationOverride field of the start command. Ignore whitespace after commas.

version

IDL_Type

string

Units

unitless

Description: Version of the configuration source. For a clone of a git repo it will be a git hash.

url

IDL_Type

string

Units

unitless

Description: URL of the configuration source. For a clone of a git repo this will be a file URL. For a database it will be a standard database URL.

schemaVersion

IDL_Type

string

Units

unitless

Description: Version of config schema used by the CSC. For a configuration git repo, this is the name of a folder in the config package, and is typically something like “v1”.

errorCode

Description: Output when a CSC goes into the Fault state as an explanation of the problem.

EFDB_Topic

SALGeneric_logevent_errorCode

Category

csc

errorCode

IDL_Type

long

Units

unitless

Description: A numeric error code

errorReport

IDL_Type

string

Units

unitless

Description: An string providing detailed information about the error

traceback

IDL_Type

string

Units

unitless

Description: An optional stack trace of the error condition

heartbeat

EFDB_Topic

SALGeneric_logevent_heartbeat

Category

mandatory

heartbeat

IDL_Type

boolean

Units

unitless

Description: Beats the drum.

logLevel

Description: Current logging level.

EFDB_Topic

SALGeneric_logevent_logLevel

Category

mandatory

level

IDL_Type

int

Units

unitless

Description: Current logging level, a Python logging level: error=40, warning=30, info=20, debug=10.

subsystem

IDL_Type

string

Units

unitless

Description: If the CSC itself has sub-ordinate components, they may be listed here. An empty string means the setting applies to all such sub-ordinate components, or just to the CSC itself.

logMessage

Description: A log message.

EFDB_Topic

SALGeneric_logevent_logMessage

Category

mandatory

name

IDL_Type

string

Units

unitless

Description: Log name.

level

IDL_Type

int

Units

unitless

Description: Message level, a Python logging level: error=40, warning=30, info=20, debug=10.

message

IDL_Type

string

Units

unitless

Description: Log message.

traceback

IDL_Type

string

Units

unitless

Description: Exception traceback; “” if not an exception.

filePath

IDL_Type

string

Units

unitless

Description: Path to source file.

functionName

IDL_Type

string

Units

unitless

Description: Function or method name.

lineNumber

IDL_Type

long

Units

unitless

Description: Line number in the file specified by filePath.

process

IDL_Type

long

Units

unitless

Description: Process ID.

timestamp

IDL_Type

double

Units

second

Description: The time at which the condition being reported was observed (TAI unix seconds). 0 if unspecified.

simulationMode

Description: Current simulation mode.

EFDB_Topic

SALGeneric_logevent_simulationMode

Category

csc

mode

IDL_Type

int

Units

unitless

Description: Current simulation mode; 0 for normal operation (no simulation); other supported values are specific to each CSC.

softwareVersions

Description: Current versions of software in use by CSC.

EFDB_Topic

SALGeneric_logevent_softwareVersions

Category

mandatory

salVersion

IDL_Type

string

IDL_Size

256

Units

unitless

Description: This is the current version of SAL generation

xmlVersion

IDL_Type

string

IDL_Size

256

Units

unitless

Description: This is the current version of CSC XML

openSpliceVersion

IDL_Type

string

IDL_Size

256

Units

unitless

Description: This is the current version of OpenSplice

cscVersion

IDL_Type

string

IDL_Size

256

Units

unitless

Description: This is the top-level version of the CSC

subsystemVersions

IDL_Type

string

Units

unitless

Description: A comma delimited list of key=value pairs relating subsystem name (key) to its version number (value). This may be left blank if there are no subsystems within a CSC

summaryState

Description: Current summary state of the CSC

EFDB_Topic

SALGeneric_logevent_summaryState

Category

csc

summaryState

IDL_Type

long

Units

unitless

Description: High level state machine state identifier

Telemetry

chillerCoolantFlow

Description: Chiller coolant flow rate

EFDB_Topic

ATWhiteLight_chillerCoolantFlow

flow

IDL_Type

float

Units

liter/min

Description: flow rate in liters/min

chillerFanSpeeds

Description: Chiller fan speeds, in revolutions per second

EFDB_Topic

ATWhiteLight_chillerFanSpeeds

fan1

IDL_Type

float

Units

Hz

Description: fan 1 speed

fan2

IDL_Type

float

Units

Hz

Description: fan 2 speed

fan3

IDL_Type

float

Units

Hz

Description: fan 3 speed

fan4

IDL_Type

float

Units

Hz

Description: fan 4 speed

chillerTECBankCurrents

Description: Chiller thermo-electric cooler drive current

EFDB_Topic

ATWhiteLight_chillerTECBankCurrents

bank1

IDL_Type

float

Units

ampere

Description: Bank 1 current

bank2

IDL_Type

float

Units

ampere

Description: Bank 2 current

chillerTECDrive

Description: Chiller thermo-electric cooler drive status

EFDB_Topic

ATWhiteLight_chillerTECDrive

isCooling

IDL_Type

boolean

Units

unitless

Description: Cooling if true, else heating.

level

IDL_Type

float

Units

percent

Description: Drive level

chillerTemperatures

Description: Chiller set temperature and measured temperatures

EFDB_Topic

ATWhiteLight_chillerTemperatures

setTemperature

IDL_Type

float

Units

deg_C

Description: Set temperature

supplyTemperature

IDL_Type

float

Units

deg_C

Description: Supply coolant temperature

returnTemperature

IDL_Type

float

Units

deg_C

Description: Return coolant temperature

ambientTemperature

IDL_Type

float

Units

deg_C

Description: Ambient temperature