fix comment

This commit is contained in:
SheldonDai 2019-09-27 16:09:19 +08:00
parent ca133a077a
commit b34ce35f5e
1 changed files with 30 additions and 24 deletions

View File

@ -223,7 +223,7 @@ static void property_do_update(shadow_dev_property_t *property)
break;
case JSON_DATA_TYPE_STRING: // device name
/* 如果多个字符串属性,根据pProperty->key值匹配,处理字符串 */
/* 如果多个字符串属性,根据pProperty->key值匹配处理字符串 */
if (strcmp("name", property->key) != 0) {
break;
}
@ -235,7 +235,7 @@ static void property_do_update(shadow_dev_property_t *property)
}
}
/* Èç¹ûÓÐ×Ô¶¨ÒåµÄ×Ö·û´®»òÕßjson£¬ÐèÒªÔÚÕâÀï½âÎö */
/* 如果有自定义的字符串或者json需要在这里解析 */
static qcloud_err_t property_update(const char *json_doc, shadow_dev_property_t *property)
{
QCLOUD_POINTER_SANITY_CHECK(json_doc, QCLOUD_ERR_INVAL);
@ -263,13 +263,13 @@ static qcloud_err_t property_update(const char *json_doc, shadow_dev_property_t
return QCLOUD_ERR_SUCCESS;
}
/* 服务端有控制消息ä¸åï¼Œä¼šè§¦åè¿™é‡Œçš„deltaåžè°ƒ */
/* 服务端有控制消息下发会触发这里的delta回调 */
static void on_property_delta_handler(void *client, const char *json_doc, uint32_t json_doc_len, shadow_dev_property_t *property)
{
int i = 0;
for (i = 0; i < LIGHT_PROPERTY_COUNT; ++i) {
/* ÆäËûÊý¾ÝÀàÐÍÒѾ­ÔÚ_handle_deltaÁ÷³Ìͳһ´¦ÀíÁË£¬×Ö·û´®ºÍjson´®ÐèÒªÔÚÕâÀï´¦Àí£¬ÒòΪֻÓвúÆ·×Ô¼º²ÅÖªµÀstring/jsonµÄ×Ô¶¨Òå½âÎö */
/* 其他数据类型已经在_handle_delta流程统一处理了字符串和json串需要在这里处理因为只有产品自己才知道string/json的自定义解析 */
if (strcmp(light_property_handler.property_wrappers[i].property.key, property->key) != 0) {
continue;
}
@ -288,7 +288,7 @@ static void on_property_delta_handler(void *client, const char *json_doc, uint32
QCLOUD_LOG_E("property=%s changed no match", property->key);
}
/* ×¢²áÊý¾ÝÄ£°åÊôÐÔ */
/* 注册数据模板属性 */
static qcloud_err_t data_template_property_register(qcloud_shadow_client_t *client)
{
int i = 0;
@ -324,17 +324,17 @@ __weak void OLED_ShowString(int x, int y, uint8_t *str, int bold)
// handle the light(simulated)
static void light_change_color(const char *color)
{
// 作为demo,这里用oled屏字符显示来模æŸç¯é¢œè‰²çš„切换
// 这里应该由用户实现硬件操作代码,来改变智能灯的颜色
// 此处demoï¼Œåœ¨å¼€åæ¿æ˜¾ç¤ºå±ä¸Šæ˜¾ç¤ºå…·ä½“的颜色
// 作为demo这里用oled屏字符显示来模拟灯颜色的切换
// 这里应该由用户实现硬件操作代码,来改变智能灯的颜色
// 此处demo在开发板显示屏上显示具体的颜色
OLED_ShowString(0, 0, (uint8_t *)color, 8);
}
static void light_change_brightness(template_float_t brightness)
{
// 作为demo,这里用oled屏字符显示来模æŸç¯äº®åº¦çš„切换
// 这里应该由用户实现硬件操作代码,来改变智能灯的亮度
// 此处demoï¼Œåœ¨å¼€åæ¿æ˜¾ç¤ºå±ä¸Šæ˜¾ç¤ºå…·ä½“的亮度
// 作为demo这里用oled屏字符显示来模拟灯颜色的切换
// 这里应该由用户实现硬件操作代码,来改变智能灯的颜色
// 此处demo在开发板显示屏上显示具体的颜色
char brightness_str[12];
snprintf(brightness_str, sizeof(brightness_str), "%f", brightness);
@ -344,13 +344,13 @@ static void light_change_brightness(template_float_t brightness)
static void light_power_on(void)
{
// 作为demo,这里用oled屏字符显示来模æŸç¯å¼€å…³çŠ¶æ€çš„åˆ‡æ¢
// 作为demo这里用oled屏字符显示来模拟灯颜色的切换
OLED_Clear();
}
static void light_power_off(void)
{
// 作为demo,这里用oled屏字符显示来模æŸç¯å¼€å…³çŠ¶æ€çš„åˆ‡æ¢
// 作为demo这里用oled屏字符显示来模拟灯颜色的切换
char *info = "light off";
OLED_Clear();
OLED_ShowString(0, 0, (uint8_t *)info, 16);
@ -403,11 +403,12 @@ static void incoming_messsage_handler(void *client, void *context, mqtt_event_t
}
}
/* ʾÀýµÆ¹â¿ØÖÆ´¦ÀíÂß¼­ */
/* 示例灯光控制处理逻辑 */
static void deal_down_stream_user_logic(void)
{
char *color_name;
/* 灯光颜色 */
switch (light_profile.color) {
case LIGHT_COLOR_RED:
color_name = " RED ";
@ -423,10 +424,12 @@ static void deal_down_stream_user_logic(void)
}
if (light_profile.switch_state == LIGHT_SWTICH_STATE_ON) {
/* 灯光开启式,按照控制参数展示 */
light_power_on();
light_change_color(color_name);
light_change_brightness(light_profile.brightness);
} else {
/* 灯光关闭展示 */
light_power_off();
}
@ -445,14 +448,13 @@ static void deal_down_stream_user_logic(void)
#endif
}
/* Óû§ÐèҪʵÏÖµÄÉÏÐÐÊý¾ÝµÄÒµÎñÂß¼­,´Ë´¦½ö¹©Ê¾Àý */
/* 用户需要实现的上行数据的业务逻辑,此处仅供示例 */
static void deal_up_stream_user_logic(shadow_dev_property_t *properties_report[], int *count)
{
int i, j;
*count = 0;
/* ÌáÈ¡³ö·¢Éú±ä¸üÁ˵ÄÊôÐÔ£¬Éϱ¨µ½ÔÆ */
for (i = 0, j = 0; i < LIGHT_PROPERTY_COUNT; ++i) {
if (light_property_handler.property_wrappers[i].state == PROPERTY_STATE_CHANGED) {
properties_report[j++] = &(light_property_handler.property_wrappers[i].property);
@ -471,7 +473,7 @@ static void on_shadow_update_handler(void *client,
QCLOUD_LOG_I("recv shadow update response, request state: %d", req_state);
}
/* 5s¶¨Ê±Éϱ¨ÊôÐÔ״̬,¿É¸ù¾ÝÒµÎñ²Ã¼ô£¬´Ë´¦½ö¹©Ê¾Àý */
/* 5s定时上报属性状态,可根据业务裁剪,此处仅供示例 */
qcloud_err_t timely_reporting(shadow_dev_property_t *properties_report[], osal_timer_t *report_timer)
{
int i;
@ -512,10 +514,12 @@ int data_template_light_thread(void)
qcloud_device_create(&device, "XC31USKYPL", "dev001", "Pz1wK0fVJHxSojqxDuuvmg==");
// init connection
qcloud_shadow_client_create(&shadow_client, &device, incoming_messsage_handler, SHADOW_TYPE_TEMPLATE);
light_power_off();
// init data template
data_template_init(&device);
#if (QCLOUD_CFG_EVENT_EN > 0u)
@ -526,6 +530,7 @@ int data_template_light_thread(void)
}
#endif
// register data template propertys here
rc = data_template_property_register(&shadow_client);
if (rc == QCLOUD_ERR_SUCCESS) {
QCLOUD_LOG_I("data template propertys register success");
@ -535,13 +540,14 @@ int data_template_light_thread(void)
}
#define SHADOW_REQUEST_TIMEOUT (10) // in seconds
// 离线期间服务端可能有下行命令此处实现同步。version同步后台非必要
rc = qcloud_shadow_client_get_sync(&shadow_client, SHADOW_REQUEST_TIMEOUT);
if (rc != QCLOUD_ERR_SUCCESS) {
QCLOUD_LOG_E("device shadow get failed, err: %d", rc);
return rc;
}
// 属性定时上报timer,可以根据业务需要裁剪ã€
// 属性定时上报timer可以根据业务需要裁剪。
osal_timer_init(&report_timer);
while (qcloud_shadow_client_is_connected(&shadow_client) ||
@ -558,19 +564,19 @@ int data_template_light_thread(void)
break;
}
/* ·þÎñ¶ËÏÂÐÐÏûÏ¢£¬ÒµÎñ´¦ÀíÂß¼­1Èë¿Ú */
/* 服务端下行消息业务处理逻辑1入口 */
if (is_light_property_changed) {
// 服务器下发了控制指令,更改了设备的状态
deal_down_stream_user_logic();
/* ÒµÎñÂß¼­´¦ÀíÍêºóÐèҪͬ²½Í¨Öª·þÎñ¶Ë:É豸Êý¾ÝÒѸüУ¬É¾³ýdseireÊý¾Ý */
/* 业务逻辑处理完后需要同步通知服务端:设备数据已更新删除dseire数据 */
rc = qcloud_shadow_client_desire_null_construct(&shadow_client, shadow_update_buffer, sizeof(shadow_update_buffer));
if (rc == QCLOUD_ERR_SUCCESS) {
rc = qcloud_shadow_client_update_sync(&shadow_client, shadow_update_buffer, sizeof(shadow_update_buffer), 5);
if (rc == QCLOUD_ERR_SUCCESS) {
is_light_property_changed = QCLOUD_FALSE;
// Óû§ÐèÒª¸ù¾ÝÒµÎñÇé¿öÐÞ¸ÄÉϱ¨flagµÄ¸³ÖµÎ»ÖÃ,´Ë´¦½öΪʾÀý¡£
// 用户需要根据业务情况修改上报flag的赋值位置,此处仅为示例。
is_new_property_reported = QCLOUD_TRUE;
QCLOUD_LOG_I("shadow update(desired) success");
} else {
@ -581,9 +587,9 @@ int data_template_light_thread(void)
}
}
/* É豸ÉÏÐÐÏûÏ¢,ÒµÎñÂß¼­2Èë¿Ú */
/* 设备上行消息,业务逻辑2入口 */
if (is_new_property_reported) {
/* deltaÏûÏ¢ÊÇÊôÐÔµÄdesireºÍÊôÐÔµÄreportµÄ²îÒ켯£¬ÊÕµ½deseireÏûÏ¢´¦Àíºó£¬ÒªreportÊôÐÔµÄ״̬ */
/* delta消息是属性的desire和属性的report的差异集收到deseire消息处理后要report属性的状态 */
deal_up_stream_user_logic(properties_report, &properties_report_count);
if (properties_report_count > 0) {
rc = qcloud_shadow_client_report_construct_array(&shadow_client, shadow_update_buffer, sizeof(shadow_update_buffer),
@ -627,7 +633,7 @@ int data_template_light_thread(void)
}
#if (QCLOUD_CFG_EVENT_EN > 0u)
// ʼþÉϱ¨
// 事件上报
event_count = 0;
event_flag = event_flag_get();
if (EVENT_COUNTS > 0 && event_flag > 0) {