Scripts README
This commit is contained in:
parent
140a3cf0de
commit
e7ea63a43a
|
@ -1,60 +1,14 @@
|
|||
_________________
|
||||
### Focusing
|
||||
##### focus.py `nb_step` `orientation`
|
||||
# Python scripts of the PlanktoScope
|
||||
|
||||
- `nb_step` : **integer** (from 1 to 100000) - number of step to perform by the stage (about 31um/step)
|
||||
- `orientation` : **string** - orientation of the focus either `up` or `down`
|
||||
This directory contains the various scripts needed for the PlanktoScope to run properly.
|
||||
|
||||
Example:
|
||||
You should start your exploration with the file `main.py` as this is the file started by Node-Red.
|
||||
|
||||
python3.7 $HOME/PlanktonScope/scripts/focus.py 650 up
|
||||
The `planktoscope` directory contains the various modules loaded at runtime:
|
||||
|
||||
_________________
|
||||
### Pumping
|
||||
##### pump.py `volume` `flowrate` `action`
|
||||
|
||||
- `volume` : **integer**
|
||||
- `flowrate` : **float**
|
||||
- `action` : **string**
|
||||
|
||||
Example:
|
||||
|
||||
python3.7 $HOME/PlanktonScope/scripts/pump.py 1 10 suck
|
||||
|
||||
_________________
|
||||
### Image
|
||||
##### image.py `in_path` `sample_project` `sample_id` `acq_id` `volume` `flowrate`
|
||||
|
||||
- `in_path` : **string** - directory to store acquisitions **the path has to end with /**
|
||||
- `sample_project` : **string**
|
||||
- `sample_id` : **string**
|
||||
- `acq_id` : **string**
|
||||
- `volume` : **integer**
|
||||
- `flowrate` : **float**
|
||||
|
||||
Example:
|
||||
|
||||
python3.7 $HOME/PlanktonScope/scripts/image.py $HOME/PlanktonScope/Acquisitions/ tara_pacific station_125 exp_1 24 3.2
|
||||
|
||||
|
||||
_________________
|
||||
|
||||
### Light
|
||||
##### light.py `state`
|
||||
|
||||
- `state` : **string** - `on` OR `off`
|
||||
|
||||
Example:
|
||||
|
||||
python3.7 $HOME/PlanktonScope/scripts/light.py on
|
||||
|
||||
|
||||
_________________
|
||||
### Fan
|
||||
##### fan.py `state`
|
||||
|
||||
- `state` : **string** - `on` OR `off`
|
||||
|
||||
Example:
|
||||
|
||||
python3.7 $HOME/PlanktonScope/scripts/fan.py on
|
||||
- `imager_state_machine.py` is the state machine class of the imager process.
|
||||
- `imager.py` is the process that runs the camera and the streaming server for the liveview.
|
||||
- `light.py` manages the state of the light messages displayed by the Yahboom HAT.
|
||||
- `mqtt.py` is the class managing the mqtt dialogue with Mosquitto and Node-Red.
|
||||
- `segmenter.py` is the process that controls the segmentation.
|
||||
- `stepper.py` is the process that manages the stepper motors and their movements.
|
||||
|
|
Loading…
Reference in a new issue