All project documentation lives here. Start with the project README for the overview and quick start.
- COMPATIBILITY.md — OS support matrix (Windows / Linux / macOS) and real-board identity audit
- VALIDATION.md — what's verified on real hardware, timing, and how to reproduce it
- release/RELEASE_NOTES_v0.1.0.md — current release notes
- release/RELEASE_NOTES_v0.0.1.md — initial release notes
- release/README.md · release/PRE_RELEASE_CHECKLIST.md — release flow
- uploads/hands_free_upload.md — button-less serial-DFU on the maintenance CDC (the default verified path is the ProMicro clone's
promicroserialnosdworkflow) - uploads/double_reset_upload.md — manual double-reset bootloader entry
- uploads/swd_only_upload.md — flashing via an SWD probe
- platform/UPLOAD_BEHAVIOR.md — upload policy and behavior
- platform/USB_1200_TOUCH_V1_FIX.md — the firmware fixes that make hands-free upload work
- bootloaders/README.md — bootloader families
- platform/ARDUINO_IDE2_USB_GDBSTUB.md — single-cable USB-CDC GDB-stub debugging in Arduino IDE 2
- examples/vscode/README.md — sample
launch.json/tasks.jsonfor VS Code +cortex-debug
- boards/README.md — per-board reference index
- platform/BOARD_SUPPORT_STATUS.md — support matrix
- platform/BOARD_SUPPORT_NOTES.md · platform/BOARD_FAMILY_MATRIX.md — family notes & matrix
- platform/PWM_MULTI_MODULE.md — 4-module / 16-channel PWM facade, per-pin frequency, polarity, complementary pairs
- platform/RTC_DRIVER.md — low-level driver for RTC0/1/2 (compare + overflow IRQs)
cores/arduino/NrfPower.h— power management: System ON sleep (WFI/WFE), low-power / constant-latency sub-modes, DCDC, RAM retention, SystemOFF + GPIO / NFC / USB wake sourcescores/arduino/NrfNfcTag.h— NFC-A Type 2 tag emulation (NDEF URI / text), field detect IRQ, read countcores/arduino/NrfPeripherals.h— NrfRng (TRNG), NrfWdt (watchdog), NrfTemp (die temp), NrfQdec (rotary encoder), NrfTimer (TIMER0–4), NrfNvmc (flash erase/write), NrfPpi (peripheral routing), NrfEgu (software events + SWI on 6 channels), NrfComp (analog comparator), NrfMwu (memory watch unit), NrfGpioteOut (output channels for PPI use)cores/arduino/NrfMediaPeripherals.h— NrfQspi (external NOR flash), NrfPdm (MEMS mic), NrfI2s (digital audio). API complete; not verified on the reference ProMicro (no external flash/mic/codec wired) — boards with that hardware need their own verification pass.
- platform/NIMBLE_INTEGRATION_PLAN.md —
libraries/NimBLE/is not done yet: parts of the Mynewt porting/NPL layer are vendored, but the real connection/GATT stack is not in-tree andbegin()still returnsNIMBLE_NOT_VENDORED. - platform/CC310_INTEGRATION_PLAN.md —
libraries/CC310/is still a true skeleton until Nordic'slibcc_310.ais provided; the public API exists, but operations returnCC_NOT_VENDORED. - platform/ZIGBEE_INTEGRATION_PLAN.md —
libraries/Zigbee/is still a true skeleton; the Zboss + nrf-802154 runtime is not vendored andbegin()returnsZIGBEE_NOT_VENDORED. - platform/THREAD_INTEGRATION_PLAN.md —
libraries/Thread/is not done yet: OpenThread headers and some glue are present, but the actual OpenThread core + radio path are not vendored andbegin()returnsTHREAD_NOT_VENDORED.
- platform/HARDWARE_CAPABILITIES.md — what the core exposes
- platform/PWM_BEHAVIOR.md · platform/PWM_TIMER_BOUNDARIES.md — PWM model & limits (legacy single-module notes)
- platform/POWER_ADC_NOTES.md — ADC / battery-sense behavior
- platform/BLE_WIFI_BOUNDARIES.md — BLE/WiFi facade boundaries (current advertising-only stub)
- platform/clock_ble_low_power_menu.md · platform/storage_backend_menu.md — build menus
- platform/REFERENCE_COMPARISON.md — comparison vs
pdcook/nRFMicro-Arduino-Core - platform/BOARD_IMAGE_EVIDENCE.md · platform/DEVBOARD_INCREMENTAL_GATES.md — evidence & gating