Added some basic docs (waiting on auto-doc for args)

This commit is contained in:
jtc42 2019-12-21 13:18:02 +00:00
parent a8a3cafa97
commit 2372ba26e1
4 changed files with 28 additions and 0 deletions

View file

@ -56,6 +56,11 @@ class CaptureAPI(Resource):
class GPUPreviewStartAPI(Resource):
"""
Start the onboard GPU preview.
Optional "window" parameter can be passed to control the position and size of the preview window,
in the format ``[x, y, width, height]``.
"""
def post(self):
microscope = find_device("openflexure_microscope")
payload = JsonResponse(request)
@ -76,6 +81,9 @@ class GPUPreviewStartAPI(Resource):
class GPUPreviewStopAPI(Resource):
"""
Start the onboard GPU preview.
"""
def post(self):
microscope = find_device("openflexure_microscope")
microscope.camera.stop_preview()