README.md
1@page ucamera ucamera
2
3**[更正文档](https://gitee.com/alios-things/ucamera/edit/master/README.md)**      **[贡献说明](https://help.aliyun.com/document_detail/302301.html)**
4
5# 概述
6ucamera组件是摄像头图像数据处理中间框架，支持不同类型摄像头数据接入，目前已接入wifi摄像头，在使用该组件时，需要使用netmgr网络组件连接网络。
7
8## 版权信息
9> Apache 2.0 License
10
11## 目录结构
12```tree
13├── include
14│ ├── ucamera_common.h # 对外头文件
15│ ├── ucamera_device.h # 摄像头device相关头文件定义
16│ ├── ucamera_service.h # 摄像头service相关头文件定义
17│ └── device
18│ └── wifi
19│ ├── wifi_camera.h # wifi摄像头device注册函数头文件
20│ └── dechunk.h
21├── package.yaml # 编译配置文件
22├── src
23│ ├── ucamera_device.c # 摄像头设备相关函数实现
24│ ├── ucamera_service.c # 摄像头服务相关函数实现
25│ └── device
26│ └── wifi
27│ ├── wifi_camera.c # wifi摄像头device注册函数实现
28│ └── dechunk
29│ └── dechunk.c # http数据解析代码实现
30└── example
31 └── ucamera_example.c # 测试用例
32```
33
34## 依赖组件
35
36* http
37
38# 常用配置
39```yaml
40def_config: # 组件的可配置项
41 CONFIG_WIFI_CAMERA_ENABLE: 1 # 使能WiFi摄像头
42```
43
44# API说明
45- 参考 [ucamera_aos_api](https://g.alicdn.com/alios-things-3.3/doc/group__ucamera__aos__api.html)
46
47
48# 使用示例
49
50组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
51待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
52
53## 步骤1 创建或打开工程
54
55**打开已有工程**
56
57如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
58
59**创建新的工程**
60
61组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
62
63## 步骤2 添加组件
64
65案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
66
67```yaml
68
69depends:
70 - ucamera: master # helloworld_demo中引入ucamera组件
71 - netmgr: master # helloworld_demo中引入netmgr组件
72
73def_config:
74 CLI_IOBOX_ENABLE: 1 # 使能文件系统测试命令，例如ls, ll, mkdir, touch, echo等
75
76```
77
78## 步骤3 下载组件
79
80在已安装了 的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
81
82```shell
83
84aos install ucamera
85
86```
87
88上述命令执行成功后，组件源码则被下载到了./components/ucamera路径中。
89
90## 步骤4 添加示例
91
92在ucamera组件的package.yaml中添加[example示例代码](https://gitee.com/alios-things/ucamera/tree/master/example)：
93
94```yaml
95source_file:
96 - "example/ucamera_example.c" # add ucamera_example.c
97
98```
99### WiFi摄像头安装
100ucamera测试依赖WiFi摄像头，本案例测试使用ESP32-EYE进行测试。
101ESP32-EYE购买链接: [https://detail.tmall.com/item.htm?spm=a230r.1.14.1.150d6a6ftZ6h4K&id=611790371635&ns=1&abbucket=3](https://detail.tmall.com/item.htm?spm=a230r.1.14.1.150d6a6ftZ6h4K&id=611790371635&ns=1&abbucket=3)
102
103#### 1. 代码下载
104```bash
105$git clone --recursive https://github.com/espressif/esp-who.git
106```
107
108#### 2. ESP-IDF安装
109不同的操作系统安装的步骤也有所差异，请参考官网文档进行安装：
110[https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/get-started/index.html#get-started-set-up-env](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/get-started/index.html#get-started-set-up-env)
111
112#### 3. 环境变量设置
113这里以Macbook为例进行环境变量设置：
114
115```shell
116$ cd ~/esp/esp-idf
117$ ./install.sh
118$ . ./export.sh
119```
120
121注意：
122每次重启终端后都需要执行该步骤，否则找不到idf.py命令，或者可以加入到根目录.bashrc中不用每次再输入该命令。
123
124#### 4. ESP32 EYE网络设置
125**SoftAP模式**
126
127默认启动后ESP32 EYE已经开启了SSID为ESP32-Camera的AP，可以使用电脑连接该AP。
128
129也可以通过修改sdkconfig来改变ssid/password、station连接数量、AP信道、服务器IP等，然后重新进行编译：
130#### 
131
132#### 5. 分辨率配置
133> 为了减少传输带宽占用，摄像头采集的画面设置为QVGA(分辨率320x240)，esp-who/examples/single_chip/camera_web_server/main/app_httpd.c中添加代码：
134```bash
135
136static esp_err_t capture_handler(httpd_req_t *req)
137{
138 camera_fb_t *fb = NULL;
139 esp_err_t res = ESP_OK;
140 int64_t fr_start = esp_timer_get_time();
141
142 /*set resolution*/
143 sensor_t *sensor = esp_camera_sensor_get();
144 sensor->set_framesize(sensor, (framesize_t)5);/*QVGA: 3220 x 240*/
145 if (res == 0) {
146 app_mdns_update_framesize(5);/*QVGA*/
147 }
148 ......
149}
150```
151
152#### 6. 代码编译
153使用camera_web_server来建立一个web服务器，该Demo中摄像头采集的数据以jpeg格式提供，并且提供了以http请求的方式获取jpeg图像数据。编译需要进入到Demo的目录中：
154```shell
155$cd examples/single_chip/camera_web_server/
156$idf.py build
157```
158#### 7. 代码烧录
159```bash
160$idf.py -p [port] flash
161```
162例如：
163idf.py -p /dev/cu.SLAB_USBtoUART flash
164
165#### 8. Log监视器
166查看串口log，进入到camera_web_server所在目录执行。
167```bash
168$idf.py -p [port] monitor
169```
170例如：
171idf.py -p /dev/cu.SLAB_USBtoUART monitor
172
173#### 9. 检查摄像头画面采集
174为了确认ESP32-EYE摄像头是否正常，电脑连接ESP32-EYE的WiFi网络ESP32-Camera，先通过电脑方式查看web界面http://192.168.4.1:80/capture：
175抓取当前画面http://192.168.4.1:80/capture：
176
177
178### 配置WiFi摄像头IP
179在ucamera/package.yaml中配置WiFi摄像头URL：
180```yaml
181 WIFICAMERA_URL: "http://192.168.4.1:80/capture"
182```
183
184## 步骤5 编译固件
185
186在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
187
188## 步骤6 烧录固件
189
190### 文件系统烧录
191本组件示例在抓取图像后保存图像到littlefs文件系统，需烧录littlefs文件系统，请将hardware/chip/haas1000/package.yaml文件中以下代码段的注释打开：
192
193```yaml
194 program_data_files:
195 - filename: release/write_flash_tool/ota_bin/littlefs.bin
196 address: 0xB32000
197```
198
199上述步骤执行后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
200
201## 步骤7 打开串口
202
203固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
204
205当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
206
207## 步骤8 测试示例
208
209测试步骤：
210```shell
211$ ucamera init # 初始化ucamera
212$ netmgr -t wifi -c ESP32-Camera # 连接WiFi摄像头
213$ ucamera -t wifi # 获取一帧画面
214$ ls /data # 查看是否有capture.jpg文件生成
215```
216
217**CLI命令行输入：**
218```shell
219ucamera init # 在执行下面的测试命令前，该命令需要优先执行，仅需执行一次即可。
220```
221
222> CLI关键日志：
223```shell
224ucamera comp init successfully!
225```
226
227**CLI命令行输入：**
228```shell
229ucamera -t wifi
230```
231
232> CLI关键日志：
233```shell
234ucamera get frame OK! # 测试结果正常确认(说明从wifi摄像头获取到图像数据)
235save image to /data/capture.jpg successfully!
236```
237
238**CLI命令行输入：**
239```shell
240ls /data
241```
242
243> CLI关键日志：
244```shell
245capture.jpg # 生成的文件
246```
247
248# FAQ
249NA
250
){kind=link}
){kind=link}
){kind=link}
