Merge pull request #197 from spacetelescope/feature/add_service_docs_…

…meiji

Updating service docs (Meiji)

docs/services/allied_vision_camera.rst

@@ -47,13 +47,13 @@ Properties
 
 ``brightness``: Brightness of the camera.
 
-``width``: The width of the camera.
+``width``: The width of the camera frames.
 
-``height``: The height of the camera.
+``height``: The height of the camera frames.
 
-``offset_x``: The x offset of the camera.
+``offset_x``: The x offset of the camera frames on the sensor.
 
-``offset_y``: The y offset of the camera.
+``offset_y``: The y offset of the camera frames on the sensor.
 
 ``sensor_width``: The width of the sensor.
 
@@ -67,7 +67,7 @@ Commands
 
 Datastreams
 -----------
-``temperature``: The temperature as measured by this sensor in Celsius.
+``temperature``: The temperature (in Celsius) as measured by the camera.
 
 ``images``: The images acquired by the camera.
 

docs/services/hamamatsu_camera.rst

@@ -42,13 +42,13 @@ Properties
 
 ``brightness``: Brightness of the camera.
 
-``width``: The width of the camera.
+``width``: The width of the camera frames.
 
-``height``: The height of the camera.
+``height``: The height of the camera frames.
 
-``offset_x``: The x offset of the camera.
+``offset_x``: The x offset of the camera frames on the sensor.
 
-``offset_y``: The y offset of the camera.
+``offset_y``: The y offset of the camera frames on the sensor.
 
 ``sensor_width``: The width of the sensor.
 
@@ -62,7 +62,7 @@ Commands
 
 Datastreams
 -----------
-``temperature``: The temperature as measured by this sensor in Celsius.
+``temperature``: The temperature (in Celsius) as measured by the camera.
 
 ``images``: The images acquired by the camera.
 

docs/services/newport_picomotor.rst

@@ -1,14 +1,46 @@
 Newport Picomotor
 =================
 
+This service controls a Newport Picomotor Motion Controller. 
+The following Newport Picomotors have been tested and used with catkit2 so far:
+
+- `Model 8742 <https://www.newport.com/f/open-loop-picomotor-motion-controller>`_ (comes with a USB Flash Drive that contains communication drivers and software necessary for operating the controller, 
+see page 42 of the `user manual <https://www.newport.com/mam/celum/celum_assets/np/resources/8742_User_Manual.pdf?1>`_)
+
 Configuration
 -------------
 
+.. code-block:: YAML
+
+    picomotor1:
+        service_type: newport_picomotor
+        simulated_service_type: newport_picomotor_sim
+        interface: newport_picomotor
+        requires_safety: false
+
+        ip_address: 000.000.000.000
+        max_step: 2147483647
+        timeout: 60
+        atol: 1
+        daisy: 0  # use this when daisy chaining multiple picomotor controllers
+        axes:
+            x: 1
+            y: 2
+            z: 3
+        sleep_per_step: 0.0005  # sleep time (s) between every step
+        sleep_base: 0.1  # base sleep time (s) for every move command
+
 Properties
 ----------
+None.
 
 Commands
 --------
+None.
 
 Datastreams
 -----------
+``{axis_name}_command``: A movement command along the axis corresponding to axis_name (where axis_name can be x, y, or z). The axis names are defined by the config file.
+
+``{axis_name}_current_position``: The current position of the picomotor along the axis corresponding to axis_name (where axis_name can be x, y, or z). The axis names are defined by the config file.
+

docs/services/web_power_switch.rst

@@ -1,14 +1,47 @@
 Web Power Switch
 ================
 
+This service controls a power switch that is controllable over the internet.
+
+So far catkit2 has been tested on the following web power switches:
+
+- `LPC7-PRO from TeleDynamics <https://www.teledynamics.com/#/productdetails/LPC7-PRO>`_ (for more information, see the `Spec Sheet <https://www.teledynamics.com/tdresources/4046838d-f3c4-4096-8ca8-cb95f1a84700.pdf>`_ and `User Manual <https://www.teledynamics.com/tdresources/d3c690fb-d735-4159-9669-60f7b5e9dc0c.pdf>`_. Note: no software driver installation required)
+
 Configuration
 -------------
 
+.. code-block:: YAML
+
+    web_power_switch1:
+        service_type: web_power_switch
+        simulated_service_type: web_power_switch_sim
+        interface: web_power_switch
+        requires_safety: false
+
+        user: username
+        password: password
+        ip_address: 000.000.000.00
+        dns: domain_name_system
+
+        # Plugged-in devices with their outlet number:
+        outlets:
+            npoint_tiptilt_lc_400: 1
+            iris_usb_hub: 2
+            newport_xps_q8: 3
+            iris_dm: 4
+            quad_cell: 5
+            air_valve: 6
+            pupil_led: 7
+            fpm_led: 8
+
 Properties
 ----------
+None.
 
 Commands
 --------
+None.
 
 Datastreams
 -----------
+``{outlet_name}``: The name of an outlet. These are defined by the config file (see the sample Configuration section above where the names of eight example outlets are given).

docs/services/zwo_camera.rst

@@ -1,14 +1,66 @@
 ZWO Camera
 ==========
 
+This service operates a ZWO camera. The following are the different types of ZWO cameras that have been tested and used with catkit2 so far:
+
+- `ZWO ASI533MM <https://www.zwoastro.com/product/asi533mm-mc/>`_
+- `ZWO ASI290MM <https://agenaastro.com/zwo-asi290mm-cmos-monochrome-astronomy-imaging-camera.html>`_
+- `ZWO ASI178MM <https://agenaastro.com/zwo-asi178mm-cmos-monochrome-astronomy-imaging-camera.html>`_
+- `ZWO ASI1600MM <https://agenaastro.com/zwo-asi1600mm-p-cmos-monochrome-astronomy-imaging-camera-pro.html>`_
+
+For camera specs, see the website links above.
+Note that using ZWO cameras requires a manual installation of drivers from `zwoastro.com <https://astronomy-imaging-camera.com/software-drivers>`_ 
+
 Configuration
 -------------
 
+.. code-block:: YAML
+
+    camera1:
+        service_type: zwo_camera
+        simulated_service_type: camera_sim
+        requires_safety: false
+
+        device_name: ZWO ASI533MM
+        offset_x: 1038
+        offset_y: 1282
+        width: 192
+        height: 192
+        exposure_time: 1000
+        gain: 100
+
 Properties
 ----------
+``exposure_time``: Exposure time (in microseconds) of the camera.
+
+``gain``: Gain of the camera.
+
+``brightness``: Brightness of the camera.
+
+``width``: The width of the camera frames.
+
+``height``: The height of the camera frames.
+
+``offset_x``: The x offset of the camera frames on the sensor.
+
+``offset_y``: The y offset of the camera frames on the sensor.
+
+``sensor_width``: The width of the sensor.
+
+``sensor_height``: The height of the sensor.
+
+``device_name``: The name of the camera.
 
 Commands
 --------
+``start_acquisition()``: This starts the acquisition of images from the camera.
+
+``end_acquisition()``: This ends the acquisition of images from the camera.
 
 Datastreams
 -----------
+``temperature``: The temperature (in Celsius) as measured by the camera.
+
+``images``: The images acquired by the camera.
+
+``is_acquiring``: Whether the camera is currently acquiring images.

environment.yml

@@ -38,5 +38,5 @@ dependencies:
   - flake8
   - pip:
     - dcps
-    - zwoasi>=0.0.21 # Requires additional manual install of driver(s) from https://astronomy-imaging-camera.com/software-drivers
+    - zwoasi>=0.0.21
     - git+https://github.com/alliedvision/[email protected]