# k230_docs

**Repository Path**: kendryte/k230_docs

## Basic Information

- **Project Name**: k230_docs
- **Description**: Kendryte K230 SDK Docs
- **Primary Language**: other
- **License**: BSD-2-Clause
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 32
- **Forks**: 0
- **Created**: 2023-07-07
- **Last Updated**: 2025-11-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: k230

## README

# Canaan Kendryte K230 documentation

[![Github repository](https://img.shields.io/badge/github-repository-blue?logo=github&style=plastic)](https://github.com/kendryte/k230_docs)
[![Gitee repository](https://img.shields.io/badge/gitee-repository-blue?logo=gitee&style=plastic)](https://gitee.com/kendryte/k230_docs)
[![GitHub release](https://img.shields.io/github/v/release/kendryte/k230_docs?color=brightgreen&display_name=tag&logo=github&style=plastic)](https://github.com/kendryte/k230_docs/releases)

[中文文档](https://www.kendryte.com/k230/zh/dev/index.html) | [English Docs](https://www.kendryte.com/k230/en/dev/index.html)

[TOC]

## Links to K230 related resources

| link | illustrate  |
| ------ | ---- |
| [K230 SDK](https://github.com/kendryte/k230_sdk) | Kendryte K230 SDK Github Repo |
|[K230 Docs](https://github.com/kendryte/k230_docs)| Kendryte K230 Docs Github Repo |
|[K230_training_scripts](https://github.com/kendryte/K230_training_scripts/)| Kendryte K230 Training Scripts Github Repo |
| [K230 SDK Gitee mirror](https://gitee.com/kendryte/k230_sdk) | Kendryte K230 SDK Gitee mirror Repo |
|[K230 Docs Gitee mirror](https://gitee.com/kendryte/k230_docs)| Kendryte K230 Docs Gitee mirror Repo |
|[K230 SDK Release mirror](https://kendryte-download.canaan-creative.com/k230/release/sdk/k230_sdk.tar.gz)|Canaan Kendryte K230 SDK release k230_sdk.tar.gz download|
|[K230 Docs Release mirror](https://kendryte-download.canaan-creative.com/k230/release/docs/k230_docs.tar.gz)|Canaan Kendryte K230 Docs release k230_docs.tar.gz download|
|[Canaan Kendryte K230](https://www.kendryte.com/product/k230)|Canaan Kendryte K230|
|[Canaan Kendryte Forum](https://www.kendryte.com/)|Canaan Kendryte developer forum|

## K230 hardware documentation

| Document name | Summary of the documentation |
| --- | --- |
| [K230_DEMO_BOARD_Resource_Usage_Instructions.md](en/00_hardware/K230_DEMO_BOARD_Resource_Usage_Instructions.md) | K230 Demo Board Hardware Resource Usage Documentation |
| [K230_Hardware_Design_Guide.md](en/00_hardware/K230_Hardware_Design_Guide.md) | K230 Hardware Design Guide document |
| [K230_PINOUT_V1.2_20240822.xlsx](https://kendryte-download.canaan-creative.com/developer/k230/HDK/K230%E7%A1%AC%E4%BB%B6%E6%96%87%E6%A1%A3/K230_PINOUT_V1.2_20240822.xlsx) | K230 chip pin definition |
| [K230_datasheet.md](en/00_hardware/K230_datasheet.md) | K230 Datasheet |

### K230 LP3 engineering design file

| Document name | Summary of the documentation |
| --- | --- |
| [K230_DEMO_BOARD-20230427-DXF](zh/00_hardware/K230_LP3/K230_DEMO_BOARD-20230427-DXF.zip) | K230 Demo Board DXF File|
| [K230_DEMO_BOARD-20230427-GERBER](zh/00_hardware/K230_LP3/K230_DEMO_BOARD-20230427-GERBER.zip) | GERBER files for K230 Demo Board boarding |
| [K230_DEMO_BOARD-20230427-PCB](zh/00_hardware/K230_LP3/K230_DEMO_BOARD-20230427-PCB.zip) | K230 Demo Board PCB Cadence File|
| [K230_DEMO_BOARD-20230427-SMT](zh/00_hardware/K230_LP3/K230_DEMO_BOARD-20230427-SMT.zip) | K230 Demo Board SMT welding layout and drilling files|
| [K230-DEMO-BOARD-BOM-20230510](zh/00_hardware/K230_LP3/K230-DEMO-BOARD-BOM-20230510.xlsx) | The BOM of the device used in the K230 Demo Board |
| [K230-DEMO-BOARD-SCH. DSN](zh/00_hardware/K230_LP3/K230-DEMO-BOARD-SCH.DSN) | K230 Demo Board Cadence CIS Capture File |
| [K230-DEMO-BOARD-SCH.pdf](zh/00_hardware/K230_LP3/K230-DEMO-BOARD-SCH.pdf) | K230 Demo Board schematic pdf file |

### K230 LP4 engineering design file

| Document name | Summary of the documentation |
| --- | --- |
| [K230-USIP-EVB-LP4-V1_1-A_1-20230412-DXF](zh/00_hardware/K230_LP4/K230-USIP-EVB-LP4-V1_1-A_1-20230412-DXF.zip) | K230 LP4 Demo Board DXF File|
| [K230-USIP-EVB-LP4-V1_1-A_1-20230412-GERBER](zh/00_hardware/K230_LP4/K230-USIP-EVB-LP4-V1_1-A_1-20230412-GERBER.zip) | K230 LP4 Demo Board for board making GEBER files |
| [K230-USIP-EVB-LP4-V1_1-A_1-20230412-PCB](zh/00_hardware/K230_LP4/K230-USIP-EVB-LP4-V1_1-A_1-20230412-PCB.zip) | K230 LP4 Demo Board PCB Cadence File|
| [K230-USIP-EVB-LP4-V1_1-A_1-20230412-SMT](zh/00_hardware/K230_LP4/K230-USIP-EVB-LP4-V1_1-A_1-20230412-SMT.zip) | K230 LP4 Demo Board SMT welding layout and drilling files|
| [K230-USIP-EVB-LP4-SCH-V1.1-A.1-20230330](zh/00_hardware/K230_LP4/K230-USIP-EVB-LP4-SCH-V1.1-A.1-20230330.xlsx) | The BOM of the device used in the K230 LP4 Demo Board |
| [K230-USIP-EVB-LP4-SCH-V1.1-A.1-20230330.DSN](zh/00_hardware/K230_LP4/K230-USIP-EVB-LP4-SCH-V1.1-A.1-20230330.DSN) | K230 LP4 Demo Board Cadence CIS Capture File |

### K230D engineering design file

| Document name | Summary of the documentation |
| --- | --- |
| [K230-SIP-EVB-V1_0-A_1-20230322-DXF](zh/00_hardware/K230D/K230-SIP-EVB-V1_0-A_1-20230322-DXF.zip) | K230D Demo Board DXF File|
| [K230-SIP-EVB-V1_0-A_1-20230322-GERBER](zh/00_hardware/K230D/K230-SIP-EVB-V1_0-A_1-20230322-GERBER.zip) | GERBER files for K230D Demo Board boarding |
| [K230-SIP-EVB-V1_0-A_1-20230322-PCB](zh/00_hardware/K230D/K230-SIP-EVB-V1_0-A_1-20230322-PCB.zip) | K230D Demo Board PCB Cadence File|
| [K230-SIP-EVB-V1_0-A_1-20230322-SMT](zh/00_hardware/K230D/K230-SIP-EVB-V1_0-A_1-20230322-SMT.zip) | K230D Demo Board SMT welding layout and drilling files|
| [K230-SIP-EVB-V1_0-A_1_20230316-BOM](zh/00_hardware/K230D/K230-SIP-EVB-V1_0-A_1_20230316-BOM.xlsx) | The BOM of the device used in the K230D Demo Board |
| [K230-SIP-EVB-V1_0-A_1-20230316.DSN](zh/00_hardware/K230D/K230-SIP-EVB-V1_0-A_1-20230316.DSN) | K230D Demo Board Cadence CIS Capture File |
| [K230-SIP-EVB-V1.0-A.1-20230317.pdf](zh/00_hardware/K230D/K230-SIP-EVB-V1.0-A.1-20230317.pdf) | K230D Demo Board schematic pdf file |
| [CanMV-K230D-Zero V1.0开发板原理图和PCB设计文件](https://kendryte-download.canaan-creative.com/developer/k230/HDK/K230D%E5%B7%A5%E7%A8%8B%E8%AE%BE%E8%AE%A1%E6%96%87%E4%BB%B6/ProDocument_CanMV-K230D-Zero_V1.0_2024-07-09.epro) | CanMV-K230D-Zero V1.0开发板原理图和PCB设计文件 |

### CanMV-K230 engineering design file

| Document name | Summary of the documentation |
| --- | --- |
| [CanMV-K230-V1.0_2023-09-15.pdf](zh/00_hardware/CanMV_K230/CanMV-K230-V1.0_2023-09-15.pdf) | CanMV-K230 Demo Board schematic pdf file|
| [CanMV-K230_2023-10-11.html](zh/00_hardware/CanMV_K230/CanMV-K230_2023-10-11.html) | CanMV-K230 Demo Board bitmap file|
| [CanMV-K230D-Zero V1.0开发板原理图和PCB设计文件](https://kendryte-download.canaan-creative.com/developer/k230/HDK/CanMV-K230%E5%B7%A5%E7%A8%8B%E8%AE%BE%E8%AE%A1%E6%96%87%E4%BB%B6/ProDocument_CanMV-K230-LP4-V3.0-20240509.epro) | CanMV-K230D-Zero V1.0开发板原理图和PCB设计文件|

## K230 SDK software documentation

### K230 SDK usage documentation

| Document name | Summary of the documentation |
| --- | --- |
| [K230_SDK_User_Manual.md](en/01_software/board/K230_SDK_User_Manual.md) | K230 SDK instructions|

#### K230 SDK nncase docs

| Document name | Summary of the documentation |
| --- | --- |
| [K230_nncase_Development_Guide.md](en/01_software/board/ai/K230_nncase_Development_Guide.md) | K230 nncase Development Guide|

#### K230 sdk cdk docs

| Document name | Summary of the documentation |
| --- | --- |
| [K230_Inter_Processer_Communication_API_Reference.md](en/01_software/board/cdk/K230_Inter_Processer_Communication_API_Reference.md) | K230 Inter Processer Communication API Reference|
| [K230_System_Control_MAPI_Reference.md](en/01_software/board/cdk/K230_System_Control_MAPI_Reference.md) | K230 System Control MAPI Reference|

#### K230 sdk demo docs

| Document name | Summary of the documentation |
| --- | --- |
| [K230_SDK_EVB_Board_Demo_User_Guide.md](en/01_software/board/examples/K230_SDK_EVB_Board_Demo_User_Guide.md) | K230 SDK EVB Board Demo User Guide|
| [K230_SDK_CanMV_Board_Demo_User_Guide.md](en/01_software/board/examples/K230_SDK_CanMV_Board_Demo_User_Guide.md) | K230 SDK CanMV Board Demo User Guide|

#### K230 sdk middleware docs

| Document name | Summary of the documentation |
| --- | --- |
| [K230_MultimediaMiddleware_API_reference.md](en/01_software/board/middleware/K230_MultimediaMiddleware_API_reference.md) | K230 Middleware API reference |
| [K230_OpenBLAS_Development_Guide.md](en/01_software/board/middleware/K230_OpenBLAS_Development_Guide.md) | K230 OpenBLAS Development Guide |
| [K230_OpenCV_Development_Guide.md](en/01_software/board/middleware/K230_OpenCV_Development_Guide.md) | K230 OpenCV Development Guide|

#### K230 sdk mpp docs

| Document name | Summary of the documentation |
| --- | --- |
| [K230_Camera_Sensor_Adaptation_Guide.md](en/01_software/board/mpp/K230_Camera_Sensor_Adaptation_Guide.md) | K230 Camera Sensor Adaptation Guide|
| [K230_DMA_API_Reference.md](en/01_software/board/mpp/K230_DMA_API_Reference.md) | K230 DMA API Reference|
| [K230_DPU_API_Reference](en/01_software/board/mpp/K230_DPU_API_Reference.md) | K230 DPU API Reference|
| [K230_GPU_API_Reference.md](en/01_software/board/mpp/K230_GPU_API_Reference.md) | K230 GPU API Reference|
| [K230_SHA256_API_Reference.md](en/01_software/board/mpp/K230_SHA256_API_Reference.md) | K230 SHA256 API Reference|
| [K230_VICAP_API_Reference.md](en/01_software/board/mpp/K230_VICAP_API_Reference.md) | K230 VICAP API Reference|
| [K230_VICAP_SENSOR_Parameter_Partition_Reference.md](en/01_software/board/mpp/K230_VICAP_SENSOR_Parameter_Partition_Reference.md) | K230 VICAP SENSOR Parameter Partition Reference|
| [K230_System_Control_API_Reference.md](en/01_software/board/mpp/K230_System_Control_API_Reference.md) | K230 System Control API Reference|
| [K230_video_codec_API_reference.md](en/01_software/board/mpp/K230_video_codec_API_reference.md) | K230 Video Codec API Reference|
| [K230_video_output_API_reference.md](en/01_software/board/mpp/K230_video_output_API_reference.md) | K230 Video Output API Reference|
| [K230_Audio_API_Reference](en/01_software/board/mpp/K230_Audio_API_Reference.md) | K230 Audio API Reference|
| [K230_FFT_API_Reference.md](en/01_software/board/mpp/K230_FFT_API_Reference.md) | K230 FFT API Reference|
| [K230_PM_Usage_Guide.md](en/01_software/board/mpp/K230_PM_Usage_Guide.md) | K230 PM Usage Guide|

#### K230 sdk osdrv docs

| Document name | Summary of the documentation |
| --- | --- |
| [K230_DRM_API_Reference.md](en/01_software/board/osdrv/K230_DRM_API_Reference.md) | K230 DRM API Reference|
| [K230_PMU_User_Guide.md](en/01_software/board/osdrv/K230_PMU_User_Guide.md) | K230 PMU User Guide|
| [K230_SDK_IoT_WiFi_AiW4211LV10_User_Guide.md](en/01_software/board/osdrv/K230_SDK_IoT_WiFi_AiW4211LV10_User_Guide.md) | K230 SDK IoT WiFi AiW4211LV10_ User Guide|
| [K230_SDK_IoT_WiFi_AiW4211LV10_Driver_Development_Guide.md](en/01_software/board/osdrv/K230_SDK_IoT_WiFi_AiW4211LV10_Driver_Development_Guide.md) | K230 SDK IoT WiFi AiW4211LV10 Driver Development Guide|
| [K230_Big_Core_Low_Speed_Driver_API_Reference.md](en/01_software/board/osdrv/K230_Big_Core_Low_Speed_Driver_API_Reference.md) | K230 Big Core Low Speed Drive API Reference|
| [K230_Little_Core_Linux_Driver_API_Reference.md](en/01_software/board/osdrv/K230_Little_Core_Linux_Driver_API_Reference.md) | K230 Small Core Linux Driver API Reference|

### K230 PC software documentation

| Document name | Summary of the documentation |
| --- | --- |
| [K230_ISP_Tuning_Tool_User_Guide.md](en/01_software/pc/pqtools/K230_ISP_Tuning_Tool_User_Guide.md) | K230 SDK Tuning Tool User Guide|
| [K230_SDK_Dewarp_Guide.md](en/01_software/pc/dewarp/K230_SDK_Dewarp_Guide.md) | K230 SDK Dewarp User Guide |
| [K230_SDK_Burntool_User_Guide.md](en/01_software/pc/burntool/K230_SDK_Burntool_User_Guide.md) | K230 SDK Burntool User Guide |
| [K230_ISP_Image_Tuning_Guide.md](en/01_software/pc/ISP_tuning/K230_ISP_Image_Tuning_Guide.md) | K230 ISP Image Tuning Guide |
| [K230_ISP_Initial_Setting_Guide.md](en/01_software/pc/ISP_tuning/K230_ISP_Initial_Setting_Guide.md) | K230 ISP Initial Setting Guide |

## K230 SDK usage tutorial

### K230 SDK basic tutorial

| Document name | Summary of the documentation |
| --- | --- |
| [K230_Practical_Basics_hello_world.md](en/02_applications/tutorials/K230_Practical_Basics_hello_world.md) | K230 Practical Basics - hello world|
| [K230_Inter_Processer_Communication_sharefs_Usage.md](en/02_applications/tutorials/K230_Inter_Processer_Communication_sharefs_Usage.md) | K230 Inter Processer Communication Sharefs Usage|
| [K230_GPU_Practice.md](en/02_applications/tutorials/K230_GPU_Practice.md) | K230 GPU in action - VGLite paints cool graphics|
| [K230_GUI_Practice_LVGL_Porting_Tutorial.md](en/02_applications/tutorials/K230_GUI_Practice_LVGL_Porting_Tutorial.md) | K230 GUI in Action - LVGL Porting Tutorial|
| [K230_RVV_In_Action.md](en/02_applications/tutorials/K230_RVV_In_Action.md) | K230 RVV in action|
| [K230_RVV_optimization_performance_description.md](en/02_applications/tutorials/K230_RVV_optimization_performance_description.md) | K230 RVV optimization performance description|
| [K230_USB_Application_Practice_UVC_Transmission_YUV_and_Encoding_Stream.md](en/02_applications/tutorials/K230_USB_Application_Practice_UVC_Transmission_YUV_and_Encoding_Stream.md) | K230 USB Application Practice - UVC Transmission YUV and Encoding Stream|
| [K230_Graphics_Practice-Boot_Video_and_Boot_Logo.md](en/02_applications/tutorials/K230_Graphics_Practice-Boot_Video_and_Boot_Logo.md) | K230 Graphics Practice - Boot Video and Boot Logo|
| [K230_Image_Capture_Practice_How_to_support_a_new_sensor.md](en/02_applications/tutorials/K230_Image_Capture_Practice_How_to_support_a_new_sensor.md) | K230 Image Capture Practice How to support a new sensor|
| [K230_Audio_Capture_Playback_Codec_In_Action.md](en/02_applications/tutorials/K230_Audio_Capture_Playback_Codec_In_Action.md) | K230 Audio in Action - Audio capture, playback, codec|
| [K230_Coding_In_Action_rtsp_server_build_and_push_stream.md](en/02_applications/tutorials/K230_Coding_In_Action_rtsp_server_build_and_push_stream.md) | K230 Coding in Action - rtsp sever build and stream|
| [K230_AI_in_Action_HHB_Neural_Network_Model_Deployment_Tool.md](en/02_applications/tutorials/K230_AI_in_Action_HHB_Neural_Network_Model_Deployment_Tool.md) | K230 AI in Action - HHB Neural Network Model Deployment Tool|
| [K230_Memory_Usage_Analysis_Guide.md](en/02_applications/tutorials/K230_Memory_Usage_Analysis_Guide.md) | K230 Memory Analysis Guide|
| [K230_Memory_Optimization_Guide.md](en/02_applications/tutorials/K230_Memory_Optimization_Guide.md) | K230 Memory Optimization Guide|
| [K230_Boot_Optimization_Guide.md](en/02_applications/tutorials/K230_Boot_Optimization_Guide.md) | K230 Boot Optimization Guide|

### K230 SDK for business applications

| Document name | Summary of the documentation |
| --- | --- |
| [K230_Scene_Practice_Smart_Door_Lock_POC.md](en/02_applications/business_poc/K230_Scene_Practice_Smart_Door_Lock_POC.md) | K230 Scene Practice Smart Door Lock|
| [K230_Scene_Practice_Smart_Door_Lock_POC_OV9286.md](en/02_applications/business_poc/K230_Scene_Practice_Smart_Door_Lock_POC_OV9286.md) | K230 Scene Practice Smart Door Lock POC_OV9286|
| [K230_Scene_Pratice-Peephole_POC.md](en/02_applications/business_poc/K230_Scene_Pratice-Peephole_POC.md) |K230 Scene Pratice Peephole POC|

### K230 SDK AI tutorial

| Document name | Summary of the documentation |
| --- | --- |
| [K230_AI_Demo_Introduction.md](en/02_applications/ai_demos/K230_AI_Demo_Introduction.md) | K230 AI Demo Introduction|
| [K230_Fancy_Poc_Introduction.md](en/02_applications/fancy_poc/K230_Fancy_Poc_Introduction.md) | K230 Fancy Poc Introduction |

## Additional documentation for the K230 SDK

| Document name | Summary of the documentation |
| --- | --- |
| [K230_FAQ.md](en/03_other/K230_FAQ.md) | K230 SDK FAQ|
| [K230_SDK_Release_Notes.md](en/03_other/K230_SDK_Release_Notes.md) | K230 SDK Release Notes|
| [K230_AI_demo_FAQ_C++.md](en/03_other/K230_AI_demo_FAQ_C++.md) | K230_AI_demo_FAQ |
| [K230_nncase_FAQ.md](en/03_other/K230_nncase_FAQ.md) | K230_nncase_FAQ |
| [K230_AI_Cube_FAQ.md](en/03_other/K230_AI_Cube_FAQ.md) | K230_AI_Cube_FAQ |

## Contribution guidelines

IF YOU ARE INTERESTED IN THIS PROJECT, WOULD LIKE TO GIVE FEEDBACK OR SUBMIT DOCUMENTATION, PLEASE REFER TO [CONTRIBUTING](.github/CONTRIBUTING.md)

## Contact us

Canaan Inc.

Website:[www.kendryte.com](https://www.kendryte.com/)

Business inquiries:[salesAI@canaan-creative.com](mailto:salesAI@canaan-creative.com)