Add onboarding & gesture docs, sensor field notes, and improve optical sensor normalization - #18
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Description
docs/Onboarding90Min.mdwith a 90‑minute workshop syllabus that walks hardware → firmware → visualizer.docs/GestureVocabulary.mdlinking human‑readable gesture rules to the exact knobs infirmware/include/gesture_engine.h.docs/Sensors/OpticalReflective.mdanddocs/Sensors/CapacitiveSingleWire.md, plus updatedocs/Sensors/README.md,docs/SensingSurvey.md, and top‑levelREADME.mdto include the new pages.firmware/src/optical_sensor.cppto track an ambient floor, subtract it before normalization, apply a small gain, and smooth the resulting envelope (ambient_floor_,gain_,env_), making the front‑end more stable and easier to teach.Testing
pio test -d firmware -e nativefor gesture unit tests and building the firmware targets for CI validation.Codex Task