[codex] Add maintenance timer fixes and traceability notes#207
Draft
yury-g wants to merge 4 commits into
Draft
Conversation
be9c3b3 to
02f9535
Compare
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.
Purpose
This draft PR prepares a maintenance branch for branch-based testing before any merge back to
master. It keeps the public version line at2.5.1while fixing traceability and timer issues that were found by inspection.What changed
library.propertiesand in-code version macros with releasev2.5.1.MAINTAINER_NOTES.mdso the maintenance reasoning and follow-up areas are easy to audit later.sensorIndex == SensorCount.sawNewSample()report hardware-timer samples as documented.scripts/end-user-install-test.shandresources/EndUserInstallTesting.mdto test the library as an Arduino IDE ZIP install.resources/ManualHardwareTestPlan.mdresources/ReleaseNotes-2.5.2-draft.mdresources/MaintenanceBranchHandoff.mdValidation already run
git diff --checkarduino-cliscripts/end-user-install-test.shesp32:esp32:XIAO_ESP32S3for:GettingStartedProjectGetting_BPM_to_MonitorPulseSensor_BPMPulseSensor_Pulse_Transit_TimeTwoPulseSensors_On_OneArduinoPulseSensor_XIAO_ESP32S3_BPMKnown limitation
Local AVR and UNO R4 compiles were attempted, but this Mac's installed Arduino toolchains fail before compilation with
bad CPU type in executable. The added end-user install script documents a broader board matrix that can be run on Linux or another machine with compatible Arduino toolchains.Prepared but not pushed yet
A GitHub Actions Arduino compile matrix exists as local commit
7e5ae73and as a patch bundle at:/Users/narwhal2/Documents/PulseSensorPlayground-local-patches/0001-Add-Arduino-compile-smoke-workflow.patchPushing
.github/workflows/arduino-compile.ymlrequires the GitHub token to haveworkflowscope. Once authorized, push the local branch and monitor the checks.Release intent
After this branch is reviewed, hardware-tested, and merged, prepare a separate
2.5.2bump branch usingresources/ReleaseNotes-2.5.2-draft.mdas the release-note starting point.