docs: 添加 Nordic NCS 和 Zephyr 官方知识索引文档
添加了两个新的文档文件： - nordic_ncs_官方知识索引.md：收录 Nordic NCS 官方文档链接， 包括 Zephyr 镜像文档、CAF 框架、Partition Manager 等相关内容 - zephyr_官方知识索引.md：收录 Zephyr 官方文档链接， 涵盖构建配置、设备树、内核并发、蓝牙、USB、外设驱动等模块 这两个索引文档基于项目实际使用的 nrf52840 芯片和 NCS 3.2.3 版本， 通过浏览器渲染验证确保链接有效性，并按功能模块进行分类整理。
This commit is contained in:
96
docs/zephyr_官方知识索引.md
Normal file
96
docs/zephyr_官方知识索引.md
Normal file
@@ -0,0 +1,96 @@
|
||||
# new_kbd 项目 Zephyr 官方知识索引
|
||||
|
||||
## 说明
|
||||
|
||||
- 生成时间：2026-03-30
|
||||
- 扫描范围：`src/`、`inc/`、`prj.conf`、`sysbuild.conf`、`app.overlay`、`pm_static.yml`
|
||||
- 收录原则：仅收录 `E:\projects\new_kbd` 当前实际用到、且已确认页面真实存在的 Zephyr 官方文档
|
||||
- 链接范围：`https://docs.zephyrproject.org/latest/`、`https://docs.zephyrproject.org/apidoc/latest/`、`https://docs.zephyrproject.org/latest/doxygen/html/`
|
||||
- 不收录范围：Nordic NCS/CAF/App Event Manager/Partition Manager 文档，以及项目自定义驱动或项目私有协议说明
|
||||
- Nordic NCS 官方补充索引见：[new_kbd 项目 Nordic NCS 官方知识索引](./nordic_ncs_官方知识索引.md)
|
||||
|
||||
## 构建与配置
|
||||
|
||||
- [应用开发总览](https://docs.zephyrproject.org/latest/develop/application/index.html)
|
||||
- [CMake 构建系统](https://docs.zephyrproject.org/latest/build/cmake/index.html)
|
||||
- [Kconfig 配置系统](https://docs.zephyrproject.org/latest/build/kconfig/index.html)
|
||||
- [Sysbuild 系统构建](https://docs.zephyrproject.org/latest/build/sysbuild/index.html)
|
||||
|
||||
## 设备树与设备模型
|
||||
|
||||
- [设备树入门](https://docs.zephyrproject.org/latest/build/dts/intro.html)
|
||||
- [设备树 HOWTO](https://docs.zephyrproject.org/latest/build/dts/howtos.html)
|
||||
- [设备树 C/C++ API 用法](https://docs.zephyrproject.org/latest/build/dts/api-usage.html)
|
||||
- [zephyr,user 自定义节点](https://docs.zephyrproject.org/latest/build/dts/zephyr-user-node.html)
|
||||
- [设备模型 API](https://docs.zephyrproject.org/apidoc/latest/group__device__model.html)
|
||||
- [设备树通用标识符 API](https://docs.zephyrproject.org/apidoc/latest/group__devicetree-generic-id.html)
|
||||
|
||||
## 内核与并发
|
||||
|
||||
- [工作队列与延迟工作](https://docs.zephyrproject.org/latest/kernel/services/threads/workqueue.html)
|
||||
- [原子操作](https://docs.zephyrproject.org/latest/kernel/services/other/atomic.html)
|
||||
- [自旋锁 API](https://docs.zephyrproject.org/apidoc/latest/spinlock_8h.html)
|
||||
- [时钟、超时与 uptime](https://docs.zephyrproject.org/latest/kernel/services/timing/clocks.html)
|
||||
|
||||
## 日志与存储
|
||||
|
||||
- [日志子系统](https://docs.zephyrproject.org/latest/services/logging/index.html)
|
||||
- [Settings 设置子系统](https://docs.zephyrproject.org/latest/services/storage/settings/index.html)
|
||||
- [NVS 非易失存储](https://docs.zephyrproject.org/latest/services/storage/nvs/nvs.html)
|
||||
- [Flash Map 闪存映射](https://docs.zephyrproject.org/latest/services/storage/flash_map/flash_map.html)
|
||||
|
||||
## 蓝牙 Low Energy
|
||||
|
||||
- [Bluetooth GAP 概览](https://docs.zephyrproject.org/latest/connectivity/bluetooth/api/gap.html)
|
||||
- [Bluetooth GAP API](https://docs.zephyrproject.org/apidoc/latest/group__bt__gap.html)
|
||||
- [Bluetooth 连接管理](https://docs.zephyrproject.org/latest/connectivity/bluetooth/api/connection_mgmt.html)
|
||||
- [Bluetooth 连接管理 API](https://docs.zephyrproject.org/apidoc/latest/group__bt__conn.html)
|
||||
- [Bluetooth GATT 概览](https://docs.zephyrproject.org/latest/connectivity/bluetooth/api/gatt.html)
|
||||
- [Bluetooth GATT Server API](https://docs.zephyrproject.org/apidoc/latest/group__bt__gatt__server.html)
|
||||
- [Bluetooth UUID API](https://docs.zephyrproject.org/apidoc/latest/group__bt__uuid.html)
|
||||
- [Bluetooth Battery Service (BAS) API](https://docs.zephyrproject.org/apidoc/latest/group__bt__bas.html)
|
||||
- [Bluetooth 标准服务总览](https://docs.zephyrproject.org/latest/connectivity/bluetooth/api/services.html)
|
||||
- [BLE HID 外设官方示例](https://docs.zephyrproject.org/latest/samples/bluetooth/peripheral_hids/README.html)
|
||||
|
||||
## USB 与 HID
|
||||
|
||||
- [USB 设备栈（Device Stack Next）](https://docs.zephyrproject.org/latest/connectivity/usb/device_next/usb_device.html)
|
||||
- [USB Device API](https://docs.zephyrproject.org/apidoc/latest/group__usbd__api.html)
|
||||
- [USB HID 设备 API](https://docs.zephyrproject.org/latest/connectivity/usb/device_next/api/usbd_hid_device.html)
|
||||
- [USB HID Device API 参考](https://docs.zephyrproject.org/apidoc/latest/group__usbd__hid__device.html)
|
||||
- [HID 通用定义与报告描述符](https://docs.zephyrproject.org/latest/connectivity/usb/api/hid.html)
|
||||
- [zephyr,hid-device 设备树绑定](https://docs.zephyrproject.org/latest/build/dts/api/bindings/usb/zephyr%2Chid-device.html)
|
||||
|
||||
## 外设驱动
|
||||
|
||||
- [ADC 外设概览](https://docs.zephyrproject.org/latest/hardware/peripherals/adc.html)
|
||||
- [ADC API](https://docs.zephyrproject.org/apidoc/latest/group__adc__interface.html)
|
||||
- [GPIO 外设概览](https://docs.zephyrproject.org/latest/hardware/peripherals/gpio.html)
|
||||
- [GPIO API](https://docs.zephyrproject.org/apidoc/latest/group__gpio__interface.html)
|
||||
- [I2C 外设概览](https://docs.zephyrproject.org/latest/hardware/peripherals/i2c.html)
|
||||
- [传感器子系统概览](https://docs.zephyrproject.org/latest/hardware/peripherals/sensor/index.html)
|
||||
- [传感器 API](https://docs.zephyrproject.org/apidoc/latest/group__sensor__interface.html)
|
||||
- [LED 外设概览](https://docs.zephyrproject.org/latest/hardware/peripherals/led.html)
|
||||
- [LED API](https://docs.zephyrproject.org/apidoc/latest/group__led__interface.html)
|
||||
- [Nordic nRF QDEC 设备树绑定](https://docs.zephyrproject.org/latest/build/dts/api/bindings/sensor/nordic%2Cnrf-qdec.html)
|
||||
|
||||
## 显示与 GUI
|
||||
|
||||
- [显示子系统概览](https://docs.zephyrproject.org/latest/hardware/peripherals/display/index.html)
|
||||
- [MIPI-DBI SPI 设备树绑定](https://docs.zephyrproject.org/latest/build/dts/api/bindings/mipi-dbi/zephyr%2Cmipi-dbi-spi.html)
|
||||
- [ST7789V 设备树绑定](https://docs.zephyrproject.org/latest/build/dts/api/bindings/display/sitronix%2Cst7789v.html)
|
||||
- [PWM LEDs 设备树绑定](https://docs.zephyrproject.org/latest/build/dts/api/bindings/led/pwm-leds.html)
|
||||
- [GPIO LEDs 设备树绑定](https://docs.zephyrproject.org/latest/build/dts/api/bindings/led/gpio-leds.html)
|
||||
- [LVGL 官方示例入口](https://docs.zephyrproject.org/latest/samples/modules/lvgl/lvgl.html)
|
||||
|
||||
## 通用工具宏与字节序
|
||||
|
||||
- [sys/util 通用工具宏 API](https://docs.zephyrproject.org/apidoc/latest/group__sys-util.html)
|
||||
- [sys/byteorder 字节序 API](https://docs.zephyrproject.org/latest/doxygen/html/sys_2byteorder_8h.html)
|
||||
|
||||
## 未纳入本索引的项目项
|
||||
|
||||
- `zephyr/drivers/power/ip5305.h`、`CONFIG_IP5305`：当前项目使用的是自定义驱动/自定义绑定，Zephyr 官方 latest 站点未核到对应官方页面，因此未纳入
|
||||
- `pm_static.yml` 对应的 Partition Manager 规划：属于 Nordic NCS 范畴，不属于 Zephyr 官方 docs 站点范围；Nordic 官方索引见 [nordic_ncs_官方知识索引.md](./nordic_ncs_官方知识索引.md)
|
||||
- `CAF`、`App Event Manager`、`settings_loader`、`ble_state`、`ble_common_event`、`power_manager`、`buttons_def.h` 等：属于 Nordic NCS/CAF 文档范围，不属于本 Zephyr 官方索引；Nordic 官方索引见 [nordic_ncs_官方知识索引.md](./nordic_ncs_官方知识索引.md)
|
||||
- 项目私有协议与实现，如时间同步私有 GATT 服务、主机 HID 命令协议、显示主题持久化逻辑等：只索引其依赖的 Zephyr 通用能力，不索引项目私有设计本身
|
||||
Reference in New Issue
Block a user