docs(apple): native HRM Enroll for Apple Watch, drop BluetoothLE app workflow#323
Conversation
…for Apple Watch Current firmware emulates a Heart Rate Monitor (BLE 0x180D) during enrollment, so iOS and watchOS pair to it directly from Settings > Bluetooth -- the BluetoothLE / Bluetooth Terminal companion-app workaround is no longer required. - apple.mdx: rewrite Apple Watch section for the native pair flow, clarify the HRM emulation in the lead paragraph, fix "iWatch" to "Apple Watch", restructure Enrollment heading hierarchy, add last-verified footer (v4.0.6, 2026-05-11). - devices.md: change Apple Watches note from "Use iCloud keychain to get IRK" to "Pair to retrieve IRK". - guides/enrolling-devices.md: flip Apple Watch row in triage table from mixed to settled, replace the "no settled solution" caution with the native pair recipe, keep Mac Keychain as a labeled fallback. Closes ESPA-71. Co-Authored-By: Paperclip <noreply@paperclip.ing>
|
Caution Review failedPull request was closed or merged during review No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
WalkthroughThis PR updates Apple device enrollment documentation across three guides to modernize Apple Watch pairing instructions. The main apple.mdx file is rewritten to simplify the Apple Watch workflow by replacing the Bluetooth Terminal app workaround with native watchOS Bluetooth settings pairing, while also clarifying fingerprint collision concerns and device advertising behavior. The devices.md compatibility table and enrolling-devices.md guide are updated to reflect the new Apple Watch enrollment procedure and mark it as settled with a documented Mac Keychain fallback. ChangesApple Device Enrollment Documentation
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
Closes ESPA-71 (Apple Watch).
Current firmware emulates a Heart Rate Monitor (BLE service
0x180Dwith encrypted-read characteristic0x2A37) during enrollment, so iOS and watchOS pair to it natively fromSettings → Bluetooth. The previous workflow required a third-partyBluetoothLE/ Bluetooth Terminal companion app on both phone and watch; that's no longer necessary.This PR updates the three docs surfaces that pointed users at the old flow:
apple.mdx— rewrote the Apple Watch section as a 5-step native pair, clarified the HRM emulation in the lead paragraph, fixediWatch→Apple Watch, restructured the Enrollment heading hierarchy (was## Enrollmentthen## iPhone / iPadsas siblings — now H3 children), added a "Last verified against firmware v4.0.6 on 2026-05-11" footer.devices.md— Apple Watches row note changed from "Use iCloud keychain to get IRK" to "Pair to retrieve IRK" (now matches the iPhone row).guides/enrolling-devices.md— Apple Watch row in the triage table flipped fromVerified by reading firmware source
src/Enrollment.cpponESPresense/ESPresense@main:Enrollment::Setup()creates Heart Rate service0x180Dwith characteristic0x2A37(NIMBLE_PROPERTY::NOTIFY | NIMBLE_PROPERTY::READ_ENC).Enrollment::Loop()switches advertising to connectable HRM mode whileenrollingis true.enrollingEndMillis = millis() + 120000).Test plan
npm run build(with Node 22) — clean, 35 pages generated,/apple/,/devices/, and/guides/enrolling-devices/all built without errors.🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation