.. Fill out data so contacts section below is auto-populated
.. |CSC_developer| replace::  *Rolando Cantarutti*
.. |CSC_product_owner| replace:: *Patrick Ingraham*

.. Note that the "ts_" prefix is omitted from the title

############
ATPneumatics
############

.. image:: https://img.shields.io/badge/GitHub-ts_ATPneumatics-green.svg
    :target: https://github.com/lsst-ts/ts_ATMCS
.. image:: https://img.shields.io/badge/Jira-ts_ATPneumatics-green.svg
    :target: https://jira.lsstcorp.org/issues/?jql=labels+%3D+ts_ATPneumatics
.. image:: https://img.shields.io/badge/ts_xml-ATPneumatics-green.svg
    :target: https://ts-xml.lsst.io/sal_interfaces/ATPneumatics.html

.. TODO: Delete the note when the page becomes populated

.. Warning::

   **This CSC documentation is still under development.**

.. _Overview:

Overview
========

The ATPneumatics CSC controls the air-driven (pneumatic) systems of the Auxiliary Telescope Mount.
This is primarily the actuators located under the M1 mirror, which are used to support the mirror and hold the shape as the telescope moves in elevation and the force of gravity results in mirror sag.
Without correction of this sag, the image quality would become significantly deteriorated.
The ATPneumatics CSC also controls the opening and closing of the M1 mirror cover and multiple air vents located in the mirror cell.
Although independent, the ATPneumatics CSC works in tandem with the `ATMCS CSC <https://ts-atmcs.lsst.io>`__ during the slewing of the telescope.
The source code is also co-located in the ATMCS repository.
Like the ATMCS, the software is deployed on the cRIO inside the Telescope Control Cabinet located on the first level of the Auxiliary Telescope Building.

In nearly all cases, the ATPneumatics CSC is controlled from the high-level `ATCS class <https://ts-observatory-control.lsst.io/user-guide/auxtel/atcs-user-guide.html>`__.
Using this class is important as it ensures the system is operated according to proper procedure (e.g. the mirror cover isn't opened with the dome slewing).

Generally, the pneumatic actuators under M1 are controlled via the ATAOS (Auxiliary Telescope Active Optics System).
This system monitors the telescope position and continually adjusts the pressures to ensure the mirror remains in the proper shape.

Like the ATMCS, the ATPneumatics CSC was developed by a team at CTIO who created the control system(s) for the mount.
Their deliverables included documentation that is heavily referenced in these documentation pages.
The top-level index of their docs is found `in Docushare <https://docushare.lsst.org/docushare/dsweb/View/Collection-9776>`__.

Note that improper use of this CSC can result in the mirror being lifted from its hardpoints.
Please reach out to the product owner prior to commanding this CSC outside the ATCS class.


.. note:: If you are interested in viewing other branches of this documentation repository append a `/v` to the end of the url link. For example `https://ts_atpneumatics.lsst.io/v/`


.. _User_Documentation:

User Documentation
==================

User-level documentation, found at the link below, is aimed at personnel looking to perform the standard use-cases/operations with the ATPneumatics.

.. toctree::
    user-guide/user-guide
    :maxdepth: 2

.. _Configuration:

Configuring the ATPneumatics
=========================================

The configuration for the ATPneumatics is described at the following link.
However, no changes to the configuration are expected to be performed by the user.

.. toctree::
    configuration/configuration
    :maxdepth: 1


.. _Development_Documentation:

Development Documentation
=========================

This area of documentation focuses on the classes used, API's, and how to participate to the development of the ATPneumatics software packages.

.. toctree::
    developer-guide/developer-guide
    :maxdepth: 1

.. _Version_History:

Version History
===============

.. At the time of writing the Version history/release notes are not yet standardized amongst CSCs.
.. Until then, it is not expected that both a version history and a release_notes be maintained.
.. It is expected that each CSC link to whatever method of tracking is being used for that CSC until standardization occurs.
.. No new work should be required in order to complete this section.

The version history of the ATPneumatics is combined with that of the `ATMCS <https://ts-atmcs.lsst.io>`__.