rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Docstring for preview API route

Browse source
This commit is contained in:
Joel Collins 2018-12-04 15:14:19 +00:00
parent c3692aa3ef
commit f42dcf8b95
1 changed files with 22 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

23
openflexure_microscope/api/v1.py
View file

@ -653,7 +653,28 @@ class GPUPreviewAPI(MicroscopeView):
def post(self, operation):
"""
TODO: Documentation
Create a new image capture.
.. :quickref: GPU Preview; Start/stop preview
**Example requests**:
.. sourcecode:: http
POST /camera/preview/start HTTP/1.1
Accept: application/json
:>header Accept: application/json
.. sourcecode:: http
POST /camera/preview/stop HTTP/1.1
Accept: application/json
:>header Accept: application/json
:<header Content-Type: application/json
:status 200: preview started/stopped
"""
if operation == "start":
self.microscope.camera.start_preview()