diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 741efeb..09ba66d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,7 +2,7 @@ 首先感谢您参与本开源项目，在您提交issue和pull request之前请认真阅读本指南 -在提交pull request时一定要关联相应的issue，如果没有相应issue，请先创建issue +在提交pull request时一定要关联相应的issue，如果没有相应issue，请先创建issue 关于pull request关联issue，GitHub支持自动和手动关联，具体操作请参考[Link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) issue和pull request填写时都支持Markdown，关于GitHub的Markdown语法和扩展请参考[GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github) @@ -29,6 +29,6 @@ issue和pull request填写时都支持Markdown，关于GitHub的Markdown语法 ## Markdown检查 -本项目会对上传的Markdown文件进行格式化检查和内部引用链接检查，如果不符合格式要求或存在不能访问的链接，CI会报异常，导致PR不能被merge，因此提交PR前请确保您已在本地进行过检查。 -格式检查工具使用的是`markdownlint`，规则配置文件是[markdownlint.json](../.markdownlint.json)。本地可使用`vscode`安装`markdownlint`来进行在线检查和格式化。 -您也可以在提交PR之前，先push到您GitHub仓库的`check`分支进行CI检查，避免重复修改PR。 +本项目会对上传的Markdown文件进行格式化检查和内部引用链接检查，如果不符合格式要求或存在不能访问的链接，CI会报异常，导致PR不能被merge，因此提交PR前请确保您已在本地进行过检查 +格式检查工具使用的是`markdownlint`，规则配置文件是[markdownlint.json](../.markdownlint.json)。本地可使用`vscode`安装`markdownlint`来进行在线检查和格式化 +您也可以在提交PR之前，先push到您GitHub仓库的`check`分支进行CI检查，避免重复修改PR diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a2418ce --- /dev/null +++ b/LICENSE @@ -0,0 +1,25 @@ +Copyright (c) 2022, Canaan Bright Sight Co., Ltd + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright +notice, this list of conditions and the following disclaimer in the +documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND +CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/README.md b/README.md index d7908d9..e26e188 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -![](https://github.com/wycwyhwyq/k510_docs/actions/workflows/markdown_check.yml/badge.svg) +[![Gitee repository](https://img.shields.io/badge/gitee-repository-blue?logo=gitee&style=plastic)](https://gitee.com/kendryte/k510_docs) +[![GitHub release](https://img.shields.io/github/v/release/kendryte/k510_docs?color=brightgreen&display_name=tag&logo=github&style=plastic)](https://github.com/kendryte/k510_docs/releases) # 文档概述 @@ -28,6 +29,6 @@ k510 相关文档如下： ## 联系我们 -北京嘉楠捷思信息技术有限公司 -网址：[canaan-creative.com](https://canaan-creative.com/) +北京嘉楠捷思信息技术有限公司 +网址：[canaan-creative.com](https://canaan-creative.com/) 商务垂询：[salesAI@canaan-creative.com](mailto:salesAI@canaan-creative.com) diff --git a/zh/K510_Multimedia_Developer_Guides.md b/zh/K510_Multimedia_Developer_Guides.md index 402e9da..0909b22 100644 --- a/zh/K510_Multimedia_Developer_Guides.md +++ b/zh/K510_Multimedia_Developer_Guides.md @@ -739,7 +739,7 @@ rtmp推流前需要部署rtmp服务器，将数据流推送到服务器上。支 ffmpeg运行命令示例: ```shell -ffmpeg -f v4l2 -s 1920x1080 -conf "video_sample.conf" -isp 1 -buf_type 2 -r 30 -i /dev/video3 -vcodec libk510_h264 -an -f flv rtmp://10.100.232.11/live/1 +ffmpeg -f v4l2 -s 1920x1080 -conf "video_sample.conf" -isp 1 -buf_type 2 -r 30 -i /dev/video3 -vcodec libk510_h264 -f flv rtmp://10.100.232.11/live/1 ``` - `rtmp://10.100.232.11/live/1`为向rtmp服务器推流的url地址 diff --git a/zh/K510_SDK_Application_Guides.md b/zh/K510_SDK_Application_Guides.md index f7193a6..564b026 100644 --- a/zh/K510_SDK_Application_Guides.md +++ b/zh/K510_SDK_Application_Guides.md @@ -548,7 +548,7 @@ v4l2_drm demo展示了摄像头输入和显示的功能。 ```shell cd /app/mediactl_lib -./v4l2_drm.out -f video_drm_1080x1920.conf +./v4l2_drm.out -f video_drm_1080x1920.conf -e 1 或者 ./v4l2_drm.out -f video_drm_1920x1080.conf ``` diff --git a/zh/K510_V4l2_Developer_Guides.md b/zh/K510_V4l2_Developer_Guides.md index 015be2d..6a4f1ab 100644 --- a/zh/K510_V4l2_Developer_Guides.md +++ b/zh/K510_V4l2_Developer_Guides.md @@ -282,12 +282,13 @@ isp_modules: 程序放在`/app/mediactl_lib`目录下： -- `v4l2_drm.out`：v4l2和drm联动case，添加了-f 修改输入配置文件的名字。可以使用-h 查看帮助。 +- `v4l2_drm.out`：v4l2和drm联动case，添加了-f 修改输入配置文件的名字, -e 打开isp ae 功能。可以使用-h 查看帮助。 运行v4l2_drm.out +- -e：0 关闭所有ae，1打开 f-2k ae，2打开r-2k ae，3打开所有ae。默认情况下可以不指定-e 就是关闭所有ae。 - 该demo 需要video配置文件及对应的sensor配置文件在当前目录下。 - 该demo通过更改配置文件，可以演示单双摄。 -- 该demo演示单摄全屏：./v4l2_drm.out -f video_drm_1080x1920.conf +- 该demo演示单摄全屏：./v4l2_drm.out -e 1 -f video_drm_1080x1920.conf - 该demo演示双摄：./v4l2_drm.out -f video_drm_1920x1080.conf - 该demo必须保证video_drm_1920x1080.conf，imx219_0.conf及imx219_1.conf三个配置文件存在