README.md
1# BearPi-HM_Nano开发板智能台灯案例开发
2本示例将演示如何在BearPi-HM_Nano开发板上使用MQTT协议连接华为IoT平台,使用E53_SC1 智能台灯扩展板与 BearPi-HM_Nano 开发板实现智能台灯的案例,设备安装如下图所示。
3
4![](../../docs/figures/D8_iot_cloud_oc_light/E53_SC1_Install.png "E53_SC1安装")
5
6## 软件设计
7
8### 连接平台
9在连接平台前需要设置获取CONFIG_APP_DEVICEID、CONFIG_APP_DEVICEPWD、CONFIG_APP_SERVERIP、CONFIG_APP_SERVERPORT,通过oc_mqtt_profile_connect()函数连接平台。
10```c
11 WifiConnect(CONFIG_WIFI_SSID, CONFIG_WIFI_PWD);
12 dtls_al_init();
13 mqtt_al_init();
14 oc_mqtt_init();
15
16 g_app_cb.app_msg = queue_create("queue_rcvmsg",10,1);
17 if(g_app_cb.app_msg == NULL){
18 printf("Create receive msg queue failed");
19
20 }
21 oc_mqtt_profile_connect_t connect_para;
22 (void) memset( &connect_para, 0, sizeof(connect_para));
23
24 connect_para.boostrap = 0;
25 connect_para.device_id = CONFIG_APP_DEVICEID;
26 connect_para.device_passwd = CONFIG_APP_DEVICEPWD;
27 connect_para.server_addr = CONFIG_APP_SERVERIP;
28 connect_para.server_port = CONFIG_APP_SERVERPORT;
29 connect_para.life_time = CONFIG_APP_LIFETIME;
30 connect_para.rcvfunc = msg_rcv_callback;
31 connect_para.security.type = EN_DTLS_AL_SECURITY_TYPE_NONE;
32 //连接平台
33 ret = oc_mqtt_profile_connect(&connect_para);
34 if((ret == (int)en_oc_mqtt_err_ok)){
35 g_app_cb.connected = 1;
36 printf("oc_mqtt_profile_connect succeed!\r\n");
37 }
38 else
39 {
40 printf("oc_mqtt_profile_connect failed!\r\n");
41 }
42```
43
44### 推送数据
45
46当需要上传数据时,需要先拼装数据,让后通过oc_mqtt_profile_propertyreport上报数据。代码示例如下:
47
48```c
49static void deal_report_msg(report_t *report)
50{
51 oc_mqtt_profile_service_t service;
52 oc_mqtt_profile_kv_t luminance;
53 oc_mqtt_profile_kv_t led;
54
55 if (g_app_cb.connected != 1) {
56 return;
57 }
58
59 service.event_time = NULL;
60 service.service_id = "Light";
61 service.service_property = &luminance;
62 service.nxt = NULL;
63
64 luminance.key = "Luminance";
65 luminance.value = &report->lum;
66 luminance.type = EN_OC_MQTT_PROFILE_VALUE_INT;
67 luminance.nxt = &led;
68
69 led.key = "LightStatus";
70 led.value = g_app_cb.led ? "ON" : "OFF";
71 led.type = EN_OC_MQTT_PROFILE_VALUE_STRING;
72 led.nxt = NULL;
73 //发送数据
74 oc_mqtt_profile_propertyreport(NULL,&service);
75 return;
76}
77```
78
79
80
81
82### 命令接收
83
84华为IoT平台支持下发命令,命令是用户自定义的。接收到命令后会将命令数据发送到队列中,CloudMainTaskEntry函数中读取队列数据并调用deal_cmd_msg函数进行处理,代码示例如下:
85
86```c
87
88// use this function to push all the message to the buffer
89static int msg_rcv_callback(oc_mqtt_profile_msgrcv_t *msg)
90{
91 int ret = 0;
92 char *buf;
93 int buf_len;
94 app_msg_t *app_msg;
95
96 if ((msg == NULL) || (msg->request_id == NULL) || (msg->type != EN_OC_MQTT_PROFILE_MSG_TYPE_DOWN_COMMANDS)) {
97 return ret;
98 }
99
100 buf_len = sizeof(app_msg_t) + strlen(msg->request_id) + 1 + msg->msg_len + 1;
101 buf = malloc(buf_len);
102 if (buf == NULL) {
103 return ret;
104 }
105 app_msg = (app_msg_t *)buf;
106 buf += sizeof(app_msg_t);
107
108 app_msg->msg_type = en_msg_cmd;
109 app_msg->msg.cmd.request_id = buf;
110 buf_len = strlen(msg->request_id);
111 buf += buf_len + 1;
112 memcpy_s(app_msg->msg.cmd.request_id, buf_len, msg->request_id, buf_len);
113 app_msg->msg.cmd.request_id[buf_len] = '\0';
114
115 buf_len = msg->msg_len;
116 app_msg->msg.cmd.payload = buf;
117 memcpy_s(app_msg->msg.cmd.payload, buf_len, msg->msg, buf_len);
118 app_msg->msg.cmd.payload[buf_len] = '\0';
119
120 ret = osMessageQueuePut(g_app_cb.app_msg, &app_msg, 0U, CONFIG_QUEUE_TIMEOUT);
121 if (ret != 0) {
122 free(app_msg);
123 }
124
125 return ret;
126}
127static void oc_cmdresp(cmd_t *cmd, int cmdret)
128{
129 oc_mqtt_profile_cmdresp_t cmdresp;
130 ///< do the response
131 cmdresp.paras = NULL;
132 cmdresp.request_id = cmd->request_id;
133 cmdresp.ret_code = cmdret;
134 cmdresp.ret_name = NULL;
135 (void)oc_mqtt_profile_cmdresp(NULL, &cmdresp);
136}
137///< COMMAND DEAL
138#include <cJSON.h>
139static void deal_cmd_msg(cmd_t *cmd)
140{
141 cJSON *obj_root;
142 cJSON *obj_cmdname;
143 cJSON *obj_paras;
144 cJSON *obj_para;
145
146 int cmdret = 1;
147
148 obj_root = cJSON_Parse(cmd->payload);
149 if (obj_root == NULL) {
150 oc_cmdresp(cmd, cmdret);
151 }
152
153 obj_cmdname = cJSON_GetObjectItem(obj_root, "command_name");
154 if (obj_cmdname == NULL) {
155 cJSON_Delete(obj_root);
156 }
157 if (strcmp(cJSON_GetStringValue(obj_cmdname), "Light_Control_Led") == 0) {
158 obj_paras = cJSON_GetObjectItem(obj_root, "paras");
159 if (obj_paras == NULL) {
160 cJSON_Delete(obj_root);
161 }
162 obj_para = cJSON_GetObjectItem(obj_paras, "Led");
163 if (obj_para == NULL) {
164 cJSON_Delete(obj_root);
165 }
166 ///< operate the LED here
167 if (strcmp(cJSON_GetStringValue(obj_para), "ON") == 0) {
168 g_app_cb.led = 1;
169 LightStatusSet(ON);
170 printf("Led On!\r\n");
171 } else {
172 g_app_cb.led = 0;
173 LightStatusSet(OFF);
174 printf("Led Off!\r\n");
175 }
176 cmdret = 0;
177 oc_cmdresp(cmd, cmdret);
178 }
179
180 return;
181}
182```
183
184
185## 编译调试
186
187
188### 登录
189
190设备接入华为云平台之前,需要在平台注册用户账号,华为云地址:<https://www.huaweicloud.com/>
191
192在华为云首页单击产品,找到IoT物联网,单击设备接入IoTDA 并单击立即使用,如下图所示。
193
194![](../../docs/figures/D8_iot_cloud_oc_light/platformlogin01.png "登录平台")
195
196![](../../docs/figures/D8_iot_cloud_oc_light/platformlogin02.png "登录平台")
197
198### 创建产品
199
200在设备接入页面可看到总览界面,展示了华为云平台接入的协议与域名信息,根据需要选取MQTT通讯必要的信息备用,如下图所示。
201
202接入协议(端口号):MQTT 1883
203
204域名:iot-mqtts.cn-north-4.myhuaweicloud.com
205
206![](../../docs/figures/D8_iot_cloud_oc_light/viewplatform.png "查看平台信息")
207
208选中侧边栏产品页,单击右上角“创建产品”,在页面中选中所属资源空间,并且按要求填写产品名称,选中MQTT协议,数据格式为JSON,并填写厂商名称,在下方模型定义栏中选择所属行业以及添加设备类型,并单击右下角“确定”,如下图所示。:
209
210![](../../docs/figures/D8_iot_cloud_oc_light/createproduct01.png "创建产品")
211
212
213
214创建完成后,在产品页会自动生成刚刚创建的产品,单击“查看”可查看创建的具体信息,如下图所示。
215
216![](../../docs/figures/D8_iot_cloud_oc_light/viewitem.png "查看产品")
217
218
219单击产品详情页的自定义模型,在弹出页面中新增服务,如下图所示。
220
221服务ID:`Light`(必须一致)
222
223服务类型:`Senser`(可自定义)
224![](../../docs/figures/D8_iot_cloud_oc_light/createproduct02.png "创建产品")
225
226在“Light”的下拉菜单下点击“添加属性”填写相关信息“Luminance”,“LightStatus”,如下图所示。
227
228
229![](../../docs/figures/D8_iot_cloud_oc_light/createproduct03.png "创建产品")
230
231![](../../docs/figures/D8_iot_cloud_oc_light/createproduct04.png "创建产品")
232
233在“Light”的下拉菜单下点击“添加命令”填写相关信息,如下图所示。
234
235命令名称:`Light_Control_Led`
236
237参数名称:`Led`
238
239数据类型:`string`
240
241长度:`3`
242
243枚举值:`ON,OFF`
244
245![](../../docs/figures/D8_iot_cloud_oc_light/createproduct05.png "创建产品")
246
247
248#### 注册设备
249
250在侧边栏中单击“设备”,进入设备页面,单击右上角“注册设备”,勾选对应所属资源空间并选中刚刚创建的产品,注意设备认证类型选择“秘钥”,按要求填写秘钥,如下图所示。
251
252![](../../docs/figures/D8_iot_cloud_oc_light/registerdevice01.png "注册设备")
253
254记录下设备ID和设备密钥,如下图所示。
255![](../../docs/figures/D8_iot_cloud_oc_light/registerdevice02.png "注册设备")
256
257注册完成后,在设备页面单击“所有设备”,即可看到新建的设备,同时设备处于未激活状态,如下图所示。
258
259![](../../docs/figures/D8_iot_cloud_oc_light/registerdevice03.png "注册设备")
260
261
262### 修改代码中设备信息
263修改`iot_cloud_oc_sample.c`中第31行附近的wifi的ssid和pwd,以及设备的DEVICEID和DEVICEPWD(这两个参数是在平台注册设备时产生的),如下图所示。
264
265![](../../docs/figures/D8_iot_cloud_oc_light/modifydevicemsg.png "修改设备信息")
266
267### 修改 BUILD.gn 文件
268
269修改 `device\board\bearpi\bearpi_hm_nano\app`路径下 BUILD.gn 文件,指定 `cloud_oc_light` 参与编译。
270
271```r
272#"D7_iot_cloud_oc_smoke:cloud_oc_smoke",
273"D8_iot_cloud_oc_light:cloud_oc_light",
274#"D9_iot_cloud_oc_manhole_cover:cloud_oc_manhole_cover",
275#"D10_iot_cloud_oc_infrared:cloud_oc_infrared",
276#"D11_iot_cloud_oc_agriculture:cloud_oc_agriculture",
277#"D12_iot_cloud_oc_gps:cloud_oc_gps",
278```
279### 测试
280
281
282示例代码编译烧录代码后,按下开发板的RESET按键,平台上的设备显示为在线状态,如下图所示。
283
284![](../../docs/figures/D8_iot_cloud_oc_light/deviceOnline.png "设备在线")
285
286点击设备右侧的“查看”,进入设备详情页面,可看到上报的数据。
287
288
289
290在华为云平台设备详情页,单击“命令”,选择同步命令下发,选中创建的命令属性,单击“确定”,即可发送下发命令控制设备。
291