Skip to content

Commit

Permalink
k230 canmv docs release v0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
wuwentao committed Mar 15, 2024
1 parent 806f3f2 commit 004a18d
Show file tree
Hide file tree
Showing 50 changed files with 1,228 additions and 1,181 deletions.
24 changes: 21 additions & 3 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ markdownlint:
- echo "---push to github---"
- git push --atomic --tags -u -f github main || git push --atomic --tags -u -f github main || git push --atomic --tags -u -f github main

build-web-docs:
build web docs:
stage: build
rules:
- if: $CI_PIPELINE_SOURCE == "push" && ($CI_COMMIT_BRANCH == "dev" || $CI_COMMIT_BRANCH == "main")
Expand All @@ -168,8 +168,26 @@ build-web-docs:
- make mhtml
- rm -rf /data1/k230/k230_canmv_docs/*
- cp -r _build/* /data1/k230/k230_canmv_docs
- ssh -p 52522 [email protected] "rm -rf /data/webapp/k230_canmv"
- scp -P 52522 -O -r _build [email protected]:/data/webapp/k230_canmv
artifacts:
paths:
- _build

deploy production:
stage: deploy
image: ai.b-bug.org:5000/python:web-docs-v2
dependencies:
- build web docs
rules:
- if: $CI_PIPELINE_SOURCE == "push" && ($CI_COMMIT_BRANCH == "dev" || $CI_COMMIT_BRANCH == "main")
tags:
- k230
environment:
name: production
url: https://developer.canaan-creative.com/k230_canmv/dev/index.html
retry: 2
script:
- scp -P 52522 -O -C -r _build/* [email protected]:/data/webapp/k230_canmv/


# sync dev branch to main branch
dev_to_main:
Expand Down
1 change: 1 addition & 0 deletions _static/topbar.css
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ nav.navbar a {
padding: 10px !important;
color: #fff;
text-align: start !important;
text-wrap: wrap !important;
}

.document-select:hover {
Expand Down
4 changes: 3 additions & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,6 @@ Welcome to K230 CanMV's documentation!
zh/userguide/userguide.rst
zh/example/example.rst
zh/api/api.rst
zh/CanMV-K230常见问题解答_MicroPython.md
zh/CanMV-K230常见问题解答_MicroPython.md
zh/CanMV-K230版本说明.md
zh/CanMV-K230_SDK_nncase版本对应关系.md
49 changes: 49 additions & 0 deletions zh/CanMV-K230_SDK_nncase版本对应关系.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# CanMV-K230_SDK_nncase版本对应关系

![cover](images/canaan-cover.png)

版权所有©2023北京嘉楠捷思信息技术有限公司

<div style="page-break-after:always"></div>

## 免责声明

您购买的产品、服务或特性等应受北京嘉楠捷思信息技术有限公司(“本公司”,下同)及其关联公司的商业合同和条款的约束,本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定,本公司不对本文档的任何陈述、信息、内容的正确性、可靠性、完整性、适销性、符合特定目的和不侵权提供任何明示或默示的声明或保证。除非另有约定,本文档仅作为使用指导参考。

由于产品版本升级或其他原因,本文档内容将可能在未经任何通知的情况下,不定期进行更新或修改。

## 商标声明

![logo](images/logo.png)、“嘉楠”和其他嘉楠商标均为北京嘉楠捷思信息技术有限公司及其关联公司的商标。本文档可能提及的其他所有商标或注册商标,由各自的所有人拥有。

**版权所有 © 2023北京嘉楠捷思信息技术有限公司。保留一切权利。**
非经本公司书面许可,任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部,并不得以任何形式传播。

<div style="page-break-after:always"></div>

## 目录

[TOC]

## 前言

### 概述

本文档主要介绍了CanMV(micropython)、K230 SDK 和NNCASE之间的版本关系。

### 读者对象

本文档(本指南)主要适用于以下人员:

- 技术支持工程师
- 软件开发工程师

## Canmv(micropython)、K230 SDK、nncase版本对应关系

在进行AI开发时,k230_sdk和nncase版本对应关系如下表,编译镜像和使用nncase转换kmodel时请注意版本对应关系。

| Canmv(micropython) 版本| K230 SDK 版本 | nncase 版本 | 备注 |
| -------------| ------------- | ----------- | ---- |
| 0.2.0 | 1.1.0 | 2.4.0 | - |
| 0.3.0 | 1.1.0 | 2.4.0 | - |
| 0.4.0 | 1.3.0 | 2.7.0 | - |
12 changes: 11 additions & 1 deletion zh/CanMV-K230常见问题解答_MicroPython.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,20 @@
1、请确定开发板两个USB口都与电脑连接。
![CanMV-K230-poweron](images/CanMV-K230-poweron.png)

2、查看电脑的设备管理器
2、TF卡烧录的固件是“CanMV-K230_micropython”开头的固件,烧录其它的固件也无法连接。

3、查看电脑的设备管理器
![CanMV-K230-micropython-serial](images/CanMV-K230-micropython-serial.png)

是否有"USB串行设备(COMxx)的设备,如果没有请重新插拔USB。如果还没有,则请更换USB线。

### 2.2 虚拟U盘在哪?如何使用?

V0.5版本后的Canmv镜像支持虚拟U盘,即将板子的TF虚拟为U盘,可以像U盘一样对TF进行操作。系统正常启动后会在“我的电脑”或“此电脑”,在设备和驱动器中会出现“CanMV"设备。
![virtual_Udisk](images/virtual_Udisk.png)

将其做为普通的U盘即可。默认里面会存储micropython的示例,建议使用这里面的示例,可以保证镜像与示例版本一致。

## 3.nncase类问题解答

## 4.AI demo类问题解答
93 changes: 53 additions & 40 deletions zh/CanMV-K230快速入门指南.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,43 +58,25 @@ CanMV-K230开发板默认套件包含以下物品:

4、Type-C数据线

## 3 USB连接
## 3. 固件获取及烧录

使用Type-C线连接CanMV-K230如下图的位置,线另一端连接至电脑
### 3.1 固件获取

![CanMV-K230-usbotg](images/CanMV-K230-usbotg.png)

### 3.2 Windows

查看设备管理器

![CanMV-K230-micropython-serial](images/CanMV-K230-micropython-serial.png)

- `USB-Enhanced-SERIAL-A CH342(COM80)`为小核linux调试串口
- `USB-Enhanced-SERIAL-B CH342(COM81)`为大核rt-smart调试串口
- `USB串行设备(COM75)`为micropython REPL串口 是CanMV-IDE需要连接的串口。如果没有这个设备,请确定两个USB口都与电脑连接。

### 3.2.2 linux

Linux串口显示如下:

- `/dev/ttyACM0`为小核linux调试串口
- `/dev/ttyACM1`为大核rt-smart调试串口
- `/dev/ttyACM2`为micropython REPL串口 是CanMV-IDE需要连接的串口。如果没有这个设备,请确定两个USB口都与电脑连接。
CanMV-K230 固件下载地址: <https://github.com/kendryte/k230_canmv/releases> 或者 <https://developer.canaan-creative.com/resource>

## 4 固件获取及烧录
CanMV源码下载地址如下:

### 4.1 固件获取
`https://github.com/kendryte/k230_canmv`

CanMV-K230 固件下载地址: <https://github.com/kendryte/k230_canmv/releases> 或者 <https://developer.canaan-creative.com/resource>
`https://gitee.com/kendryte/k230_canmv`

请下载“CanMV-K230_micropython”开头的gz压缩包,解压得到sysimage-sdcard.img文件,即为CanMV-K230的固件。

### 4.2 固件烧录
### 3.2 固件烧录

将固件通过电脑烧写至TF卡中。

#### 4.2.1 Linux下烧录
#### 3.2.1 Linux下烧录

在TF卡插到宿主机之前,输入:

Expand All @@ -112,30 +94,52 @@ CanMV-K230 固件下载地址: <https://github.com/kendryte/k230_canmv/release

`sudo dd if=sysimage-sdcard.img of=/dev/sdc bs=1M oflag=sync`

#### 4.2.2 Windows下烧录
#### 3.2.2 Windows下烧录

Windows下可通过rufus工具对TF卡进行烧录(rufus工具下载地址 `http://rufus.ie/downloads/`)。

Windows下可通过balena Etcher工具对TF卡进行烧录(balena Etcher工具下载地址 `https://www.balena.io/etcher`
1)将TF卡插入PC,然后启动rufus工具,点击工具界面的"选择”按钮,选择待烧写的固件

1)将TF卡插入PC,然后启动balena Etcher工具,点击工具界面的"Flash from file”按钮,选择待烧写的固件。
![rufus-flash-from-file](images/rufus_select.png)

![balena-Etcher-flash-from-file](images/balena-Etcher-flash-from-file.jpg)
2)点击“开始”按钮开始烧写,烧写过程有进度条展示,烧写结束后会提示“准备就绪”。

2)点击工具界面的“Select target”按钮,选择目标sdcard卡。
![rufus-flash](images/rufus_start.png)
![rufus-sure](images/rufus_sure.png)
![rufus-warning](images/rufus_warning.png)
![rufus-finish](images/rufus_finish.png)

![balena-Etcher-select-target](images/balena-Etcher-select-target.jpg)
## 4. USB连接

3)点击“Flash”按钮开始烧写,烧写过程有进度条展示,烧写结束后会提示Flash Finish
使用Type-C线连接CanMV-K230如下图的位置,线另一端连接至电脑。这时请注意把第3步烧录好的TF卡插到板子上

![balena-Etcher-flash](images/balena-Etcher-flash.jpg)
![balena-Etcher-finish](images/balena-Etcher-finish.jpg)
![CanMV-K230-usbotg](images/CanMV-K230-usbotg.png)

### 4.1 Windows

查看设备管理器

![CanMV-K230-micropython-serial](images/CanMV-K230-micropython-serial.png)

- `USB-Enhanced-SERIAL-A CH342(COM80)`为小核linux调试串口
- `USB-Enhanced-SERIAL-B CH342(COM81)`为大核rt-smart调试串口
- `USB串行设备(COM75)`为micropython REPL串口 是CanMV-IDE需要连接的串口。如果没有这个设备,请确定两个USB口都与电脑连接,TF卡烧录的固件是否为“CanMV-K230_micropython”开头的固件。

## 5 CanMV-IDE下载
### 4.2 linux

下载地址 : <https://kendryte-download.canaan-creative.com/developer/common/canmv-ide-4.0.5.exe>
Linux串口显示如下:

- `/dev/ttyACM0`为小核linux调试串口
- `/dev/ttyACM1`为大核rt-smart调试串口
- `/dev/ttyACM2`为micropython REPL串口 是CanMV-IDE需要连接的串口。如果没有这个设备,请确定两个USB口都与电脑连接,TF卡烧录的固件是否为“CanMV-K230_micropython”开头的固件。

## 5. CanMV-IDE下载

## 6 启动系统
下载地址 : <https://developer.canaan-creative.com/resource> 下载最新的CanMV IDE

将烧好固件的TF卡插入CanMV-K230 TF卡插槽,Type-C线连接电脑和板端的POWER口,板子即上电,系统开始启动。注意:这里两个USB口都要连接电脑,否则板子无法与IDE联通。
## 6. 启动系统

将烧好固件的TF卡插入CanMV-K230 TF卡插槽,Type-C线连接电脑和板端的POWER口,板子即上电,系统开始启动。(**注意:这里两个USB口都要连接电脑,否则板子无法与IDE联通**)
![CanMV-K230-poweron](images/CanMV-K230-poweron.png)

### 6.1 连接开发板
Expand All @@ -151,10 +155,19 @@ Windows下可通过balena Etcher工具对TF卡进行烧录(balena Etcher工具

### 6.2 运行python

<https://github.com/kendryte/k230_canmv/tree/main/tests> 下载测试程序,通过IDE加载。
<https://github.com/kendryte/k230_canmv/tree/main/tests> 下载测试程序,通过IDE加载。(**V0.5版本之前,0.5版本后建议使用虚拟U盘**)

![canmv_open_py](images/canmv_open_py.png)

点击打开按钮,选择下载的文件,打开。 点击左下角的绿色按钮运行,等待一会儿,显示器会显示sensor采集的图像,该程序为人脸检测程序,可以看到人脸被框出。

(**V0.5版本之后已经支持虚拟U盘功能,可以直接打开TF卡中的示例**)

查看“我的电脑”或“此电脑”,在设备和驱动器中会出现“CanMV"设备。
![virtual_Udisk](images/virtual_Udisk.png)

建议使用虚拟U盘里面的示例。
![open_Udisk](images/open_Udisk.png)
![face_detect_file](images/face_detect_file.png)

![CanMV-K230-aidemo](images/CanMV-K230-aidemo.png)
5 changes: 5 additions & 0 deletions zh/CanMV-K230版本说明.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
| K230 CanMV | V0.2.0 | 2023-11-23 |
| K230 CanMV | V0.3.0 | 2023-12-28 |
| K230 CanMV | V0.4.0 | 2024-01-26 |
| K230 CanMV | V0.5.0 | 2024-03-15 |

## 2. 支持的硬件

Expand Down Expand Up @@ -85,6 +86,9 @@ K230平台支持CanMV-K230等主板
| 18 | V0.4.0 | 升级SDK及nncase | SDK升级至V1.3,nncase升级至v2.7 | |
| 19 | V0.4.0 | lvgl | 支持LVGL | |
| 20 | V0.4.0 | wifi | 支持WIFI | |
| 21 | V0.5.0 | 虚拟U盘 | 支持虚拟U盘的功能 | |
| 22 | V0.5.0 | 外设模块 | 根据micropython官方重新整理fpioa、adc、uart、spi、i2c、rtc、timer模块的API | |
| 23 | V0.5.0 | MCM | 支持多摄像头,添加2sensors,3sensors demo | |

### 4.2 AI Demo

Expand Down Expand Up @@ -117,6 +121,7 @@ K230平台支持CanMV-K230等主板
| 25 | V0.3.0 | 拼图游戏 | 复现数字华容道拼图游戏 | |
| 26 | V0.3.0 | 基于关键点的手势识别 | 基于关键点的手势识别 | |
| 27 | V0.4.0 | 自学习 | 根据图像特征判断类别 | |
| 28 | V0.5.0 | TTS中文 | 中文文字转语音 | |

## 5. 版本的遗留问题及限制说明

Expand Down
33 changes: 4 additions & 29 deletions zh/api/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,7 @@ CanMV API 手册
.. toctree::
:maxdepth: 1

cipher/K230_CanMV_Hashlib模块API手册.md
cipher/K230_CanMV_Ucryptolib模块API手册.md
extmod/K230_CanMV_uctypes模块API手册.md
extmod/K230_CanMV_network模块API手册.md
extmod/K230_CanMV_socket模块API手册.md
machine/K230_CanMV_ADC模块API手册.md
machine/K230_CanMV_FFT模块API手册.md
machine/K230_CanMV_GPIO模块API手册.md
machine/K230_CanMV_I2C模块API手册.md
machine/K230_CanMV_IOMUX_API手册.md
machine/K230_CanMV_PWM模块API手册.md
machine/K230_CanMV_SPI模块API手册.md
machine/K230_CanMV_Timer模块API手册.md
machine/K230_CanMV_WDT模块API手册.md
machine/K230_CanMV_UART模块API手册.md
machine/K230_CanMV_machine模块API手册.md
mpp/K230_CanMV_Audio模块API手册.md
mpp/K230_CanMV_Camera模块API手册.md
mpp/K230_CanMV_Display模块API手册.md
mpp/K230_CanMV_Media模块API手册.md
mpp/K230_CanMV_MP4模块API手册.md
mpp/K230_CanMV_VDEC模块API手册.md
mpp/K230_CanMV_VENC模块API手册.md
mpp/K230_CanMV_播放器模块API手册.md
mpp/K230_CanMV_PM模块API手册.md
nncase_runtime/K230_CanMV_nncase_runtime_API手册.md
openmv/image.md
stdlib/utime.md
lvgl/lvgl.md
python_micropython.rst
machine.rst
image_video.rst
nncase.rst
16 changes: 16 additions & 0 deletions zh/api/image_video.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
图像多媒体
===========
.. toctree::
:maxdepth: 1

mpp/K230_CanMV_Audio模块API手册.md
mpp/K230_CanMV_Camera模块API手册.md
mpp/K230_CanMV_Display模块API手册.md
mpp/K230_CanMV_Media模块API手册.md
mpp/K230_CanMV_MP4模块API手册.md
mpp/K230_CanMV_VDEC模块API手册.md
mpp/K230_CanMV_VENC模块API手册.md
mpp/K230_CanMV_播放器模块API手册.md
mpp/K230_CanMV_PM模块API手册.md
openmv/image.md
lvgl/lvgl.md
19 changes: 19 additions & 0 deletions zh/api/machine.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Micropython特有库
===========
.. toctree::
:maxdepth: 1

extmod/K230_CanMV_uctypes模块API手册.md
extmod/K230_CanMV_network模块API手册.md
extmod/K230_CanMV_socket模块API手册.md
machine/K230_CanMV_ADC模块API手册.md
machine/K230_CanMV_FFT模块API手册.md
machine/K230_CanMV_GPIO模块API手册.md
machine/K230_CanMV_I2C模块API手册.md
machine/K230_CanMV_IOMUX_API手册.md
machine/K230_CanMV_PWM模块API手册.md
machine/K230_CanMV_SPI模块API手册.md
machine/K230_CanMV_Timer模块API手册.md
machine/K230_CanMV_WDT模块API手册.md
machine/K230_CanMV_UART模块API手册.md
machine/K230_CanMV_machine模块API手册.md
Loading

0 comments on commit 004a18d

Please sign in to comment.