How grantdpowell/integrated-lab-companion works
What this project is (type + purpose)
From the file tree + README, this is a lab companion system consisting of:
• A Windows desktop application written in Python (ILC Release X Source Code.py) that provides the UI, experiment workflow, analysis, and “data management”.
• An Arduino firmware sketch (ILC Release X Ard Source Code.ino) that likely performs data acquisition / instrument control and streams measurements to the PC.
• A Windows installer artifact (ILC Release X-Installer.msi) produced via cx_Freeze (as stated in README).
• Supporting assets (Images/).
What the file structure implies architecturally
The repo is very “release-bundled” rather than a typical multi-folder source tree:
• A single monolithic Python file strongly suggests the desktop app code may be internally modular (classes/sections), but not split into packages.
• A single Arduino sketch suggests one firmware image.
What to extract from the README and represent explicitly
• Modules: data acquisition, processing, visualization (explicitly mentioned).
• Python as the core application language.
• Database exists and stores experimental data.
• Packaging/Distribution: cx_Freeze → executable → MSI installer.
• Missing “description key”: there is an external secret/config element not in source; show as “Config/License/Key material (not in repo)”.
ILC Desktop App (Python)
• UI Layer (experiment workflow, operator controls)
• Data Acquisition Client (talks to Arduino)
• Processing/Analysis Module
• Visualization/Plotting Module
• Data Management Module (CRUD/query/export)
• Configuration/Secrets Loader (“description key” not shipped)
Local Persistence
• “Experiment Database” (unknown type; annotate as e.g., “SQLite / local DB / file-based DB”)
Device / Embedded layer
Arduino Firmware
• Sensor/measurement acquisition
• Signal conditioning (if applicable)
• Command handler (receives control commands from PC)
• Data streaming
Connectivity layer
Packaging & Installer
• Python source → cx_Freeze → EXE → MSI
• Drivers prerequisite (README mentions drivers; show as “USB/Serial driver dependency”)
• User → ILC UI
• “starts experiment”, “configures parameters”, “views plots”
• ILC App → Arduino Firmware
• “control commands” (start/stop, set sample rate, calibration, etc.)
• Arduino Firmware → ILC App
• “measurement stream” (timestamped samples, status frames)
• ILC App ↔ Database
• “store experiment runs”, “query history”, “retrieve results”
• ILC App → Visualization
• internally: “processed data → plots”
• ILC App → Export (optional)
• “reports / datasets”
• Installer/MSI → Windows PC
• “deploy app + dependencies”
• Windows drivers → USB link
Architectural patterns/design principles
• Layered architecture inside the desktop app:
• Presentation (UI)
• Application/Service layer (experiment orchestration)
• Infrastructure (device comms + database)
• Modular responsibilities (as README says): Acquisition, Processing, Visualization, Data Management
• Boundary between embedded real-time acquisition (Arduino) and non-real-time analysis/UI (PC)
Real-world hardware boundary
• Arduino and any sensors/instruments in a separate “Physical Lab Bench” zone.
Data lifecycle
• Acquisition → buffering → processing → visualization → persistence → retrieval/export.
Operational concerns
• Drivers, COM port selection, calibration, and configuration keys (even if conceptual).
• User, Windows PC app, Arduino device, database (as internal), external dependencies (drivers).
• Break the Python app into the modules named above (Acquisition/Processing/Visualization/Data Mgmt/UI/Config).
• Python source + assets → cx_Freeze build → EXE/MSI → installed app + driver prerequisites.
• In ILC Release X Source Code.py:
• Which GUI framework (Tkinter/PyQt/etc)
• Whether DB is SQLite (sqlite3), files (json/csv), or external service
• Which serial library (pyserial) and the message format
• In .ino:
• Serial baud rate, framing (CSV lines, binary packets), supported commands
• Sensor pins / peripheral interfaces (I2C/SPI/ADC)
• Installer:
• Whether it bundles Python runtime, drivers, and DB initialization
Confirmed facts; for unknowns, annotate explicitly (“TBD/unknown”) rather than guessing.