k230 canmv docs release v0.6

kendryte · Apr 29, 2024 · 0127f40 · 0127f40
1 parent 004a18d
commit 0127f40
Show file tree

Hide file tree

Showing 11 changed files with 1,313 additions and 4 deletions.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -174,7 +174,7 @@ build web docs:
 
 deploy production:
   stage: deploy
-  image: ai.b-bug.org:5000/python:web-docs-v2
+  image: ai.b-bug.org:5000/huangziyi/deploy:v1
   dependencies:
     - build web docs
   rules:
@@ -186,7 +186,7 @@ deploy 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/
+    - scp -P $AWS_PORT -C -r _build/* $AWS/data/webapp/k230_canmv/
 
 
 # sync dev branch to main branch

diff --git a/zh/CanMV-K230_SDK_nncase版本对应关系.md b/zh/CanMV-K230_SDK_nncase版本对应关系.md
@@ -47,3 +47,5 @@
 | 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       |  -    |
+| 0.5.0        | 1.4.0         | 2.8.0       |  -    |
+| 0.6.0        | 1.5.0         | 2.8.1       |  -    |
diff --git a/zh/CanMV-K230版本说明.md b/zh/CanMV-K230版本说明.md
@@ -51,6 +51,7 @@
 | K230 CanMV | V0.3.0 | 2023-12-28 |
 | K230 CanMV | V0.4.0 | 2024-01-26 |
 | K230 CanMV | V0.5.0 | 2024-03-15 |
+| K230 CanMV | V0.6.0 | 2024-04-30 |
 
 ## 2. 支持的硬件
 
@@ -89,6 +90,9 @@ K230平台支持CanMV-K230等主板
 | 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 | |
+| 24 | V0.6.0 | sensor | 增加sensor类 | |
+| 25 | V0.6.0 | lcd | 增加lcd类 | |
+| 25 | V0.6.0 | HDMI | 添加720P、480P分辨率 | |
 
 ### 4.2 AI Demo
 

diff --git a/zh/api/image_video.rst b/zh/api/image_video.rst
@@ -5,7 +5,9 @@
 
    mpp/K230_CanMV_Audio模块API手册.md
    mpp/K230_CanMV_Camera模块API手册.md
+   mpp/K230_CanMV_Sensor模块API手册.md
    mpp/K230_CanMV_Display模块API手册.md
+   mpp/K230_CanMV_Lcd模块API手册.md
    mpp/K230_CanMV_Media模块API手册.md
    mpp/K230_CanMV_MP4模块API手册.md
    mpp/K230_CanMV_VDEC模块API手册.md

diff --git a/zh/api/machine/K230_CanMV_TOUCH模块API手册.md b/zh/api/machine/K230_CanMV_TOUCH模块API手册.md
@@ -0,0 +1,126 @@
+# K230 CanMV TOUCH 模块API手册
+
+![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]
+
+## 前言
+
+### 概述
+
+本文档主要介绍machine模块下的TOUCH类API。
+
+### 读者对象
+
+本文档（本指南）主要适用于以下人员：
+
+- 技术支持工程师
+- 软件开发工程师
+
+### 缩略词定义
+
+| 简称 | 说明 |
+| ---- | ---- |
+| | |
+
+### 修订记录
+
+| 文档版本号 | 修改说明 | 修改者     | 日期       |
+| ---------- | -------- | ---------- | ---------- |
+| V1.0       | 初版     | 软件部      | 2024-04-20 |
+
+## 1. 概述
+
+触摸模块基于rtt的触摸框架，支持单点多点电容触摸屏、电阻触摸屏。
+
+## 2. API描述
+
+TOUCH类位于machine模块下
+
+### 示例
+
+```python
+from machine import TOUCH
+# 实例化TOUCH设备0
+tp = TOUCH(0)
+# 获取TOUCH数据
+p = tp.read()
+print(p)
+# print(p[0].x)
+# print(p[0].y)
+# print(p[0].event)
+```
+
+### 构造函数
+
+```python
+touch = TOUCH(index)
+```
+
+【参数】
+
+- index: TOUCH设备号，取值:[0,9]，实际取决于有几个触摸设备
+
+### read
+
+```python
+TOUCH.read([count])
+```
+
+获取触摸数据
+
+【参数】
+
+- count: 最多读取多少个触摸点，取值:[0:10]，默认为0，读取全部触摸点
+
+【返回值】
+
+返回触摸点数据，类型为tuple，([tp[,tp...]])，每个tp都是一个touch_info类
+
+### deinit
+
+```python
+TOUCH.deinit()
+```
+
+释放TOUCH资源
+
+【参数】
+
+无
+
+【返回值】
+
+无
+
+## 3. TOUCH_INFO 类
+
+TOUCH_INFO类存储了触摸点的信息，用户可通过相关属性(只读)去访问
+
+- event，事件码
+- track_id，触点id，用于多点触摸
+- width，触点width
+- x，触点x坐标
+- y，触点y坐标
+- timestamp，触点时间辍
diff --git a/zh/api/mpp/K230_CanMV_Camera模块API手册.md b/zh/api/mpp/K230_CanMV_Camera模块API手册.md
@@ -54,6 +54,8 @@
 
 ## 1. 概述
 
+`该模块将在V1.0版本后废弃，请使用sensor模块`
+
         K230 CanMV平台Camera模块负责图像采集处理任务。本模块提供了一系列Highe Levl的API，应用开发者可以不用关注底层硬件细节，仅通过该模块提供的API即可获取不同格式和尺寸的图像。
 
         K230 CanMV平台Camera模块包括三个独立的能力完全相同的camera设备，每个camera设备均可独立完成图像数据采集捕获处理，并可以同时输出3路图像数据。如下图所示：

diff --git a/zh/api/mpp/K230_CanMV_Display模块API手册.md b/zh/api/mpp/K230_CanMV_Display模块API手册.md
@@ -53,6 +53,8 @@
 
 ## 1. 概述
 
+`该模块将在V1.0版本后废弃，请使用lcd模块`
+
 此文档介绍CanMV Display模块，用以指导开发人员如何调用Micro Python API实现图像输出功能。
 
 ## 2. API描述
@@ -297,8 +299,14 @@ def deinit()
 
 | 成员名称  | 描述                            |
 |---------|---------------------------------|
-| HX8377_1080X1920_30FPS | VO和DSI模块输出1080X1920_30FPS时序到LCD |
-| LT9611_1920X1080_30FPS | VO和DSI模块输出1920X1080_30FPS时序到HDMI |
+| HX8377_1080X1920_30FPS | VO和DSI模块输出1080X1920 30FPS时序到LCD |
+| ST7701_V1_MIPI_2LAN_480X800_30FPS | VO和DSI模块输出480x800 30FPS时序到LCD |
+| LT9611_1920X1080_30FPS | VO和DSI模块输出1920X1080 30FPS时序到HDMI |
+| LT9611_MIPI_4LAN_1920X1080_60FPS | VO和DSI模块输出1920X1080 60FPS时序到HDMI |
+| LT9611_MIPI_4LAN_1280X720_60FPS | VO和DSI模块输出1280x720 60FPS时序到HDMI |
+| LT9611_MIPI_4LAN_1280X720_50FPS | VO和DSI模块输出1280x720 50FPS时序到HDMI |
+| LT9611_MIPI_4LAN_1280X720_30FPS | VO和DSI模块输出1280x720 30FPS时序到HDMI |
+| LT9611_MIPI_4LAN_640X480_60FPS | VO和DSI模块输出640x480 30FPS时序到HDMI |
 
 【注意事项】