Skip to content

READMEs: the instrument, in full - #20

Open
at350 wants to merge 4 commits into
mainfrom
alan-tai
Open

at350 wants to merge 4 commits into
mainfrom
alan-tai

Conversation

@at350

@at350 at350 commented Sep 20, 2026 •

Copy link
Copy Markdown
Collaborator

What

The root README told readers the pill reading was mocked and treated the hardware as an afterthought. This puts the instrument first and documents it properly.

README.md

  • Intro: Peel is an instrument plus a backend.
  • New The instrument section: parts (ESP32-S3 sensor board, Espressif ESP32-S3-BOX-3 face over ESP-NOW, six LEDs from 940 nm to 400 nm, transmission and scatter sensors, temperature probe, magnetic stirrer), power, the JSON wire protocol and single-byte commands, the fault engine, the steps of a run, classification, and everything that works without hardware (software board, captures, tools, self-test).
  • Classification is described through truepill (Add truepill: the spectral classification layer, tuned to the bench rig #26) and its /pill integration (Connect real pill captures to /pill and remove the mock path #27), with a plain statement that main still returns a labelled stand-in until those merge. No links to paths that are not on main.
  • Architecture diagram, Runpod paragraph, API table and project layout updated to match.

hardware/README.md

  • Intro names both boards; firmware folders named by board; "case", not "orange".

Includes a merge of current main (hardware photo from #28).

Docs only, no code changes.

The root README described the pill reading as mocked. It now has a section on
the instrument (parts, a run, the verdicts, what the screen can and cannot say),
routes the hardware observation through hardware/classify in the architecture
diagram, and lists hardware/ and mobile/ in the layout. POST /pill is described
as the no-instrument development stand-in it is.

hardware/README.md matches: BOX-3 first, firmware named by job, 'case' not
'orange'.
…n main

Parts, power, the wire protocol and commands, the fault engine, a run, the
simulator, captures and tools. The classification layer is described through
truepill (#26) and its /pill integration (#27) rather than hardware/classify,
which never reached main. Two boards, as the firmware has it: an ESP32-S3
sensor board and the ESP32-S3-BOX-3 face over ESP-NOW.
@at350 at350 changed the title READMEs: lead with the instrument, built on the ESP32-S3-BOX-3 READMEs: the instrument, in full Sep 20, 2026
Covers the QLoRA post-training setup, reproduction steps on Apple Silicon,
the synthetic dataset and evaluation protocol, and the privacy boundaries
for the local bottle/imprint endpoints.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant