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

Updated dev readme

Browse source
This commit is contained in:
Joel Collins 2018-11-08 16:24:56 +00:00
parent 92669e06a9
commit ed3c82a5b4
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -13,13 +13,13 @@ This module is currently in very early development, and is perhaps best installe
# Developer usage examples
## Running the web API in Gunicorn (port 5000)
- Ensure Gunicorn is installed to the current environment (`pip install gunicorn`)
- Run `gunicorn --threads 5 --workers 1 --bind 0.0.0.0:5000 openflexure_microscope.api.app:app`
- Run `gunicorn --threads 5 --workers 1 --bind 0.0.0.0:5000 openflexure_microscope.api.v1:app`
- Alternatively, run `source start_interface` from the openflexure-microscope-software directory.
## Running tests through the PTVSD remote debugger (port 3000)
- From the openflexure-microscope-software directory, run `python3 -m ptvsd --host 0.0.0.0 --port 3000 --wait tests/test_camera.py`
## Example API request (through CURL)
## Example API request (through CURL) (Deprecated. Needs to be updated to API v1.)
- Capture a still image from the video port
- `curl --header "Content-Type: application/json" --request POST --data '{"use_video_port": true}' raspberrypi.local:5000/capture`
- Get the image for download from a browser