Selaa lähdekoodia

[添加]:添加 onenet um 框架

zylx 7 vuotta sitten
vanhempi
sitoutus
08b2a70113
8 muutettua tiedostoa jossa 132 lisäystä ja 0 poistoa
  1. 14 0
      docs/README.md
  2. 24 0
      docs/api.md
  3. 28 0
      docs/introduction.md
  4. 22 0
      docs/port.md
  5. 4 0
      docs/principle.md
  6. 11 0
      docs/samples.md
  7. 22 0
      docs/user-guide.md
  8. 7 0
      docs/version.md

+ 14 - 0
docs/README.md

@@ -0,0 +1,14 @@
+# 文档
+
+## 文档列表
+
+|文件名                             |描述|
+|:-----                             |:----|
+|[version.md](version.md)           |版本信息|
+|[introduction.md](introduction.md) |详细介绍|
+|[principle.md](principle.md)       |工作原理|
+|[user-guide.md](user-guide.md)     |使用指南|
+|[api.md](api.md)                   |API 说明|
+|[samples.md](samples.md)           |示例说明|
+|[port.md](port.md)                 |移植文档|
+

+ 24 - 0
docs/api.md

@@ -0,0 +1,24 @@
+# OneNET API
+
+## OneNET 初始化
+
+> int onenet_mqtt_init(void);
+
+OneNET 初始化函数,需要在使用 OneNET 功能前调用
+
+| 参数     | 描述    |
+| :-----   | :-----  |
+|无        | 无   |
+| **返回**    | **描述**  |
+|0       | 成功 |
+|-1        | 获得设备信息失败 |
+|-2        | mqtt 客户端初始化失败 |
+
+
+## mqtt 数据上传
+
+> rt_err_t onenet_mqtt_publish(const char *topic, const uint8_t *msg, size_t len);
+
+
+
+

+ 28 - 0
docs/introduction.md

@@ -0,0 +1,28 @@
+# OneNET 软件包介绍 #
+
+OneNET 平台是中国移动基于物联网产业打造的生态平台,可以适配多种网络环境和协议类型,例如MQTT、HTTP、LWM2M等,方便用户数据的管理和设备控制。
+
+该组件包是 RT-Thread 系统针对 OneNET 平台连接的适配,通过这个组件包可以让设备在 RT-Thread 上使用 MQTT 协议连接 OneNet 平台,完成数据的接收、发送、设备的注册和控制等功能。
+
+## 文件目录结构
+
+``` {.c}
+OneNET
+│   README.md                       // 软件包使用说明
+│   SConscript                      // RT-Thread 默认的构建脚本
+├───docs 
+│   │   api.md                      // API 使用说明
+│   │   introduction.md             // 软件包详细介绍
+│   │   port.md                     // 移植说明文档
+│   └───user-guide.md               // 用户手册
+├───inc                             // 头文件
+├───src                             // 源文件
+├───ports                           // 移植文件                 
+│           rt_ota_key_port.c       // 移植文件模板
+├───samples                         // 示例代码
+│   └───onenet_sample.c             // 软件包应用示例代码
+```
+
+## OneNET 功能特点 ##
+
+

+ 22 - 0
docs/port.md

@@ -0,0 +1,22 @@
+# OneNET 包移植说明
+
+本文主要介绍拿到 OneNET 软件包后,需要做的移植工作。
+
+OneNET 软件包已经将硬件平台相关的特性剥离出去,因此 OneNET 本身的移植工作非常少。
+
+## 移植过程中主要涉及的文件
+
+|文件                                    | 说明 |
+|:-----                                  |:----|
+|/ports/onenet_port.c           		| OneNET 软件包接口的移植 |
+
+OneNET 软件包仅有一个移植文件 `onenet_port`, 文件主要是实现开启自动注册后获取注册信息和设备信息,接口定义如下所示: 
+
+```
+
+```
+
+开发者只需要在该接口内,将       即可。
+
+**Note:**  
+

+ 4 - 0
docs/principle.md

@@ -0,0 +1,4 @@
+# OneNET 工作原理
+
+原理,主要将上传数据和命令接收,获取数据流和数据点的实现
+

+ 11 - 0
docs/samples.md

@@ -0,0 +1,11 @@
+# OneNET 示例应用程序 #
+
+## 示例介绍 ##
+
+示例文件:
+
+> samples/onenet_sample.c
+
+该例程是 **OneNET ** 软件包的示例展示,主要是展示用户如何使用 **OneNET ** 软件包上传数据和响应平台下发的命令。
+
+示例里导出的 msh 的 api 介绍。

+ 22 - 0
docs/user-guide.md

@@ -0,0 +1,22 @@
+# OneNET 使用说明 #
+
+## 使用前的准备
+
+
+### OneNET 配置与下载
+
+
+
+### OneNET port 接口移植(可选)
+
+
+
+
+
+## 运行示例
+
+
+
+
+## 注意事项
+

+ 7 - 0
docs/version.md

@@ -0,0 +1,7 @@
+# 版本和修订
+
+| Date       | Version | Author | Note     |
+| ---------- | :-----: | :----- | :------- |
+| 2018-07-17 |  v0.1   | zylx   | 初始版本 |
+|            |         |        |          |
+