lsst.ts.ess.labjack#

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

Overview#

This package provides LabJackDataClient, data client for the ESS CSC that reads environmental data from a LabJack T4 or T7 module and reports it as one one or more ESS telemetry topics.

LabJackDataClient can only write array-based ESS telemetry topics, such as temperature and pressure.

This data client lives in its own package because it requires a LabJack-specific library. In order to run an ESS CSC that uses LabJackDataClient, all you have to do is install this package.

User Guide#

To make LabJackDataClient available to the ESS CSC you must install this package and the LabJack software.

Configuration#

LabJackDataClient has its own configuration schema provided by the LabJackDataClient.get_config_schema class method (source).

This configuration specifies which LabJack to talk to, which inputs to read, and how to map those inputs to ESS telemetry topics.

Developer Guide#

LabJackDataClient uses LabJack’s own labjack-ljm software to communicate with a LabJack T4 or T7. If this proves to be a problem, it is possible to use modbus instead.

Python API reference#

lsst.ts.ess.labjack Package#

Classes#

BaseLabJackDataClient(config, topics, log[, ...])

Base class for ESS data clients that read a LabJack T7 or similar.

LabJackAccelerometerDataClient(config, ...)

Read 3-axis accelerometer data from a LabJack T7 or similar, and report using the accelerometerPSD topic.

LabJackDataClient(config, topics, log[, ...])

Get environmental data from a LabJack T7 or similar.

Class Inheritance Diagram#

Inheritance diagram of lsst.ts.ess.labjack.base_labjack_data_client.BaseLabJackDataClient, lsst.ts.ess.labjack.labjack_accelerometer_data_client.LabJackAccelerometerDataClient, lsst.ts.ess.labjack.labjack_data_client.LabJackDataClient

Contributing#

lsst.ts.ess.labjack is developed at lsst-ts/ts_ess_labjack. You can find Jira issues for this module using labels=ts_ess_labjack.

Version History#