README.md
1@page oss oss
2
3[更正文档](https://gitee.com/alios-things/oss/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6OSS也叫对象存储服务（Object Storage Service），是阿里云提供的一种存储服务，随着智能设备越来越普及，越来越多终端的内容需要存储在云端，例如录音留言，照片、视频、文件日志等等。下面介绍几个OSS中的概念，后面在开发的过程中会用到
7
8- **存储空间（Bucket）**
9存储空间是您用于存储对象（Object）的容器，所有的对象都必须隶属于某个存储空间。存储空间具有各种配置属性，包括地域、访问权限、存储类型等。您可以根据实际需求，创建不同类型的存储空间来存储不同的数据。
10- **对象（Object）**
11对象是OSS存储数据的基本单元，也被称为OSS的文件。对象由元信息（Object Meta）、用户数据（Data）和文件名（Key）组成。对象由存储空间内部唯一的Key来标识。对象元信息是一组键值对，表示了对象的一些属性，例如最后修改时间、大小等信息，同时您也可以在元信息中存储一些自定义的信息。
12- **访问域名（Endpoint）**
13Endpoint表示OSS对外服务的访问域名。OSS以HTTP RESTful API的形式对外提供服务，当访问不同地域的时候，需要不同的域名。通过内网和外网访问同一个地域所需要的域名也是不同的。
14- **访问密钥（AccessKey）**
15AccessKey简称AK，指的是访问身份验证中用到的AccessKey Id和AccessKey Secret。OSS通过使用AccessKey Id和AccessKey Secret对称加密的方法来验证某个请求的发送者身份。AccessKey Id用于标识用户；AccessKey Secret是用户用于加密签名字符串和OSS用来验证签名字符串的密钥，必须保密。
16## 版权信息
17
18
19> Apache license v2.0
20
21
22
23## 目录结构
24
25
26```tree
27├── src
28│ ├── auth/*.cc # 证书认证相关实现函数
29│ ├── client/*.cc # 客户端设备核心逻辑实现函数
30│ ├── encryption/*.cc # 加密安全相关部分
31│ ├── external
32│ │ ├── json/*.cc # json相关的函数
33│ │ └── tinyxml2/*.cc # tinyxml2网络资源
34│ ├── http/*.cc # http相关的网络函数
35│ ├── model/*.cc # OSS模型相关的网络函数
36│ ├── utils/*.cc # OSS组件资源通用部分
37│ ├── resumable/*.cc # 相关恢复逻辑
38│ └── *.cc # 其他部分
39├── include/alibabacloud/oss
40│ ├── auth/*.h # 证书认证相关头文件
41│ ├── client/*.h # 客户端设备核心逻辑头文件
42│ ├── encryption/*.h # 加密安全相关头文件
43│ ├── http/*.h # http相关的函数头文件
44│ ├── model/*.h # OSS模型相关的网络函数头文件
45│ ├── utils/*.h # OSS组件资源通用部分头文件
46│ └── *.h # 其他头文件
47├── package.yaml # 编译配置文件
48└── example
49 └── oss_example.c # OSS测试代码
50```
51
52
53## 依赖组件
54
55
56- haas100
57- mbedtls
58- cplusplus
59- fatfs
60
61
62
63# 常用配置
64
65
66系统中相关配置已有默认值，如需修改配置，统一在package.yaml修改，具体如下：
67
68
69> 选择使用CRYPTO MBEDTLS加密方式
70
71
72
73```yaml
74USE_CRYPTO_MBEDTLS: 1
75```
76
77
78> 选择使用POSIX API的timer接口
79
80
81
82```yaml
83USE_AOS_TIME_POSIX_API: 1
84```
85
86
87> 选择支持读取SD上传文件，READ_SD_SIZE_MAX可以配置最大读取的文件大小，默认15KB
88
89```yaml
90USE_SD_FOR_OSS: 1
91READ_SD_SIZE_MAX: 1024*15
92```
93# API说明
94
95> 在使用OSS组件之前，开发者需要从阿里云平台购买OSS服务获取，在oss_example.c中替换即可。
96```c
97char AccessKey_ID[] = "Access Key ID";
98char AccessKey_Secret[] = "Access Key Secret";
99char Endpoint[] = "End point";
100char Bucket[] = "Bucket";
101```
102
103> OSS上传本地文件的API接口
104
105```c
106--------------------------------------------------
107-- keyId --> 身份验证AccessKey Id --
108-- keySecret --> 身份验证AccessKey Secret --
109-- endPoint --> OSS对外服务的访问域名 --
110-- bucketName --> 存储空间 --
111-- localfilepath --> 本地文件路径 --
112--------------------------------------------------
113char* oss_upload_local_file(char *keyId,
114 char *keySecret,
115 char *endPoint,
116 char *bucketName,
117 char* localfilepath);
118```
119> OSS上传本地字符内容API接口
120
121```c
122--------------------------------------------------
123-- keyId --> 身份验证AccessKey Id --
124-- keySecret --> 身份验证AccessKey Secret --
125-- endPoint --> OSS对外服务的访问域名 --
126-- bucketName --> 存储空间 --
127-- scontent --> 本地字符内容 --
128--------------------------------------------------
129char* oss_upload_local_content(char *keyId,
130 char *keySecret,
131 char *endPoint,
132 char *bucketName,
133 char *scontent);
134```
135
136# 使用示例
137
138组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
139待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
140
141## 步骤1 创建或打开工程
142
143**打开已有工程**
144
145如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
146
147**创建新的工程**
148
149组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
150
151## 步骤2 添加组件
152
153案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
154
155```yaml
156depends:
157 - linksdk: master
158 - mbedtls: master
159 - netmgr: master
160 - oss: master
161```
162
163## 步骤3 下载组件
164
165在已安装了 的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
166
167```shell
168
169aos install oss
170
171```
172
173上述命令执行成功后，组件源码则被下载到了./components/oss路径中。
174
175## 步骤4 添加示例
176
177> oss组件的package.yaml中添加[example示例代码](https://gitee.com/alios-things/oss/tree/master/example)：
178
179```yaml
180source_file:
181 - example/oss_example.c
182```
183
184> helloworld.c中添加网络相关部分，因为oss依赖网络的连接
185
186```c
187#include <stdio.h>
188#include <stdlib.h>
189#include <aos/errno.h>
190#include <aos/kernel.h>
191#include "aos/init.h"
192#include "board.h"
193#include <k_api.h>
194
195//添加网络
196#include "netmgr.h"
197#include <uservice/uservice.h>
198#include <uservice/eventid.h>
199
200int application_start(int argc, char *argv[])
201{
202 int count = 0;
203
204 printf("nano entry here!\r\n");
205 aos_set_log_level(AOS_LL_DEBUG);
206 event_service_init(NULL);
207 netmgr_service_init(NULL); //添加网络
208
209 while(1) {
210 aos_msleep(1000);
211 };
212}
213```
214
215## 步骤5 编译固件
216
217在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
218
219## 步骤6 烧录固件
220
221helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
222
223## 步骤7 打开串口
224
225固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
226
227当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
228
229## 步骤8 测试示例
230
231**CLI命令行输入：**
232网络连接：
233```sh
234netmgr -t wifi -c SSID PWD
235```
236CLI关键日志：
237```sh
238[ 41.977]<I>WIFI_SERVICE set sntp server:1.cn.pool.ntp.org successfully
239[ 41.977]<I>WIFI_SERVICE sntp config servadd end.
240[ 42.231]<I>WIFI_SERVICE [sntp] OK: sec 1616747078 usec 875314
241```
242**CLI命令行输入：**
243测试OSS上传本地字符内容
244```sh
245oss_test 0 hello_oss # 上传本地内容，例如hello_oss到oss系统中
246```
247
248
249> CLI关键日志：
250
251
252
253```sh
254oss upload begin 0...
255objectfile_path:oss/test/oss.txt
256----- time 1616747084 ---------
257read
258ProgressCallback[0] => 9 ,9,9
259read
260ProgressCallback[0] => 0 ,9,9
261[makeRequest]response_code: 200
262oss ->url:http://xxxxxxxxxx.xxxxxx
263oss_upload_local_content success, ETag:ED9BE43B38DDC1254170BEBCA4046368
264oss upload end !!!
265```
266**CLI命令行输入：**
267测试OSS上传本地文件
268```sh
269oss_test 1 /sdcard/oss.txt # 上传本地文件，例如SD卡读取oss.txt上传
270```
271
272
273> CLI关键日志：
274
275
276
277```sh
278oss upload begin 1...
279objectfile_path:sdcard/oss.txt
280localfile_path:/sdcard/oss.txt
281[ 106.852]<A>AOS open file /sdcard/oss.txt
282[ 106.854]<A>AOS SD open file size <51>.
283----- time 1616747022 ---------
284oss ->url:http://xxxxxxxxxx.xxxxxxxxxx
285oss_upload_local_file success, ETag:22065065146EAA25CFB9FF5E774DD1C9
286oss upload end !!!
287```
288# FAQ
289
290
291Q1： OSS本组件依赖网络吗？
292
293
294答：是的，OSS组件只有在网络正常的时候才可以使用。
295