Alan-Jowett / sonde / 23362891951
82%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 72
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 82.631%. Remained the same
23362891951

push

github

web-flow 
docs(modem): document 6 undocumented behaviors and 2 constraint deviations (#394)

* docs(modem): document 6 undocumented behaviors and 2 constraint deviations

Document behaviors found by the modem code compliance audit (#386):

- D9-1: ESP-NOW RX ring buffer (\RX_RING_CAP = 16\) drops frames when full
- D9-2: \MAX_BLE_EVENTS_PER_POLL\ (16) caps BLE processing per main-loop iteration
- D9-3: \MAX_BLE_EVENT_QUEUE\ (32) and \MAX_INDICATION_CHUNKS\ (64) queue limits
- D9-4: GATT writes gated on \uthenticated\ flag (explicit § 15.2.1 subsection)
- D9-5: Tentative accept model in \on_confirm_pin\ callback with mitigations
- D9-6: Watchdog timeout corrected to 35 s (modem sdkconfig overrides root 10 s)
- D10-4: BLE disconnect reason code is approximated (NimBLE binding limitation)
- D10-5: \dvertise_on_disconnect(true)\ vs \BLE_DISABLE\ interaction documented

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: address PR #394 review comments

- Move ESP-NOW RX ring buffer callout (D9-1) from §4.2 to §6.2 where it belongs
- Add USB-CDC RX ring buffer callout to §4.2
- Fix counter names: distinguish drop_count vs contention_drops (D9-1)
- Update §6.2 text to match ring-based implementation
- Fix D9-3: note that firmware emits warnings on some drop conditions
- Clarify §15.2 pairing flow: BLE stack proceeds immediately, modem waits
  for operator approval before setting authenticated flag
- Fix D9-6: document ESP_IDF_SDKCONFIG_DEFAULTS ordering and last-wins rule
- Update §9 main-loop description to reflect ring-drain model

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: correct `ESP_IDF_SDKCONFIG_DEFAULTS` ordering for modem build

Swap the semicolon-separated sdkconfig file order so that
`sdkconfig.defaults.esp32s3` (10 s watchdog) is listed first and
`crates/sonde-modem/sdkconfig.defaults` (35 s watchdog) is listed
last.  ESP-IDF applies overrides in list order (last value wins), so
the previous ord... (continued)

16532 of 20007 relevant lines covered (82.63%)

49.64 hits per line

Jobs
ID Job ID Ran Files Coverage
1 23362891951.1 72
82.63
 GitHub Action Run
Source Files on build 23362891951