Skip to content

Add sensor field-notes index and clarify normalization comments in sensor code - #17

Merged
bseverns merged 1 commit into
mainfrom
codex/locate-sensor-implementations-and-document-usage
Jan 5, 2026
Merged

bseverns merged 1 commit into
mainfrom
codex/locate-sensor-implementations-and-document-usage

Conversation

@bseverns

@bseverns bseverns commented Jan 5, 2026

Copy link
Copy Markdown
Owner

Motivation

  • Make it easier for newcomers and instructors to find per-sensor wiring, RC recipes, calibration rituals, and expected gesture behavior.
  • Surface the intent and normalization behavior of each sensor read path so classroom narration matches the implementation.
  • Keep the Sensor abstraction teachable and reduce onboarding time during live demos.

Description

  • Add a short field-notes index at docs/Sensors/README.md that links to each per-sensor page and gives a quick teaching flow.
  • Cross-link the index from docs/SensingSurvey.md and the top-level README.md so the notes show up in the onboarding paths.
  • Clarify inline comments in firmware sensor implementations to explicitly call out normalization behavior (and small wording tweaks) in firmware/src/time_of_flight_sensor.cpp, firmware/src/piezo_sensor.cpp, firmware/src/pir_sensor.cpp, firmware/src/electret_mic_sensor.cpp, and firmware/src/i2s_mic_sensor.cpp.
  • Changes are documentation and comment updates; no sensor logic or public API surface was changed.

Testing

  • No automated tests were run for this change because it is documentation and comment updates only.
  • No firmware/device builds were executed as part of this PR.
  • Docs-only changes were added to the repo and committed; local docs render was not validated by CI in this rollout.
  • If desired, run pio test -d firmware -e native and CI build targets to smoke-check firmware builds after these edits.

Codex Task

@bseverns
bseverns merged commit 1498a52 into main Jan 5, 2026
8 checks passed
@bseverns
bseverns deleted the codex/locate-sensor-implementations-and-document-usage branch January 5, 2026 05:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant