Repository navigation
Align firmware README defaults with SongbirdConfig.h - #58
Merged
Merged
Conversation
Document temp_alert_low_c as 0 and audio_volume as 80, matching DEFAULT_TEMP_ALERT_LOW_C and DEFAULT_AUDIO_VOLUME. Update skill notes that still recorded the old README values as an open discrepancy. Co-authored-by: Brandon Satrom <bsatrom+gh@gmail.com>
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.
Summary
The firmware README Configuration table documented two defaults that disagreed with the compiled constants. This updates those documented defaults to match
songbird-firmware/src/core/SongbirdConfig.h:SongbirdConfig.htemp_alert_low_cDEFAULT_TEMP_ALERT_LOW_C0.0f(SongbirdConfig.h)audio_volumeDEFAULT_AUDIO_VOLUME80(SongbirdConfig.h)Skill notes in
skills/product.md,skills/notefiles.md, andskills/index.mdstill recorded the old README numbers (5and50) as an open discrepancy and told readers to preserve it. Those notes now state the same two defaults (0and80). The product skill threshold table already listedtemp_alert_low_cas0; no other default in that table was changed.Sources:
songbird-firmware/README.md(Configuration defaults table)songbird-firmware/src/core/SongbirdConfig.h(DEFAULT_TEMP_ALERT_LOW_C,DEFAULT_AUDIO_VOLUME)Out of scope
Docs only. No firmware under
src/, no alert-threshold or env-handling changes, and no device tests.