lsst.ts.ess.csc

https://img.shields.io/badge/ProjectMetadata-gray.svg https://img.shields.io/badge/SAL Interface-gray.svg https://img.shields.io/badge/GitHub-gray.svg https://img.shields.io/badge/Jira-gray.svg

Overview

The ESS Commandable SAL Component (CSC) reads various environmental sensors at the Vera C. Rubin Observatory, and publishes the resulting data in ESS telemetry topics. There will be at least one, and likely several, ESS CSC(s) running at Rubin Observatory.

ESS stands for Environmental Sensors Suite.

User Guide

To run an instance of the ESS CSC:

run_ess_csc.py sal_index

The sal_index you specify must have a matching entry in the configuration you specify in the start command, else the command will fail.

This command-line script supports --help.

Configuration

Configuration files are stored in ts_config_ocs.

There should be one standard configuration file for each site. Each configuration file specifies configuration for all ESS SAL indices supported at that site. To run all ESS CSCs appropriate for a site, examine the configuration file and run one ESS CSC for each entry in it.

The ESS CSC uses “data clients” to communicate with environmental data servers and publish the telemetry, in order to flexibly handle different kinds of data servers. Each data client class has its own configuration schema. A CSC configuration file primarily contains of a list of sal_index: configuration for a data client.

This ts_ess_csc package defines most of our data clients, including:

A few that use hard-to-install libraries are defined in ts_ess_labjack and possibly other packages.

Developer Guide

Documentation for sensors is in is in ts_ess_common, along with documentation of the API for the ts_ess_controller server and instructions for supporting a new kind of sensor.

Python API reference

lsst.ts.ess.csc Package

Functions

command_ess_csc()

run_ess_csc()

Classes

EssCsc(index[, config_dir, initial_state, ...])

Upper level Commandable SAL Component for the Environmental Sensors Support.

MockYoung32400DataServer(log, ...[, do_timeout])

Mock Young 32400 data server.

SiglentSSA3000xSpectrumAnalyzerDataClient(...)

Get data from a Siglent SSA3000X Spectrum analyzer.

Young32400RawDataGenerator([...])

Generate simulated raw data for the Young 32400 weather station.

Young32400WeatherStationDataClient(config, ...)

Get environmental data from Young 32400 weather station serial interface.

Class Inheritance Diagram

Inheritance diagram of lsst.ts.ess.csc.ess_csc.EssCsc, lsst.ts.ess.csc.data_client.young_32400_weather_station_data_client.MockYoung32400DataServer, lsst.ts.ess.csc.data_client.siglent_ssa3000x_spectrum_analyzer_data_client.SiglentSSA3000xSpectrumAnalyzerDataClient, lsst.ts.ess.csc.data_client.young_32400_weather_station_data_client.Young32400RawDataGenerator, lsst.ts.ess.csc.data_client.young_32400_weather_station_data_client.Young32400WeatherStationDataClient

Contributing

lsst.ts.ess.csc is developed at https://github.com/lsst-ts/ts_ess_csc. You can find Jira issues for this module using labels=ts_ess_csc.

Version History