Instruction
Z-Ware SDK 7.14.x Library C API Reference Manual
Document No.:
INS14416
Version:
13
Description:
The Z-Ware Library is a Z-Wave Plus v2 SmartStart Z-Wave for IP client.
Written By:
MIKOZIK;KAJAROSZ;ADGIELNI;JFR
Date:
Reviewed By:
JCC;SCBROWNI;TRBOYD
Restrictions:
Public
Approved by:
Date CET Initials Name Justification
2020-07-07 03:09:29 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-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page ii of xxviii
REVISION RECORD
Doc. Rev
DateByPages
affected
Brief description of changes
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
20180802
DCHOW
SNA
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".
- Added ZIPGW 7.x CCs, separated Z-Ware supported CCs.
20180803
DCHOW
ALL
- v9.05
2
20180823
SNA
DCHOW
ALL17Formatted for Silabs and fixed page numbers.
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.
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page iii of xxviii
REVISION RECORD
Doc. Rev
DateByPages
affected
Brief description of changes
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 ZWare"
-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”
20190816
SNA
ALL
Moved all non API & File format documentation out
9
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"
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page iv of xxviii
REVISION RECORD
Doc. Rev
DateByPages
affected
Brief description of changes
10
20191128
20191205
TWC
SNA
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
Added techpub edits
11
20100110
SNA
V10.05 – no changes
12
20200325
SNA
Removed Portal support documentation
12
20200417
ADGIELNI
67, 68
Support Battery CC v3
13
20200615
MILOS
All
TechPubs review
13
20200703
MIKOZIK
All
Changed title to 7.14.x
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page v of xxviii
Table of Contents
1 INTRODUCTION................................................................................................................1
1.1 Purpose ................................................................................................................................1
1.2 Audience and Prerequisites..................................................................................................1
2 ERROR CODES ..................................................................................................................2
3 DEVICE DATABASE API......................................................................................................5
3.1 zwdev_cfg_load....................................................................................................................5
3.2 zwdev_cfg_free ..................................................................................................................26
3.3 zwdev_global_sett_free.....................................................................................................26
3.4 zwdev_cfg_find ..................................................................................................................26
4 NETWORK API ................................................................................................................27
4.1 Discovering ZIPGWs............................................................................................................27
4.1.1 zwnet_gw_discvr_start .............................................................................................27
4.1.2 zwnet_gw_discvr_stop .............................................................................................28
4.2 Network Initialization and Clean up...................................................................................28
4.2.1 zwnet_init .................................................................................................................28
4.2.2 zwnet_exit.................................................................................................................36
4.2.3 zwnet_reset ..............................................................................................................36
4.3 Network Creation...............................................................................................................37
4.3.1 zwnet_add ................................................................................................................37
4.3.2 Secure Inclusion ........................................................................................................38
4.3.2.1 zwnet_add_sec2_accept ......................................................................................38
4.3.2.2 zwnet_add_sec2_grant_key.................................................................................38
4.3.3 SmartStart Provisioning ............................................................................................39
4.3.3.1 zwnet_pl_add .......................................................................................................39
4.3.3.2 zwnet_pl_get ........................................................................................................42
4.3.3.3 zwnet_pl_del ........................................................................................................43
4.3.3.4 zwnet_pl_list_get .................................................................................................43
4.3.3.5 zwnet_pl_list_del..................................................................................................43
4.4 Network Management.......................................................................................................44
4.4.1 zwnet_initiate ...........................................................................................................44
4.4.2 zwnet_fail..................................................................................................................44
4.4.3 zwnet_update ...........................................................................................................44
4.4.4 zwnet_abort..............................................................................................................45
4.5 Network Attributes and Traversal......................................................................................45
4.5.1 zwnet_get_desc ........................................................................................................45
4.5.2 zwnet_version...........................................................................................................46
4.5.3 zwnet_get_node .......................................................................................................46
4.5.4 zwnet_get_node_ by_id ...........................................................................................46
4.5.5 zwnet_get_ep_ by_id................................................................................................46
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page vi of xxviii
4.5.6 zwnet_get_if_ by_id..................................................................................................47
4.5.7 zwnet_all_node_sts_get ...........................................................................................47
4.5.8 zwnet_node_sts_get.................................................................................................47
4.6 Advanced Network APIs.....................................................................................................47
4.6.1 zwnet_migrate ..........................................................................................................48
4.6.2 zwnet_initiate_classic ...............................................................................................48
4.6.3 zwnet_health_chk.....................................................................................................48
4.6.4 zwnet_identify ..........................................................................................................48
4.6.5 zwnet_get_user ........................................................................................................48
4.6.6 zwnet_send_nif.........................................................................................................49
4.6.7 zwnet_poll_rm ..........................................................................................................49
4.6.8 zwnet_poll_rm_mul..................................................................................................49
4.6.9 zwnet_pref_set .........................................................................................................49
4.6.10 zwnet_pref_get.........................................................................................................49
4.6.11 zwnet_client_pref_set ..............................................................................................50
4.6.12 zwnet_client_pref_get..............................................................................................50
4.6.13 zwnet_sec2_get_dsk.................................................................................................50
4.7 Network Utilities APIs.........................................................................................................50
4.7.1 zwnet_ip_aton ..........................................................................................................51
4.7.2 zwnet_ip_ntoa ..........................................................................................................51
4.7.3 zwnet_local_addr_get...............................................................................................51
4.7.4 zwnet_listen_port_get..............................................................................................51
5 NODE API .......................................................................................................................52
5.1 zwnoded_t..........................................................................................................................52
5.2 zwnode_get_net.................................................................................................................53
5.3 zwnode_get_next...............................................................................................................54
5.4 zwnode_get_ep..................................................................................................................54
5.5 zwnode_update..................................................................................................................54
5.6 zwnode_identify.................................................................................................................54
5.7 zwnode_get_ext_ver..........................................................................................................55
5.8 Advanced Node APIs ..........................................................................................................55
5.8.1 zwnode_mul_cmd_ctl_set........................................................................................55
5.8.2 zwnode_mul_cmd_ctl_get........................................................................................55
6 ENDPOINT API ................................................................................................................57
6.1 zwepd_t..............................................................................................................................57
6.2 zwep_get_node..................................................................................................................57
6.3 zwep_get_next...................................................................................................................58
6.4 zwep_get_if........................................................................................................................58
6.5 zwep_nameloc_set.............................................................................................................58
7 INTERFACE API ...............................................................................................................59
7.1 zwifd_t................................................................................................................................59
7.2 zwif_get_ep........................................................................................................................60
7.3 zwif_get_next.....................................................................................................................60
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page vii of xxviii
7.4 zwif_exec............................................................................................................................60
7.5 zwif_xxx_poll......................................................................................................................60
8 MANAGEMENT CCS BASED INTERFACES .........................................................................62
8.1 Group Interface API............................................................................................................62
8.1.1 zwif_group_sup_get .................................................................................................62
8.1.2 zwif_group_actv_get ................................................................................................62
8.1.3 zwif_group_get .........................................................................................................63
8.1.4 zwif_group_add ........................................................................................................63
8.1.5 zwif_group_del .........................................................................................................64
8.1.6 zwif_group_info_get.................................................................................................64
8.1.7 zwif_group_info_free................................................................................................65
8.2 Group Command Interface API ..........................................................................................65
8.2.1 zwif_group_cmd_sup_get.........................................................................................65
8.2.2 zwif_group_cmd_get ................................................................................................66
8.2.3 zwif_group_cmd_set.................................................................................................66
8.3 Battery Interface API..........................................................................................................67
8.3.1 zwif_battery_rpt_set ................................................................................................67
8.3.2 zwif_battery_get.......................................................................................................68
8.3.3 zwif_battery_health_rpt_set ....................................................................................68
8.3.4 zwif_battery_health_get...........................................................................................69
8.4 Time and Date Interface API...............................................................................................69
8.4.1 zwif_time_rpt_set.....................................................................................................69
8.4.2 zwif_time_get ...........................................................................................................70
8.4.3 zwif_date_rpt_set.....................................................................................................70
8.4.4 zwif_date_get ...........................................................................................................70
8.4.5 zwif_tz_dst_rpt_set ..................................................................................................70
8.4.6 zwif_tz_dst_get.........................................................................................................71
8.5 Firmware Update Interface API..........................................................................................71
8.5.1 zwif_fw_info_get ......................................................................................................71
8.5.2 zwif_fw_updt_req.....................................................................................................72
8.5.3 zwif_fw_updt_actv....................................................................................................75
8.5.4 zwif_fw_downld_req ................................................................................................75
8.6 Indicator Interface API........................................................................................................77
8.6.1 zwif_ind_rpt_set .......................................................................................................77
8.6.2 zwif_ind_get..............................................................................................................81
8.6.3 zwif_ind_set..............................................................................................................81
8.6.4 zwif_ind_sup_get......................................................................................................81
8.6.5 zwif_ind_sup_cache_get...........................................................................................82
8.6.6 zwif_ind_sup_free.....................................................................................................82
8.7 Wakeup Interface API.........................................................................................................82
8.7.1 zwif_wakeup_get ......................................................................................................82
8.7.2 zwif_wakeup_set ......................................................................................................83
8.8 Status Interface API............................................................................................................83
8.8.1 zwif_appl_busy_rpt_set............................................................................................83
8.8.2 zwif_appl_reject_rpt_set ..........................................................................................84
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page viii of xxviii
9 NETWORK CC BASED INTERFACES...................................................................................85
9.1 Z/IP Gateway Interface API ................................................................................................85
9.1.1 zwif_gw_mode_set ...................................................................................................85
9.1.2 zwif_gw_mode_get...................................................................................................86
9.1.3 zwif_gw_cfg_lock......................................................................................................86
9.1.4 zwif_gw_unsolicit_set...............................................................................................86
9.1.5 zwif_gw_unsolicit_get ..............................................................................................87
9.2 Z/IP Portal Interface API.....................................................................................................87
9.2.1 zwif_gw_cfg_set........................................................................................................87
9.2.2 zwif_gw_cfg_get .......................................................................................................88
9.3 Power Level Interface API ..................................................................................................88
9.3.1 zwif_power_level_rpt_set ........................................................................................88
9.3.2 zwif_power_level_get...............................................................................................88
9.3.3 zwif_power_level_set ...............................................................................................89
9.3.4 zwif_power_level_test_rpt_set ................................................................................89
9.3.5 zwif_power_level_test_get.......................................................................................89
9.3.6 zwif_power_level_test_set .......................................................................................90
10 APPLICATION CC BASED INTERFACES ..............................................................................91
10.1 Basic Interface API..............................................................................................................91
10.1.1 zwif_basic_rpt_set ....................................................................................................91
10.1.2 zwif_basic_get...........................................................................................................91
10.1.3 zwif_basic_set...........................................................................................................92
10.2 Switch Interface API ...........................................................................................................92
10.2.1 zwif_switch_rpt_set..................................................................................................92
10.2.2 zwif_switch_get ........................................................................................................93
10.2.3 zwif_switch_set.........................................................................................................93
10.2.4 zwif_switch_mset .....................................................................................................93
10.3 Level Interface API..............................................................................................................94
10.3.1 zwif_level_rpt_set.....................................................................................................94
10.3.2 zwif_level_sup_get ...................................................................................................95
10.3.3 zwif_level_sup_cache_get ........................................................................................95
10.3.4 zwif_level_get ...........................................................................................................96
10.3.5 zwif_level_set ...........................................................................................................96
10.3.6 zwif_level_mset ........................................................................................................96
10.3.7 zwif_level_start.........................................................................................................97
10.3.8 zwif_level_mstart......................................................................................................97
10.3.9 zwif_level_stop .........................................................................................................97
10.3.10 zwif_level_mstop ......................................................................................................97
10.4 Color Switch Interface API..................................................................................................98
10.4.1 zwif_color_sw_rpt_set..............................................................................................98
10.4.2 zwif_color_sw_get ....................................................................................................99
10.4.3 zwif_color_sw_set ....................................................................................................99
10.4.4 zwif_color_sw_start..................................................................................................99
10.4.5 zwif_color_sw_stop ................................................................................................100
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page ix of xxviii
10.4.6 zwif_color_sw_sup_get ..........................................................................................100
10.4.7 zwif_color_sw_sup_cache_get ...............................................................................100
10.5 Window Covering Interface API .......................................................................................101
10.5.1 zwif_wincvr_rpt_set................................................................................................101
10.5.2 zwif_wincvr_get......................................................................................................103
10.5.3 zwif_wincvr_set ......................................................................................................103
10.5.4 zwif_wincvr_mset ...................................................................................................103
10.5.5 zwif_wincvr_start....................................................................................................104
10.5.6 zwif_wincvr_mstart ................................................................................................104
10.5.7 zwif_wincvr_stop ....................................................................................................104
10.5.8 zwif_wincvr_mstop.................................................................................................104
10.5.9 zwif_wincvr_sup_get ..............................................................................................105
10.5.10 zwif_wincvr_sup_cache_get ...................................................................................105
10.6 Barrier Operator Interface API .........................................................................................105
10.6.1 zwif_barrier_rpt_set ...............................................................................................105
10.6.2 zwif_barrier_get......................................................................................................106
10.6.3 zwif_barrier_set......................................................................................................106
10.6.4 zwif_barrier_mset...................................................................................................107
10.6.5 zwif_barrier_notif_sup_get ....................................................................................107
10.6.6 zwif_barrier_notif_sup_cache_get .........................................................................107
10.6.7 zwif_barrier_notif_rpt_set......................................................................................108
10.6.8 zwif_barrier_notif_cfg_get .....................................................................................108
10.6.9 zwif_barrier_notif_cfg_set......................................................................................108
10.7 Sound Switch Interface API ..............................................................................................109
10.7.1 zwif_snd_switch_rpt_set ........................................................................................109
10.7.2 zwif_snd_switch_config_get...................................................................................110
10.7.3 zwif_snd_switch_config_set ...................................................................................110
10.7.4 zwif_snd_switch_tone_play_get ............................................................................110
10.7.5 zwif_snd_switch_tone_play_set.............................................................................110
10.7.6 zwif_snd_switch_tone_info_get.............................................................................111
10.8 Binary Sensor Interface API ..............................................................................................112
10.8.1 zwif_bsensor_rpt_set .............................................................................................112
10.8.2 zwif_bsensor_get....................................................................................................112
10.8.3 zwif_bsensor_sup_get ............................................................................................112
10.8.4 zwif_bsensor_sup_cache_get.................................................................................113
10.9 Alarm/Notification Interface API......................................................................................113
10.9.1 zwif_alrm_rpt_set...................................................................................................113
10.9.2 zwif_alrm_get .........................................................................................................124
10.9.3 zwif_alrm_set..........................................................................................................124
10.9.4 zwif_alrm_sup_get..................................................................................................125
10.9.5 zwif_alrm_sup_cache_get ......................................................................................125
10.9.6 zwif_alrm_sup_evt_get...........................................................................................125
10.9.7 zwif_alrm_sup_evt_cache_get ...............................................................................126
10.9.8 zwif_alrm_vtype_sup_get.......................................................................................126
10.10Alarm Sensor Interface API...............................................................................................126
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page x of xxviii
10.10.1 zwif_alrm_snsr_rpt_set ..........................................................................................126
10.10.2 zwif_alrm_snsr_get.................................................................................................127
10.10.3 zwif_alrm_snsr_sup_get .........................................................................................127
10.10.4 zwif_alrm_snsr_sup_cache_get..............................................................................128
10.11Sensor Interface API .........................................................................................................128
10.11.1 zwif_sensor_rpt_set................................................................................................128
10.11.2 zwif_sensor_get ......................................................................................................131
10.11.3 zwif_sensor_sup_get ..............................................................................................132
10.11.4 zwif_sensor_unit_get..............................................................................................132
10.11.5 zwif_sensor_unit_cache_get ..................................................................................133
10.11.6 zwif_sensor_sup_cache_get ...................................................................................133
10.12Central Scene Interface API ..............................................................................................133
10.12.1 zwif_csc_rpt_set .....................................................................................................133
10.12.2 zwif_csc_sup_get ....................................................................................................135
10.12.3 zwif_csc_cfg_rpt_set...............................................................................................136
10.12.4 zwif_csc_cfg_get .....................................................................................................136
10.12.5 zwif_csc_cfg_set .....................................................................................................136
10.13Pulse Meter Interface API.................................................................................................137
10.13.1 zwif_pulsemeter_rpt_set........................................................................................137
10.13.2 zwif_pulsemeter_get ..............................................................................................137
10.14Meter Interface API ..........................................................................................................137
10.14.1 zwif_meter_rpt_set ................................................................................................137
10.14.2 zwif_meter_get.......................................................................................................139
10.14.3 zwif_meter_sup_get ...............................................................................................139
10.14.4 zwif_meter_sup_cache_get....................................................................................140
10.14.5 zwif_meter_reset....................................................................................................140
10.14.6 zwif_meter_set_admin ...........................................................................................140
10.14.7 zwif_meter_get_desc..............................................................................................141
10.15Door Lock Interface API....................................................................................................141
10.15.1 zwif_dlck_op_rpt_set..............................................................................................141
10.15.2 zwif_dlck_op_get ....................................................................................................143
10.15.3 zwif_dlck_op_set ....................................................................................................143
10.15.4 zwif_dlck_op_mset .................................................................................................143
10.15.5 zwif_dlck_cfg_set....................................................................................................143
10.15.6 zwif_dlck_cfg_get ...................................................................................................144
10.15.7 zwif_dlck_cap_get...................................................................................................144
10.15.8 zwif_dlck_cap_cache_get .......................................................................................145
10.15.9 zwif_dlck_cap_free .................................................................................................146
10.16Door Lock Logging Interface API.......................................................................................146
10.16.1 zwif_lcklog_rpt_set .................................................................................................146
10.16.2 zwif_lcklog_get .......................................................................................................148
10.16.3 zwif_lcklog_sup_get................................................................................................148
10.16.4 zwif_lcklog_sup_cache_get ....................................................................................148
10.17User Code Interface API ...................................................................................................148
10.17.1 zwif_usrcod_rpt_set ...............................................................................................148
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xi of xxviii
10.17.2 zwif_usrcod_get......................................................................................................149
10.17.3 zwif_usrcod_set ......................................................................................................150
10.17.4 zwif_usrcod_sup_get ..............................................................................................150
10.17.5 zwif_usrcod_sup_cache_get...................................................................................150
10.17.6 zwif_usrcod_ext_rpt_set ........................................................................................150
10.17.7 zwif_usrcod_ext_get...............................................................................................151
10.17.8 zwif_usrcod_ext_set ...............................................................................................151
10.17.9 zwif_usrcod_cap_get ..............................................................................................152
10.17.10 zwif_usrcod_cap_cache_get...................................................................................152
10.17.11 zwif_usrcod_kp_mod_rpt_set ................................................................................153
10.17.12 zwif_usrcod_kp_mod_get.......................................................................................153
10.17.13 zwif_usrcod_kp_mod_set .......................................................................................154
10.17.14 zwif_usrcod_ms_cod_rpt_set.................................................................................154
10.17.15 zwif_usrcod_ms_cod_get .......................................................................................154
10.17.16 zwif_usrcod_ms_cod_set........................................................................................154
10.17.17 zwif_usrcod_chksum_rpt_set .................................................................................155
10.17.18 zwif_usrcod_chksum_get .......................................................................................155
10.18Thermostat Fan Mode Interface API ................................................................................155
10.18.1 zwif_thrmo_fan_md_rpt_set..................................................................................155
10.18.2 zwif_thrmo_fan_md_get ........................................................................................156
10.18.3 zwif_thrmo_fan_md_set.........................................................................................157
10.18.4 zwif_thrmo_fan_md_sup_get.................................................................................157
10.18.5 zwif_thrmo_fan_md_sup_cache_get .....................................................................157
10.19Thermostat Fan State Interface API .................................................................................158
10.19.1 zwif_thrmo_fan_sta_rpt_set ..................................................................................158
10.19.2 zwif_thrmo_fan_sta_get.........................................................................................158
10.20Thermostat Mode Interface API.......................................................................................158
10.20.1 zwif_thrmo_md_rpt_set.........................................................................................159
10.20.2 zwif_thrmo_md_get ...............................................................................................160
10.20.3 zwif_thrmo_md_set................................................................................................160
10.20.4 zwif_thrmo_md_sup_get........................................................................................160
10.20.5 zwif_thrmo_md_sup_cache_get ............................................................................161
10.21Thermostat Operating State Interface API .......................................................................161
10.21.1 zwif_thrmo_op_sta_rpt_set ...................................................................................161
10.21.2 zwif_thrmo_op_sta_get..........................................................................................162
10.21.3 zwif_thrmo_op_sta_log_sup_get ...........................................................................162
10.21.4 zwif_thrmo_op_sta_log_sup_cache_get................................................................162
10.21.5 zwif_thrmo_op_sta_log_rpt_set ............................................................................162
10.21.6 zwif_thrmo_op_sta_log_get...................................................................................163
10.22Thermostat Setback Interface API....................................................................................163
10.22.1 zwif_thrmo_setb_rpt_set .......................................................................................164
10.22.2 zwif_thrmo_setb_get..............................................................................................164
10.22.3 zwif_thrmo_setb_set ..............................................................................................164
10.23Thermostat Setpoint Interface API...................................................................................165
10.23.1 zwif_thrmo_setp_rpt_set .......................................................................................165
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xii of xxviii
10.23.2 zwif_thrmo_setp_get..............................................................................................166
10.23.3 zwif_thrmo_setp_set ..............................................................................................166
10.23.4 zwif_thrmo_setp_sup_get ......................................................................................166
10.23.5 zwif_thrmo_setp_sup_cache_get...........................................................................167
10.23.6 zwif_thrmo_setp_sup_range_get...........................................................................167
10.23.7 zwif_thrmo_setp_sup_range_cache_get................................................................167
10.24Configuration Interface API ..............................................................................................168
10.24.1 zwif_config_rpt_set ................................................................................................168
10.24.2 zwif_config_get.......................................................................................................168
10.24.3 zwif_config_set .......................................................................................................168
10.24.4 zwif_config_bulk_rpt_set........................................................................................169
10.24.5 zwif_config_bulk_get ..............................................................................................170
10.24.6 zwif_config_bulk_set ..............................................................................................170
10.24.7 zwif_config_prm_reset ...........................................................................................170
10.24.8 zwif_config_info_get...............................................................................................170
10.24.9 zwif_config_info_free .............................................................................................172
10.25Clock Interface API ...........................................................................................................172
10.25.1 zwif_clock_rpt_set ..................................................................................................172
10.25.2 zwif_clock_get ........................................................................................................172
10.25.3 zwif_clock_set.........................................................................................................173
10.26Climate Control Schedule Interface API ...........................................................................173
10.26.1 zwif_clmt_ctl_schd_rpt_set....................................................................................173
10.26.2 zwif_clmt_ctl_schd_get ..........................................................................................174
10.26.3 zwif_clmt_ctl_schd_set...........................................................................................174
10.26.4 zwif_clmt_ctl_schd_chg_rpt_set ............................................................................174
10.26.5 zwif_clmt_ctl_schd_chg_get...................................................................................174
10.26.6 zwif_clmt_ctl_schd_ovr_rpt_set.............................................................................175
10.26.7 zwif_clmt_ctl_schd_ovr_get ...................................................................................175
10.26.8 zwif_clmt_ctl_schd_ovr_set ...................................................................................175
10.27AV Interface API ...............................................................................................................175
10.27.1 zwif_av_set .............................................................................................................176
10.27.2 zwif_av_caps...........................................................................................................176
10.28Protection Interface API ...................................................................................................176
10.28.1 zwif_prot_rpt_set ...................................................................................................176
10.28.2 zwif_prot_get..........................................................................................................177
10.28.3 zwif_prot_set ..........................................................................................................177
10.28.4 zwif_prot_sup_get ..................................................................................................178
10.28.5 zwif_prot_sup_cache_get.......................................................................................178
10.28.6 zwif_prot_ec_rpt_set..............................................................................................178
10.28.7 zwif_prot_ec_get ....................................................................................................179
10.28.8 zwif_prot_ec_set ....................................................................................................179
10.28.9 zwif_prot_tmout_rpt_set .......................................................................................179
10.28.10 zwif_prot_tmout_get..............................................................................................180
10.28.11 zwif_prot_tmout_set ..............................................................................................180
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xiii of xxviii
11 DEVICE DATABASE FILE FORMAT ..................................................................................181
12 HOME NETWORK FILE FORMAT ....................................................................................189
12.1 Introduction......................................................................................................................189
12.2 Top Level Entities .............................................................................................................189
12.3 Network............................................................................................................................189
12.4 Nodes ...............................................................................................................................190
12.5 Endpoints .........................................................................................................................191
12.6 Interfaces..........................................................................................................................192
12.6.1 Association Group Info CC ......................................................................................192
12.6.2 Configuration CC .....................................................................................................192
12.6.3 Association and Multi Channel Association CC .......................................................193
12.6.4 Central Scene CC .....................................................................................................194
12.6.5 Multi Level Sensor CC..............................................................................................194
12.6.6 Indicator CC.............................................................................................................195
12.6.7 Thermostat Fan Mode CC .......................................................................................196
12.6.8 Thermostat Mode CC..............................................................................................196
12.6.9 Thermostat Setpoint CC..........................................................................................196
12.6.10 Thermostat Operating State CC ..............................................................................198
12.6.11 Thermostat Fan State CC ........................................................................................198
12.6.12 Multi Level Switch CC..............................................................................................199
12.6.13 Binary Switch CC .....................................................................................................199
12.6.14 Binary Sensor CC .....................................................................................................200
12.6.15 Simple AV Control CC ..............................................................................................200
12.6.16 Alarm or Notification CC .........................................................................................200
12.6.17 Protection CC ..........................................................................................................201
12.6.18 User Code CC...........................................................................................................203
12.6.19 Meter CC .................................................................................................................203
12.6.20 Meter Table Monitor CC .........................................................................................204
12.6.21 Door Lock CC ...........................................................................................................205
12.6.22 Door Lock Logging CC..............................................................................................207
12.6.23 Alarm Sensor CC......................................................................................................207
12.6.24 Barrier Operator CC ................................................................................................207
12.6.25 Color Switch CC .......................................................................................................208
12.6.26 Sound Switch CC .....................................................................................................208
12.6.27 Window Covering CC...............................................................................................209
12.6.28 Battery CC ...............................................................................................................210
12.6.29 Basic CC ...................................................................................................................211
REFERENCES .......................................................................................................................212
Table 1 – Error Codes, ZW_ERR_XXX .............................................................................................2
Table of Tables
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xiv of xxviii
Table 2 – Low-Level Library Error Codes........................................................................................3
Table 3 – zwdev_cfg_load Parameters ..........................................................................................5
Table 4 – dev_rec_t Structure .......................................................................................................5
Table 5 – DEV_XXX Meaning and Values .......................................................................................5
Table 6 – ep_rec_t Structure .........................................................................................................6
Table 7 – redir_rec_t Structure .....................................................................................................6
Table 8 – if_rec_t Structure ...........................................................................................................6
Table 9 – Interface Types: IF_REC_TYPE_XXX................................................................................7
Table 10 – rec Union......................................................................................................................7
Table 11 – if_rec_grp_t Structure..................................................................................................7
Table 12 – if_rec_config_t Structure .............................................................................................8
Table 13 – if_rec_cfg_set_t Structure............................................................................................8
Table 14 – if_rec_cfg_info_t Structure ..........................................................................................8
Table 15 – if_rec_bsnsr_t Structure ..............................................................................................8
Table 16 – if_rec_bsnsr_match_t Structure ..................................................................................9
Table 17 – Table 18 – if_rec_snsr_t Structure ...............................................................................9
Table 19 – if_rec_meter_t Structure .............................................................................................9
Table 20 – if_rec_alarm_match_t Structure..................................................................................9
Table 21 – if_rec_alarm_result_t Structure.................................................................................10
Table 22 – if_rec_alarm_rev_match_t Structure.........................................................................10
Table 23 – if_rec_basic_match_t Structure.................................................................................10
Table 24 – if_rec_alrm_snsr_match_t Structure .........................................................................10
Table 25 – zwsetp_temp_range_t Structure ...............................................................................11
Table 26 – if_rec_dlck_t Structure...............................................................................................11
Table 27 – if_rec_mcmd_t Structure ...........................................................................................11
Table 28 – Binary Sensor Types: ZW_BSENSOR_TYPE_XXX.........................................................11
Table 29 – Multi-Level Sensor Type: ZW_SENSOR_TYPE_XXX.....................................................12
Table 30 – Multi-Level Sensor Unit..............................................................................................14
Table 31 – Meter Type.................................................................................................................17
Table 32 – Meter Supported Unit Bit-Mask.................................................................................17
Table 33 – Z-Wave Alarm/Notification Type ...............................................................................17
Table 34 – Z-Wave Alarm/Notification Event ..............................................................................18
Table 35 – Z-Wave Alarm/Notification Event Parameter Type....................................................24
Table 36 – Alarm Sensor Type .....................................................................................................24
Table 37 – Thermostat Setpoint Types: ZW_THRMO_SETP_TYP_XXX ........................................24
Table 38 – Thermostat Setpoint Unit ..........................................................................................25
Table 39 – Door Lock Operation Mode........................................................................................25
Table 40 – Door lock Operation Type ..........................................................................................25
Table 41 – dev_cfg_error_t Structure .........................................................................................25
Table 42 – zwdev_cfg_free Parameters ......................................................................................26
Table 43 – zwdev_global_sett_free Parameters .........................................................................26
Table 44 – zwdev_cfg_find Parameters.......................................................................................26
Table 45 – dev_rec_srch_key_t Structure ...................................................................................26
Table 46 – zwnet_gw_discvr_start Parameters...........................................................................27
Table 47 – zwnet_gw_discvr_cb_t Parameters ...........................................................................27
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xv of xxviii
Table 48 – zwnet_gw_discvr_stop Parameters ...........................................................................28
Table 49 – zwnet_init Parameters ...............................................................................................28
Table 50 – zwnet_init_t Structure ...............................................................................................28
Table 51 – dev_cfg_usr_t Structure.............................................................................................30
Table 52 – zwnet_dev_rec_find_fn Parameters..........................................................................30
Table 53 – dev_global_sett_t Structure ......................................................................................30
Table 54 – zwnet_xxx Generic Parameters..................................................................................31
Table 55 – zwnet_unhandled_cmd_fn Parameters.....................................................................31
Table 56 – sup_cmd_cls_t Structure ...........................................................................................31
Table 57 – zwnet_notify_fn Parameters......................................................................................31
Table 58 – zwnet_sts_t Structure ................................................................................................33
Table 59 – NW_CHG_UPDT_XXX .................................................................................................34
Table 60 – zw_health_prg_t Structure ........................................................................................34
Table 61 – zw_health_rpt_t Structure.........................................................................................34
Table 62 – zw_health_sts_t Structure .........................................................................................34
Table 63 – Additional Information Associated to Network Op and Status..................................35
Table 64 – zwnet_node_fn Parameters.......................................................................................35
Table 65 – zwnet_appl_fn Parameters ........................................................................................35
Table 66 – pl_info_fn Parameters ...............................................................................................36
Table 67 – zwnet_net_err_fn Parameters...................................................................................36
Table 68 – print_fn Parameter ....................................................................................................36
Table 69 – zwnet_dev_rec_find_fn Parameter ...........................................................................36
Table 70 – zwnet_exit Parameters ..............................................................................................36
Table 71 – zwnet_add Parameters ..............................................................................................37
Table 72 – sec2_add_prm_t Structure ........................................................................................37
Table 73 – add_node_sec2_fn Parameters .................................................................................37
Table 74 – sec2_add_cb_prm_t Structure...................................................................................37
Table 75 – sec2_keys_req_cb_prm_t Structure ..........................................................................38
Table 76 – sec2_dsk_cb_prm_t Structure ...................................................................................38
Table 77 – zwnet_add_sec2_accept Parameters ........................................................................38
Table 78 – zwnet_add_sec2_grant_key Parameters...................................................................39
Table 79 – zwnet_pl_add Parameters .........................................................................................39
Table 80 – pl_info_t Structure .....................................................................................................39
Table 81 – pl_prod_type_t Structure ..........................................................................................41
Table 82 – pl_prod_id_t Structure...............................................................................................41
Table 83 – pl_uuid_t Structure ....................................................................................................41
Table 84 – pl_nw_sts_t Structure................................................................................................42
Table 85 – zwnet_pl_get Parameters ..........................................................................................42
Table 86 – pl_info_fn Parameters ...............................................................................................42
Table 87 – pl_lst_ent_t Structure ................................................................................................42
Table 88 – zwnet_pl_del Parameters ..........................................................................................43
Table 89 – zwnet_pl_list_get Parameters ...................................................................................43
Table 90 – pl_list_fn Parameters .................................................................................................43
Table 91 – zwnet_pl_list_del Parameters....................................................................................43
Table 92 – zwnet_initiate Parameters.........................................................................................44
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xvi of xxviii
Table 93 – zwnet_fail Parameters ...............................................................................................44
Table 94 – zwnet_get_desc Parameters......................................................................................45
Table 95 – zwnetd_t Structure ....................................................................................................45
Table 96 – zwnet_version Parameters ........................................................................................46
Table 97 – zwnet_get_node Parameters.....................................................................................46
Table 98 – zwnet_get_node_by_id Parameters ..........................................................................46
Table 99 – zwnet_get_ep_by_id Parameters ..............................................................................46
Table 100 – zwnet_get_if_by_id Parameters ..............................................................................47
Table 101 – zwnet_all_node_sts_get Parameters.......................................................................47
Table 102 – zwnet_node_sts_get Parameters ............................................................................47
Table 103 – zwnet_initiate_classic Parameters...........................................................................48
Table 104 – zwnet_get_user Parameters ....................................................................................48
Table 105 – zwnet_send_nif Parameters ....................................................................................49
Table 106 – zwnet_poll_rm Parameters......................................................................................49
Table 107 – zwnet_poll_rm_mul Parameters..............................................................................49
Table 108 – zwnet_pref_set Parameters.....................................................................................49
Table 109 – zwnet_pref_get Parameters ....................................................................................49
Table 110 – zwnet_client_pref_set Parameters..........................................................................50
Table 111 – zwnet_client_pref_get Parameters..........................................................................50
Table 112 – zwnet_sec2_get_dsk Parameters ............................................................................50
Table 113 – get_dsk_fn Parameters ............................................................................................50
Table 114 – zwnet_ip_aton Parameters......................................................................................51
Table 115 – zwnet_ip_ntoa Parameters......................................................................................51
Table 116 – zwnet_local_addr_get Parameters ..........................................................................51
Table 117 – zwnet_listen_port_get Parameters .........................................................................51
Table 118 – zwnoded_t Structure ...............................................................................................52
Table 119 – NODE_PROPTY_XXX .................................................................................................52
Table 120 – dev_id_t Structure ...................................................................................................53
Table 121 – zwsw_ver_t Structure ..............................................................................................53
Table 122 – zwnode_get_net Parameters...................................................................................53
Table 123 – zwnode_get_next Parameters .................................................................................54
Table 124 – zwnode_get_ep Parameters ....................................................................................54
Table 125 – zwnode_update Parameters....................................................................................54
Table 126 – zwnode_identify Parameters ...................................................................................54
Table 127 – zwnode_get_ext_ver Parameters ............................................................................55
Table 128 – ext_ver_t Structure ..................................................................................................55
Table 129 – zwnode_mul_cmd_ctl_set Parameters....................................................................55
Table 130 – zwnode_mul_cmd_ctl_get Parameters ...................................................................55
Table 131 – zwepd_t Structure....................................................................................................57
Table 132 – zwplus_info_t structure ...........................................................................................57
Table 133 – zwep_get_node Parameters ....................................................................................57
Table 134 – zwep_get_next Parameters .....................................................................................58
Table 135 – zwep_get_if Parameters ..........................................................................................58
Table 136 – zwep_nameloc_set Parameters...............................................................................58
Table 137 – zw_nameloc_t Structure ..........................................................................................58
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xvii of xxviii
Table 138 – zwifd_t Structure......................................................................................................59
Table 139 – zwif_get_ep Parameters ..........................................................................................60
Table 140 – zwif_get_next Parameters .......................................................................................60
Table 141 – zwif_exec Parameters ..............................................................................................60
Table 142 – zwif_xxx_poll Parameters ........................................................................................60
Table 143 – zwpoll_req_t Structure ............................................................................................61
Table 144 – zwpoll_cmplt_fn Parameters ...................................................................................61
Table 145 – zwif_group_sup_get Parameters .............................................................................62
Table 146 – zwrep_group_sup_fn Parameters............................................................................62
Table 147 – zwif_group_actv_get Parameters ............................................................................62
Table 148 – zwrep_group_actv_fn Parameters...........................................................................62
Table 149 – zwif_group_get Parameters.....................................................................................63
Table 150 – zwrep_group_fn Parameters ...................................................................................63
Table 151 – grp_member_t structure .........................................................................................63
Table 152 – zwif_group_add Parameters....................................................................................63
Table 153 – zwif_grp_rr_fn Parameters ......................................................................................64
Table 154 – RRA_XXX...................................................................................................................64
Table 155 – zwif_group_del Parameters .....................................................................................64
Table 156 – zwif_group_info_get Parameters.............................................................................64
Table 157 – if_grp_info_dat_t Structure .....................................................................................64
Table 158 – zw_grp_info_t Structure ..........................................................................................65
Table 159 – grp_cmd_ent_t Structure.........................................................................................65
Table 160 – zwif_group_info_free Parameters ...........................................................................65
Table 161 – zwif_group_cmd_sup_get Parameters ....................................................................65
Table 162 – zwrep_grp_cmd_sup_fn Parameters .......................................................................65
Table 163 – zwgrp_cmd_cap_t structure ....................................................................................66
Table 164 – zwif_group_cmd_get Parameters............................................................................66
Table 165 – zwrep_grp_cmd_fn Parameters...............................................................................66
Table 166 – zwif_group_cmd_set Parameters ............................................................................66
Table 167 – zwif_battery_rpt_set Parameters ............................................................................67
Table 168 – zwrep_batt_lvl_fn Parameters.................................................................................67
Table 169 – zwbatt_dat_t Structure............................................................................................67
Table 170 – BATT_STS_XXX .........................................................................................................68
Table 171 – BATT_RECHG_XXX....................................................................................................68
Table 172 – BATT_LO_TEMP_XXX ...............................................................................................68
Table 173 – zwif_battery_get Parameters...................................................................................68
Table 174 – zwif_battery_health_rpt_set Parameters................................................................68
Table 175 – zwrep_batt_health_fn Parameters ..........................................................................68
Table 176 – zwbatt_health_t Structure.......................................................................................68
Table 177 – zwif_battery_health_get Parameters ......................................................................69
Table 178 – zwif_time_rpt_set Parameters ................................................................................69
Table 179 – zwrep_time_fn Parameters......................................................................................69
Table 180 – zwif_time_get Parameters.......................................................................................70
Table 181 – zwif_date_rpt_set Parameters.................................................................................70
Table 182 – zwrep_date_fn Parameters......................................................................................70
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xviii of xxviii
Table 183 – zwif_date_get Parameters .......................................................................................70
Table 184 – zwif_tz_dst_rpt_set Parameters ..............................................................................70
Table 185 – zwrep_tz_dst_fn Parameters ...................................................................................70
Table 186 – tmzone_info_t Structure..........................................................................................70
Table 187 – dst_info_t Structure .................................................................................................71
Table 188 – zwif_tz_dst_get Parameters ....................................................................................71
Table 189 – zwif_fw_info_get Parameters ..................................................................................71
Table 190 – zwrep_fw_info_fn Parameters.................................................................................71
Table 191 – zwfw_info_t structure..............................................................................................72
Table 192 – zwif_fw_updt_req Parameters ................................................................................72
Table 193 – zwfw_updt_req_t Structure.....................................................................................72
Table 194 – zwrep_fw_updt_sts_fn Parameters.........................................................................73
Table 195 – ZW_FW_UPDT_ERR_XXX .........................................................................................73
Table 196 – zwrep_fw_updt_cmplt_fn Parameters ....................................................................73
Table 197 – ZW_FW_UPDT_CMPLT_XXX.....................................................................................74
Table 198 – zwrep_fw_tgt_restart_fn Parameters......................................................................74
Table 199 – ZW_FW_UPDT_RESTART_XXX .................................................................................74
Table 200 – zwif_fw_updt_actv Parameters ...............................................................................75
Table 201 – zwrep_fw_actv_fn Parameters ................................................................................75
Table 202 – zwfw_actv_sts_t Structure.......................................................................................75
Table 203 – ZW_FW_ACTV_STS_XXX ..........................................................................................75
Table 204 – zwif_fw_downld_req Parameters ............................................................................75
Table 205 – zwfw_downld_req_t Structure ................................................................................76
Table 206 – zwfw_downld_sts_fn Parameters............................................................................76
Table 207 – ZW_FW_DL_RQ_XXX................................................................................................76
Table 208 – zwfw_downld_cmplt_fn Parameters .......................................................................76
Table 209 – ZW_FW_DL_CMPLT_XXX .........................................................................................76
Table 210 – zwif_ind_rpt_set Parameters...................................................................................77
Table 211 – zwrep_ind_fn Parameters........................................................................................77
Table 212 – zwind_data_t Structure............................................................................................77
Table 213 – zwind_propty_val_t Structure .................................................................................78
Table 214 – ZWIND_ID_XXX.........................................................................................................78
Table 215 – ZWIND_PPTY_ID_XXX...............................................................................................80
Table 216 – zwif_ind_get Parameters .........................................................................................81
Table 217 – zwif_ind_set Parameters..........................................................................................81
Table 218 – zwif_ind_sup_get Parameters..................................................................................81
Table 219 – zwrep_ind_sup_fn Parameters ................................................................................82
Table 220 – zwind_sup_t Structure .............................................................................................82
Table 221 – zwif_ind_sup_cache_get Parameters ......................................................................82
Table 222 – zwif_ind_sup_free Parameters ................................................................................82
Table 223 – zwif_wakeup_get Parameters..................................................................................82
Table 224 – zwrep_wakeup_fn Parameters ................................................................................83
Table 225 – zwif_wakeup_t Structure .........................................................................................83
Table 226 – zwif_wakeup_set Parameters ..................................................................................83
Table 227 – zwif_appl_busy_rpt_set Parameters .......................................................................83
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xix of xxviii
Table 228 – zwrep_appl_busy_fn Parameters ............................................................................83
Table 229 – ZW_BSY_STS_XXX ....................................................................................................84
Table 230 – zwif_appl_reject_rpt_set Parameters......................................................................84
Table 231 – zwrep_appl_reject_fn Parameters...........................................................................84
Table 232 – ZW_RJ_STS_XXX .......................................................................................................84
Table 233 – zwif_gw_mode_set Parameters...............................................................................85
Table 234 – zwgw_portal_prof_t structure .................................................................................85
Table 235 – zwif_gw_mode_get Parameters ..............................................................................86
Table 236 – zwrep_gw_mode_fn Parameters.............................................................................86
Table 237 – zwif_gw_mode_get Parameters ..............................................................................86
Table 238 – zwif_gw_unsolicit_set Parameters ..........................................................................86
Table 239 – zwif_gw_unsolicit_get Parameters ..........................................................................87
Table 240 – zwrep_gw_unsolicit_fn Parameters.........................................................................87
Table 241 – zwif_gw_cfg_set Parameters ...................................................................................87
Table 242 – zwportal_cfg_t Structure .........................................................................................87
Table 243 – zwrep_cfg_sts_fn Parameters..................................................................................87
Table 244 – zwif_gw_mode_get Parameters ..............................................................................88
Table 245 – zwrep_gw_cfg_fn Parameters .................................................................................88
Table 246 – zwif_power_level_rpt_set Parameters ...................................................................88
Table 247 – zwrep_power_level_fn Parameters .........................................................................88
Table 248 – zwif_power_level_get Parameters ..........................................................................88
Table 249 – zwif_power_level_set Parameters...........................................................................89
Table 250 – zwif_power_level_test_rpt_set Parameters ...........................................................89
Table 251 – zwrep_power_level_test_fn Parameters.................................................................89
Table 252 – POWERLEVEL_TEST_XXX ..........................................................................................89
Table 253 – zwif_power_level_test_get Parameters ..................................................................89
Table 254 – zwif_power_level_test_set Parameters...................................................................90
Table 255 – zwif_basic_rpt_set Parameters...............................................................................91
Table 256 – zwrep_basic_fn Parameters.....................................................................................91
Table 257 – zwbasic_t Structure..................................................................................................91
Table 258 – zwif_basic_get Parameters ......................................................................................91
Table 259 – zwif_basic_set Parameters.......................................................................................92
Table 260 – zwif_switch_rpt_set Parameters .............................................................................92
Table 261 – zwrep_switch_fn Parameters...................................................................................92
Table 262 – zwswitch_t Structure ...............................................................................................92
Table 263 – zwif_switch_get Parameters....................................................................................93
Table 264 – ZWIF_GET_BMSK_XXX .............................................................................................93
Table 265 – zwif_switch_set Parameters ....................................................................................93
Table 266 – zwif_switch_mset Parameters .................................................................................93
Table 267 – zw_postset_fn Parameters ......................................................................................94
Table 268 – zwif_level_rpt_set Parameters ................................................................................94
Table 269 – zwrep_level_fn Parameters .....................................................................................94
Table 270 – zwlevel_dat_t structure ...........................................................................................94
Table 271 – zwif_level_sup_get Parameters ...............................................................................95
Table 272 – zwrep_lvl_sup_fn Parameters..................................................................................95
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xx of xxviii
Table 273 – zwif_level_sup_cache_get Parameters....................................................................95
Table 274 – zwif_level_get Parameters.......................................................................................96
Table 275 – zwif_level_set Parameters .......................................................................................96
Table 276 – zwif_level_mset Parameters....................................................................................96
Table 277 – zwif_level_start Parameters ....................................................................................97
Table 278 – zwlevel_t structure...................................................................................................97
Table 279 – zwif_level_mstart Parameters .................................................................................97
Table 280 – zwif_level_stop Parameters.....................................................................................97
Table 281 – zwif_level_mstop Parameters..................................................................................98
Table 282 – zwif_color_sw_rpt_set Parameters .........................................................................98
Table 283 – zwrep_color_sw_get_fn Parameters .......................................................................98
Table 284 – zwcolor_t Structure..................................................................................................98
Table 285 – COL_SW_COMP_ID_XXX ..........................................................................................98
Table 286 – zwif_color_sw_get Parameters................................................................................99
Table 287 – zwif_color_sw_set Parameters ................................................................................99
Table 288 – zwif_color_sw_start Parameters..............................................................................99
Table 289 – zwcol_ctl_t structure...............................................................................................99
Table 290 – COL_SW_LVL_XXX ..................................................................................................100
Table 291 – zwif_color_sw_stop Parameters............................................................................100
Table 292 – zwif_color_sw_sup_get Parameters ......................................................................100
Table 293 – zwrep_color_sw_sup_fn Parameters.....................................................................100
Table 294 – zwif_color_sw_sup_cache_get Parameters...........................................................100
Table 295 – zwif_wincvr_rpt_set Parameters ...........................................................................101
Table 296 – zwrep_wincvr_fn Parameters ................................................................................101
Table 297 – wincvr_dat_t Structure ..........................................................................................101
Table 298 – WIN_COVER_ID_XXX..............................................................................................101
Table 299 – zwif_wincvr_get Parameters..................................................................................103
Table 300 – zwif_wincvr_set Parameters ..................................................................................103
Table 301 – zwif_wincvr_mset Parameters...............................................................................103
Table 302 – zwif_wincvr_start Parameters ...............................................................................104
Table 303 – zwif_wincvr_mstart Parameters ............................................................................104
Table 304 – zwif_wincvr_stop Parameters................................................................................104
Table 305 – zwif_wincvr_mstop Parameters.............................................................................105
Table 306 – zwif_wincvr_sup_get Parameters ..........................................................................105
Table 307 – zwrep_wincvr_sup_fn Parameters.........................................................................105
Table 308 – zwif_wincvr_sup_cache_get Parameters...............................................................105
Table 309 – zwif_barrier_rpt_set Parameters...........................................................................105
Table 310 – zwrep_barrier_fn Parameters................................................................................106
Table 311 – ZW_BAR_STA_XXX .................................................................................................106
Table 312 – zwif_barrier_get Parameters .................................................................................106
Table 313 – zwif_barrier_set Parameters..................................................................................106
Table 314 – zwif_barrier_mset Parameters ..............................................................................107
Table 315 – zwif_barrier_notif_sup_get Parameters ................................................................107
Table 316 – zwrep_barrier_notif_sup_fn Parameters...............................................................107
Table 317 – ZW_BAR_NOTIF_TYP_XXX......................................................................................107
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xxi of xxviii
Table 318 – zwif_barrier_notif_sup_cache_get Parameters.....................................................107
Table 319 – zwif_barrier_notif_rpt_set Parameters .................................................................108
Table 320 – zwrep_barrier_subsys_fn Parameters ...................................................................108
Table 321 – zwif_barrier_notif_cfg_get Parameters .................................................................108
Table 322 – zwif_barrier_notif_cfg_set Parameters .................................................................108
Table 323 – zwif_snd_switch_rpt_set Parameters....................................................................109
Table 324 – zwrep_snd_switch_config_fn Parameters .............................................................109
Table 325 – zwrep_snd_switch_tone_play_fn Parameters.......................................................109
Table 326 – zwif_snd_switch_config_get Parameters ..............................................................110
Table 327 – zwif_snd_switch_config_set Parameters...............................................................110
Table 328 – zwif_snd_switch_tone_play_get Parameters ........................................................110
Table 329 – zwif_snd_switch_tone_play_set Parameters ........................................................110
Table 330 – zwif_snd_switch_tone_info_get Parameters.........................................................111
Table 331 – zwrep_snd_switch_tone_info_fn Parameters .......................................................111
Table 332 – zwsnd_switch_tone_info_t Structure ....................................................................111
Table 333 – if_snd_switch_tone_info_t Structure ....................................................................111
Table 334 – zwif_bsensor_rpt_set Parameters .........................................................................112
Table 335 – zwrep_bsensor_fn Parameters ..............................................................................112
Table 336 – zwif_bsensor_get Parameters................................................................................112
Table 337 – zwif_bsensor_sup_get Parameters........................................................................112
Table 338 – zwrep_bsensor_sup_fn Parameters ......................................................................112
Table 339 – zwif_bsensor_sup_cache_get Parameters.............................................................113
Table 340 – zwif_alrm_rpt_set Parameters..............................................................................113
Table 341 – zwrep_alrm_fn Parameters....................................................................................113
Table 342 – zwalrm_t Structure................................................................................................113
Table 343 – ZW_ALRM_STS_XXX...............................................................................................114
Table 344 – ZW_ALRM_XXX ......................................................................................................114
Table 345 – ZW_ALRM_EVT_XXX ..............................................................................................115
Table 346 – zwif_alrm_get Parameters .....................................................................................124
Table 347 – zwif_alrm_set Parameters .....................................................................................124
Table 348 – zwif_alrm_sup_get Parameters ............................................................................125
Table 349 – zwrep_alrm_sup_fn Parameters...........................................................................125
Table 350 – zwif_alrm_sup_cache_get Parameters ..................................................................125
Table 351 – zwif_alrm_sup_evt_get Parameters .....................................................................125
Table 352 – zwrep_alrm_evt_fn Parameters............................................................................126
Table 353 – zwif_alrm_sup_evt_cache_get Parameters...........................................................126
Table 354 – zwif_alrm_vtype_sup_get Parameters .................................................................126
Table 355 – zwif_alrm_snsr_rpt_set Parameters ......................................................................126
Table 356 – zwrep_alrm_snsr_fn Parameters ...........................................................................127
Table 357 – zw_alrm_snsr_t Structure .....................................................................................127
Table 358 – ZW_ALRM_SNSR_TYPE_XXX ..................................................................................127
Table 359 – zwif_alrm_snsr_get Parameters ............................................................................127
Table 360 – zwif_alrm_snsr_sup_get Parameters.....................................................................127
Table 361 – zwrep_alrm_snsr_sup_fn Parameters ...................................................................128
Table 362 – zwif_alrm_snsr_sup_cache_get Parameters .........................................................128
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xxii of xxviii
Table 363 – zwif_sensor_rpt_set Parameters ...........................................................................128
Table 364 – zwrep_sensor_fn Parameters ................................................................................128
Table 365 – zwsensor_t Structure .............................................................................................129
Table 366 – ZW_SENSOR_TYPE_XXX, ZW_SENSOR_UNIT_XXX_YYY .........................................129
Table 367 – zwif_sensor_get Parameters..................................................................................131
Table 368 – zwif_sensor_sup_get Parameters ..........................................................................132
Table 369 – zwrep_sensor_sup_fn Parameters.........................................................................132
Table 370 – zwif_sensor_unit_get Parameters .........................................................................132
Table 371 – zwrep_sensor_unit_fn Parameters........................................................................132
Table 372 – zwif_sensor_unit_cache_get Parameters ..............................................................133
Table 373 – zwif_sensor_sup_cache_get Parameters...............................................................133
Table 374 – if_sensor_data_t Structure ....................................................................................133
Table 375 – zwif_csc_rpt_set Parameters .................................................................................133
Table 376 – zwrep_csc_fn Parameters ......................................................................................134
Table 377 – zwcsc_notif_t Structure ........................................................................................134
Table 378 – ZW_CSC_KEY_ATTRIB_XXX.....................................................................................134
Table 379– zwif_csc_sup_get Parameters.................................................................................135
Table 380 – zwrep_csc_sup_fn Parameters ..............................................................................135
Table 381– zwif_csc_cfg_rpt_set Parameters ...........................................................................136
Table 382 – zwrep_csc_cfg_fn Parameters ...............................................................................136
Table 383– zwif_csc_cfg_get Parameters..................................................................................136
Table 384– zwif_csc_cfg_set Parameters..................................................................................136
Table 385 – zwif_pulsemeter_rpt_set Parameters...................................................................137
Table 386 – zwrep_pulsemeter_fn Parameters........................................................................137
Table 387 – zwif_pulsemeter_get Parameters..........................................................................137
Table 388 – zwif_meter_rpt_set Parameters ...........................................................................137
Table 389 – zwrep_meter_fn Parameters .................................................................................137
Table 390 – zwmeter_dat_t Structure.......................................................................................138
Table 391 – ZW_METER_TYPE_XXX and ZW_METER_UNIT_XXX ..............................................138
Table 392 – zwif_meter_get Parameters ..................................................................................139
Table 393 – zwif_meter_sup_get Parameters...........................................................................139
Table 394 – zwrep_meter_sup_fn Parameters .........................................................................139
Table 395 – zwmeter_cap_t Structure ......................................................................................139
Table 396 – ZW_METER_SUP_UNIT_XXX ..................................................................................140
Table 397 – zwif_meter_sup_cache_get Parameters................................................................140
Table 398 – zwif_meter_reset Parameters ...............................................................................140
Table 399 – zwif_meter_set_admin Parameters.......................................................................140
Table 400 – zwif_meter_get_desc Parameters .........................................................................141
Table 401 – zwrep_meterd_fn Parameters ...............................................................................141
Table 402 – zwmeter_t Structure ..............................................................................................141
Table 403 – zwif_dlck_op_rpt_set Parameters ........................................................................141
Table 404 – zwrep_dlck_op_fn Parameters ..............................................................................141
Table 405 – zwdlck_op_t Structure ..........................................................................................142
Table 406 – ZW_DOOR_XXX ......................................................................................................142
Table 407 – ZW_COND_XXX_MASK...........................................................................................142
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xxiii of xxviii
Table 408 – zwif_dlck_op_get Parameters................................................................................143
Table 409 – zwif_dlck_op_set Parameters ................................................................................143
Table 410 – zwif_dlck_op_mset Parameters.............................................................................143
Table 411 – zwif_dlck_cfg_set Parameters...............................................................................143
Table 412 – zwdlck_cfg_t Structure..........................................................................................143
Table 413 – zwif_dlck_cfg_get Parameters ...............................................................................144
Table 414 – zwrep_dlck_cfg_fn Parameters.............................................................................144
Table 415 – zwif_dlck_cap_get Parameters ..............................................................................144
Table 416 – zwrep_dlck_cap_fn Parameters.............................................................................145
Table 417 – zwdlck_cap_t Structure..........................................................................................145
Table 418 – ZW_DLCK_CAP_XXX_MASK....................................................................................145
Table 419 – zwif_dlck_cap_cache_get Parameters...................................................................145
Table 420 – zwif_dlck_cap_free Parameters.............................................................................146
Table 421 – zwif_lcklog_rpt_set Parameters.............................................................................146
Table 422 – zwrep_lcklog_fn Parameters..................................................................................146
Table 423 – zwdlck_log_t Structure ..........................................................................................146
Table 424 – ZWLCK_EVT_XXX ....................................................................................................147
Table 425 – zwif_lcklog_get Parameters ...................................................................................148
Table 426 – zwif_lcklog_sup_get Parameters ...........................................................................148
Table 427 – zwrep_lcklog_cap_fn Parameters ..........................................................................148
Table 428 – zwif_lcklog_sup_cache_get Parameters ................................................................148
Table 429 – zwif_usrcod_rpt_set Parameters ..........................................................................149
Table 430 – zwrep_usr_cod_fn Parameters ..............................................................................149
Table 431 – zwusrcod_t structure .............................................................................................149
Table 432 – ZW_USRCOD_XXX ..................................................................................................149
Table 433 – zwif_usrcod_get Parameters .................................................................................149
Table 434 – zwif_usrcod_set Parameters..................................................................................150
Table 435 – zwif_usrcod_sup_get Parameters..........................................................................150
Table 436 – zwrep_usr_sup_fn Parameters ..............................................................................150
Table 437 – zwif_usrcod_sup_cache_get Parameters ..............................................................150
Table 438 – zwif_usrcod_ext_rpt_set Parameters ...................................................................150
Table 439 – zwrep_usr_cod_ext_fn Parameters .......................................................................150
Table 440 – zwusrcod_ext_t structure ......................................................................................151
Table 441 – zwif_usrcod_ext_get Parameters ..........................................................................151
Table 442 – zwif_usrcod_ext_set Parameters...........................................................................151
Table 443 – zwif_usrcod_cap_get Parameters..........................................................................152
Table 444 – zwrep_usr_cap_fn Parameters ..............................................................................152
Table 445 – zwusrcod_cap_t structure......................................................................................152
Table 446 – ZW_USRCOD_CAP_XXX Bitmask ............................................................................152
Table 447 – zwif_usrcod_cap_cache_get Parameters...............................................................152
Table 448 – zwif_usrcod_kp_mod_rpt_set Parameters ...........................................................153
Table 449 – zwrep_usr_kpmod_fn Parameters.........................................................................153
Table 450 – ZW_KEYPAD_MOD_XXX.........................................................................................153
Table 451 – zwif_usrcod_kp_mod_get Parameters ..................................................................153
Table 452 – zwif_usrcod_kp_mod_set Parameters...................................................................154
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xxiv of xxviii
Table 453 – zwif_usrcod_ms_cod_rpt_set Parameters............................................................154
Table 454 – zwrep_ms_cod_fn Parameters ..............................................................................154
Table 455 – zwif_usrcod_ms_cod_get Parameters ...................................................................154
Table 456 – zwif_usrcod_ms_cod_set Parameters ...................................................................154
Table 457 – zwif_usrcod_chksum_rpt_set Parameters............................................................155
Table 458 – zwrep_chksum_fn Parameters...............................................................................155
Table 459 – zwif_usrcod_chksum_get Parameters ...................................................................155
Table 460 – zwif_thrmo_fan_md_rpt_set Parameters .............................................................155
Table 461 – zwrep_thrmo_fan_md_fn Parameters ..................................................................155
Table 462 – ZW_THRMO_FAN_MD_XXX...................................................................................156
Table 463 – zwif_thrmo_fan_md_get Parameters....................................................................156
Table 464 – zwif_thrmo_fan_md_set Parameters ....................................................................157
Table 465 – zwif_thrmo_fan_md_sup_get Parameters ............................................................157
Table 466 – zwrep_thrmo_fan_md_sup_fn Parameters...........................................................157
Table 467 – zwif_thrmo_fan_md_sup_cache_get Parameters.................................................157
Table 468 – zwif_thrmo_fan_sta_rpt_set Parameters..............................................................158
Table 469 – zwrep_thrmo_fan_sta_fn Parameters...................................................................158
Table 470 – ZW_THRMO_FAN_STA_XXX...................................................................................158
Table 471 – zwif_thrmo_fan_sta_get Parameters ....................................................................158
Table 472 – zwif_thrmo_md_rpt_set Parameters.....................................................................159
Table 473 – zwrep_thrmo_md_fn Parameters..........................................................................159
Table 474 – ZW_THRMO_MD_XXX............................................................................................159
Table 475 – zwif_thrmo_md_get Parameters ...........................................................................160
Table 476 – zwif_thrmo_md_set Parameters ...........................................................................160
Table 477 – zwif_thrmo_md_sup_get Parameters ...................................................................160
Table 478 – zwrep_thrmo_md_sup_fn Parameters..................................................................160
Table 479 – zwif_thrmo_md_sup_cache_get Parameters ........................................................161
Table 480 – zwif_thrmo_op_sta_rpt_set Parameters...............................................................161
Table 481 – zwrep_thrmo_op_sta_fn Parameters....................................................................161
Table 482 – ZW_THRMO_OP_STA_XXX.....................................................................................161
Table 483 – zwif_thrmo_op_sta_get Parameters .....................................................................162
Table 484 – zwif_thrmo_op_sta_log_sup_get Parameters.......................................................162
Table 485 – zwrep_thrmo_op_sta_log_sup_fn Parameters .....................................................162
Table 486 – zwif_thrmo_op_sta_log_sup_cache_get Parameters............................................162
Table 487 – zwif_thrmo_op_sta_log_rpt_set Parameters ........................................................162
Table 488 – zwrep_thrmo_op_sta_log_fn Parameters .............................................................163
Table 489 – zwthrmo_op_sta_log_t Structure .........................................................................163
Table 490 – zwif_thrmo_op_sta_log_get Parameters...............................................................163
Table 491 – zwif_thrmo_setb_rpt_set Parameters...................................................................164
Table 492 – zwrep_thrmo_setb_fn Parameters........................................................................164
Table 493 – ZW_THRMO_SETB_TYP_XXX..................................................................................164
Table 494 – ZW_THRMO_SETB_STA_XXX..................................................................................164
Table 495 – zwif_thrmo_setb_get Parameters .........................................................................164
Table 496 – zwif_thrmo_setb_set Parameters..........................................................................164
Table 497 – zwif_thrmo_setp_rpt_set Parameters...................................................................165
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xxv of xxviii
Table 498 – zwrep_thrmo_setp_fn Parameters........................................................................165
Table 499 – zwsetp_t structure ................................................................................................165
Table 500 – ZW_THRMO_SETP_TYP_XXX..................................................................................165
Table 501 – ZW_THRMO_SETP_UNIT_XXX................................................................................166
Table 502 – zwif_thrmo_setp_get Parameters .........................................................................166
Table 503 – zwif_thrmo_setp_set Parameters..........................................................................166
Table 504 – zwif_thrmo_setp_sup_get Parameters..................................................................166
Table 505 – zwrep_thrmo_setp_sup_fn Parameters ................................................................166
Table 506 – zwif_thrmo_setp_sup_cache_get Parameters ......................................................167
Table 507 – zwif_thrmo_setp_sup_range_get Parameters.......................................................167
Table 508 – zwrep_thrmo_setp_range_fn Parameters.............................................................167
Table 509 – zwif_thrmo_setp_sup_range_cache_get Parameters ...........................................167
Table 510 – zwif_config_rpt_set Parameters ...........................................................................168
Table 511 – zwrep_config_fn Parameters .................................................................................168
Table 512 – zwconfig_t Structure ..............................................................................................168
Table 513 – zwif_config_get Parameters ..................................................................................168
Table 514 – zwif_config_set Parameters...................................................................................169
Table 515 – zwif_config_bulk_rpt_set Parameters ..................................................................169
Table 516 – zwrep_cfg_bulk_fn Parameters .............................................................................169
Table 517 – zwcfg_bulk_t Structure ..........................................................................................169
Table 518 – zwif_config_bulk_get Parameters..........................................................................170
Table 519 – zwif_config_bulk_set Parameters ..........................................................................170
Table 520 – zwif_config_prm_reset Parameters.......................................................................170
Table 521 – zwif_config_info_get Parameters ..........................................................................170
Table 522 – zwcfg_info_cap_t structure ...................................................................................170
Table 523 – zwcfg_info_t structure ...........................................................................................170
Table 524 – gen_dat_u Union....................................................................................................171
Table 525 – zwif_config_info_free Parameters.........................................................................172
Table 526 – zwif_clock_rpt_set Parameters..............................................................................172
Table 527 – zwrep_clock_fn Parameters...................................................................................172
Table 528 – ZW_CLOCK_XXX .....................................................................................................172
Table 529 – zwif_clock_get Parameters ....................................................................................172
Table 530 – zwif_clock_set Parameters ....................................................................................173
Table 531 – zwif_clmt_ctl_schd_rpt_set Parameters................................................................173
Table 532 – zwrep_clmt_ctl_schd_fn Parameters.....................................................................173
Table 533 – zwcc_shed_t Structure..........................................................................................173
Table 534 – zwcc_shed_swpt_t Structure .................................................................................173
Table 535 – zwif_clmt_ctl_schd_get Parameters ......................................................................174
Table 536 – zwif_clmt_ctl_schd_set Parameters ......................................................................174
Table 537 – zwif_clmt_ctl_schd_chg_rpt_set Parameters ........................................................174
Table 538 – zwrep_clmt_ctl_schd_chg_fn Parameters .............................................................174
Table 539 – zwif_clmt_ctl_schd_chg_get Parameters ..............................................................174
Table 540 – zwif_clmt_ctl_schd_ovr_rpt_set Parameters ........................................................175
Table 541 – zwrep_clmt_ctl_schd_ovr_fn Parameters .............................................................175
Table 542 – zwcc_shed_t Structure..........................................................................................175
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xxvi of xxviii
Table 543 – zwif_clmt_ctl_schd_ovr_get Parameters...............................................................175
Table 544 – zwif_clmt_ctl_schd_ovr_set Parameters ...............................................................175
Table 545 – zwif_av_set Parameters.........................................................................................176
Table 546 – zwif_av_caps Parameters.......................................................................................176
Table 547 – zwrep_av_fn Parameters .......................................................................................176
Table 548 – zwif_prot_rpt_set Parameters ...............................................................................176
Table 549 – zwrep_prot_fn Parameters ....................................................................................176
Table 550 – ZW_LPROT_XXX......................................................................................................177
Table 551 – ZW_RFPROT_XXX ...................................................................................................177
Table 552 – zwif_prot_get Parameters .....................................................................................177
Table 553 – zwif_prot_set Parameters......................................................................................177
Table 554 – zwif_prot_sup_get Parameters..............................................................................178
Table 555 – zwrep_prot_sup_fn Parameters ............................................................................178
Table 556 – zwprot_sup_t structure .........................................................................................178
Table 557 – zwif_prot_sup_cache_get Parameters ..................................................................178
Table 558 – zwif_prot_ec_rpt_set Parameters .........................................................................178
Table 559 – zwrep_prot_ec_fn Parameters ..............................................................................179
Table 560 – zwif_prot_ec_get Parameters................................................................................179
Table 561 – zwif_prot_ec_set Parameters ................................................................................179
Table 562 – zwif_prot_tmout_rpt_set Parameters ...................................................................179
Table 563 – zwrep_prot_tmout_fn Parameters ........................................................................179
Table 564 – zwif_prot_tmout_get Parameters .........................................................................180
Table 565 – zwif_prot_tmout_set Parameters..........................................................................180
Table 566 – Top level entities....................................................................................................189
Table 567 – Network object ......................................................................................................189
Table 568 – Node object............................................................................................................190
Table 569 – Z-Wave software version object ............................................................................191
Table 570 – Endpoint object......................................................................................................191
Table 571 – Common Interface object ......................................................................................192
Table 572 – Interface object for Association Group Info CC......................................................192
Table 573 –Association Group Info object.................................................................................192
Table 574 – Command object....................................................................................................192
Table 575 – Interface object for Configuration CC ....................................................................192
Table 576 – Configuration parameter object ............................................................................193
Table 577 – Interface object for Association and Multi channel Association CC.......................193
Table 578 –Association Group Cache object .............................................................................194
Table 579 –Group member object.............................................................................................194
Table 580 – Interface object for Central Scene CC ....................................................................194
Table 581 –Scene object............................................................................................................194
Table 582 – Interface object for Multi Level Sensor CC.............................................................194
Table 583 –Multi level sensor object.........................................................................................195
Table 584 – Multi level sensor Cache object .............................................................................195
Table 585 – Interface object for Indicator CC............................................................................195
Table 586 –Indicator object.......................................................................................................195
Table 587 – Indicator Cache object ...........................................................................................195
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xxvii of xxviii
Table 588 – Indicator property object .......................................................................................195
Table 589 – Interface object for Thermostat Fan Mode CC ......................................................196
Table 590 – Thermostat Fan Mode Cache object ......................................................................196
Table 591 – Interface object for Thermostat Mode CC .............................................................196
Table 592 – Thermostat Mode Cache object.............................................................................196
Table 593 – Interface object for Thermostat Setpoint CC .........................................................196
Table 594 – Thermostat Setpoint object ...................................................................................197
Table 595 – Thermostat Setpoint Cache object.........................................................................197
Table 596 – Interface object for Thermostat Operating State CC .............................................198
Table 597 – Thermostat Operating State Cache object for “Operating State”..........................198
Table 598 – Thermostat Operating State Cache object for “Logging”.......................................198
Table 599 – Interface object for Thermostat Fan State CC........................................................198
Table 600 – Thermostat Fan State Cache object .......................................................................199
Table 601 – Interface object for Multi Level Switch CC .............................................................199
Table 602 – Multi Level Switch Cache object ............................................................................199
Table 603 – Interface object for Binary Switch CC.....................................................................199
Table 604 – Binary Switch Cache object ....................................................................................199
Table 605 – Interface object for Binary Sensor CC ....................................................................200
Table 606 – Binary Sensor Cache object....................................................................................200
Table 607 – Interface object for Simple AV Control CC .............................................................200
Table 608 – Interface object for Alarm CC.................................................................................200
Table 609 –Alarm object............................................................................................................200
Table 610 – Alarm Cache object ................................................................................................201
Table 611 – Alarm event parameter object...............................................................................201
Table 612 – Interface object for Protection CC .........................................................................201
Table 613 – Protection Cache object for “Protection State” .....................................................202
Table 614 – Protection Cache object for “Exclusive Control”....................................................202
Table 615 – Protection Cache object for “Timeout”..................................................................202
Table 616 – Interface object for User Code CC..........................................................................203
Table 617 – User Code Cache object .........................................................................................203
Table 618 – Interface object for Meter CC ................................................................................203
Table 619 – Meter Cache object................................................................................................203
Table 620 – Interface object for Meter Table Monitor CC ........................................................204
Table 621 – Interface object for Door Lock CC ..........................................................................205
Table 622 – Door Lock Cache object for “Operation Status”.....................................................205
Table 623 – Door Lock Cache object for “Configuration”..........................................................206
Table 624 – Interface object for Door Lock Logging CC .............................................................207
Table 625 – Interface object for Alarm Sensor CC.....................................................................207
Table 626 – Alarm Sensor Cache object ....................................................................................207
Table 627 – Interface object for Barrier Operator CC................................................................207
Table 628 – Barrier Operator Cache object ...............................................................................207
Table 629 – Interface object for Color Switch CC ......................................................................208
Table 630 – Color Switch Cache object......................................................................................208
Table 631 – Interface object for Sound Switch CC.....................................................................208
Table 632 – Sound Switch object...............................................................................................208
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page xxviii of xxviii
Table 633 – Sound Switch Cache object for “Tone Played”.......................................................209
Table 634 – Sound Switch Cache object for “Tone Configuration” ...........................................209
Table 635 – Interface object for Window Covering CC..............................................................209
Table 636 – Window Covering Cache object .............................................................................209
Table 637 – Interface object for Battery CC ..............................................................................210
Table 638 – Battery Cache object ..............................................................................................210
Table 639 – Interface object for Basic CC ..................................................................................211
Table 640 – Basic Cache object..................................................................................................211
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page 1 of 212
1 Introduction
1.1 Purpose
This document is the Z-Ware Library C API reference manual.
1.2 Audience and Prerequisites
This document is for Z-Wave Partners and assumes they are already comfortable with the ZWave protocol and network installation. As such, the document does not go into detail on
these matters. References are also made to the Z-Wave Device Class (DC) and Command Class
(CC) definitions and the Z-Wave for Internet Protocol (Z/IP) API, upon which this API is built.
INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07
silabs.com | Building a more connected world.
Page 2 of 212
2 Error Codes
Error code
Description
Value
ZW_ERR_NONE *
Operation succeeded.
0
ZW_ERR_QUEUED *
Success: The command is queued into mailbox and
will only be sent when the device wakes up (no
transmission status callback).
1
ZW_ERR_CACHE_AVAIL *
Success: The data is available in the cache (no live
get from the target device).
2
ZW_ERR_SEND_PENDING *
Success: The command is pending for sending in a
short while (no transmission status callback).
3
ZW_ERR_FAILED
Operation failed.
-1
ZW_ERR_WRONG_IF
Wrong interface.
-10
ZW_ERR_NO_RESP
No response from controller.
-11
ZW_ERR_MEMORY
Out of memory.
-12
ZW_ERR_NODE_NOT_FOUND
Node not found.
-13
ZW_ERR_CLASS_NOT_FOUND
CC not found.
-14
ZW_ERR_INTF_NOT_FOUND
Interface to a class not found.
-15
ZW_ERR_INTF_NO_REP_HDLR
Interface report handler not found.
-16
ZW_ERR_LAST_OP_NOT_DONE
Last operation uncompleted yet, try again.
-17
ZW_ERR_NOT_IN_LIST
Node not in protocol layer failed node ID list.
-18
ZW_ERR_OP_FAILED
The requested operation failed.
-19
ZW_ERR_EP_NOT_FOUND
Endpoint not found.
-20
ZW_ERR_RPT_NOT_FOUND
The report command of an interface not found.
-21
ZW_ERR_NET_NOT_FOUND
Network not found.
-22
ZW_ERR_CMD_VERSION
Incorrect CC version.
-23
ZW_ERR_PENDING
Operation pending, it cannot be canceled now.
-24
ZW_ERR_VALUE
The parameter value is invalid.
-25
ZW_ERR_QUEUE_FULL
The queue is full.
-26
ZW_ERR_UNSUPPORTED
The requested function is unsupported for this
node.
-27
ZW_ERR_FILE_OPEN
Open file error.
-28
ZW_ERR_FILE_WRITE
Write file error.
-29
ZW_ERR_FILE_EOF
The end-of-file was reached.
-30
ZW_ERR_FILE
File is corrupted.
-31
ZW_ERR_FILE_HOME_ID
File home ID doesn't match.
-32
ZW_ERR_EXPIRED
Expired.
-33
ZW_ERR_NO_RES
No resource for mutex, semaphore, timer, etc.
-34
The error codes used in APIs, ZW_ERR_XXX are listed in the table below. They are defined in
the header file, zip_api.h. They can also be found in Doxygen documentation under the
“Modules->Network APIs” Zw_error_codes section. Besides, occasionally, the error code
returned may be from a low-level library function call. These error codes are listed in the table
“Low-Level Library Error Codes”.
Table 1 – Error Codes, ZW_ERR_XXX
Loading...