Fixed documentation (still needs rewriting)
This commit is contained in:
Joel Collins
parent
56bc985a69
commit
387fdeeb7d
6 changed files with 96 additions and 125 deletions
|
|
@ -5,7 +5,6 @@ Summary
|
||||||
-------
|
-------
|
||||||
.. qrefflask:: openflexure_microscope.api.app:app
|
.. qrefflask:: openflexure_microscope.api.app:app
|
||||||
:undoc-endpoints: index
|
: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:
|
:undoc-static:
|
||||||
:endpoints:
|
:endpoints:
|
||||||
|
|
||||||
|
|
@ -13,7 +12,6 @@ Details
|
||||||
-------
|
-------
|
||||||
.. autoflask:: openflexure_microscope.api.app:app
|
.. autoflask:: openflexure_microscope.api.app:app
|
||||||
:undoc-endpoints: index
|
: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:
|
:undoc-static:
|
||||||
:endpoints:
|
:endpoints:
|
||||||
:order: path
|
:order: path
|
||||||
|
|
|
||||||
|
|
@ -1,29 +1,7 @@
|
||||||
Classes and Modules
|
Classes and Modules
|
||||||
===================
|
===================
|
||||||
|
|
||||||
Plugin class
|
Extension class
|
||||||
------------
|
|
||||||
.. autoclass:: openflexure_microscope.plugins.MicroscopePlugin
|
|
||||||
:members:
|
|
||||||
|
|
||||||
.. autoclass:: openflexure_microscope.api.v1.views.MicroscopeViewPlugin
|
|
||||||
:members:
|
|
||||||
|
|
||||||
|
|
||||||
Default plugins
|
|
||||||
---------------
|
---------------
|
||||||
|
.. autoclass:: openflexure_microscope.common.flask_labthings.extensions.BaseExtension
|
||||||
Autofocus
|
|
||||||
+++++++++
|
|
||||||
.. automodule:: openflexure_microscope.plugins.default.autofocus
|
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
Camera calibration
|
|
||||||
++++++++++++++++++
|
|
||||||
.. automodule:: openflexure_microscope.plugins.default.camera_calibration
|
|
||||||
:members:
|
|
||||||
|
|
||||||
Scan and Stack
|
|
||||||
++++++++++++++
|
|
||||||
.. automodule:: openflexure_microscope.plugins.default.scan
|
|
||||||
:members:
|
|
||||||
|
|
@ -184,9 +184,3 @@ JSON form example
|
||||||
|
|
||||||
.. literalinclude:: forms_example.json
|
.. literalinclude:: forms_example.json
|
||||||
:language: JSON
|
:language: JSON
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
./form/json_form.rst
|
|
||||||
|
|
@ -1,87 +1,83 @@
|
||||||
{
|
{
|
||||||
"id": "test-plugin",
|
"id": "test-plugin",
|
||||||
"icon": "pets",
|
"icon": "pets",
|
||||||
"forms": [
|
"forms": [{
|
||||||
{
|
"name": "Simple request",
|
||||||
"name": "Simple request",
|
"isCollapsible": false,
|
||||||
"isCollapsible": false,
|
"isTask": false,
|
||||||
"isTask": false,
|
"selfUpdate": true,
|
||||||
"selfUpdate": true,
|
"route": "/do",
|
||||||
"route": "/do",
|
"submitLabel": "Do things",
|
||||||
"submitLabel": "Do things",
|
"schema": [{
|
||||||
"schema": [
|
"fieldType": "numberInput",
|
||||||
{
|
"placeholder": "Some integer",
|
||||||
"fieldType": "numberInput",
|
"name": "val_int",
|
||||||
"placeholder": "Some integer",
|
"label": "Number value"
|
||||||
"name": "val_int",
|
},
|
||||||
"label": "Number value"
|
{
|
||||||
},
|
"fieldType": "textInput",
|
||||||
{
|
"placeholder": "Some string",
|
||||||
"fieldType": "textInput",
|
"label": "String value",
|
||||||
"placeholder": "Some string",
|
"name": "val_str"
|
||||||
"label": "String value",
|
},
|
||||||
"name": "val_str"
|
{
|
||||||
},
|
"fieldType": "radioList",
|
||||||
{
|
"name": "val_radio",
|
||||||
"fieldType": "radioList",
|
"label": "Radio value",
|
||||||
"name": "val_radio",
|
"options": ["First", "Second", "Third"]
|
||||||
"label": "Radio value",
|
},
|
||||||
"options": ["First", "Second", "Third"]
|
{
|
||||||
},
|
"fieldType": "checkList",
|
||||||
{
|
"name": "val_check",
|
||||||
"fieldType": "checkList",
|
"label": "Checklist values",
|
||||||
"name": "val_check",
|
"options": ["Foo", "Bar", "Baz"]
|
||||||
"label": "Checklist values",
|
},
|
||||||
"options": ["Foo", "Bar", "Baz"]
|
{
|
||||||
},
|
"fieldType": "htmlBlock",
|
||||||
{
|
"name": "html_block",
|
||||||
"fieldType": "htmlBlock",
|
"content": "<i>This is a block of HTML in a plugin!</i>"
|
||||||
"name": "html_block",
|
},
|
||||||
"content": "<i>This is a block of HTML in a plugin!</i>"
|
{
|
||||||
},
|
"fieldType": "selectList",
|
||||||
{
|
"name": "val_select",
|
||||||
"fieldType": "selectList",
|
"multi": false,
|
||||||
"name": "val_select",
|
"label": "Some selection",
|
||||||
"multi": false,
|
"options": ["Most", "Average", "Least"]
|
||||||
"label": "Some selection",
|
},
|
||||||
"options": ["Most", "Average", "Least"]
|
{
|
||||||
},
|
"fieldType": "textInput",
|
||||||
{
|
"placeholder": "Some string",
|
||||||
"fieldType": "textInput",
|
"label": "Non-persistent string",
|
||||||
"placeholder": "Some string",
|
"name": "val_disposable"
|
||||||
"label": "Non-persistent string",
|
},
|
||||||
"name": "val_disposable"
|
{
|
||||||
},
|
"fieldType": "keyvalList",
|
||||||
{
|
"label": "A key-val object",
|
||||||
"fieldType": "keyvalList",
|
"name": "val_keyval",
|
||||||
"label": "A key-val object",
|
"value": {
|
||||||
"name": "val_keyval",
|
"key1": "foo",
|
||||||
"value": {
|
"key2": "bar"
|
||||||
"key1": "foo",
|
|
||||||
"key2": "bar"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"fieldType": "tagList",
|
|
||||||
"label": "A tag list",
|
|
||||||
"name": "val_tags",
|
|
||||||
"value": ["tag2", "tag2", "squidward"]
|
|
||||||
}
|
}
|
||||||
]
|
},
|
||||||
},
|
{
|
||||||
{
|
"fieldType": "tagList",
|
||||||
"name": "Task form",
|
"label": "A tag list",
|
||||||
"isTask": true,
|
"name": "val_tags",
|
||||||
"selfUpdate": true,
|
"value": ["tag2", "tag2", "squidward"]
|
||||||
"route": "/task",
|
}
|
||||||
"submitLabel": "Start task",
|
]
|
||||||
"schema": [
|
},
|
||||||
{
|
{
|
||||||
"fieldType": "numberInput",
|
"name": "Task form",
|
||||||
"name": "run_time",
|
"isTask": true,
|
||||||
"label": "Run time (seconds)"
|
"selfUpdate": true,
|
||||||
}
|
"route": "/task",
|
||||||
]
|
"submitLabel": "Start task",
|
||||||
}
|
"schema": [{
|
||||||
]
|
"fieldType": "numberInput",
|
||||||
}
|
"name": "run_time",
|
||||||
|
"label": "Run time (seconds)"
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
@ -5,7 +5,7 @@ Install
|
||||||
-------
|
-------
|
||||||
|
|
||||||
Stable installation
|
Stable installation
|
||||||
+++++++++++++++
|
+++++++++++++++++++
|
||||||
For most users, this is the reccommended installation method.
|
For most users, this is the reccommended installation method.
|
||||||
|
|
||||||
- Run ``curl -LSs get.openflexure.org/microscope |sudo bash``
|
- 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
|
- Follow on-screen prompts
|
||||||
|
|
||||||
Developer and non-interactive installation
|
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.
|
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.
|
Options also exist to run the installer without any user prompts.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,16 +4,21 @@
|
||||||
Raspberry Pi camera implementation of the PiCameraStreamer class.
|
Raspberry Pi camera implementation of the PiCameraStreamer class.
|
||||||
|
|
||||||
NOTES:
|
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:
|
Video port:
|
||||||
Splitter port 0: Image capture (if use_video_port == True)
|
|
||||||
Splitter port 1: Streaming frames
|
* Splitter port 0: Image capture (if use_video_port == True)
|
||||||
Splitter port 2: Video capture
|
* Splitter port 1: Streaming frames
|
||||||
Splitter port 3: [Currently unused]
|
* Splitter port 2: Video capture
|
||||||
|
* Splitter port 3: [Currently unused]
|
||||||
|
|
||||||
PiCameraStreamer streams at video_resolution
|
PiCameraStreamer streams at video_resolution
|
||||||
|
|
||||||
Camera capture resolution set to stream_resolution in frames()
|
Camera capture resolution set to stream_resolution in frames()
|
||||||
|
|
||||||
Video port uses that resolution for everything. If a different resolution
|
Video port uses that resolution for everything. If a different resolution
|
||||||
is specified for video capture, this is handled by the resizer.
|
is specified for video capture, this is handled by the resizer.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue