lsst.ts.mtdomecom#

TCP/IP interface to the controller for the Simonyi Survey Telescope dome at Vera C. Rubin Observatory.

Using lsst.ts.mtdomecom#

Build and Test#

This package has the following requirements:

  • ts_tcpip

  • ts_utils

The package is compatible with LSST DM’s scons build system and eups package management system. Assuming you have the basic LSST DM stack installed you can do the following, from within the package directory:

  • setup -r . to setup the package and dependencies.

  • scons to build the package and run unit tests.

  • scons install declare to install the package and declare it to eups.

  • package-docs build to build the documentation. This requires documenteer; see building single package docs for installation instructions.

Usage#

The primary classes are:

  • MTDomeCom: TCP/IP interface to the controller for the Simonyi Survey Telescope dome.

  • MockDomeController: Simulator for the dome TCP/IP interface.

Contributing#

lsst.ts.mtdomecom is developed at lsst-ts/ts_mtdomecom. You can find Jira issues for this module using labels=ts_mtdomcoecom.

Python API reference#

lsst.ts.mtdomecom Package#

Functions#

get_louvers_enabled(config_dir)

Load a set of all enabled louvers from the "louvers_enabled.yaml" configuration file.

Classes#

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

Engagable brakes.

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

Command names.

CommandTime(command, tai)

Class representing the TAI time at which a command was issued.

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

Control mode.

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

Internal Motion states.

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

LLC names.

MTDomeCom(log, config, config_dir[, ...])

TCP/IP interface to the MTDome controller.

MockMTDomeController(port, log[, ...])

Mock MTDome Controller that talks over TCP/IP.

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

Response codes.

ScheduledCommand(command, params)

Class representing a scheduled command.

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

StopCommand(scheduled_command, llc_name)

Class representing a command to stop an ongoing motion.

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

Valid values for the simulation_mode attribute of the CSC.

Class Inheritance Diagram#

Inheritance diagram of lsst.ts.mtdomecom.enums.Brake, lsst.ts.mtdomecom.enums.CommandName, lsst.ts.mtdomecom.mtdome_com.CommandTime, lsst.ts.mtdomecom.enums.ControlMode, lsst.ts.mtdomecom.enums.InternalMotionState, lsst.ts.mtdomecom.enums.LlcName, lsst.ts.mtdomecom.mtdome_com.MTDomeCom, lsst.ts.mtdomecom.mock_controller.MockMTDomeController, lsst.ts.mtdomecom.enums.ResponseCode, lsst.ts.mtdomecom.enums.ScheduledCommand, lsst.ts.mtdomecom.enums.SlipRingState, lsst.ts.mtdomecom.enums.StopCommand, lsst.ts.mtdomecom.enums.ValidSimulationMode

Version History#