ATBuilding#

Note

This page is generated by python script generate_cet.py.

Back to table

Commands#

closeVentGate#

Description: Close the specified vent gate.

EFDB_Topic:

ATBuilding_command_closeVentGate

gate#

IDL_Type:

int

Units:

unitless

Count:

4

Description: Which gate to close (0-3, counter-clockwise from door).

openVentGate#

Description: Open the specified vent gate.

EFDB_Topic:

ATBuilding_command_openVentGate

gate#

IDL_Type:

int

Units:

unitless

Count:

4

Description: Which gate to open (0-3, counter-clockwise from door).

resetExtractionFanDrive#

Description: Reset extraction fan VFD faults.

EFDB_Topic:

ATBuilding_command_resetExtractionFanDrive

setExtractionFanDriveFreq#

Description:

Sets extraction fan target drive frequency (Hz). 0 or negative values stops the fan. Fan is started if positive value is provided and it’s not running.

EFDB_Topic:

ATBuilding_command_setExtractionFanDriveFreq

targetFrequency#

IDL_Type:

float

Units:

Hz

Description: Fan drive target frequency.

setExtractionFanManualControlMode#

Description:

Enters and leaves extraction fan manual (control box) control mode. Fan will be stopped if running.

EFDB_Topic:

ATBuilding_command_setExtractionFanManualControlMode

enableManualControlMode#

IDL_Type:

boolean

Units:

unitless

Description: Enable manual control mode.

startExtractionFan#

Description: Start (run) the extraction fan.

EFDB_Topic:

ATBuilding_command_startExtractionFan

stopExtractionFan#

Description: Stops the extraction fan.

EFDB_Topic:

ATBuilding_command_stopExtractionFan

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. Most CSCs will quit, but CSCs that support the enterControl command will keep running.

EFDB_Topic:

SALGeneric_command_exitControl

Category:

csc

setAuthList#

Description: Specify who can command this CSC.

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 this 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 this CSC itself.

standby#

Description: Transition from state Offline/Available, 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#

FanDriveState:
  • Stopped

  • Operating

  • Fault

VentGateState:
  • Closed

  • PartiallyOpen

  • Opened

Events#

extractionFanDriveFaultCode#

Description: Most recent fault code reported by extraction fan drive.

EFDB_Topic:

ATBuilding_logevent_extractionFanDriveFaultCode

state#

IDL_Type:

long

Units:

unitless

Description: Most recent fault code reported. See VFD documentation for interpretation.

extractionFanDriveState#

Description: Current state of the extraction fan drive.

EFDB_Topic:

ATBuilding_logevent_extractionFanDriveState

state#

IDL_Type:

long

Units:

unitless

Description: Current state. A FanDriveState enumeration.

internalCommand#

EFDB_Topic:

ATBuilding_logevent_internalCommand

commandObject#

IDL_Type:

byte

Units:

unitless

Count:

800

Description: The error code being published.

loopTimeOutOfRange#

EFDB_Topic:

ATBuilding_logevent_loopTimeOutOfRange

loopTimeOutOfRange#

IDL_Type:

boolean

Units:

unitless

Description: Loop timeout is out of range.

rejectedCommand#

EFDB_Topic:

ATBuilding_logevent_rejectedCommand

command#

IDL_Type:

string

Units:

unitless

Description: Name of the rejected command.

state#

IDL_Type:

string

Units:

unitless

Description: Current state.

timestamp#

IDL_Type:

double

Units:

unitless

Description: Timestamp of the rejected command.

ventGateState#

Description: Vent gate states (gates numbered 0-3, counter-clockwise from door).

EFDB_Topic:

ATBuilding_logevent_ventGateState

state#

IDL_Type:

long

Units:

unitless

Count:

4

Description: Current state. A VentGateState enumeration.

authList#

Description: Who can command this CSC.

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.

errorCode#

Description: Output when this 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#

Description: Event output at regular intervals (typcally once per second) to show that the SAL component is alive.

EFDB_Topic:

SALGeneric_logevent_heartbeat

Category:

mandatory

heartbeat#

IDL_Type:

boolean

Units:

unitless

Description: Deprecated field that you should ignore.

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 this 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 this 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: The software version of this 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 this CSC.

summaryState#

Description: Current summary state of this CSC.

EFDB_Topic:

SALGeneric_logevent_summaryState

Category:

csc

summaryState#

IDL_Type:

long

Units:

unitless

Description: High level state machine state identifier.

Telemetry#

extractionFan#

Description: Telemetry for auxtel vent extraction fan.

EFDB_Topic:

ATBuilding_extractionFan

driveFrequency#

IDL_Type:

float

Units:

Hz

Description: Drive frequency (Hz).

loopTime#

EFDB_Topic:

ATBuilding_loopTime

loopTime#

IDL_Type:

double

Units:

unitless

Description: The actual loop time is milliseconds.

timestamp#

EFDB_Topic:

ATBuilding_timestamp

timestamp#

IDL_Type:

double

Units:

unitless

Description: The system time (TAI).