diff --git a/docs/source/api.rst b/docs/source/api.rst
index fafe0b79..218713b7 100644
--- a/docs/source/api.rst
+++ b/docs/source/api.rst
@@ -5,7 +5,6 @@ Summary
-------
.. qrefflask:: openflexure_microscope.api.app:app
:undoc-endpoints: index
- :blueprints: v2_root_blueprint, v2_streams_blueprint, v2_captures_blueprint, v2_settings_blueprint, v2_status_blueprint, v2_plugin_blueprint, v2_tasks_blueprint, v2_actions_blueprint
:undoc-static:
:endpoints:
@@ -13,7 +12,6 @@ Details
-------
.. autoflask:: openflexure_microscope.api.app:app
:undoc-endpoints: index
- :blueprints: v2_root_blueprint, v2_streams_blueprint, v2_captures_blueprint, v2_settings_blueprint, v2_status_blueprint, v2_plugin_blueprint, v2_tasks_blueprint, v2_actions_blueprint
:undoc-static:
:endpoints:
:order: path
diff --git a/docs/source/plugins/class.rst b/docs/source/plugins/class.rst
index 6e0fb3e3..6f6002ef 100644
--- a/docs/source/plugins/class.rst
+++ b/docs/source/plugins/class.rst
@@ -1,29 +1,7 @@
Classes and Modules
===================
-Plugin class
-------------
-.. autoclass:: openflexure_microscope.plugins.MicroscopePlugin
- :members:
-
-.. autoclass:: openflexure_microscope.api.v1.views.MicroscopeViewPlugin
- :members:
-
-
-Default plugins
+Extension class
---------------
-
-Autofocus
-+++++++++
-.. automodule:: openflexure_microscope.plugins.default.autofocus
+.. autoclass:: openflexure_microscope.common.flask_labthings.extensions.BaseExtension
:members:
-
-Camera calibration
-++++++++++++++++++
-.. automodule:: openflexure_microscope.plugins.default.camera_calibration
- :members:
-
-Scan and Stack
-++++++++++++++
-.. automodule:: openflexure_microscope.plugins.default.scan
- :members:
\ No newline at end of file
diff --git a/docs/source/plugins/forms.rst b/docs/source/plugins/forms.rst
index 25b4863a..c8eecb71 100644
--- a/docs/source/plugins/forms.rst
+++ b/docs/source/plugins/forms.rst
@@ -184,9 +184,3 @@ JSON form example
.. literalinclude:: forms_example.json
:language: JSON
-
-
-.. toctree::
- :maxdepth: 1
-
- ./form/json_form.rst
\ No newline at end of file
diff --git a/docs/source/plugins/forms_example.json b/docs/source/plugins/forms_example.json
index 07b348d2..404ddae8 100644
--- a/docs/source/plugins/forms_example.json
+++ b/docs/source/plugins/forms_example.json
@@ -1,87 +1,83 @@
{
- "id": "test-plugin",
- "icon": "pets",
- "forms": [
- {
- "name": "Simple request",
- "isCollapsible": false,
- "isTask": false,
- "selfUpdate": true,
- "route": "/do",
- "submitLabel": "Do things",
- "schema": [
- {
- "fieldType": "numberInput",
- "placeholder": "Some integer",
- "name": "val_int",
- "label": "Number value"
- },
- {
- "fieldType": "textInput",
- "placeholder": "Some string",
- "label": "String value",
- "name": "val_str"
- },
- {
- "fieldType": "radioList",
- "name": "val_radio",
- "label": "Radio value",
- "options": ["First", "Second", "Third"]
- },
- {
- "fieldType": "checkList",
- "name": "val_check",
- "label": "Checklist values",
- "options": ["Foo", "Bar", "Baz"]
- },
- {
- "fieldType": "htmlBlock",
- "name": "html_block",
- "content": "This is a block of HTML in a plugin!"
- },
- {
- "fieldType": "selectList",
- "name": "val_select",
- "multi": false,
- "label": "Some selection",
- "options": ["Most", "Average", "Least"]
- },
- {
- "fieldType": "textInput",
- "placeholder": "Some string",
- "label": "Non-persistent string",
- "name": "val_disposable"
- },
- {
- "fieldType": "keyvalList",
- "label": "A key-val object",
- "name": "val_keyval",
- "value": {
- "key1": "foo",
- "key2": "bar"
- }
- },
- {
- "fieldType": "tagList",
- "label": "A tag list",
- "name": "val_tags",
- "value": ["tag2", "tag2", "squidward"]
+ "id": "test-plugin",
+ "icon": "pets",
+ "forms": [{
+ "name": "Simple request",
+ "isCollapsible": false,
+ "isTask": false,
+ "selfUpdate": true,
+ "route": "/do",
+ "submitLabel": "Do things",
+ "schema": [{
+ "fieldType": "numberInput",
+ "placeholder": "Some integer",
+ "name": "val_int",
+ "label": "Number value"
+ },
+ {
+ "fieldType": "textInput",
+ "placeholder": "Some string",
+ "label": "String value",
+ "name": "val_str"
+ },
+ {
+ "fieldType": "radioList",
+ "name": "val_radio",
+ "label": "Radio value",
+ "options": ["First", "Second", "Third"]
+ },
+ {
+ "fieldType": "checkList",
+ "name": "val_check",
+ "label": "Checklist values",
+ "options": ["Foo", "Bar", "Baz"]
+ },
+ {
+ "fieldType": "htmlBlock",
+ "name": "html_block",
+ "content": "This is a block of HTML in a plugin!"
+ },
+ {
+ "fieldType": "selectList",
+ "name": "val_select",
+ "multi": false,
+ "label": "Some selection",
+ "options": ["Most", "Average", "Least"]
+ },
+ {
+ "fieldType": "textInput",
+ "placeholder": "Some string",
+ "label": "Non-persistent string",
+ "name": "val_disposable"
+ },
+ {
+ "fieldType": "keyvalList",
+ "label": "A key-val object",
+ "name": "val_keyval",
+ "value": {
+ "key1": "foo",
+ "key2": "bar"
}
- ]
- },
- {
- "name": "Task form",
- "isTask": true,
- "selfUpdate": true,
- "route": "/task",
- "submitLabel": "Start task",
- "schema": [
- {
- "fieldType": "numberInput",
- "name": "run_time",
- "label": "Run time (seconds)"
- }
- ]
- }
- ]
- }
\ No newline at end of file
+ },
+ {
+ "fieldType": "tagList",
+ "label": "A tag list",
+ "name": "val_tags",
+ "value": ["tag2", "tag2", "squidward"]
+ }
+ ]
+ },
+ {
+ "name": "Task form",
+ "isTask": true,
+ "selfUpdate": true,
+ "route": "/task",
+ "submitLabel": "Start task",
+ "schema": [{
+ "fieldType": "numberInput",
+ "name": "run_time",
+ "label": "Run time (seconds)"
+ }]
+ }
+ ]
+}
\ No newline at end of file
diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
index 10e66e7a..00f29ec9 100644
--- a/docs/source/quickstart.rst
+++ b/docs/source/quickstart.rst
@@ -5,7 +5,7 @@ Install
-------
Stable installation
-+++++++++++++++
++++++++++++++++++++
For most users, this is the reccommended installation method.
- Run ``curl -LSs get.openflexure.org/microscope |sudo bash``
@@ -13,7 +13,7 @@ For most users, this is the reccommended installation method.
- Follow on-screen prompts
Developer and non-interactive installation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The installer script can pull the latest development package from our git repository, and use install into a developer environment using Poetry.
Options also exist to run the installer without any user prompts.
diff --git a/openflexure_microscope/camera/pi.py b/openflexure_microscope/camera/pi.py
index d73d0c02..6d22eaf2 100644
--- a/openflexure_microscope/camera/pi.py
+++ b/openflexure_microscope/camera/pi.py
@@ -4,16 +4,21 @@
Raspberry Pi camera implementation of the PiCameraStreamer class.
NOTES:
-Still port used for image capture
-Preview port reserved for onboard GPU preview
+
+Still port used for image capture.
+Preview port reserved for onboard GPU preview.
+
Video port:
- Splitter port 0: Image capture (if use_video_port == True)
- Splitter port 1: Streaming frames
- Splitter port 2: Video capture
- Splitter port 3: [Currently unused]
+
+* Splitter port 0: Image capture (if use_video_port == True)
+* Splitter port 1: Streaming frames
+* Splitter port 2: Video capture
+* Splitter port 3: [Currently unused]
PiCameraStreamer streams at video_resolution
+
Camera capture resolution set to stream_resolution in frames()
+
Video port uses that resolution for everything. If a different resolution
is specified for video capture, this is handled by the resizer.