Skip to content

Align firmware README defaults with SongbirdConfig.h #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bsatrom merged 1 commit into from
Nov 6, 2026
Merged

Align firmware README defaults with SongbirdConfig.h #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion skills/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,4 @@ Internal requirements and any restricted enablement material remain **restricted

**Solid also:** daily fleet activity digest recipe (`recipes.md`; weekday morning routine).

**Open follow-up:** README vs firmware defaults for `temp_alert_low_c`/`audio_volume` — prefer firmware; `unlock` (not README `lock_override`) is authoritative.
**Open follow-up:** `unlock` (not README `lock_override`) is authoritative. README defaults for `temp_alert_low_c` (`0`) and `audio_volume` (`80`) match `SongbirdConfig.h`.
2 changes: 1 addition & 1 deletion skills/notefiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ Boolean parsing is literal: only the string `true` or `1` becomes true; any othe

Locks override `mode` env. Companion dashboard fleet defaults may sync into Notehub environment at fleet scope, but configured ≠ applied until the device fetches the change. `[documented:songbird-firmware/src/commands/SongbirdEnv.cpp:66-79; sales-enablement/setup-guide.md:49-75, reviewed 2026-10-01 conf:high]`

**Source precedence note:** `SongbirdConfig.h` is authoritative for firmware defaults. The firmware README configuration table currently lists `temp_alert_low_c=5` and `audio_volume=50`, while the compiled defaults are `0` and `80`; preserve this discrepancy as an open documentation gap rather than silently merging it. `[documented:songbird-firmware/README.md:421-437 vs src/core/SongbirdConfig.h:174-189, reviewed 2026-10-01 conf:high]`
**Source precedence note:** `SongbirdConfig.h` is authoritative for firmware defaults. The firmware README configuration table matches those constants: `temp_alert_low_c` is `0` and `audio_volume` is `80`. `[documented:songbird-firmware/README.md:421-437; src/core/SongbirdConfig.h:174-189, reviewed 2026-11-06 conf:high]`

## Derivation notes

Expand Down
2 changes: 1 addition & 1 deletion skills/product.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ The threshold keys most useful in a sales demo are:

Values are clamped by firmware; alert events are emitted on `alert.qo` and synced immediately. For a live demo, lowering `temp_alert_high_c` (or another threshold) is the documented no-firmware-flash story. `[documented:songbird-firmware/src/commands/SongbirdEnv.cpp:102-138; src/core/SongbirdConfig.h:174-180; sales-enablement/demo-script.md:227-254, reviewed 2026-10-01 conf:high]`

**Source precedence note:** the firmware constants are authoritative for defaults. The firmware README table currently shows `temp_alert_low_c=5` and `audio_volume=50`, which disagree with `SongbirdConfig.h` (`0` and `80`); do not repeat those README values as firmware defaults. `[documented:songbird-firmware/README.md:421-437 vs src/core/SongbirdConfig.h:174-189, reviewed 2026-10-01 conf:high]`
**Source precedence note:** the firmware constants are authoritative for defaults. The firmware README configuration table matches `SongbirdConfig.h`: `temp_alert_low_c` is `0` and `audio_volume` is `80`. `[documented:songbird-firmware/README.md:421-437; src/core/SongbirdConfig.h:174-189, reviewed 2026-11-06 conf:high]`



Expand Down
4 changes: 2 additions & 2 deletions songbird-firmware/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,9 +428,9 @@ Configuration is managed via Notehub environment variables:
| `gps_interval_min` | number | 5 | GPS update interval (minutes) |
| `sync_interval_min` | number | 15 | Cloud sync interval (minutes) |
| `temp_alert_high_c` | number | 35 | High temperature alert threshold |
| `temp_alert_low_c` | number | 5 | Low temperature alert threshold |
| `temp_alert_low_c` | number | 0 | Low temperature alert threshold |
| `audio_enabled` | boolean | true | Enable audio feedback |
| `audio_volume` | number | 50 | Audio volume (0-100) |
| `audio_volume` | number | 80 | Audio volume (0-100) |
| `motion_sensitivity` | string | medium | Motion sensitivity (low/medium/high) |
| `gps_power_save_enabled` | boolean | true | Enable GPS power management in transit mode |
| `gps_signal_timeout_min` | number | 15 | Minutes to wait for GPS signal before disabling (10-30) |
Expand Down