Updated docs

openflexure_microscope/api/app.py

@@ -148,6 +148,12 @@ app.register_blueprint(task_blueprint, url_prefix=uri('/task', 'v1'))
 def routes():
     """
     List of all connected API routes
+
+    .. :quickref: System; Routes
+
+    :>header Accept: application/json
+    :>header Content-Type: application/json
+    :status 200: stream active
     """
     return jsonify(list_routes(app))
 
@@ -156,6 +162,12 @@ def routes():
 def err_log():
     """
     Most recent 1mb of log output
+
+    .. :quickref: System; Log
+
+    :>header Accept: application/json
+    :>header Content-Type: application/json
+    :status 200: stream active
     """
     timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
     return send_file(

openflexure_microscope/api/v1/blueprints/base.py

@@ -100,35 +100,36 @@ class ConfigAPI(MicroscopeView):
           Content-Type: application/json
 
           {
-            "image_resolution": [
-                2592, 
-                1944
-            ], 
-            "jpeg_quality": 75, 
-            "name": "0e2c6fac5421429aac67c7903107bdd8", 
-            "numpy_resolution": [
-                1312, 
-                976
-            ], 
-            "picamera_settings": {
-                "analog_gain": 1.0, 
-                "digital_gain": 1.0, 
-                "awb_gains": [
-                0.92578125, 
-                2.94921875
-                ], 
-                "awb_mode": "off", 
-                "exposure_mode": "off", 
-                "framerate": 24.0, 
-                "saturation": 0, 
-                "shutter_speed": 5378
-            }, 
+            "id": "0e2c6fac5421429aac67c7903107bdd8", 
+            "name": "docuscope-2000",
+            "fov": [4100, 3146],
+            "camera_settings": {
+                "image_resolution": [2592, 1944], 
+                "numpy_resolution": [1312, 976], 
+                "video_resolution": [832, 624],
+                "jpeg_quality": 75, 
+                "picamera_settings": {
+                    "analog_gain": 1.0, 
+                    "digital_gain": 1.0, 
+                    "awb_gains": [0.92578125, 2.94921875], 
+                    "awb_mode": "off", 
+                    "exposure_mode": "off", 
+                    "framerate": 24.0, 
+                    "saturation": 0, 
+                    "shutter_speed": 5378
+                }, 
+            },
+            "stage_settings": {
+                "backlash": {
+                    "x": 256,
+                    "y": 256,
+                    "z": 0
+                }
+            }
             "plugins": [
-                "openflexure_microscope.plugins.default:Plugin"
-            ], 
-            "stream_resolution": [
-                832, 
-                624
+                "openflexure_microscope.plugins.default.autofocus:AutofocusPlugin",
+                "openflexure_microscope.plugins.default.scan:ScanPlugin",
+                "openflexure_microscope.plugins.default.camera_calibration:Plugin"
             ]
           }
 
@@ -152,18 +153,52 @@ class ConfigAPI(MicroscopeView):
           Accept: application/json
 
           {
-            "analog_gain": 1.0, 
-            "digital_gain": 1.0, 
-            "jpeg_quality": 75, 
-            "picamera_params": {
-                "framerate": 24.0, 
-                "saturation": 0, 
-                "shutter_speed": 5000
+            "id": "0e2c6fac5421429aac67c7903107bdd8", 
+            "name": "docuscope-2000",
+            "fov": [4100, 3146],
+            "camera_settings": {
+                "image_resolution": [2592, 1944], 
+                "numpy_resolution": [1312, 976], 
+                "video_resolution": [832, 624],
+                "jpeg_quality": 75, 
+                "picamera_settings": {
+                    "analog_gain": 1.0, 
+                    "digital_gain": 1.0, 
+                    "awb_gains": [0.92578125, 2.94921875], 
+                    "awb_mode": "off", 
+                    "exposure_mode": "off", 
+                    "framerate": 24.0, 
+                    "saturation": 0, 
+                    "shutter_speed": 5378
+                }, 
+            },
+            "stage_settings": {
+                "backlash": {
+                    "x": 256,
+                    "y": 256,
+                    "z": 0
+                }
             }
+            "plugins": [
+                "openflexure_microscope.plugins.default.autofocus:AutofocusPlugin",
+                "openflexure_microscope.plugins.default.scan:ScanPlugin",
+                "openflexure_microscope.plugins.default.camera_calibration:Plugin"
+            ]
           }
 
         :>header Accept: application/json
 
+        :<json string id: Unique string identifier of the microscope.
+        :<json string name: Friendly name for the microscope
+        :<json array fov: Field of view (motor steps per full width and height of frame)
+        :<json json camera_settings:    - **image_resolution** *(array)*: Resolution of full image captures
+                                        - **numpy_resolution** *(array)*: Resolution of full numpy array captures
+                                        - **video_resolution** *(array)*: Resolution of video recordings, low res image captures, and the preview stream
+                                        - **jpeg_quality** *(int)*: Quality in which to store JPEG capture data
+                                        - **picamera_settings** *(json)*: Key-value pairs to apply directly to any attached PiCamera object
+        :<json json stage_settings:     - **backlash** *(json)*: x, y, and z backlash compensation, in motor steps
+        :<json array plugins: Array of plugin paths to load. Requires reloading the microscope object after applying
+
         :<header Content-Type: application/json
         :status 200: capture created