简介

generic模型，就是sig mesh协议里面规定的一套通用功能模型，各个厂家只要按照协议去设计设备功能，设备之间即可兼容使用！
下面就用元素0x0106里面的“通用开关模型（generic_onoff_model）”来举例，了解并记录SDK里面，具体是如何应用generic模型的！

订阅、发布模式：

image.png

单播模式：

image.png

SDK代码参考

以下代码是一些代码片段，需要了解完整内容的话，可以在工程里面进行全局搜索！
只举例发布、订阅模式

客户端(gateway节点)：
初始化

  1. if (API_SUCCESS == retval)
  2.     {
  3.         /* Register Configuration model client */
  4.         retval = UI_register_config_model_client(element_handle);
  5.     }
  8.     if (API_SUCCESS == retval)
  9.     {
  10.         /* Register Generic OnOff model client */
  11.         retval = UI_register_generic_onoff_model_client(element_handle);
  12.     }
  15.     #ifdef  USE_VENDORMODEL
  18.     if (API_SUCCESS == retval)
  19.     {
  20.         /* Register Vendor Defined model server */
  21.         retval = UI_register_vendor_defined_model_client(element_handle);
  22.     }
  25.     #endif
  26.     UI_config_client_appkey_binding(0,0,UI_appkey);//重点
  27.     printf("0x%08X 0x%08X 0x%02X\n",ms_iv_index.iv_index,ms_iv_index.iv_expire_time,ms_iv_index.iv_update_state);
  28.     UI_prov_data.uaddr = 0x0001;
  29.     //Get network key
  30.     retval = MS_access_cm_get_netkey_at_offset(0,0,UI_prov_data.netkey);
  33.     if(retval == ACCESS_NO_MATCH)     //if can't find netkey,generate it
  34.     {
  35.         UI_netkey_generate(UI_prov_data.netkey);
  36.     }
  39.     //Get key refresh state
  40.     MS_access_cm_get_key_refresh_phase(0,&key_refresh_state);
  41.     key_refresh_state = (MS_ACCESS_KEY_REFRESH_PHASE_2 == key_refresh_state) ? 0x01 : 0x00;
  42.     UI_prov_data.ivindex = ms_iv_index.iv_index;
  43.     UI_prov_data.flags = ((ms_iv_index.iv_update_state & 0x01) << 1) | key_refresh_state;
  44.     retval = UI_set_provision_data(UI_prov_data.uaddr);
  45.     /* Set the Publish address for onoff and vendor model Client */
  46.     UI_prov_data.uaddr = 0xCFFF;//重点
  47.     UI_set_publish_address(UI_prov_data.uaddr, UI_generic_onoff_client_model_handle,MS_FALSE);//重点
  48.     UI_set_publish_address(UI_prov_data.uaddr, UI_vendor_defined_client_model_handle,MS_FALSE);

发送“generic_onoff_set”命令

  1. void UI_generic_onoff_set(UCHAR state)
  2. {
  3.     API_RESULT retval;
  4.     MS_GENERIC_ONOFF_SET_STRUCT  param;
  5.     CONSOLE_OUT
  6.     ("Send Generic Onoff Set\n");
  7.     param.onoff = state;
  8.     param.tid = 0;
  9.     param.optional_fields_present = 0x00;
  10.     retval = MS_generic_onoff_set(&param);//重点
  11.     CONSOLE_OUT
  12.     ("Retval - 0x%04X\n", retval);
  13. }
  15. #define MS_generic_onoff_set(param) \
  16.     MS_generic_onoff_client_send_reliable_pdu \
  17.     (\
  18.      MS_ACCESS_GENERIC_ONOFF_SET_OPCODE,\//重点
  19.      param,\
  20.      MS_ACCESS_GENERIC_ONOFF_STATUS_OPCODE\
  21.     )

处理generic_onoff回调

  1. API_RESULT UI_generic_onoff_client_cb
  2. (
  3.     /* IN */ MS_ACCESS_MODEL_HANDLE* handle,
  4.     /* IN */ UINT32                   opcode,
  5.     /* IN */ UCHAR*                   data_param,
  6.     /* IN */ UINT16                   data_len
  7. )
  8. {
  9.     API_RESULT retval;
  10.     retval = API_SUCCESS;
  11.     CONSOLE_OUT (
  12.         "[GENERIC_ONOFF_CLIENT] Callback. Opcode 0x%04X\n", opcode);
  13.     appl_dump_bytes(data_param, data_len);
  16.     switch(opcode)
  17.     {
  18.     case MS_ACCESS_GENERIC_ONOFF_STATUS_OPCODE://重点
  19.     {
  20.         CONSOLE_OUT(
  21.             "MS_ACCESS_GENERIC_ONOFF_STATUS_OPCODE\n");
  22.     }
  23.     break;
  24.     }
  27.     return retval;
  28. }

服务端（light节点）：
初始化

  1. if (API_SUCCESS == retval)
  2.     {
  3.         /* Register Generic OnOff model server */
  4.         retval = UI_register_generic_onoff_model_server(element_handle);
  5.     }

绑定appkey

  1. API_RESULT UI_sample_binding_app_key(void)
  2. {
  3.     MS_APPKEY_HANDLE  handle;
  4.     UINT8*              key;
  5.     UINT8             aid;
  6.     DECL_CONST UINT8  t_key[16] = {0};
  7.     API_RESULT retval;
  8.     CONSOLE_OUT("Fetching App Key for Handle 0x0000\n");
  9.     handle = 0x0000;
  10.     retval = MS_access_cm_get_app_key
  11.              (
  12.                  handle,
  13.                  &key,
  14.                  &aid
  15.              );
  18.     /* Check Retval. Print App Key */
  19.     if (API_SUCCESS == retval)
  20.     {
  21.         CONSOLE_OUT("App Key[0x%02X]: %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X %02X\r\n",
  22.                     handle, key[0], key[1], key[2], key[3], key[4], key[5], key[6], key[7],
  23.                     key[8], key[9], key[10], key[11], key[12], key[13], key[14], key[15]);
  26.         if (0 == EM_mem_cmp(key, t_key, 16))
  27.         {
  28.             /* NO AppKey Bound */
  29.             retval = API_FAILURE;
  30.         }
  31.         else
  32.         {
  33.             /* Found a Valid App Key */
  34.             /* Keeping the retval as API_SUCCESS */
  36.             retval=MS_access_bind_model_app(UI_generic_onoff_server_model_handle, handle);//重点
  37.             #ifdef  USE_LIGHTNESS
  38.             retval=MS_access_bind_model_app(UI_light_lightness_server_model_handle, handle);
  39.             CONSOLE_OUT("BINDING App Key %04x (%04x %04x)\n",retval,UI_light_lightness_server_model_handle,handle);
  40.             #endif
  41.             #ifdef  USE_CTL
  42.             retval=MS_access_bind_model_app(UI_light_ctl_server_model_handle, handle);
  43.             CONSOLE_OUT("BINDING App Key %04x (%04x %04x)\n",retval,UI_light_ctl_server_model_handle,handle);
  44.             #endif
  45.             #ifdef  USE_HSL
  46.             retval=MS_access_bind_model_app(UI_light_hsl_server_model_handle, handle);
  47.             CONSOLE_OUT("BINDING App Key %04x (%04x %04x)\n",retval,UI_light_hsl_server_model_handle,handle);
  48.             #endif
  49.             #ifdef  USE_SCENE
  50.             retval=MS_access_bind_model_app(UI_scene_server_model_handle, handle);
  51.             CONSOLE_OUT("BINDING App Key %04x (%04x %04x)\n",retval,UI_scene_server_model_handle,handle);
  52.             #endif
  53.             #ifdef  USE_VENDORMODEL
  54.             retval=MS_access_bind_model_app(UI_vendor_defined_server_model_handle, handle);
  55.             CONSOLE_OUT("BINDING App Key %04x (%04x %04x)\n",retval,UI_vendor_defined_server_model_handle,handle);
  56.             #endif
  57.         }
  58.     }
  61.     #ifdef EASY_BOUNDING
  62.     //Provision ok,stop provision/config timeout handler  by hq
  63.     CONSOLE_OUT("Stop timer\n");
  64.     EM_stop_timer(&procfg_timer_handle);
  65.     blebrr_prov_started = MS_FALSE;
  66.     #endif
  67.     return retval;
  68. }

订阅0xCFFF

  1. vm_subscriptiong_add (0xCFFF);//重点
  3. void vm_subscriptiong_add (MS_NET_ADDR addr)
  4. {
  5.     CONSOLE_OUT("vm_subscriptiong_add:%x\n",addr);
  6.     MS_ACCESS_ADDRESS       sub_addr;
  7.     sub_addr.use_label=0;
  8.     sub_addr.addr=addr;
  9.     MS_access_ps_store_disable(MS_TRUE);
  10.     MS_access_cm_add_model_subscription(UI_generic_onoff_server_model_handle,&sub_addr);
  11.     #ifdef  USE_LIGHTNESS
  12.     MS_access_cm_add_model_subscription(UI_light_lightness_server_model_handle,&sub_addr);
  13.     #endif
  14.     #ifdef  USE_CTL
  15.     MS_access_cm_add_model_subscription(UI_light_ctl_server_model_handle,&sub_addr);
  16.     MS_access_cm_add_model_subscription(UI_light_ctl_setup_server_model_handle,&sub_addr);
  17.     #endif
  18.     #ifdef  USE_HSL
  19.     MS_access_cm_add_model_subscription(UI_light_hsl_server_model_handle,&sub_addr);
  20.     MS_access_cm_add_model_subscription(UI_light_hsl_setup_server_model_handle,&sub_addr);
  21.     #endif
  22.     #ifdef  USE_SCENE
  23.     MS_access_cm_add_model_subscription(UI_scene_server_model_handle,&sub_addr);
  24.     MS_access_cm_add_model_subscription(UI_scene_setup_server_model_handle,&sub_addr);
  25.     #endif
  26.     MS_access_ps_store_disable(MS_FALSE);
  27.     MS_access_ps_store_all_record();
  28. }

回调处理

  1. static API_RESULT UI_generic_onoff_server_cb
  2. (
  3.     /* IN */ MS_ACCESS_MODEL_REQ_MSG_CONTEXT*     ctx,
  4.     /* IN */ MS_ACCESS_MODEL_REQ_MSG_RAW*         msg_raw,
  5.     /* IN */ MS_ACCESS_MODEL_REQ_MSG_T*           req_type,
  6.     /* IN */ MS_ACCESS_MODEL_STATE_PARAMS*        state_params,
  7.     /* IN */ MS_ACCESS_MODEL_EXT_PARAMS*          ext_params
  8. )
  9. {
  10.     MS_STATE_GENERIC_ONOFF_STRUCT    param;
  11.     MS_ACCESS_MODEL_STATE_PARAMS     current_state_params;
  12.     API_RESULT                       retval;
  13.     retval = API_SUCCESS;
  16.     /* Check message type */
  17.     if (MS_ACCESS_MODEL_REQ_MSG_T_GET == req_type->type)
  18.     {
  19.         CONSOLE_OUT("[GENERIC_ONOFF] GET Request.\n");
  20.         UI_generic_onoff_model_state_get(state_params->state_type, 0, &param, 0);
  21.         current_state_params.state_type = state_params->state_type;
  22.         current_state_params.state = &param;
  23.         /* Using same as target state and remaining time as 0 */
  24.     }
  25.     else if (MS_ACCESS_MODEL_REQ_MSG_T_SET == req_type->type)//重点
  26.     {
  27.         CONSOLE_OUT("[GENERIC_ONOFF] SET Request.\n");
  28.         retval = UI_generic_onoff_model_state_set(state_params->state_type, 0, (MS_STATE_GENERIC_ONOFF_STRUCT*)state_params->state, 0);//重点
  29.         current_state_params.state_type = state_params->state_type;
  30.         current_state_params.state = (MS_STATE_GENERIC_ONOFF_STRUCT*)state_params->state;
  31.     }
  34.     /* See if to be acknowledged */
  35.     if (0x01 == req_type->to_be_acked)
  36.     {
  37.         CONSOLE_OUT("[GENERIC_ONOFF] Sending Response.\n");
  38.         /* Parameters: Request Context, Current State, Target State (NULL: to be ignored), Remaining Time (0: to be ignored), Additional Parameters (NULL: to be ignored) */
  39.         retval = MS_generic_onoff_server_state_update(ctx, &current_state_params, NULL, 0, NULL);
  40.     }
  43.     return retval;
  44. }
  48. static API_RESULT UI_generic_onoff_model_state_set(UINT16 state_t, UINT16 state_inst, void* param, UINT8 direction)
  49. {
  50.     API_RESULT retval;
  51.     UCHAR  proxy_state;
  52.     retval = API_SUCCESS;
  55.     switch (state_t)
  56.     {
  57.     case MS_STATE_GENERIC_ONOFF_T:
  58.     {
  59.         MS_STATE_GENERIC_ONOFF_STRUCT* param_p;
  60.         param_p = (MS_STATE_GENERIC_ONOFF_STRUCT*)param;
  61.         /* Instantaneous Change */
  62.         UI_generic_onoff.onoff = param_p->onoff;
  63.         *param_p = UI_generic_onoff;
  64.         CONSOLE_OUT("[state] current: 0x%02X\n", UI_generic_onoff.onoff);
  65.         CONSOLE_OUT("[state] target: 0x%02X\n", UI_generic_onoff.target_onoff);
  66.         CONSOLE_OUT("[state] remaining_time: 0x%02X\n", UI_generic_onoff.transition_time);
  67.         proxy_state = UI_proxy_state_get();
  70.         if(proxy_state==MS_PROXY_CONNECTED)
  71.         {
  72.             EM_start_timer (&proxy_dly_thandle,    (EM_TIMEOUT_MILLISEC | 100), proxy_dly_generic_onoff, NULL, 0);
  73.         }
  74.         else
  75.         {
  76.             generic_onoff_set_pl(param_p->onoff);//重点
  77.         }
  80.         /* Ignoring Instance and direction right now */
  81.     }
  82.     break;
  85.     default:
  86.         break;
  87.     }
  90.     return retval;
  91. }