Developer Guide

Developers are expected to manually maintain the Python enumeration modules in lsst.ts.idl.enums, updating them as the enumerations in ts_xml are updated.

API

lsst.ts.idl Package

Functions

get_data_dir()	Return the data directory of this package.
get_idl_dir()	Return the path to the idl dir within this package.

lsst.ts.idl.enums.ATCamera Module

Classes

OfflineDetailedState(value[, names, module, ...])
ImageReadinessDetailedState(value[, names, ...])
CalibrationDetailedState(value[, names, ...])
ShutterDetailedState(value[, names, module, ...])
CCSCommandState(value[, names, module, ...])
RaftsDetailedState(value[, names, module, ...])
CCDType(value[, names, module, qualname, ...])

lsst.ts.idl.enums.ATDome Module

Classes

AzimuthCommandedState(value[, names, ...])
AzimuthState(value[, names, module, ...])
ShutterDoorCommandedState(value[, names, ...])
ShutterDoorState(value[, names, module, ...])

lsst.ts.idl.enums.ATHexapod Module

Classes

DetailedState(value[, names, module, ...])

lsst.ts.idl.enums.ATMCS Module

Classes

AtMountState(value[, names, module, ...])
M3ExitPort(value[, names, module, qualname, ...])
M3State(value[, names, module, qualname, ...])

lsst.ts.idl.enums.ATMonochromator Module

Classes

Grating(value[, names, module, qualname, ...])
Slit(value[, names, module, qualname, type, ...])
LightStatus(value[, names, module, ...])
Device(value[, names, module, qualname, ...])
DetailedState(value[, names, module, ...])
Status(value[, names, module, qualname, ...])
ErrorCode(value[, names, module, qualname, ...])	ATMonochromator error codes.

lsst.ts.idl.enums.ATPneumatics Module

Classes

MirrorCoverState(value[, names, module, ...])
CellVentState(value[, names, module, ...])
AirValveState(value[, names, module, ...])

lsst.ts.idl.enums.ATPtg Module

Classes

TargetInstances(value[, names, module, ...])
LogLevel(value[, names, module, qualname, ...])
OffTypes(value[, names, module, qualname, ...])
OnOff(value[, names, module, qualname, ...])
Wraps(value[, names, module, qualname, ...])
CoordFrame(value[, names, module, qualname, ...])
RotFrame(value[, names, module, qualname, ...])
RotMode(value[, names, module, qualname, ...])
AccessModes(value[, names, module, ...])
Planets(value[, names, module, qualname, ...])
Foci(value[, names, module, qualname, type, ...])
WarningLevel(value[, names, module, ...])
DetailedStates(value[, names, module, ...])
TargetTypes(value[, names, module, ...])
WrapStrategy(value[, names, module, ...])	Defines wrap strategy enumeration.

lsst.ts.idl.enums.ATSpectrograph Module

Classes

FilterPosition(value[, names, module, ...])
DisperserPosition(value[, names, module, ...])
Status(value[, names, module, qualname, ...])
Error(value[, names, module, qualname, ...])

lsst.ts.idl.enums.ATThermoelectricCooler Module

Classes

ChillerStatus(value[, names, module, ...])
PumpStatusFlag(value[, names, module, ...])
AlarmStatusFlag(value[, names, module, ...])
WarningStatusFlag(value[, names, module, ...])

lsst.ts.idl.enums.Electrometer Module

Classes

DetailedState(value[, names, module, ...])
Units(value[, names, module, qualname, ...])

lsst.ts.idl.enums.FiberSpectrograph Module

Classes

ExposureState(value[, names, module, ...])	The event issued by the FiberSpectrograph CSC when exposures are started and/or stopped.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.idl.enums.Guider Module

Classes

GuiderStatus(value[, names, module, ...])	Guider status.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.

lsst.ts.idl.enums.LinearStage Module

Classes

DetailedState(value[, names, module, ...])

lsst.ts.idl.enums.MTAOS Module

Classes

Mode(value[, names, module, qualname, type, ...])	MTAOS wavefront sensing mode.
FilterType(value[, names, module, qualname, ...])

lsst.ts.idl.enums.MTDome Module

Classes

EnabledState(value[, names, module, ...])	Drive enabled state.
Louver(value[, names, module, qualname, ...])	Louver name and associated array index.
MotionState(value[, names, module, ...])	Motion state.
OperationalMode(value[, names, module, ...])	Operational Modes.
SubSystemId(value[, names, module, ...])	SubSystem ID bitmask.

lsst.ts.idl.enums.MTHexapod Module

Classes

ApplicationStatus(value[, names, module, ...])	Bit masks for the value reported in telemetry.application_status.
ControllerState(value[, names, module, ...])	Controller state reported as telemetry.state.
EnabledSubstate(value[, names, module, ...])	Controller substate for the ENABLED state.
OfflineSubstate(value[, names, module, ...])	Controller substate for the OFFLINE state.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices.
ErrorCode(value[, names, module, qualname, ...])	Error codes.

lsst.ts.idl.enums.MTM1M3 Module

Classes

DetailedState(value[, names, module, ...])
BumpTest(value[, names, module, qualname, ...])
HardpointActuatorMotionStates(value[, ...])
HardpointTest(value[, names, module, ...])
ILCState(value[, names, module, qualname, ...])

lsst.ts.idl.enums.MTM2 Module

Classes

InclinationTelemetrySource(value[, names, ...])
PowerType(value[, names, module, qualname, ...])	Type of the power.
PowerSystemState(value[, names, module, ...])	State of the power system.
ClosedLoopControlMode(value[, names, ...])	Closed loop control mode.
InnerLoopControlMode(value[, names, module, ...])	Inner-loop control mode.

lsst.ts.idl.enums.MTMount Module

Classes

AxisMotionState(value[, names, module, ...])	Motion state of azimuth elevation and camera cable wrap.
Commander(value[, names, module, qualname, ...])	Who commands the low-level controller.
DeployableMotionState(value[, names, ...])	Motion state of deployable systems.
ElevationLockingPinMotionState(value[, ...])	Position of elevation locking pin.
LimitsMask(value[, names, module, qualname, ...])	Bit masks for the various limits.
PowerState(value[, names, module, qualname, ...])	Power state of a system or motion controller.
System(value[, names, module, qualname, ...])	Subsystem ID: the subsystem field in error and warning events.

lsst.ts.idl.enums.MTPtg Module

Classes

LogLevel(value[, names, module, qualname, ...])
OffTypes(value[, names, module, qualname, ...])
OnOff(value[, names, module, qualname, ...])
Wraps(value[, names, module, qualname, ...])
CoordFrame(value[, names, module, qualname, ...])
RotFrame(value[, names, module, qualname, ...])
RotMode(value[, names, module, qualname, ...])
AccessModes(value[, names, module, ...])
Planets(value[, names, module, qualname, ...])
Foci(value[, names, module, qualname, type, ...])
WarningLevel(value[, names, module, ...])
DetailedStates(value[, names, module, ...])
TargetTypes(value[, names, module, ...])
WrapStrategy(value[, names, module, ...])	Defines wrap strategy enumeration.

lsst.ts.idl.enums.MTRotator Module

Classes

ControllerState(value[, names, module, ...])	Controller state reported as telemetry.state.
OfflineSubstate(value[, names, module, ...])	Controller substate for the OFFLINE state.
EnabledSubstate(value[, names, module, ...])	Controller substate for the ENABLED state.
ApplicationStatus(value[, names, module, ...])	Bit masks for the value reported in telemetry.application_status.
ErrorCode(value[, names, module, qualname, ...])	Error codes.

lsst.ts.idl.enums.PMD Module

Classes

HubType(value[, names, module, qualname, ...])

lsst.ts.idl.enums.Script Module

Classes

ScriptState(value[, names, module, ...])	ScriptState constants.
MetadataCoordSys(value[, names, module, ...])	Constants for the Script metadata.coordinateSystem event field
MetadataRotSys(value[, names, module, ...])	Constants for the Script metadata.rotationSystem event field
MetadataDome(value[, names, module, ...])	Constants for the Script metadata.dome event field

lsst.ts.idl.enums.ScriptQueue Module

Classes

Location(value[, names, module, qualname, ...])	Location constants for adding and moving scripts.
SalIndex(value[, names, module, qualname, ...])	Allowed SAL indices for the bin scripts.
ScriptProcessState(value[, names, module, ...])	ScriptQueue script.processState event constants.

lsst.ts.idl.enums.TunableLaser Module

Classes

LaserDetailedState(value[, names, module, ...])	An enumeration class for handling the TunableLaser's substates.
LaserErrorCode(value[, names, module, ...])	Laser error codes

lsst.ts.idl.enums.Watcher Module

Classes

AlarmSeverity(value[, names, module, ...])

Alarm severity.

Build and Test

This is a pure python package. You can build IDL files (see the user guide for instructions), run unit tests and build documentation.

setup -r .
pytest -v  # to run tests
package-docs clean; package-docs build  # to build the documentation

Contributing

ts_idl is developed at https://github.com/lsst-ts/ts_idl. You can find Jira issues for this package using labels=ts_idl..