README.md

MVM - gui

Code organization

• the gui folder is deputed to contain the Python files for the GUI
• the mock folder contains the mock-ups for testing purposes, basically to mimic hardware interaction

Requirements

• Python >= 3.5 (but not 3.8 because PyQtGraph is incompatible)
• PyQt5
• PyQtGraph
• PySerial
• PyYaml
• numpy
• to run it under windows, install the Cantarell font https://fonts.google.com/specimen/Cantarell

Run

You can run with

cd gui/
./mvm_gui.py

By default, the program will read from the specified serial port. If you want to run with simulated input, the program is invoked with

./mvm_gui.py fakeESP32

Default settings are stored in

./gui/default_settings.yaml

Basics settings are:

• port: (string) the serial port to use

More settings and description can be found in the yaml file itself.

If you want to read from an Arduino (ESP), you need to upload mock/mock.ino to your Arduino device, and specify the serial port in the settings file.