# xc_sdk_doc

**Repository Path**: xinchip_1/xcsdkdoc

## Basic Information

- **Project Name**: xc_sdk_doc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 3
- **Created**: 2025-01-24
- **Last Updated**: 2026-07-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# get_start(必读).md
UsageInsights目录下的文章记录了在调成程序过程中遇到的问题和解决办法  
documents存放芯片各个外设模块和蓝牙以及2.4G的说明,点击下面的链接即可跳转到各自的文档!  
**注意:有些问题在新的SDK版本已经更新了,用户并不需要改!**

### 阅读建议
建议把整个仓库克隆到本地用VSCODE打开整个文件夹,按"CTRL+T"快捷键根据标题搜索关键字点击搜索结果快速跳转标题位置:
![alt text](image/image.png)  
如果"CTRL+T"快捷键无效可以打开任意一个MD文档然后在搜索栏输入"#"加上关键字也可以搜索:
![alt text](image/image-1.png)  
找到文章打开后在文档任意位置按下CTRL+SHIFT+V快捷键即可预览MD文件,在vscode预览比Gitee效果好很多:
![alt text](picture/image-1.png)  


## SDK 介绍

[introduce sdk](./documents/introduce_sdk.md):介绍整个ble52的目录结构   

## 程序烧录

[download bin](./documents/烧录上位机使用说明.md):介绍将编译好的bin文件烧写到开发板里。
 
## 量产烧录

[offline burn](./documents/offline_burn.md):介绍将编译好的bin文件批量烧写到开发板里。 

## DCDC使用流程

[DCDC使用流程](./documents/DCDC使用流程.md):介绍开发板dcdc使用。 

## 蓝牙

[ble用户手册](./documents/Ble/ble用户手册.md):蓝牙开发手册，介绍广播，连接，加密等  

[ble peripheral](./documents/Ble/ble_peripheral.md):介绍蓝牙丛机的开发例程 

[ble central](./documents/Ble/ble_central.md):介绍蓝牙主机的开发例程  

[ble rssi debug](./documents/Ble/ble_rssi_debug.md):介绍扫描和连接状态下RSSI调试方法

说明:串口透传请参考SDK例程`project/example/ble/ble_peripheral_uart`,文档入口在[ble peripheral](./documents/Ble/ble_peripheral.md)的"串口转BLE"章节
外设同时扫描请参考`project/example/ble/ble_peripheral_scan`。

### OTA 开发

[FAST OTA](./documents/Ble/XIP_OTA使用说明.md):升级流程和协议说明,注意:这个是XIP-OTA这个APP对应的资料

[OTA](./documents/Ble/OTA.md):升级流程和协议说明,注意:这个是BLEOTA这个APP对应的资料，老OTA协议


### 低功耗
蓝牙低功耗的相关信息  
[low power](./documents/Testdata/low_power.md)

[xc65功耗数据](./documents/Testdata/XC65功耗数据.md)

## USB
[driver_usb](./documents/Driver/driver_usb.md):介绍mcu的usb使用例程 

## 2.4g
[2.4G用户手册](./documents/2.4G用户手册.md):介绍2.4G使用例程 

[2.4G_OTA使用说明](documents/2.4G/2.4G_OTA.md):介绍2.4G_OTA的使用 


## 驱动

[driver_adc](./documents/Driver/driver_adc.md):介绍mcu的adc电压采集功能  


[driver_clock](./documents/Driver/driver_clock.md):介绍mcu的时钟的配置  


[driver_gpio](./documents/Driver/driver_gpio.md):介绍mcu的gpio功能的开发例程  


[driver_iic](./documents/Driver/driver_iic.md):介绍mcu的i2c读写eeprom，主从通信   


[driver_pwm](./documents/Driver/driver_pwm.md):介绍mcu的pwm输出、捕获、刹车，使能adc等  

 
[driver_pwr](./documents/Driver/driver_pwr.md):介绍mcu的浅睡、深睡，唤醒等  

 
[driver_rtc](./documents/Driver/driver_rtc.md):介绍mcu的rtc计数功能例程  

 
[driver_spi](./documents/Driver/driver_spi.md):介绍mcu的spi读flash、主从通信等  


[driver_timer](./documents/Driver/driver_timer.md):介绍mcu的timer定时器的使用例程   

[driver_wdt](./documents/Driver/driver_wdt.md):介绍mcu的wdt使用例程  

## API 介绍

- [gap api](./documents/API/xc__gap__api_8h.md)
- [gatt client api](./documents/API/xc__gatt__client__api_8h.md)
- [gatt server api](./documents/API/xc__gatt__server__api_8h.md)

- [adc](./documents/API/adc.md)
- [clock](./documents/API/xc__drv__clock_8h.md)
- [gpio](./documents/API/xc__drv__gpio_8h.md)
- [i2c](./documents/API/xc__drv__i2c_8h.md)
- [pwm](./documents/API/xc__drv__pwm_8h.md)
- [power](./documents/API/xc__drv__pwr_8h.md)
- [rtc](./documents/API/xc__drv__rtc_8h.md)
- [spi](./documents/API/xc__drv__spi_8h.md)
- [systick](./documents/API/xc__drv__systick_8h.md)
- [timer](./documents/API/xc__drv__timer_8h.md)
- [uart](./documents/API/xc__drv__uart_8h.md)
- [wdt](./documents/API/xc__drv__wdt_8h.md)
- [dma](./documents/API/xc__drv__dma_8h.md)
- [spi dma](./documents/API/xc__drv__spi__dma_8h.md)
- [fmc spi](./documents/API/xc__drv__fmc__spi__dma_8h.md)