About

This is a guide on how to set up and operate the experimental IRIS GUI built on the Python Textual TUI framework. It can be operated with the mouse or with just the keyboard.

Dependencies

  • uv
    • Using uv python install, install a recent version of Python (3.12+)
    • Please double check uv’s recognized Python installations by running uv python list in terminal!
  • A Local Copy of the GUI
    • Make sure to pull the textual-attempt branch

Running the GUI

  1. Open a terminal window in the IRIS-GUI repo directory.
  2. Run uv run textual run textualtest.py
    • Use your mouse or keyboard to navigate the menus.
  3. For MDA, preset sketches are included in the MDAScreen

Screens

The GUI is split into several “screens”. You can switch between them with CTRL+S. You’re also prompted at startup to choose a screen.

ManualUploadScreen

Allows you to manually select a sketch to upload, and view the associated config.h file if the sketch supports a standard one. Note that the “config editor” tab is read-only. f

MDAScreen

Preset sketches are included in the MDAScreen:

  • Binary Serial Logger
    • Constantly dumps samples over the serial line.
    • Can use the included serial_importer_all_in_one script to read the data.
  • M4 Datalogger
    • Logs data continuously on 4 pins at high speeds to the SD card.
  • Toggle Switch Datalogger
    • Uses a physical switch to enable/disable data logging on 4 pins at high speeds to the SD card.
  • SD Card Exposer
    • Exposes the onboard SD card as a flash drive to the connected computer. Poor performance.