Merge pull request #180 from lsst-ts/tickets/LOVE-170

Add documentation for Control Location feature

CHANGELOG.rst

@@ -2,6 +2,11 @@
 Version History
 ===============
 
+v5.10.1
+-------
+
+* Add documentation for Control Location feature `<https://github.com/lsst-ts/LOVE-manager/pull/180>`_
+
 v5.10.0
 -------
 

docs/html/_sources/apidoc/api.tests.rst.txt

@@ -4,6 +4,14 @@ api.tests package
 Submodules
 ----------
 
+api.tests.test\_auth\_api module
+--------------------------------
+
+.. automodule:: api.tests.test_auth_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 api.tests.test\_authlist module
 -------------------------------
 
@@ -20,42 +28,50 @@ api.tests.test\_commander module
    :undoc-members:
    :show-inheritance:
 
-api.tests.test\_lovecsc module
-------------------------------
+api.tests.test\_configfile module
+---------------------------------
 
-.. automodule:: api.tests.test_lovecsc
+.. automodule:: api.tests.test_configfile
    :members:
    :undoc-members:
    :show-inheritance:
 
-api.tests.test\_schema\_validation module
------------------------------------------
+api.tests.test\_emergencycontact module
+---------------------------------------
 
-.. automodule:: api.tests.test_schema_validation
+.. automodule:: api.tests.test_emergencycontact
    :members:
    :undoc-members:
    :show-inheritance:
 
-api.tests.tests\_auth\_api module
----------------------------------
+api.tests.test\_jira module
+---------------------------
+
+.. automodule:: api.tests.test_jira
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+api.tests.test\_lovecsc module
+------------------------------
 
-.. automodule:: api.tests.tests_auth_api
+.. automodule:: api.tests.test_lovecsc
    :members:
    :undoc-members:
    :show-inheritance:
 
-api.tests.tests\_configfile module
-----------------------------------
+api.tests.test\_ole module
+--------------------------
 
-.. automodule:: api.tests.tests_configfile
+.. automodule:: api.tests.test_ole
    :members:
    :undoc-members:
    :show-inheritance:
 
-api.tests.tests\_emergencycontact module
-----------------------------------------
+api.tests.test\_schema\_validation module
+-----------------------------------------
 
-.. automodule:: api.tests.tests_emergencycontact
+.. automodule:: api.tests.test_schema_validation
    :members:
    :undoc-members:
    :show-inheritance:

docs/html/_sources/modules/how_to_use_it.rst.txt

@@ -1227,8 +1227,8 @@ The file extension must be json and the format has the form:
       "minSeverityNotification": "mute"
     },
     "camFeeds": {
-      "generic": "/gencam",
-      "allSky": "/gencam"
+      "startrackera": "/startrackera",
+      "startrackerb": "/startrackerb"
     }
   }
 This is a normal json file with ``{“key”: “value”}`` items. You can use different variable types such as: strings, numbers, arrays and objects.
@@ -1241,8 +1241,8 @@ Available configurations:
   - minSeverityNotification: {“mute”, “muted”, “warning”, “serious”, “critical”} : minimum level to report alarm notifications. If set to “mute” or “muted” no alarm will be reported.
 - **camFeeds**:
 
-  - generic: cam feed used on the GenericCamera component. This feed will be used if the “generic” value is set on the FEEDKEY configuration parameter of the Generic Camera component.
-  - allSky: cam feed used on the GenericCamera component. This feed will be used if the “allSky” value is set on the FEEDKEY configuration parameter of the Generic Camera component.
+  - startrackera: cam feed used on the GenericCamera component. This feed will be used if the “startrackera” value is set on the FEEDKEY configuration parameter of the GenericCamera or GenericCameraControls components.
+  - startrackerb: cam feed used on the GenericCamera component. This feed will be used if the “startrackerb” value is set on the FEEDKEY configuration parameter of the GenericCamera or GenericCameraControls components.
 - **efd**:
 
   - defaultEfdInstance : {“summit_efd”, "ncsa_teststand_efd", “"ldf_stable_efd"”, “ldf_int_efd”, “base_efd”, “tucson_teststand_efd”, “test_efd”} : default efd instance to be queried on the VegaTimeSeriesPlot component.
@@ -1350,4 +1350,24 @@ Endpoint to send ATCS commands.
     "data": {
       "ack": "Done",
     }
-  }
+  }
+
+Control Locations
+=================
+
+The Control Locations feature allows the user to define a set of locations that can be used to control the telescope. Only one location can be active at a time. The user can define a location by providing a name and a description.
+
+The LOVE system will come with a set of predefined locations that can be used to control the telescope. These locations are:
+
+- **summit**: Cerro Pachon.
+- **tucson**: Tucson Control Room.
+- **base**: La Serena Control Room.
+
+To set a location of control, the user must activate the specific location through the administration interface (the user can also deactivate the current location of control):
+
+1. Enter http://love-host/manager/admin/. You have to replace **love-host** with the host you are using, e.g. http://love01.cp.lsst.org/manager/admin
+2. Login with your admin credentials
+3. Go to http://love-host/manager/admin/api/controllocation/ 
+4. Select the location you want to activate
+5. Mark the "Selected" parameter checkbox
+6. Click the SAVE button