瀏覽代碼

[修改]:修改格式,方便转成pdf

朱天龙 (Armink) 7 年之前
父節點
當前提交
ce60d68d03
共有 3 個文件被更改,包括 33 次插入24 次删除
  1. 1 1
      docs/port.md
  2. 14 10
      docs/samples.md
  3. 18 13
      docs/user-guide.md

+ 1 - 1
docs/port.md

@@ -4,7 +4,7 @@
 
 OneNET 软件包已经将硬件平台相关的特性剥离出去,因此 OneNET 本身的移植工作非常少,如果不启用自动注册功能就不需要移植任何接口。
 
-如果启用了自动注册,用户需要新建 `onenet_port.c`,并将文件添加至工程。`onenet_port.c`主要是实现开启自动注册后,获取注册信息、获取设备信息和保存设备信息等功能。接口定义如下所示: 
+如果启用了自动注册,用户需要新建 **onenet_port.c**,并将文件添加至工程。**onenet_port.c** 主要是实现开启自动注册后,获取注册信息、获取设备信息和保存设备信息等功能。接口定义如下所示: 
 
 ```{.c}
 /* 检查是否已经注册 */

+ 14 - 10
docs/samples.md

@@ -46,7 +46,7 @@
 
 打开 env 工具输入 menuconfig 按照下面的路径开启 onenet 软件包
 
-```
+```{.c}
 RT-Thread online packages
     IoT - internet of things  --->
         [*] OneNET: China Mobile OneNet cloud SDK for RT-Thread
@@ -54,7 +54,7 @@ RT-Thread online packages
 
 进入 onenet 软件包的配置菜单按下图所示配置,里面的信息依据自己的产品和设备的**实际情况**填写
 
-```
+```{.c}
 --- OneNET: China Mobile OneNet cloud SDK for RT-Thread                            
     [ ]   Enable OneNET sample                                                  
     [*]   Enable support MQTT protocol                                                 
@@ -91,7 +91,7 @@ RT-Thread online packages
 
 在使用 OneNET 软件包之前必须要先调用`onenet_mqtt_init`这个命令进行初始化,初始化完成后设备会自动连接 OneNET 平台。
 
-```
+```{.c}
 msh />onenet_mqtt_init
 [D/ONENET] (mqtt_connect_callback:85) Enter mqtt_connect_callback!
 [D/[MQTT] ] ipv4 address port: 6002
@@ -105,7 +105,7 @@ msh />[I/[MQTT] ] MQTT server connect success
 
 初始化完成后,用户可以调用`onenet_upload_cycle`这个命令周期性的往云平台上传数据。输入这个命令后,设备会每隔 5s 向数据流 temperature 上传一个随机值。并将上传的数据打印到 shell 窗口。
 
-```
+```{.c}
 msh />onenet_upload_cycle
 msh />[D/ONENET] (onenet_upload_data:106) buffer : {"temperature":32}
 [D/ONENET] (onenet_upload_data:106) buffer : {"temperature":51}
@@ -119,11 +119,14 @@ msh />[D/ONENET] (onenet_upload_data:106) buffer : {"temperature":32}
 
 ![onenet_datapoints](figures/onenet_datapoints.jpg)
 
-如果用户想往别的数据流发送信息,可以使用`onenet_mqtt_publish_digit`或者`onenet_mqtt_publish_string`往云平台上传数据。
+如果用户想往别的数据流发送信息,可以使用以下 API 往云平台上传数据。
+
+> onenet_mqtt_publish_digit
+> onenet_mqtt_publish_string
 
 命令格式如下所示
 
-```
+```{.c}
 onenet_mqtt_publish_digit 数据流名称 要上传的数据
 
 onenet_mqtt_publish_string 数据流名称 要上传的字符串
@@ -133,7 +136,7 @@ onenet_mqtt_publish_string 数据流名称 要上传的字符串
 
 示例如下
 
-```
+```{.c}
 msh />onenet_mqtt_publish_digit test 1
 msh />onenet_mqtt_publish_string test 1
 msh />onenet_mqtt_publish_digit test 2
@@ -148,7 +151,7 @@ msh />onenet_mqtt_publish_string test 1
 
 在初始化时,命令响应回调函数默认指向了空,想要接收命令,必须设置命令响应回调函数,在 shell 中输入命令`onenet_set_cmd_rsp`,就把示例文件里的命令响应回调函数挂载上了,这个响应函数在接收到命令后会把命令打印出来。
 
-```
+```{.c}
 msh />onenet_set_cmd_rsp
 ```
 
@@ -162,9 +165,10 @@ msh />onenet_set_cmd_rsp
 
 就可以在 shell 中看到云平台下发的命令了。
 
-```
+```{.c}
 msh />onenet_set_cmd_rsp
-msh />[D/ONENET] (mqtt_callback:60) topic $creq/6db0c1b2-9a7e-5e4a-8897-bf62d4a3461f receive a message
+msh />[D/ONENET] (mqtt_callback:60) topic $creq/6db0c1b2-9a7e-5e4a-8897-bf62d4a3461f 
+receive a message
 [D/ONENET] (mqtt_callback:62) message length is 18
 [D/ONENET] (onenet_cmd_rsp_cb:107) recv data is hello rt-thread!
 ```

+ 18 - 13
docs/user-guide.md

@@ -18,7 +18,7 @@
 
 ### 推送数据
 
-当需要上传数据时,可以按照数据类型选择`onenet_mqtt_upload_digit`或者`onenet_mqtt_upload_string`来上传数据。代码示例如下: 
+当需要上传数据时,可以按照数据类型选择对应的 API 来上传数据。代码示例如下: 
 
 ```{.c}
 char str[] = { "hello world" };
@@ -32,9 +32,11 @@ onenet_mqtt_upload_digit("temperature",temp);
 onenet_mqtt_upload_string("string",str);
 ```
 
-除了支持上传数字和字符串外,软件包还支持上传二进制文件,可以通过`onenet_mqtt_upload_bin`或`onenet_mqtt_upload_bin_by_path`来上传二进制文件代码示例如下
+除了支持上传数字和字符串外,软件包还支持上传二进制文件。
 
-```
+可以通过`onenet_mqtt_upload_bin`或`onenet_mqtt_upload_bin_by_path`来上传二进制文件。代码示例如下
+
+```{.c}
 uint8_t buf[] = {0x01, 0x02, 0x03};
 
 /* 将根目录下的1.bin文件上传到 bin 数据流 */
@@ -49,7 +51,8 @@ onenet_mqtt_upload_bin(("bin", buf, 3);
 OneNET 支持下发命令,命令是用户自定义的。用户需要自己实现命令响应回调函数,然后利用`onenet_set_cmd_rsp_cb`将回调函数装载上。当设备收到平台下发的命令后,会调用用户实现的命令响应回调函数,等待回调函数执行完成后,将回调函数返回的响应内容再发给云平台。保存响应的内存必须是动态申请出来的,在发送完响应后,程序会自动释放申请的内存。代码示例如下: 
 
 ```{.c}
-static void onenet_cmd_rsp_cb(uint8_t *recv_data, size_t recv_size, uint8_t **resp_data, size_t *resp_size)
+static void onenet_cmd_rsp_cb(uint8_t *recv_data, size_t recv_size,uint8_t **resp_data,
+size_t *resp_size)
 {
   /* 申请内存 */
 
@@ -80,7 +83,7 @@ int main()
 
 用户可以通过`onenet_http_get_datastream`来获取数据流的信息,包括数据流 id,数据流最后更新时间,数据流单位,数据流当前值等等,获取的数据流信息会保存在传入的 datastream 结构体指针所指向的结构体中。代码示例如下
 
-```
+```{.c}
 struct rt_onenet_ds_info ds_temp;
 
 /* 获取到 temperature 数据流的信息后保存到 ds_temp 结构体中 */
@@ -91,19 +94,20 @@ onenet_http_get_datastream("temperature",ds_temp);
 
 数据点信息可以通过以下 3 个 API 来获取
 
-```
-cJSON *onenet_get_dp_by_limit(char *ds_name, size_t limit);
-cJSON *onenet_get_dp_by_start_end(char *ds_name, uint32_t start, uint32_t end, size_t limit);
-cJSON *onenet_get_dp_by_start_duration(char *ds_name, uint32_t start, size_t duration, size_t limit);
-```
+> cJSON *onenet_get_dp_by_limit(char *ds_name, size_t limit);
+> 
+> cJSON *onenet_get_dp_by_start_end(char *ds_name, uint32_t start, uint32_t end, size_t limit);
+> 
+> cJSON *onenet_get_dp_by_start_duration(char *ds_name, uint32_t start, size_t duration, size_t limit);
 
 这三个 API 返回的都是 cJSON 格式的数据点信息,区别只是查询的方法不一样,下面通过示例来讲解如何使用这 3 个 API。
 
-```
+```{.c}
 /* 获取 temperature 数据流的最后10个数据点信息 */
 dp = onenet_get_dp_by_limit("temperature",10);
 
-/* 获取 temperature 数据流2018年7月19日14点50分0秒到2018年7月19日14点55分20秒的前10个数据点信息 */
+/* 获取 temperature 数据流2018年7月19日14点50分0秒到2018年7月19日14点55分20秒的前10个
+数据点信息 */
 /* 第二、三个参数是Unix时间戳 */
 dp = onenet_get_dp_by_start_end("temperature",1531983000,1531983320,10);
 
@@ -115,4 +119,5 @@ dp = onenet_get_dp_by_start_end("temperature",1531983000,50,10);
 ## 注意事项
 
 - 设置命令响应回调函数之前必须要先调用`onenet_mqtt_init`函数,在初始化函数里会将回调函数指向RT_NULL。
-- 命令响应回调函数里存放响应内容的 buffer 必须是 malloc 出来的,在发送完响应内容后,程序会将这个 buffer 释放掉。
+- 命令响应回调函数里存放响应内容的 buffer 必须是 malloc 出来的,在发送完响应内容后,程序会将这个 buffer 释放掉。
+