planktoscope/software/scripts/README.md

19 lines
836 B
Markdown
Raw Normal View History

2022-11-03 15:31:27 +01:00
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
-->
2020-10-06 12:24:08 +02:00
# Python scripts of the PlanktoScope
2019-12-13 22:34:45 +01:00
2020-10-06 12:24:08 +02:00
This directory contains the various scripts needed for the PlanktoScope to run properly.
2019-12-13 22:34:45 +01:00
2020-10-06 12:24:08 +02:00
You should start your exploration with the file `main.py` as this is the file started by Node-Red.
2019-12-13 22:34:45 +01:00
2020-10-06 12:24:08 +02:00
The `planktoscope` directory contains the various modules loaded at runtime:
2019-12-13 22:34:45 +01:00
2020-10-06 12:24:08 +02:00
- `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.