Z-Ware SDK 7.15.X Library C API Reference Manual
Total Page:16
File Type:pdf, Size:1020Kb
Instruction Z-Ware SDK 7.15.x Library C API Reference Manual Document No.: INS14416 Version: 14 Description: The Z-Ware Library is a Z-Wave Plus v2 SmartStart Z-Wave for IP client. Written By: MIKOZIK;KAJAROSZ;ADGIELNI;JFR;MASZPIEC Date: Reviewed By: JCC;SCBROWNI;TRBOYD Restrictions: Public Approved by: Date CET Initials Name Justification 2020-12-02 05:26:04 NTJ Niels Johansen This document is the property of Silicon Labs. The data contained herein, in whole or in part, may not be duplicated, used or disclosed outside the recipient for any purpose. This restriction does not limit the recipient's right to use information contained in the data if it is obtained from another source without restriction. INS14416-15 Z-Ware SDK 7.15.x Library C API Reference Manual 2020-12-02 REVISION RECORD Doc. Rev Date By Pages Brief description of changes affected 1 20180713 DCHOW ALL - Cloned from INS14129-5 for SDK 7.00.00 - v9.03 -Modified tables "Controlled Z Wave CCs", "ZIPGW SDK 2.8x Supported Z Wave CCs", "Interface Types: IF_REC_TYPE_XXX", "Error Codes, ZW_ERR_XXX", "zwnetd_t structure", "if_rec_meter_t structure","rec union", "NODE_PROPTY_XXX", "zwnoded_t structure", "zwrep_group_fn Parameters", "zwif_group_get Parameters", "zwrep_wakeup_fn Parameters", "zwif_wakeup_get Parameters", "zwrep_switch_fn Parameters", "zwif_switch_set Parameters", "zwrep_level_fn Parameters", "ZW_METER_TYPE_XXX and ZW_METER_UNIT_XXX", "ZW_METER_SUP_UNIT_XXX", "zwmeter_dat_t structure", "zwmeter_cap_t structure", "zwif_meter_get Parameters", "zwrep_dlck_op_fn Parameters", "zwdlck_cfg_t structure", "zwrep_dlck_cfg_fn Parameters", "zwrep_thrmo_fan_md_fn Parameters", "zwrep_thrmo_md_fn Parameters", "zwrep_thrmo_setp_fn Parameters", "zwrep_thrmo_setp_range_fn Parameters", "zwif_thrmo_setp_sup_range_cache_get Parameters", "zwif_ind_rpt_set Parameters", "zwif_ind_get Parameters", "zwif_ind_set Parameters", "zwrep_barrier_fn Parameters", "zwrep_barrier_subsys_fn Parameters" -Added tables "if_rec_dlck_t structure", "Thermostat Setpoint Types: ZW_THRMO_SETP_TYP_XXX", "Thermostat Setpoint Unit", "Door lock Operation Mode", "Door lock Operation Type", "zwsw_ver_t structure", "zwrep_ind_fn Parameters", "zwind_data_t structure", "zwind_propty_val_t structure", "ZWIND_ID_XXX", "ZWIND_PPTY_ID_XXX" -Modified section "Firmware update". -Added sections "zwnet_identify", "zwnet_version", "zwnode_identify", "zwif_switch_mset", "zwif_dlck_cap_get", "zwif_dlck_cap_cache_get", "zwif_dlck_cap_free", "zwif_ind_sup_get", "zwif_ind_sup_cache_get", "zwif_ind_sup_free", "Sound Switch Interface API", "Time and Date Interface API". - control SOUND_SWITCH v1, INDICATOR CC v3, TIME CC v2 20180718 DCHOW ALL -Modified tables "zwnet_init_t structure", "Files", "ZIPGW SDK 2.1x Supported Z Wave CCs" -Modified sections "Role", "CC Support", "zwnet_identify", "zwnode_identify", "Node Update". 20180802 SNA - Added ZIPGW 7.x CCs, separated Z-Ware supported CCs. 20180803 DCHOW ALL - v9.05 2 20180823 SNA ALL Formatted for Silabs and fixed page numbers. DCHOW 17 Replaced S2 inclusion flow diagram as picture. 3 20181113 DCHOW ALL -Modified tables "Error Codes, ZW_ERR_XXX", "zwnet_notify_fn Parameters", "zwnet_node_fn Parameters", "zwusrcod_t structure" and "ZWIND_PPTY_ID_XXX". -Added table “ZW_USRCOD_XXX”. -Modified section "zwif_battery_rpt_set". -Support callbacks when node has been reset. 4 20181122 SNA V9.05.04 SDK v7.00.02 beta: removed older ZIPGW info, Corrected mailbox CC support version; removed BBB references. silabs.com | Building a more connected world. Page ii of xxxvi INS14416-15 Z-Ware SDK 7.15.x Library C API Reference Manual 2020-12-02 REVISION RECORD Doc. Rev Date By Pages Brief description of changes affected 5 20190222 DCHOW ALL -v9.11 -Modified tables "Controlled Z Wave CCs", "Z Wave Alarm/Notification Event Parameter Type", "zwalrm_t Structure", "zwnet_add_sec2_grant_key Parameters", "zwnoded_t Structure", "zwcfg_info_t structure", "ZW_USRCOD_XXX", "zwusrcod_t structure", "zwif_usrcod_get Parameters", "zwif_usrcod_sup_get Parameters", "zwrep_usr_sup_fn Parameters", "zwif_usrcod_sup_cache_get", "zwrep_ind_sup_fn Parameters", "zwif_ind_set Parameters", "zwfw_updt_req_t Structure", "pl_info_t Structure", "zwnet_sts_t Structure", "zwnet_node_fn Parameters" -Added new entries in tables "Error Codes, ZW_ERR_XXX", "zwnet_notify_fn Parameters", "zwnet_sts_t Structure", "dev_global_sett_t Structure", "zwif_switch_set Parameters", "zwrep_color_sw_get_fn Parameters", "zwrep_basic_fn Parameters", "ZW_ALRM_XXX", "Z Wave Alarm/Notification Type", "– Z Wave Alarm/Notification Event", "zwif_snd_switch_rpt_set Parameters", "zwrep_snd_switch_config_fn Parameters", "ZW_ALRM_EVT_XXX" -Added tables "Additional Info Associated to Network Op and Status" -Modified sections "JSON File Format", "zwnet_add_sec2_grant_key", "Node Update" -Added sections "zwif_usrcod_rpt_set", "zwif_usrcod_ext_rpt_set", "zwif_usrcod_ext_set", "zwif_usrcod_ext_get", "zwif_usrcod_cap_get", "zwif_usrcod_cap_cache_get", "zwif_usrcod_kp_mod_rpt_set", "zwif_usrcod_kp_mod_set", "zwif_usrcod_kp_mod_get", "zwif_usrcod_ms_cod_rpt_set", "zwif_usrcod_ms_cod_set", "zwif_usrcod_ms_cod_get", "zwif_usrcod_chksum_rpt_set", "zwif_usrcod_chksum_get", "zwif_fw_downld_req", "Window Covering Interface API", "Node Update endpoint get/set CCs" - control User Code CC v2, Window Covering CC v1, Notification CC v8, N/W IMA CC v2 6 20190318 SNA 192 -v9.12 -Update supported CC table -Added firmware update completion status for low/unknown battery level 7 20190325 DCHOW 112 -v9.13 -Changed the description of ep_id in Table 193 - grp_member_t structure -Changed the description of grp_member in Table 195 - zwif_group_del Parameters 8 20190531 DCHOW ALL -v9.15 -Added parameters to zwif_switch_set API to support post-set polling -Added entries to tables ZW_THRMO_FAN_MD_XXX, ZW_FW_UPDT_ERR_XXX, "zwfw_info_t structure" -Modified tables "Controlled Z Wave CCs", "Supported Z-Wave CCs Pushed down from Z- Ware" -Added description on backoff intervals for "down" node in section "Background Polling" -Support and control Association CC v3 & Multichannel Association CC v4 -Control Firmware Update MD CC v6,- Thermostat Fan Mode CC v5, -Added section “Persistent Storage for Z-Ware Library” 9 20190816 SNA ALL Moved all non API & File format documentation out silabs.com | Building a more connected world. Page iii of xxxvi INS14416-15 Z-Ware SDK 7.15.x Library C API Reference Manual 2020-12-02 REVISION RECORD Doc. Rev Date By Pages Brief description of changes affected 20190902 TWC ALL -v9.22 -Added IF_REC_TYPE_MULTI_CMD in table "Interface Types: IF_REC_TYPE_XXX" -Added entries in tables "ZW_ALRM_EVT_XXX", "rec Union", "ZWIND_ID_XXX", "ZWIND_PPTY_ID_XXX", "zwfw_info_t structure", "zwfw_updt_req_t Structure", "zwrep_snd_switch_tone_play_fn Parameters", "zwif_snd_switch_tone_play_set Parameters" -Added error code ZW_ERR_SEND_PENDING and changed definition of ZW_ERR_QUEUED -Added tables "if_rec_mcmd_t Structure" -Change section "zwif_group_add" to support assign return route completion callback. -Added multicast APIs: zwif_level_mset, zwif_level_mstart, zwif_level_mstop, zwif_dlck_op_mset, zwif_barrier_mset, zwif_wincvr_mset, zwif_wincvr_mstart, zwif_wincvr_mstop -Modified section "zwif_battery_rpt_set" -Added section "zwif_fw_updt_actv" -Control Firmware Update MD CC v7, Battery CC v2, Sound Switch CC v2, Door Lock Logging CC v1 -Updated "Home network file format"->"interfaces"->"Sound switch CC" -Updated "Home network file format"->"interfaces"->"Battery CC" -Added "Home network file format"->"interfaces"->"Door Lock Logging CC" -Added entry "send_encap" in "Device Database File Format" 10 20191128 TWC ALL -v10.03 -Removed entries support_multi_clients and wakeup_no_more_info_delay in Device Database Global Setting -Added state-numbers in Protection CC cache JSON object -Used Z/IP gateway mailbox: internal command queue related APIs (zwnode_cmd_q_xxx)are removed. -Support multi-cast -Allow the zwif_prot_tmout_set API to accept parameter "tmout" with value zero -Added usr_code_len to zwdlck_log_t structure -Support COMMAND_CLASS_NETWORK_MANAGEMENT_PROXY version 3 20191205 SNA Added techpub edits 11 20100110 SNA V10.05 – no changes 12 20200325 SNA Removed Portal support documentation 12 20200417 ADGIELNI 92, 93 Support Battery CC v3 13 20200615 MILOS All TechPubs review 13 20200703 MIKOZIK All Changed title to 7.14.x 14 20201124 MASZPIEC All -Support Anti-Theft Unlock v1. -Added "restricted” field to the JSON Node Object. -Support Long Range channel set/get. KAJAROSZ 27, 31, 32, 34, Change title to 7.15.x, define node_id_t, zwnet_unhandled_cmd_fn, zwnet_notify_fn, 40, 41, 42, 44, zwnet_sts_t, zw_health_prg_t, zw_health_rpt_t, zw_health_sts_t, pl_info_t, pl_nw_sts_t, 45, 46, 47, 48, zwnet_fail, zwnetd_t, zwnet_get_node_by_id, zwnet_get_ep_by_id, zwnet_get_if_by_id, 53, 58, 60, 64, zwnet_all_node_sts_get, zwnet_node_sts_get, zwnoded_t, zwepd_t, zwifd_t, 67, 90, 95, grp_member_t, zwif_group_cmd_get, zwrep_grp_cmd_fn, zwif_group_cmd_set, 114, 128, 180, zwrep_power_level_test_fn, zw_postset_fn, zwalrm_t, zw_alrm_snsr_t, 192, 193, 197, zwrep_prot_ec_fn, Network object, Node object, Group member object, Alarm Cache 204, 205, 210 object, Protection Cache object for “Exclusive Control”, Alarm Sensor Cache object. 15 20201201 SCBROWNI All Tech Pubs review of everything revised/added since last Tech Pubs review silabs.com | Building a more connected world. Page iv of xxxvi INS14416-15 Z-Ware SDK 7.15.x Library C API Reference Manual 2020-12-02 Table of Contents 1 INTRODUCTION ............................................................................................................................1