Skip to content

Commit

Permalink
k230 canmv docs release v0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
wuwentao committed Dec 28, 2023
1 parent cbc0028 commit d81c668
Show file tree
Hide file tree
Showing 116 changed files with 18,627 additions and 3,749 deletions.
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ build-web-docs:
script:
- git fetch
- git checkout dev
- git pull
- git reset --hard origin/dev
- python3 preprocess.py
- git config --global user.email "[email protected]"
- git config --global user.name "GitLab CI"
Expand Down
13 changes: 4 additions & 9 deletions zh/CanMV-K230快速入门指南.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@ Linux串口显示如下:

### 4.1 固件获取

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

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

### 4.2 固件烧录

Expand Down Expand Up @@ -131,9 +131,7 @@ Windows下可通过balena Etcher工具对TF卡进行烧录(balena Etcher工具

## 5 CanMV-IDE下载

下载地址 : <https://github.com/kendryte/canmv_ide/releases>

用户也可以选择使用 OpenMV IDE : <https://github.com/openmv/openmv-ide/releases>
下载地址 : <https://kendryte-download.canaan-creative.com/developer/common/canmv-ide-4.0.5.exe>

## 6 启动系统

Expand All @@ -145,11 +143,8 @@ Windows下可通过balena Etcher工具对TF卡进行烧录(balena Etcher工具
打开CanMV-IDE,连接开发板如下图所示
![Canmv-link-board](images/Canmv-link-board.png)

点击左下角红框按钮,选择串口,点击OK进行连接。

等待下图框消失
点击左下角红框按钮。

![canmv_waiting](images/canmv_waiting.png)
![canmv_connect_pass](images/canmv_connect_pass.png)

左下角图标变为绿色三角,即为连接成功。
Expand Down
53 changes: 33 additions & 20 deletions zh/CanMV-K230版本说明.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

### 概述

本文档主要介绍了K230 CanMV V0.2.0 版本发布相关的内容,包括当前版本支持的硬件、功能、使用限制等。
本文档主要介绍了K230 CanMV 版本发布相关的内容,包括当前版本支持的硬件、功能、使用限制等。

### 读者对象

Expand All @@ -48,12 +48,14 @@
| 文档版本号 | 修改说明 | 修改者 | 日期 |
| --- | --- | --- | --- |
| V0.2.0 | 初版 | SDK 部 | 2023-11-23 |
| V0.3.0 | 增强micropython稳定性,新增7个AIdemo,支持IDE图像实时回传 | SDK 部 | 2023-12-28 |

## 1. 版本信息

| 所属产品 | 版本号 | 发布日期 |
|----------|--------|----------|
| K230 CanMV | V0.2.0 | 2023-11-23 |
| K230 CanMV | V0.3.0 | 2023-12-28 |

## 2. 支持的硬件

Expand Down Expand Up @@ -82,30 +84,41 @@ K230平台支持CanMV-K230等主板
| 11 | V0.2.0 | spi | 支持SPI通信 | |
| 12 | V0.2.0 | timer | 支持定时器 | |
| 13 | V0.2.0 | wdt | 支持看门狗 | |
| 14 | V0.3.0 | omv | 支持openmv相关的算法 | |
| 15 | V0.3.0 | 网络 | 支持有线网络 | |
| 16 | V0.3.0 | 稳定性 | 提升micropython的稳定性 | |
| 17 | V0.3.0 | IDE显示 | IDE可以实时显示图像 | |

### 4.2 AI Demo

| ID | 支持版本 | 功能概要 | 功能描述 | 备注 |
| --- | --- | --- | --- | --- |
| 1 | V0.2.0 | 人脸检测 | | |
| 2 | V0.2.0 | COCO目标检测 | | |
| 3 | V0.2.0 | yolov8 | | |-seg
| 4 | V0.2.0 | 车牌检测 | | |
| 5 | V0.2.0 | OCR识别 | | |
| 6 | V0.2.0 | 手掌检测 | | |
| 7 | V0.2.0 | 人体检测 | | |
| 8 | V0.2.0 | 人体姿态估计 | | |
| 9 | V0.2.0 | KWS | | |
| 10 | V0.2.0 | 人脸关键点检测 | | |
| 11 | V0.2.0 | 人脸解析 | | |
| 12 | V0.2.0 | 人脸识别 | | |
| 13 | V0.2.0 | OCR检测 | | |
| 14 | V0.2.0 | 车牌识别 | | |
| 15 | V0.2.0 | 人脸姿态角 | | |
| 16 | V0.2.0 | 石头剪刀布 | | |
| 17 | V0.2.0 | 手掌关键点检测 | | |
| 18 | V0.2.0 | 静态手势识别 | | |
| 19 | V0.2.0 | 人脸mesh | | |
| 1 | V0.2.0 | 人脸检测 | 定位人脸 | |
| 2 | V0.2.0 | COCO目标检测 | 定位物体 | |
| 3 | V0.2.0 | yolov8-seg | 分割物体 | |
| 4 | V0.2.0 | 车牌检测 | 定位车牌 | |
| 5 | V0.2.0 | OCR识别 | 识别文字 | |
| 6 | V0.2.0 | 手掌检测 | 定位手掌 | |
| 7 | V0.2.0 | 人体检测 | 定位人体 | |
| 8 | V0.2.0 | 人体姿态估计 | 定位人体关键点 | |
| 9 | V0.2.0 | KWS | 关键词唤醒 | |
| 10 | V0.2.0 | 人脸关键点检测 | 定位人脸106关键点 | |
| 11 | V0.2.0 | 人脸解析 | 人脸不同部位分割 | |
| 12 | V0.2.0 | 人脸识别 | 识别不同人脸 | |
| 13 | V0.2.0 | OCR检测 | 定位文字 | |
| 14 | V0.2.0 | 车牌识别 | 识别车牌内容 | |
| 15 | V0.2.0 | 人脸姿态角 | 推理出人脸旋转角度 | |
| 16 | V0.2.0 | 石头剪刀布 | 剪刀石头布手势游戏 | |
| 17 | V0.2.0 | 手掌关键点检测 | 定位手掌关键点 | |
| 18 | V0.2.0 | 静态手势识别 | 识别手势 | |
| 19 | V0.2.0 | 人脸mesh | 定位3d人脸关键点 | |
| 20 | V0.3.0 | 跌倒检测 | 判断是否摔倒 | |
| 21 | V0.3.0 | 注视估计 | 推理眼镜注视角度 | |
| 22 | V0.3.0 | 动态手势识别 | 识别动态手势 | |
| 23 | V0.3.0 | 单目标跟踪 | 跟踪指定目标 | |
| 24 | V0.3.0 | 隔空放大 | 隔空放大和缩小对应区域图像 | |
| 25 | V0.3.0 | 拼图游戏 | 复现数字华容道拼图游戏 | |
| 26 | V0.3.0 | 基于关键点的手势识别 | 基于关键点的手势识别 | |

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

Expand Down
10 changes: 9 additions & 1 deletion zh/api/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ CanMV API 手册
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
Expand All @@ -15,11 +17,17 @@ CanMV API 手册
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_播放器模块API手册.md
mpp/K230_CanMV_PM模块API手册.md
nncase_runtime/K230_CanMV_nncase_runtime_API手册.md
openmv/image.md
stdlib/utime.md
4 changes: 2 additions & 2 deletions zh/api/cipher/K230_CanMV_Hashlib模块API手册.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# K230 CanMV Hashlib 模块API手册

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

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

Expand All @@ -14,7 +14,7 @@

## 商标声明

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

**版权所有 © 2023北京嘉楠捷思信息技术有限公司。保留一切权利。**
非经本公司书面许可,任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部,并不得以任何形式传播。
Expand Down
4 changes: 2 additions & 2 deletions zh/api/cipher/K230_CanMV_Ucryptolib模块API手册.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# K230 CanMV Ucryptolib 模块API手册

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

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

Expand All @@ -14,7 +14,7 @@

## 商标声明

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

**版权所有 © 2023北京嘉楠捷思信息技术有限公司。保留一切权利。**
非经本公司书面许可,任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部,并不得以任何形式传播。
Expand Down
Binary file removed zh/api/cipher/images/canaan-cover.png
Binary file not shown.
Binary file removed zh/api/cipher/images/canaan-lable.png
Binary file not shown.
Binary file removed zh/api/cipher/images/logo.png
Binary file not shown.
95 changes: 95 additions & 0 deletions zh/api/extmod/K230_CanMV_network模块API手册.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# K230 CanMV network 模块API手册

![cover](C:\Users\wangjianxin\images\canaan-cover.png)

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

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

## 免责声明

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

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

## 商标声明

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

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

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

## 目录

[TOC]

## 前言

### 概述

本文档主要介绍network模块API。

### 读者对象

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

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

### 缩略词定义

| 简称 | 说明 |
| ---- | ---- |

### 修订记录

| 文档版本号 | 修改说明 | 修改者 | 日期 |
| ---------- | -------- | ------ | ---------- |
| V1.0 | 初版 | 软件部 | 2023-11-09 |

## 1. 概述

本模块主要用于配置查看网络参数

## 2. lan api

详见:`https://docs.micropython.org/en/latest/library/network.LAN.html`

This class allows you to control the Ethernet interface. The PHY hardware type is board-specific.

Example usage:

```python
import network
nic = network.LAN(0)
print(nic.ifconfig())

# now use socket as usual
...
```

### 2.1结构体

- *class*network.LAN(*id*, ***, *phy_type=<board_default>*, *phy_addr=<board_default>*, *ref_clk_mode=<board_default>*)[](https://docs.micropython.org/en/latest/library/network.LAN.html#network.LAN)

Create a LAN driver object, initialise the LAN module using the given PHY driver name, and return the LAN object.Arguments are:*id* is the number of the Ethernet port, either 0 or 1.*phy_type* is the name of the PHY driver. For most board the on-board PHY has to be used and is the default. Suitable values are port specific.*phy_addr* specifies the address of the PHY interface. As with *phy_type*, the hardwired value has to be used for most boards and that value is the default.*ref_clk_mode* specifies, whether the data clock is provided by the Ethernet controller or the PYH interface. The default value is the one that matches the board. If set to `LAN.OUT` or `Pin.OUT` or `True`, the clock is driven by the Ethernet controller, if set to `LAN.IN` or `Pin.IN` or `False`, the clock is driven by the PHY interface.For example, with the Seeed Arch Mix board you can use:`nic = LAN(0, phy_type=LAN.PHY_LAN8720, phy_addr=1, ref_clk_mode=Pin.IN)`

### 2.2函数

- LAN.active(**[***state***]**)[](https://docs.micropython.org/en/latest/library/network.LAN.html#network.LAN.active)

With a parameter, it sets the interface active if *state* is true, otherwise it sets it inactive. Without a parameter, it returns the state.

- LAN.isconnected()[](https://docs.micropython.org/en/latest/library/network.LAN.html#network.LAN.isconnected)

Returns `True` if the physical Ethernet link is connected and up. Returns `False` otherwise.

- LAN.ifconfig(**[***(ip*, *subnet*, *gateway*, *dns)***]**)[](https://docs.micropython.org/en/latest/library/network.LAN.html#network.LAN.ifconfig)

Get/set IP address, subnet mask, gateway and DNS.When called with no arguments, this method returns a 4-tuple with the above information.To set the above values, pass a 4-tuple with the required information. For example:`nic.ifconfig(('192.168.0.4', '255.255.255.0', '192.168.0.1', '8.8.8.8'))`

- LAN.config(*config_parameters*)[](https://docs.micropython.org/en/latest/library/network.LAN.html#network.LAN.config)

Sets or gets parameters of the LAN interface. The only parameter that can be retrieved is the MAC address, using:`mac = LAN.config("mac")`The parameters that can be set are:`trace=n` sets trace levels; suitable values are:2: trace TX4: trace RX8: full trace`low_power=bool` sets or clears low power mode, valid values being `False` or `True`.
Loading

0 comments on commit d81c668

Please sign in to comment.