Z-Wave SDK 7.14.x Reference Manual

Download

Instruction

Z-Ware SDK 7.14.x Library C API Reference Manual

Document No.:

INS14416

Version:

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

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

20180823

SNA DCHOW

ALL17Formatted for Silabs and fixed page numbers. Replaced S2 inclusion flow diagram as picture.

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.

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

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

20190318

SNA

192

-v9.12

-Update supported CC table

-Added firmware update completion status for low/unknown battery level

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

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

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

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

20100110

SNA

V10.05 – no changes

20200325

SNA

Removed Portal support documentation

20200417

ADGIELNI

67, 68

Support Battery CC v3

20200615

MILOS

All

TechPubs review

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.

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).

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

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 3 of 212

ZW_ERR_EVENT

Event is not processed.

-35

ZW_ERR_TOO_LARGE

Data size is too large.

-36

ZW_ERR_TOO_SMALL

Data size is too small.

-37

ZW_ERR_TIMEOUT

Timeout.

-38

ZW_ERR_TRANSMIT

Transmission failed.

-39

ZW_ERR_NONCE_NOT_FOUND

Security nonce not found.

-40

ZW_ERR_AUTH

Authentication error.

-41

ZW_ERR_SEQ_NUMBER

Incorrect sequence number.

-42

ZW_ERR_BUSY

Busy, try again later.

-43

ZW_ERR_SEC_SCHEME

Security scheme unsupported.

-44

ZW_ERR_TRANSPORT_INI

Initialization error on transport layer.

-45

ZW_ERR_FRAME_INI

Initialization error on frame layer.

-46

ZW_ERR_SESSION_INI

Initialization error on session layer.

-47

ZW_ERR_APPL_INI

Initialization error on application layer.

-48

ZW_ERR_UNEXPECTED

The error was unexpected under normal circumstances.

-49

ZW_ERR_NETWORK_IF

Network interface not configured properly.

-50

ZW_ERR_IP_ADDR

The IP address is invalid.

-51

ZW_ERR_VERSION

Wrong version number.

-52

ZW_ERR_INTF_NO_DATA

Interface data is missing.

-53

ZW_ERR_FILE_READ

Read file error.

-54

ZW_ERR_PARSE_FILE

Parsing file failed.

-55

ZW_ERR_MISSING_ENTRY

Missing mandatory entry.

-56

ZW_ERR_DEVCFG_NOT_FOUND

Device specific configuration record not found.

-57

ZW_ERR_DISALLOWED

The operation is disallowed under certain circumstances.

-58

ZW_ERR_PSK_TOO_SHORT

DTLS pre-shared key length is too short.

-59

ZW_ERR_NO_CACHE_AVAIL

The data is unavailable in the cache.

-60

ZW_ERR_NOT_APPLICABLE

Not applicable and should be skipped or ignored.

-61

ZW_ERR_SHUTDOWN

The system is shutting down.

-62

ZW_ERR_POST_SET_POLL

Post-set polling error.

-63

ZW_ERR_ORDER

Out of order.

-64

ZW_ERR_CMD_UNSUPP_TGT

Command sent by the association group is unsupported at target node or endpoint.

-65

ZW_ERR_UNSUPP_S2_TGT

The association group node does not have the S2 target node highest key scheme HEALTH_CHK.

-66

ZW_ERR_UNSUPP_S2_SRC

The target node does not have the association group node S2 highest key scheme

-67

ZW_ERR_DIFF_HIGHEST_SEC

The association group node highest key scheme is different from target node's highest key scheme

-68

Note: Error code with (*) that has a value equal or greater than zero is not an error. In fact, it

Error code

Description

Value

is an indication of success with more detailed description.

Table 2 – Low-Level Library Error Codes

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 4 of 212

ZWHCI_ERROR_MEMORY

Out of memory.

-100

ZWHCI_ERROR_RESOURCE

Out of resource.

-101

TRANSPORT_ERROR_SIGNALING

Could not signal write thread to perform actual write.

-102

FRAME_ERROR_MULTIPLE_WRITE

Write while the previous write in progress is not allowed.

-103 FRAME_ERROR_SEND_TIMER

Send timer not functioning.

-104

SESSION_ERROR_PREVIOUS_ COMMAND_UNCOMPLETED

Previous command uncompleted, retry later.

-105

SESSION_ERROR_DEST_BUSY

The message has not timed out yet.The destination host may have a long response time.

-106

SESSION_ERROR_UNREACHABLE

Frame failed to reach destination host.

-107

SESSION_ERROR_SND_FRM_TMOUT

Send frame timeout due to no ACK received.

-108

SESSION_ERROR_SYSTEM

System error, the program should exit.

-109

SESSION_ERROR_INVALID_RESP

The response command ID doesn't match with the sent command ID.

-110

SESSION_ERROR_SEND_BUSY

Send error at lower layer due to controller busy.

-111

APPL_TX_STATUS_TIMEOUT

There is no transmit status callback from lower layer.

-112 APPL_OPER_ALREADY_ACTIVE

The requested operation is already active.

-113

APPL_OPER_NOT_STARTED

The requested operation fails to start.

-114

APPL_ERROR_WAIT_CB

Waiting for transmit complete callback function, retry later.

-115 APPL_INVALID_ADDR

Invalid IPv6 address.

-116

APPL_INVALID_NODE_ID

Invalid node ID.

-117

APPL_ERROR_RSLV_NODE_ID

Couldn't resolve node ID to IP address.

-118

ZWHCI_ERROR_TOO_LARGE

The value supplied is too large.

-119

ZWHCI_ERROR_WRITE

Write failed.

-120

ZWHCI_ERROR_READ

Read failed.

-121

ZWHCI_ERROR_TIMEOUT

Time out.

-122

ZWHCI_ERROR_VERIFY

Verification failed.

-123

ZWHCI_ERROR_SHUTDOWN

System is shutting down.

-124

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 5 of 212

3 Device Database API

Attribute

Type

I/O

Description

cfg_file

const char *

Device-specific configurations file in JSON format.

records

dev_rec_t **

Device-specific configuration records sorted according to manufacturer ID, product type ID and product ID

record_cnt

uint16_t *

Number of device-specific configuration records stored in "records".

global_sett

dev_global_sett_t**

Device global settings.

global_sett_cnt

uint16_t *

Number of entries in device global settings.

err_loc

dev_cfg_error_t *

Parse error location for "device_records" in JSON file.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX. Note: Caller must free the memory allocated to "records" using zwdev_cfg_free() and memory allocated to "global_sett" using zwdev_global_sett_free() if return value is ZW_ERR_NONE.

Attribute

Type

I/O

Description

vid

uint32_t

Vendor or Manufacturer ID

ptype

uint32_t

Product Type ID

pid

uint32_t

Product ID

3.1 zwdev_cfg_load

Load and store device-specific configurations.

Table 3 – zwdev_cfg_load Parameters

Table 4 – dev_rec_t Structure

Table 5 – DEV_XXX Meaning and Values

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 6 of 212

DEV_SUB_ENERGY_METER

Sub energy meter

DEV_ADV_WHL_HOME_ENER_METER

Advanced whole home energy meter

DEV_SIM_WHL_HOME_ENER_METER

Simple whole home energy meter

DEV_SENSOR

Sensor

DEV_LIGHT_DIMMER

Light dimmer switch

DEV_WIN_COVERING_NO_POS

Window covering no position/endpoint

13 DEV_WIN_COVERING_EP

Window covering end point aware

DEV_WIN_COVERING_POS_EP

Window covering position/endpointaware

15 DEV_FAN_SWITCH

Fan switch

DEV_RMT_CTL_MULTIPURPOSE

Remote control - multipurpose

DEV_RMT_CTL_AV

Remote control - AV

DEV_RMT_CTL_SIMPLE

Remote control - simple

DEV_UNRECOG_GATEWAY

Gateway (unrecognized by client)

DEV_CENTRAL_CTLR

Central controller

DEV_SET_TOP_BOX

Set top box

DEV_TV

DEV_SUB_SYS_CTLR

Sub system controller

DEV_GATEWAY

Gateway

DEV_THERMOSTAT_HVAC

Thermostat - HVAC

DEV_THERMOSTAT_SETBACK

Thermostat - setback

DEV_WALL_CTLR

Wall controller

Table 6 – ep_rec_t Structure

Attribute

Type

I/O

Description

ep_rec_t *

Point to next endpoint record

uint8_t

Endpoint ID (starting from 0 for virtual endpoint, 1 and onwards for real endpoints)

new_if

uint16_t

New CC to be created/added to the endpoint, if any

new_if_ver

uint8_t

The "user defined version" for the new CC, if any

new_if_propty

uint8_t

New CC (interface) property (bit-mask)

redir_rec

redir_rec_t *

Command redirection records

if_rec

if_rec_t *

Interface records

Attribute

Type

I/O

Description

redir_rec_t *

Next redirection record

if_id

uint16_t

Interface ID / CC ID.

cmd

intOCommand value 0-255. -1 means don't care.

target_ep

uint8_t

Target endpoint ID to redirect to.

Attribute

Type

I/O

Description

if_rec_t *

Point to next interface record.

Table 7 – redir_rec_t Structure

Table 8 – if_rec_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 7 of 212

type

uint8_t

Interface type, IF_REC_TYPE_XXX.

usr_def_ver

uint8_t

User defined version.

propty

uint8_t

Interface type specific property (bit-mask).

tmout

uint16_t

Interface type specific timeout value in seconds.

rec

rec union

Union of interface records; the actual interface record used is indicated by the type attribute of this structure.

Table 9 – Interface Types: IF_REC_TYPE_XXX

Interface Record Type

Description

IF_REC_TYPE_GROUP

Group

IF_REC_TYPE_CONFIG

Configuration

IF_REC_TYPE_BIN_SENSOR

Binary Sensor

IF_REC_TYPE_SENSOR

Sensor

IF_REC_TYPE_METER

Meter

IF_REC_TYPE_ALARM

Alarm/Notification

IF_REC_TYPE_BASIC

Basic

IF_REC_TYPE_ALRM_SNSR

Alarm Sensor

IF_REC_TYPE_THRMO_SETP

Thermostat setpoint

IF_REC_TYPE_DOOR_LOCK

Door lock

IF_REC_TYPE_MULTI_CMD

Multi-command

Attribute

Type

I/O

Description

grp

if_rec_grp_t *

Group interface record

config

if_rec_config_t *

Configuration interface record

bsnsr

if_rec_bsnsr_t *

Binary Sensor interface record

snsr

if_rec_snsr_t *

Sensor interface record

meter

if_rec_meter_t *

Meter interface record

alarm

if_rec_alarm_match_t*

Alarm//Notification interface record

basic

if_rec_basic_match_t*

Basic interface record

alrm_snsr

if_rec_alrm_snsr_match_t*

Alarm sensor interface record

thrmo_setp

if_rec_thrmo_setp_t*

Thermostat setpoint interface record

door_lck

if_rec_dlck_t *

Door lock interface record

mcmd

if_rec_mcmd_t *

Multi-command encapsulation record

Attribute

Type

I/O

Description

grp_cnt

uint8_t

Number of group ID in the grp_id array

Table 10 – rec Union

Table 11 – if_rec_grp_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 8 of 212

grp_id

uint8_t[7]

Group IDs for the controller to set its node ID into the groups

Table 12 – if_rec_config_t Structure

Attribute

Type

I/O

Description

if_rec_config_t *

Point to next configuration interface record.

Record type CONFIG_REC_TYPE_XXX.

XXX

Description

SET

Configuration record type set.

rec_type

uint16_t

INFO

Configuration record type information.

rec

union

Record as indicated by record type; union of the following:

cfg_set

if_rec_cfg_set_t

For CONFIG_REC_TYPE_SET

cfg_info

if_rec_cfg_info_t

For CONFIG_REC_TYPE_INFO

Attribute

Type

I/O

Description

param_num

uint8_t

Parameter number

param_size

uint8_t

Data size: 1, 2, or 4 bytes

param_val

int32_t

Configuration parameter value (signed integer)

Attribute

Type

I/O

Description

param_num

uint8_t

Parameter number

param_size

uint8_t

Data size: 1,2,or 4 bytes

param_min

int32_t

Minimum configuration parameter value (signed integer)

param_max

int32_t

Maximum configuration parameter value (signed integer)

param_deflt

int32_t

Default configuration parameter value (signed integer)

param_name

char *

Parameter name

param_info

char *

Parameter information

Attribute

Type

I/O

Description

type

uint8_t

Supported binary sensor type ZW_BSENSOR_TYPE_XXX (for version 1 only)

rec_match

if_rec_bsnsr_match_t *

Record matching condition

Table 13 – if_rec_cfg_set_t Structure

Table 14 – if_rec_cfg_info_t Structure

Table 15 – if_rec_bsnsr_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 9 of 212

Table 16 – if_rec_bsnsr_match_t Structure

Attribute

Type

I/O

Description

pResult

void *

The result record that maps to, e.g., if_rec_alarm_result_t*

type

intOBinary sensor type ZW_BSENSOR_TYPE_XXX

state

intOBinary sensor state.

resultType

intOType of the resulting conversion. IF_REC_TYPE_XXX

Attribute

Type

I/O

Description

type

uint8_t

Sensor type ZW_SENSOR_TYPE_XXX

unit

uint8_t

Sensor unit ZW_SENSOR_UNIT_XXX

Attribute

Type

I/O

Description

type

uint8_t

ZW_METER_TYPE_XXX.

unit_supp

uint8_t

Supported unit bit-mask : ZW_METER_SUP_UNIT_XXX.

rate_type

uint8_t

ZW_METER_RATE_XXX.

reset_cap

uint8_t

Meter reset capability: 1=capable to reset; 0=incapable of reset.

Attribute

Type

I/O

Description

if_rec_alarm_match_t *

Point to next match record

pResult

if_rec_alarm_result_t *

The result alarm record that maps to

pRevMatch

if_rec_alarm_rev_match_t *

Device specific alarm reverse-matching record (It is the OR result of match and result struct)

match_valid

intOFlag to indicate whether the match entries below are valid

type

intOVendor proprietary alarm type

level_low

intOVendor proprietary alarm level or lower limit of a range

level_high

intOVendor proprietary alarm level higher limit of a range

isRange

intOFlag to indicate vendor proprietary alarm level is a range

ex_type

intOZ-Wave Alarm/Notification type (ZW_ALRM_XXX)

ex_event

intOZ-Wave Alarm/Notification event (ZW_ALRM_EVT_XXX)

ex_evt_len

intOZ-Wave Alarm/Notification event parameter length. Zero if the event has no parameter

Table 17 – Table 18 – if_rec_snsr_t Structure

Table 19 – if_rec_meter_t Structure

Table 20 – if_rec_alarm_match_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 10 of 212

pEx_evt_prm

uint8_t *

Pointer to Z-Wave Alarm/Notification event parameter

Table 21 – if_rec_alarm_result_t Structure

Attribute

Type

I/O

Description

type

intOVendor proprietary alarm type

level

intOVendor proprietary alarm level

ex_type

intOZ-Wave alarm/Notification type (ZW_ALRM_XXX)

type_name

char *

Device specific alarm type name.

ex_event

intOZ-Wave alarm/Notification event (ZW_ALRM_EVT_XXX).

level_name

char *

Device specific alarm level name.

ex_evt_len

intOZ-Wave alarm/Notification event parameter length. Zero if the event has no parameter.

ex_evt_type

intOZ-Wave alarm/Notification event parameter type (ZW_ALRM_PARAM_XXX).

pEx_evt_prm

uint8_t *

pointer to Z-Wave alarm/Notification event parameter.

Attribute

Type

I/O

Description

type

intOVendor proprietary alarm type

ex_type

intOZ-Wave alarm/Notification type (ZW_ALRM_XXX)

ex_event

intOZ-Wave alarm/Notification event (ZW_ALRM_EVT_XXX)

Attribute

Type

I/O

Description

if_rec_basic_match_t *

Point to next match record.

pResult

void *

The result record that maps to, e.g., if_rec_alarm_result_t*.

command

intOBasic CC command. eg. BASIC_SET.

value

intOCommand value 0-255. -1 means don't care.

resultType

IntOType of the resulted conversion. IF_REC_TYPE_xxx.

Attribute

Type

I/O

Description

if_rec_alrm_snsr_match_t *

Point to next match record

pResult

void *

The result record that maps to. eg. if_rec_alarm_result_t*

type

intOAlarm sensor type. (ZW_ALRM_SNSR_TYPE_XXX)

state_low

intOAlarm sensor state or lower limit of a range. -1 means don't care.

state_high

intOAlarm sensor state higher limit of a range

Table 22 – if_rec_alarm_rev_match_t Structure

Table 23 – if_rec_basic_match_t Structure

Table 24 – if_rec_alrm_snsr_match_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 11 of 212

isRange

intOFlag to indicate Alarm sensor state is a range

resultType

intOType of the resulted conversion. IF_REC_TYPE_xxx

if_rec_thrmo_setp_t Structure

Attribute

Type

I/O

Description

type_cnt

uint8_t

Number of thermostat setpointsupported temperature ranges

temp_range

zwsetp_temp_range_t *

Temperature ranges

Attribute

Type

I/O

Description

min

zwsetp_t

Minimum setpoint temperature

max

zwsetp_t

Maximum setpoint temperature

Attribute

Type

I/O

Description

op_type_cnt

uint8_t

Number of supported door lock operation types in "op_type" buffer.

mode_cnt

uint8_t

Number of supported door lock modes in "mode" buffer.

out_hdl

uint8_t

Supported outside door handle mode bitmask. It's a 4-bit mask; bit set to 1 if the corresponding handle can be enabled and disabled; otherwise, the corresponding handle cannot be enabled or disabled.

in_hdl

uint8_t

Supported inside door handle mode bitmask. It's a 4-bit mask; bit set to 1 if the corresponding handle can be enabled and disabled; otherwise, the corresponding handle cannot be enabled or disabled.

op_type

uint8_t *

Door lock operation type (ZW_DOOR_OP_XXX) buffer.

mode

uint8_t *

Door lock mode (ZW_DOOR_XXX except ZW_DOOR_UNKNOWN) buffer.

Attribute

Type

I/O

Description

send_encap

uint8_t

Control whether to send consecutive commands using multi-command encapsulation

Binary Sensor Type

Description

ZW_BSENSOR_TYPE_GP

General purpose sensor

ZW_BSENSOR_TYPE_SMOKE

Smoke sensor

ZW_BSENSOR_TYPE_CO

CO sensor

ZW_BSENSOR_TYPE_CO2

CO2 sensor

Table 25 – zwsetp_temp_range_t Structure

Table 26 – if_rec_dlck_t Structure

Table 28 – Binary Sensor Types: ZW_BSENSOR_TYPE_XXX

Table 27 – if_rec_mcmd_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 12 of 212

ZW_BSENSOR_TYPE_HEAT

Heat sensor

ZW_BSENSOR_TYPE_WATER

Water sensor

ZW_BSENSOR_TYPE_FREEZE

Freeze sensor

ZW_BSENSOR_TYPE_TAMPER

Tamper sensor

ZW_BSENSOR_TYPE_AUX

Aux sensor

ZW_BSENSOR_TYPE_DR_WIN

Door/Window sensor

ZW_BSENSOR_TYPE_TILT

Tilt sensor

ZW_BSENSOR_TYPE_MOTION

Motion sensor

ZW_BSENSOR_TYPE_GLASS_BRK

Glass break sensor

ZW_BSENSOR_TYPE_1ST_SUP

Return first sensor type on supported list

Table 29 – Multi-Level Sensor Type: ZW_SENSOR_TYPE_XXX

Multi-level Sensor Type

Description

ZW_SENSOR_TYPE_TEMP

Temperature sensor

ZW_SENSOR_TYPE_GP

General purpose sensor

ZW_SENSOR_TYPE_LUM

Luminance sensor

ZW_SENSOR_TYPE_POW

Power sensor

ZW_SENSOR_TYPE_HUMD

Relative humidity sensor

ZW_SENSOR_TYPE_VELO

Velocity sensor

ZW_SENSOR_TYPE_DIR

Direction sensor

ZW_SENSOR_TYPE_ATM

Atmospheric pressure sensor

ZW_SENSOR_TYPE_BARO

Barometric pressure sensor

9 ZW_SENSOR_TYPE_SLR

Solar radiation sensor

ZW_SENSOR_TYPE_DEW

Dew point sensor

ZW_SENSOR_TYPE_RAIN

Rain rate sensor

ZW_SENSOR_TYPE_TIDE

Tide level sensor

ZW_SENSOR_TYPE_WGT

Weight sensor

ZW_SENSOR_TYPE_VOLT

Voltage sensor

ZW_SENSOR_TYPE_CUR

Current sensor

ZW_SENSOR_TYPE_CO2

CO2-level sensor

ZW_SENSOR_TYPE_AIR

Air flow sensor

ZW_SENSOR_TYPE_TANK

Tank capacity sensor

ZW_SENSOR_TYPE_DIST

Distance sensor

ZW_SENSOR_TYPE_AGL

Angle Position sensor

ZW_SENSOR_TYPE_ROT

Rotation sensor

ZW_SENSOR_TYPE_WTR_TEMP

Water temperature sensor

ZW_SENSOR_TYPE_SOIL_TEMP

Soil temperature sensor

ZW_SENSOR_TYPE_SEIS_INT

Seismic intensity sensor

ZW_SENSOR_TYPE_SEIS_MAG

Seismic magnitude sensor

ZW_SENSOR_TYPE_UV

Ultraviolet sensor

ZW_SENSOR_TYPE_ELEC_RES

Electrical resistivity sensor

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 13 of 212

ZW_SENSOR_TYPE_ELEC_COND

Electrical conductivity sensor

29 ZW_SENSOR_TYPE_LOUDNESS

Loudness sensor

ZW_SENSOR_TYPE_MOIST

Moisture sensor

ZW_SENSOR_TYPE_FREQ

Frequency sensor

ZW_SENSOR_TYPE_TIME

Time sensor

ZW_SENSOR_TYPE_TGT_TEMP

Target temperature sensor

ZW_SENSOR_TYPE_PM_2_5

Particulate matter 2.5 sensor

ZW_SENSOR_TYPE_F_CH2O

Formaldehyde CH2O-level sensor

ZW_SENSOR_TYPE_RAD_CONT

Radon Concentration sensor

ZW_SENSOR_TYPE_METH_DENS

Methane Density CH4 sensor

ZW_SENSOR_TYPE_VOC

Volatile Organic Compound sensor

ZW_SENSOR_TYPE_CO_LVL

Carbon Monoxide COlevel sensor

40 ZW_SENSOR_TYPE_SOIL_HUMD

Soil Humidity sensor

ZW_SENSOR_TYPE_SOIL_REAC

Soil Reactivity sensor

ZW_SENSOR_TYPE_SOIL_SAL

Soil Salinity sensor

ZW_SENSOR_TYPE_HEART_RT

Heart Rate sensor

ZW_SENSOR_TYPE_BLOOD_PRS

Blood Pressure sensor

ZW_SENSOR_TYPE_MUSCLE_MS

Muscle Mass sensor

ZW_SENSOR_TYPE_FAT_MS

Fat Mass sensor

ZW_SENSOR_TYPE_BONE_MS

Bone Mass sensor

ZW_SENSOR_TYPE_TBW

Total Body Water sensor

ZW_SENSOR_TYPE_BMR

Basic Metabolic Rate sensor

50 ZW_SENSOR_TYPE_BMI

Body Mass Index sensor

ZW_SENSOR_TYPE_ACCEL_X

Acceleration, X-axis sensor

ZW_SENSOR_TYPE_ACCEL_Y

Acceleration, Y-axis sensor

ZW_SENSOR_TYPE_ACCEL_Z

Acceleration, Z-axis sensor

ZW_SENSOR_TYPE_SMOKE_DEN

Smoke Density sensor

ZW_SENSOR_TYPE_WATER_FLW

Water Flow sensor

ZW_SENSOR_TYPE_WATER_PRS

Water Pressure sensor

ZW_SENSOR_TYPE_RF_SGN

RF Signal Strength sensor

ZW_SENSOR_TYPE_PM_10

Particulate Matter 10 sensor

59 ZW_SENSOR_TYPE_RESPI_RATE

Respiratory rate sensor

ZW_SENSOR_TYPE_REL_MOD

Relative Modulation level sensor

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 14 of 212

ZW_SENSOR_TYPE_BOILER_WTR_TEMP

Boiler water temperature sensor

ZW_SENSOR_TYPE_DHW_TEMP

Domestic Hot Water (DHW) temperature sensor

63 ZW_SENSOR_TYPE_OUTSIDE_TEMP

Outside temperature sensor

ZW_SENSOR_TYPE_EXHAUST_TEMP

Exhaust temperature sensor

ZW_SENSOR_TYPE_WATER_CHLOR_LVL

Water Chlorine level sensor

66 ZW_SENSOR_TYPE_WATER_ACID

Water acidity sensor

ZW_SENSOR_TYPE_WATER_OXI_RED

Water Oxidation reduction potential sensor

Table 30 – Multi-Level Sensor Unit

Multi-level Sensor Type

Unit

Celsius (C)

ZW_SENSOR_TYPE_TEMP Fahrenheit (F)

Percentage value

ZW_SENSOR_TYPE_GP Dimensionless value

Percentage value

ZW_SENSOR_TYPE_LUM Lux1W

ZW_SENSOR_TYPE_POW Btu/h

Percentage value

ZW_SENSOR_TYPE_HUMD g/m3

m/s

ZW_SENSOR_TYPE_VELO mph

ZW_SENSOR_TYPE_DIR

Direction unit: 0 to 360 degrees. 0 = no wind, 90 = east,180 = south, 270 = west, and 360 = north

kPa

ZW_SENSOR_TYPE_ATM inches of Mercury

kPa

ZW_SENSOR_TYPE_BARO inches of Mercury

ZW_SENSOR_TYPE_SLR

W/m2

Celsius (C)

ZW_SENSOR_TYPE_DEW Fahrenheit (F)

mm/h

ZW_SENSOR_TYPE_RAIN in/h

ZW_SENSOR_TYPE_TIDE feet

ZW_SENSOR_TYPE_WGT pounds

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 15 of 212

ZW_SENSOR_TYPE_VOLT mV

ZW_SENSOR_TYPE_CUR mA1ZW_SENSOR_TYPE_CO2

ppm

m3/h

ZW_SENSOR_TYPE_AIR cfm (cubic feet per minute)

1l0

cbm

ZW_SENSOR_TYPE_TANK

US gallons

2m0

ZW_SENSOR_TYPE_DIST

feet

Percentage value

Degrees relative to north pole of standing eye view

ZW_SENSOR_TYPE_AGL

Degrees relative to south pole of standing eye view

2 rpm (revolutions per minute)

ZW_SENSOR_TYPE_ROT Hz (Hertz)

Celsius (C)

ZW_SENSOR_TYPE_WTR_TEMP Fahrenheit (F)

Celsius (C)

ZW_SENSOR_TYPE_SOIL_TEMP Fahrenheit (F)

Mercalli

European Macroseismic

Liedu

ZW_SENSOR_TYPE_SEIS_INT

Shindo

Local (ML)

Moment (MW)

Surface wave (MS)

ZW_SENSOR_TYPE_SEIS_MAG

Body wave (MB)

ZW_SENSOR_TYPE_UV

UV index

ZW_SENSOR_TYPE_ELEC_RES

ohm metre

ZW_SENSOR_TYPE_ELEC_COND

siemens per metre (S/m)

Absolute loudness (dB)

ZW_SENSOR_TYPE_LOUDNESS A-weighted decibels (dBA)

Percentage value

Volume water content (m3/m3)

Impedance (k ohm)

ZW_SENSOR_TYPE_MOIST

Water activity (aw)

ZW_SENSOR_TYPE_FREQ

Hz - Must be used until 4.294967295 GHz

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 16 of 212

kHz- Must be used after 4.294967295 GHz

1 ZW_SENSOR_TYPE_TIME

Seconds

Celsius (C)

ZW_SENSOR_TYPE_TGT_TEMP Fahrenheit (F)

Moles per cubic meter (mol/m3)

ZW_SENSOR_TYPE_PM_2_5 Absolute microgram/cubic meter (ug/m3)

1 ZW_SENSOR_TYPE_F_CH2O

Moles per cubic meter (mol/m3)

Becquerel/cubic meter (bq/m3)

ZW_SENSOR_TYPE_RAD_CONT Picocuries/liter (pCi/L)

ZW_SENSOR_TYPE_METH_DENS

Moles per cubic meter (mol/m3)

ZW_SENSOR_TYPE_VOC

Moles per cubic meter (mol/m3)

ZW_SENSOR_TYPE_CO_LVL

Moles per cubic meter (mol/m3)

ZW_SENSOR_TYPE_SOIL_HUMD

Percentage value

ZW_SENSOR_TYPE_SOIL_REAC

Acidity (pH)

ZW_SENSOR_TYPE_SOIL_SAL

Moles per cubic meter (mol/m3)

ZW_SENSOR_TYPE_HEART_RT

Beats/minute (Bpm)

Systolic mmHg (upper number)

ZW_SENSOR_TYPE_BLOOD_PRS Diastolic mmHg (lower number)

ZW_SENSOR_TYPE_MUSCLE_MS

Kilograms (kg)

ZW_SENSOR_TYPE_FAT_MS

Kilograms (kg)

ZW_SENSOR_TYPE_BONE_MS

Kilograms (kg)

ZW_SENSOR_TYPE_TBW

Kilograms (kg)

ZW_SENSOR_TYPE_BMR

Joules (J)

ZW_SENSOR_TYPE_BMI

BMI Index

ZW_SENSOR_TYPE_ACCEL_X

(m/s2)

ZW_SENSOR_TYPE_ACCEL_Y

(m/s2)

ZW_SENSOR_TYPE_ACCEL_Z

(m/s2)

ZW_SENSOR_TYPE_SMOKE_DEN

Percentage value

ZW_SENSOR_TYPE_WATER_FLW

Liters/hour (l/h)

ZW_SENSOR_TYPE_WATER_PRS

Kilopascals (kPa)

RSSI (Percentage value)

ZW_SENSOR_TYPE_RF_SGN (dBm)

Moles per cubic meter (mol/m3)

ZW_SENSOR_TYPE_PM_10 Micrograms per cubic meter (µg/m3)

ZW_SENSOR_TYPE_RESPI_RATE

Breaths per minute (bpm)

ZW_SENSOR_TYPE_REL_MOD

Percentage value (%)

ZW_SENSOR_TYPE_BOILER_WTR_TEMP

Celsius (C)

ZW_SENSOR_TYPE_DHW_TEMP

Celsius (C)

ZW_SENSOR_TYPE_OUTSIDE_TEMP

Celsius (C)

ZW_SENSOR_TYPE_EXHAUST_TEMP

Celsius (C)

ZW_SENSOR_TYPE_WATER_CHLOR_LVL

Milligram per liter (mg/l)

ZW_SENSOR_TYPE_WATER_ACID

Acidity (pH)

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 17 of 212

ZW_SENSOR_TYPE_WATER_OXI_RED

MilliVolt (mV)

Table 31 – Meter Type

Meter Type

Description

ZW_METER_TYPE_ELEC

Electric meter

1 ZW_METER_TYPE_GAS

Gas meter

ZW_METER_TYPE_WATER

Water meter

Multi-level Sensor Type

Unit

Bitmask

kWh

0x01

kVAh

0x02

0x04

Pulse count

0x08

0x10

0x20

ZW_METER_TYPE_ELEC

Power factor

0x40

Cubic meters

0x01

Cubic feet

0x02

ZW_METER_TYPE_GAS

Pulse count

0x08

Cubic meters

0x01

Cubic feet

0x02

US gallons

0x04

ZW_METER_TYPE_WATER

Pulse count

0x08

Z-Wave Alarm Type

Description

ZW_ALRM_SMOKE

Smoke alarm

ZW_ALRM_CO

Carbon monoxide alarm

ZW_ALRM_CO2

Carbon dioxide alarm

ZW_ALRM_HEAT

Heat alarm

ZW_ALRM_WATER

Water alarm

ZW_ALRM_LOCK

Lock access control alarm

ZW_ALRM_BURGLAR

Burglar alarm or home security

7 ZW_ALRM_POWER

Power management alarm

ZW_ALRM_SYSTEM

System alarm

ZW_ALRM_EMERGENCY

Emergency alarm

ZW_ALRM_CLOCK

Alarm clock

ZW_ALRM_APPLIANCE

Home appliance alarm

ZW_ALRM_HEALTH

Home health alarm

ZW_ALRM_SIREN

Siren alarm

ZW_ALRM_WATER_VLV

Water Valve alarm

Table 32 – Meter Supported Unit Bit-Mask

Table 33 – Z-Wave Alarm/Notification Type

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 18 of 212

ZW_ALRM_WEATHER

Weather alarm

ZW_ALRM_IRRIGATION

Irrigation alarm

ZW_ALRM_GAS

Gas alarm

ZW_ALRM_PEST_CTL

Pest control

ZW_ALRM_LIGHT_SNSR

Light sensor

ZW_ALRM_WATER_QM

Water quality monitoring

ZW_ALRM_HOME_MNTR

Home monitoring

Table 34 – Z-Wave Alarm/Notification Event

Z-Wave Alarm/Notificati on type

Z-Wave Alarm/Notification Event

# Unknown event.

25 4

All

Event inactive (push mode) / Previous Events cleared (pull mode).

0 Smoke detected with location.

Smoke detected.

Smoke alarm test.

Replacement required.

Replacement required, End-of-life.

Maintenance required, planned periodic inspection.

Smoke alarm

Maintenance required, dust in device.

Carbon monoxide detected with location.

Carbon monoxide detected.

Carbon monoxide test. Event parameter value: 1 = OK; 2 = Failed.

3 Replacement required.

Replacement required, End-of-life.

Alarm silenced.

Carbon monoxide alarm

Maintenance required, planned periodic inspection.

Carbon dioxide detected with location.

Carbon dioxide detected.

Carbon dioxide test. Event parameter value: 1 = OK; 2 = Failed.

3 Replacement required.

Replacement required, End-of-life.

Alarm silenced.

Carbon dioxide alarm

Maintenance required, planned periodic inspection.

Overheat detected with location info.

Heat alarm Overheat detected.

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 19 of 212

Rapid temperature rise detected with location.

Rapid temperature rise detected.

Underheat detected with location.

Underheat detected.

Heat alarm test.

Replacement required, End-of-life.

Alarm silenced.

Maintenance required, dust in device.

Maintenance required, planned periodic inspection.

Rapid temperature fall with location info.

Rapid temperature fall.

Water leak detected with location.

Water leak detected.

Water level drop detected with location.

Water level drop detected.

Replace Water Filter.

Water flow. Event parameter value: 1=no data; 2=below low threshold; 3=above high threshold; 4=max.

6 Water pressure. Event parameter meaning same as those for water flow.

Water temperature. Event parameter value: 1 = no data; 2=below low threshold; 3 = above high threshold.

Water level. Event parameter meaning same as those for water temperature.

9 Sump pump active.

Water alarm

Sump pump failure.

Manual lock operation.

Manual unlock operation.

RF lock operation.

RF unlock operation.

Keypad lock operation with user identifier.

Keypad unlock operation with user identifier.

Manual not fully locked operation.

RF not fully locked operation.

Auto lock locked operation.

Auto lock not fully operational.

Lock jammed.

All user codes deleted.

Single user code deleted.

New user code added.

New user code not added due to duplicate code.

Keypad temporarily disabled.

Lock access control alarm

Keypad busy.

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 20 of 212

New program code entered - unique code for lock configuration.

Manually entered user access code exceeds code limit.

Unlock by RF with invalid user code.

Locked by RF with invalid user code.

Window/door is open.

Window/door is closed.

Window/door handle is open.

Window/door handle is closed.

User Code entered via keypad (with event param: ZW_ALRM_PARAM_USRID)

Barrier performing Initialization process. Event parameter value: 0 = Completed; 0xFF = In progress.

64 Barrier operation (Open / Close) force has been exceeded.

Barrier motor has exceeded manufacturer’s operational time limit. Event parameter value: 0 to 0x7F = 0 to 127 seconds; 0x80 to 0xFE = 1 to 127 minutes.

66 Barrier operation has exceeded physical mechanical limits. (For example: barrier has opened past the open limit.)

Barrier unable to perform requested operation due to UL requirements.

Barrier Unattended operation has been disabled per UL requirements.

Barrier failed to perform Requested operation, device malfunction

Barrier Vacation Mode. Event parameter value: 0 = disabled; 0xFF = enabled.

Barrier Safety Beam Obstacle. Event parameter value: 0 = no obstruction; 0xFF = obstruction.

Barrier Sensor Not Detected / Supervisory Error. Event parameter value: 0 = sensor not defined; 1 to 0xFF = sensor ID.

Barrier Sensor Low Battery Warning. Event parameter value: 0 = sensor not defined; 1 to 0xFF = sensor ID.

74 Barrier detected short in Wall Station wires.

Barrier associated with non-Z-Wave remote control.

Intrusion detected with location.

Intrusion detected.

Tampering, product covering removed.

Tampering, Invalid Code.

Glass breakage detected with location.

Glass breakage detected.

Motion detected with location info.

Burglar alarm

Motion detected with unknown location info.

Power has been applied.

Power management

AC mains disconnected.

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 21 of 212

AC mains reconnected.

Surge Detection.

Voltage Drop/Drift detected.

Over-current detected.

Over-voltage detected.

Over-load detected.

Load error.

Replace battery soon.

Replace battery now.

Battery is charging.

Battery is fully charged.

Charge battery soon.

Charge battery now.

Back-up battery is low.

alarm

Battery fluid is low.

System hardware failure.

System software failure.

System hardware failure with OEM proprietary failure code.

System alarm

System software failure with OEM proprietary failure code.

Contact police.

Contact fire service.

Emergency alarm

Contact medical service.

Wake up.

Timer ended.

Alarm clock

Time remaining. Event parameter value (3 bytes): byte-0 unit = hours; byte-1 unit = minutes; byte-2 unit = seconds.

Barrier performing Initialization process.

Barrier operation (Open / Close) force has been exceeded.

Barrier motor has exceeded manufacturer’s operational time limit.

Barrier operation has exceeded physical mechanical limits. (For example, barrier has opened past the open limit.)

Barrier unable to perform requested operation due to UL requirements.

Barrier Unattended operation has been disabled per UL requirements.

Barrier failed to perform Requested operation, device malfunction.

70 Barrier Vacation Mode.

Barrier Safety Beam Obstacle.

Barrier Sensor Not Detected / Supervisory Error.

Barrier Sensor Low Battery Warning.

Barrier

Barrier detected short in Wall Station wires.

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 22 of 212

Barrier associated with non-Z-Wave remote control.

Program started.

Program in progress.

Program completed.

Replace main filter.

Failure to set target temperature.

Supplying water.

Water supply failure.

Boiling.

Boiling failure.

Washing.

Washing failure.

Rinsing.

Rinsing failure.

Draining.

Draining failure.

Spinning.

Spinning failure.

Drying.

Drying failure.

Fan failure.

Appliance

Compressor failure.

Leaving Bed.

Sitting on bed.

Lying on bed.

Posture changed.

Sitting on edge of bed.

Volatile Organic Compound level. Event parameter value (pollution level): 1 = clean; 2 = Slightly polluted ; 3 = Moderately polluted; 4 = Highly polluted.

Sleep apnea detected. Event parameter value (breath level): 1 = low breath; 2 = No breath at all.

7 Sleep stage 0 detected: Dreaming/REM.

Sleep stage 1 detected: Light sleep, non-REM 1.

Sleep stage 2 detected: Medium sleep, non-REM 2.

Home Health

Sleep stage 3 detected: Deep sleep, non-REM 3.

Siren

Siren Active.

Valve Operation. Event parameter value: 0 = closed; 1 = open.

Master Valve Operation. Event parameter value: 0 = closed; 1 = open.

2 Valve Short Circuit.

Water Valve

Master Valve Short Circuit.

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 23 of 212

Valve Current Alarm. Event parameter value: 1 = no data; 2 = below low threshold; 3 = above high threshold; 4 = max.

5 Master Valve Current Alarm. Event parameter value same as Valve Current Alarm.

6 Rain.

Moisture.

Weather

Freeze

Schedule Started. Event parameter value is schedule ID.

Schedule Finished. Event parameter value is schedule ID.

Valve Table Run Started. Event parameter value is valve table ID.

Valve Table Run Finished. Event parameter value is valve table ID.

Irrigation

Device is not Configured.

Combustible Gas detected with location info.

Combustible Gas detected with unknown location info.

Toxic Gas detected with location info.

Toxic Gas detected with unknown location info.

Gas Alarm Test.

Gas

Replacement Required.

Trap armed with location info.

Trap armed.

Trap rearm required with location info.

Trap rearm required.

Pest detected with location info.

Pest detected.

Pest exterminated with location info.

Pest Control

Pest exterminated.

Light detected.

Light Sensor Light color transition detected.

Chlorine alarm. Event parameter value: 1 = Below low threshold; 2 = Above high threshold.

Acidity (pH). Event parameter value: 1 = Below low threshold; 2 = Above high threshold; 3 = Decreasing pH; 4 = Increasing pH.

Water Oxidation alarm. Event parameter value: 1 = Below low threshold; 2 = Above high threshold.

3 Chlorine empty.

Acidity empty.

Waterflow measuring station shortage detected.

Waterflow clear water shortage detected.

Water Quality Monitoring

Disinfection system error detected. Event parameter value (bitmask): bit 0~3: System 1~4 disorder detected. bit 4~7: System 1~4 salt shortage.

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 24 of 212

Filter cleaning ongoing. Event parameter value: 1~255 = Filter number.

9 Heating operation ongoing.

Filter pump operation ongoing.

Freshwater operation ongoing.

Dry protection operation active.

Water tank is empty.

Water tank level is unknown.

Water tank is full.

Collective disorder.

Home occupied with location info.

Home Monitoring

Home occupied.

Table 35 – Z-Wave Alarm/Notification Event Parameter Type

Z-Wave Alarm/Notification Event Parameter Type

Description

ZW_ALRM_PARAM_LOC

Node location UTF-8 string (NULL terminated).

ZW_ALRM_PARAM_USRID

User ID. 1 or 2 bytes long; if 2 bytes, the first byte is the MSB

2 ZW_ALRM_PARAM_OEM_ERR_CODE

OEM proprietary system failure code.

ZW_ALRM_PARAM_PROPRIETARY

Proprietary event parameters.

ZW_ALRM_PARAM_EVENT_ID

Event ID which is no more active.

ZW_ALRM_PARAM_UNKNOWN

Unknown alarm event parameters. It could be from a higher version of CC, or the device violates the spec and send parameters when Spec does not define.

255

Alarm Sensor Type

Description

Assigned Number

ZW_ALRM_SNSR_TYPE_GP

General Purpose Alarm

ZW_ALRM_SNSR_TYPE_SMOKE

Smoke Alarm

ZW_ALRM_SNSR_TYPE_CO

CO Alarm

ZW_ALRM_SNSR_TYPE_CO2

CO2 Alarm

ZW_ALRM_SNSR_TYPE_HEAT

Heat Alarm

ZW_ALRM_SNSR_TYPE_WATER_LEAK

Water Leak Alarm

Thermostat Setpoint Type

Description

Assigned Number

ZW_THRMO_SETP_TYP_HEATING

Heating

ZW_THRMO_SETP_TYP_COOLING

Cooling

ZW_THRMO_SETP_TYP_FURNACE

Furnace

ZW_THRMO_SETP_TYP_DRY

Dry air

ZW_THRMO_SETP_TYP_MOIST

Moist air

ZW_THRMO_SETP_TYP_AUTO_CHANGEOVER

Auto changeover

Table 36 – Alarm Sensor Type

Table 37 – Thermostat Setpoint Types: ZW_THRMO_SETP_TYP_XXX

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 25 of 212

ZW_THRMO_SETP_TYP_ENE_SAVE_HEAT

Energy Save Heating

ZW_THRMO_SETP_TYP_ENE_SAVE_COOL

Energy Save Cooling

ZW_THRMO_SETP_TYP_AWAY_HEAT

Away heating

ZW_THRMO_SETP_TYP_AWAY_COOL

Away cooling

ZW_THRMO_SETP_TYP_FULL_POWER

Full power

Table 38 – Thermostat Setpoint Unit

Thermostat Setpoint Unit

Description

Assigned Number

ZW_THRMO_SETP_UNIT_C

Celsius

ZW_THRMO_SETP_UNIT_F

Fahrenheit

Door lock Operation Mode

Description

Assigned Number

ZW_DOOR_UNSEC

Door unsecured.

ZW_DOOR_UNSEC_TMOUT

Door unsecured with timeout. Fallback to secured mode after timeout has expired.

ZW_DOOR_UNSEC_IN

Door unsecured for inside door handles.

ZW_DOOR_UNSEC_IN_TMOUT

Door unsecured for inside door handles with timeout.

17 ZW_DOOR_UNSEC_OUT

Door unsecured for outside door handles.

ZW_DOOR_UNSEC_OUT_TMOUT

Door unsecured for outside door handles with timeout.

ZW_DOOR_SEC

Door secured.

255

Door lock Operation Type

Description

Assigned Number

ZW_DOOR_OP_CONST

Constant operation.

ZW_DOOR_OP_TIMED

Timed operation.

Attribute

Type

I/O

Description

dev_ent

unsigned

Device entry number (starting from 1)

ep_ent

unsigned

Endpoint entry number (starting from 1)

if_ent

unsigned

Interface entry number (starting from 1)

Table 39 – Door Lock Operation Mode

Table 40 – Door lock Operation Type

Table 41 – dev_cfg_error_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 26 of 212

3.2 zwdev_cfg_free

Attribute

Type

I/O

Description

records

dev_rec_t *

Device specific configuration records

record_cnt

intINumber of records stored in "records" array

Attribute

Type

I/O

Description

global_sett

dev_global_sett_t *

Device setting records

global_sett_cnt

uint16_t

Number of records stored in " global_sett" array

Attribute

Type

I/O

Description

srch_key

dev_rec_srch_key_t *

Search key

records

dev_rec_t *

Device-specific configuration records sorted according to manufacturer ID, product type ID, and product ID.

record_cnt

intINumber of records stored in "records" array.

matched_rec

dev_rec_t *

The matched record; either exact match or partial match as explained in the note below. Note: This function supports "don't care" cases in device-specific configuration records. The search priority is as follows (in the format (Manf ID, Product Type, Product ID)) : (V, V, V), (V, V, X), (V, X, X), (X, X, X) where V="valid value" and X="don't care".

Return

intONon-zero if a match is found; else returns zero.

Attribute

Type

I/O

Description

vid

uint32_t

Vendor or Manufacturer ID

ptype

uint32_t

Product Type ID

pid

uint32_t

Product ID

Free device-specific configuration records.

Table 42 – zwdev_cfg_free Parameters

3.3 zwdev_global_sett_free

Free device global settings.

Table 43 – zwdev_global_sett_free Parameters

3.4 zwdev_cfg_find

Search for a match in device-specific configuration records.

Table 44 – zwdev_cfg_find Parameters

Table 45 – dev_rec_srch_key_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 27 of 212

4 Network API

Attribute

Type

I/O

Description

zwnet_gw_discvr_cb_t

Callback function when the scanning has completed.

usr_param

void *

User-defined parameter used in callback function.

ipv4

intIFlag to indicate whether to use IPv4 as transport IP protocol. 1= use IPv4; 0= use IPv6.

use_mdns

intIFlag to indicate whether to use MDNS for gateway discovery. Note: MDNS gateway discovery is only supported in ZIPGW version 2.

return

void *

Context on success, NULL on failure. Caller is required to call zwnet_gw_discvr_stop() with the returned context if it is not null.

Attribute

Type

I/O

Description

gw_addr

uint8_t *

Gateway addresses. If the ipv4 flag is set, each gateway address is 4-bytes long; otherwise, each gateway address is 16-bytes long.

gw_cnt

uint8_t

Number of gateway addresses returned in gw_addr.

ipv4

intIFlag to indicate the gw_addr parameter is IPv4 or IPv6. 1=IPv4; 0=IPv6.

usr_param

void *

User-defined parameter passed when calling zwnet_gw_discvr_start().

rpt_num

intIReport number that this callback is delivering the gateway addresses report; start from 1.

total_rpt

intITotal reports that will be delivered by callbacks. Each callback delivers one report. Zero is returned if there is no valid IP to facilitate gateway discovery.

gw_name

char * *

Gateway names corresponding to the gw_addr. If NULL, it means gateway name information is unavailable.

The network is seen through the eyes of a ZIPGW attached controller.

4.1 Discovering ZIPGWs

4.1.1 zwnet_gw_discvr_start

This call starts a network scanning for ZIPGW IP addresses using the ZIPGW Discovery protocol. Once the scanning is done, the result will be available through a callback function. Take note that this function can be called without calling the zwnet_init function first.

Table 46 – zwnet_gw_discvr_start Parameters

Table 47 – zwnet_gw_discvr_cb_t Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 28 of 212

4.1.2 zwnet_gw_discvr_stop

Attribute

Type

I/O

Description

ctx

void *

The context returned from the call to zwnet_gw_discvr_start().

return

intOZero on success, non-zero on failure.

Attribute

Type

I/O

Description

init

zwnet_init_t *

User filled initialization information.

net

zwnet_t **

Handle to network for use in other zwnet_xxx API calls.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

user

void *

User context used in callbacks.

host_port

uint16_t

Host listening and sending port.

use_ipv4

IntIFlag to indicate whether to use IPv4 as transport IP protocol. 1=use IPv4; 0=use IPv6.

zip_router

uint8_t[16]

ZIPGW (gateway) IPv4/IPv6 address in numeric format.

notify

zwnet_notify_fn

Network operation notification.

node

zwnet_node_fn

Node add/delete/status callback.

appl_tx

zwnet_appl_fn

Application transmit data status callback.

inif_cb

pl_info_fn

Unsolicited included node information frame (INIF) callback when a Smart Start device (which has joined a foreign network

This call stops the network scanning for ZIPGW IP addresses and frees the resources used in network scanning. Take note that this function should not be called in the callback function that was passed to the zwnet_gw_discvr_start function as parameter cb.

Table 48 – zwnet_gw_discvr_stop Parameters

4.2 Network Initialization and Clean up

4.2.1 zwnet_init

This call runs a state-machine to acquire the ZIPGW attached controller’s Home ID, Node ID, HAN address, and node list of the HAN. An internal network data structure is created and initialized with each of the node IDs found in the acquired node list. A user application could get access to the controller Home ID and Node ID by calling zwnet_get_desc API only after the zwnet_notify_fn callback function returns status is ZW_ERR_NONE. To populate the internal network data structure with endpoints and interfaces, this API tries to retrieve the node information from an internally maintained database. For those nodes found in the controller routing table but without corresponding node information in the database, the node information state-machine is invoked to get the information (CCs supported, CC version, node name and location, manufacturer ID, product type ID, product ID and multiinstance/channel endpoints, etc.) directly from the node device.

Table 49 – zwnet_init Parameters

Table 50 – zwnet_init_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 29 of 212

but is listed in the local provisioning list) is powering up.

unhandled_cmd

zwnet_unhandled_cmd_fn

Unhandled command callback.

print_txt_fn

print_fn

Print text function pointer.

portal_fd

intINetwork file descriptor to connect to ZIPGW using TLS.

portal_ssl

void *

SSL object pointer to connect to ZIPGW using TLS.

display_ctx

void *

Display context for the print_txt_fn.

net_err

zwnet_net_err_fn

Unrecoverable network error callback, application should close this instance of ZWare object, i.e. call zwnet_exit().

portal_prof

clnt_prof_t

Profile of the ZIPGW that is connected to the portal.

net_info_dir

const char *

Full path of directory for storing network and node information file (a.k.a. network persistent storage). The file is generated by the library with filename in the format “nifXXXXXXXX.dat”, where XXXXXXXX denotes Z-Wave network home ID.

pref_dir

const char *

Full path of directory for storing network/user preference files.

dev_cfg_file

const char *

Device-specific configurations file (a.k.a device database) in JSON format. If it is NULL, device-specific configurations will be managed by user application. In this case, dev_cfg_usr must be valid.

cmd_cls_cfg_file

const char *

Optional CC configuration file. Enable specific CC probing after a new node inclusion and during background polling. If NULL, ALL supported CCs are enabled. The current supported CC configuration file is distributed in the “config” folder of the source distribution with the name “cmd_class.cfg”.

dev_cfg_usr

dev_cfg_usr_t *

Device-specific configurations (managed by user application). If it is NULL, devicespecific configurations will be managed by Z-Ware Library internally. In this case, dev_cfg_file must be valid.

err_loc

dev_cfg_error_t

Error location while parsing device-specific configuration file. Note: The error is not due to JSON format parsing error.

sup_cmd_cls

sup_cmd_cls_t *

User application implemented CCs.NOTE: if the controller has already implemented the

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 30 of 212

CC, the user's request for that CC will be ignored.

sup_cmd_cls_cnt

uint8_t

User application implemented CCs count.

s2_unsolicited_cb

add_node_sec2_fn

Callback to report unsolicited joining device requested keys and/or status of Device Specific Key (DSK)

dtls_psk*

uint8_t[32]

DTLS pre-shared key in binary format, MUST be at least 16 bytes.

dtls_psk_len*

uint8_t

DTLS pre-shared key length (bytes). If length is zero, no DTLS will be used, i.e., communication will be insecured.

Note: Attributes marked with (#) are only available for the Portal version; whereas those

Attribute

Type

I/O

Description

dev_rec_find_fn

zwnet_dev_rec_find_fn

User-supplied function to find device record

dev_cfg_ctx

void *

User-specified device configuration context for use in dev_rec_find_fn

dev_glob_sett

dev_global_sett_t *

Optional device global settings

global_sett_cnt

uint16_t

Global settings count in dev_glob_sett

Attribute

Type

I/O

Description

dev_cfg_ctx

void *

User-specified device configuration context.

srch_key

dev_rec_srch_key_t *

Search key.

matched_rec

dev_rec_t *

The matched record; either exact match or partial match as explained in the note below. Note: This function supports "don't care" cases in device-specific configuration records. The search priority is as follows (in the format (Manf ID, Product Type, Product ID)): (V, V, V), (V, V, X), (V, X, X), (X, X, X) where V="valid value"; X="don't care".

return

intONon-zero if a match is found; else returns zero.

Attribute

Type

I/O

Description

Setting type, GLOB_SET_TYPE_XXX:

XXX

Description

type

uint16_t

WKUP_INTV

Wakeup interval to set for a newly added sleeping node.

marked with (*) are only available for the CE version. Typical zwnet operations take in the network handle returned from this call and return the success status of the operation as show in the table below. The parameters for such operations are not further documented.

Table 51 – dev_cfg_usr_t Structure

Table 52 – zwnet_dev_rec_find_fn Parameters

Table 53 – dev_global_sett_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 31 of 212

sett

union

Settings as indicated by setting type; union of the following:

wkup_intv

uint32_t

For GLOB_SET_TYPE_WKUP_INTV

Table 54 – zwnet_xxx Generic Parameters

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle from zwnet_init return

intOZW_ERR_XXX

Attribute

Type

I/O

Description

user

void *

User context

src_node

uint8_t

Source node ID

src_ep

uint8_t

Source endpoint ID

cmd

uint8_t *

Buffer that stores the unhandled command

cmd_len

Uint16_t

Length of the unhandled command

Attribute

Type

I/O

Description

cls

uint16_t

ver

uint8_t

Version of the CC

Properties of the interface (bit-mask): BITMASK_CMD_CLS_XXX

BITMASK_CMD_CLS_INSECURE

CC is insecure

propty

uint8_t

BITMASK_CMD_CLS_SECURE

CC is secure

Attribute

Type

I/O

Description

user

void *

from zwnet_init

operation ZWNET_OP_XXX

XXX

Description

NONE

Idle.

INITIALIZE

Initializing local Z/IP controller.

ADD_NODE

Adding a node.

RM_NODE

Removing a node.

RP_NODE

Replacing a failed node.

RM_FAILED_ID

Removing a failed node.

INITIATE

Initiating in response to or anticipation of some operation.

UPDATE

Updating network topology from SUC/SIS.

RESET

Restoring ZIPGW attached controller to factory default settings.

NODE_UPDATE

Updating node information.

MIGRATE

Migrating primary controller.

uint8_t

SEND_NIF

Sending node information frame.

Table 55 – zwnet_unhandled_cmd_fn Parameters

Table 56 – sup_cmd_cls_t Structure

Table 57 – zwnet_notify_fn Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 32 of 212

NW_CHANGED

Network change detection.

NODE_CACHE_UPT

Update node cached info. (Internally used; application won’t receive this notification.)

SAVE_NW

Save network and node information to persistent storage. (Internally used; application won’t receive this notification.)

SLP_NODE_POLL

Sleeping device node information polling. (Internally used; application won’t receive this notification.)

FW_UPDT

Firmware update.

HEALTH_CHK

Network health check.

NODE_RESET

Remove node which has been reset.

FW_DOWNLD

Firmware download

Status of current operation. When upper-byte is zero, the lower byte is the current status of the operation (see table below). When upper-byte is non-zero, it represents the total number of nodes to get detailed node information, while the lower-byte represents the number of nodes that have completed getting detailed node information.

Operation: ZWNET_OP_

Status OP_

Description

DONE

Operation completed.

All

FAILED

Operation failed.

ADD_NODE_PROTOCOL_DONE

Protocol part done.

ADD_NODE_GET_NODE_INFO

Getting node detailed information.

ADD_NODE

ADD_NODE_PROTOCOL_START

Smart Start add node Z-Wave protocol started.

RP_NODE_PROTOCOL_DONE

Protocol part done.

RP_NODE

RP_NODE_GET_NODE_INFO

Getting node detailed information.

INI_PROTOCOL_DONE

Protocol part done.

INITIATE

INI_GET_NODE_INFO

Getting node detailed information.

sts

uint16_t

UPDATE

NU_TOPOLOGY

Network topology update started.

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 33 of 212

NU_NEIGHBOR

Node neighbor update started.

NU_GET_NODE_INFO

Node information update started.

FW_UPLOAD_STARTED

Uploading firmware to device started.

FW_UPDT

FW_UPLOADING

Uploading firmware to device in progress.

HEALTH_CHK_STARTED

Network health check started.

HEALTH_CHK_PROGRESS

Network health check in progress.

HEALTH_CHK

HEALTH_CHK_CMPLT

Network health check completed.

FW_DOWNLD_STARTED

Downloading firmware from device (for backup purposes) has started.

FW_DOWNLD

FW_DOWNLOADING

Downloading firmware from device in progress.

info

zwnet_sts_t *

Additional information for the specified op and sts; NULL if there is no additional info. For a cross reference of this additional information to the network op and sts, see table “Additional Info Associated to Network Op and Status”

ret

intIZW_ERR_XXX.

Table 58 – zwnet_sts_t Structure

Attribute

Type

I/O

Description

type

intOType of info, ZWNET_STS_INFO_XXX. See the description in “info” below.

Union of the following as indicated by “type”:

info

union

O Description

For type = ZWNET_STS_INFO_XXX

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 34 of 212

s2_dsk

char []

The S2 DSK associated with the Smart Start adding node protocol started status.

SS_START

progress_percent

uint8_t

Firmware update progress in %

FW_UPDT_PRG

health_chk_progress

zw_health_prg_t

Network health check progress

HEALTH_CHK_PRG

health_chk_rpt

zw_health_rpt_t

Network health check completion report

HEALTH_CHK_RPT

node_id

uint8_t

Node ID involved in the corresponding network operation

NODE_ID

nw_change_updt_sts

uint8_t

Network change/update status, NW_CHG_UPDT_XXX

NW_CHANGE_UPDT progress_bytes

uint32_t

Firmware download progress in number of bytes downloaded

FW_DL_PRG

Table 59 – NW_CHG_UPDT_XXX

Network change/update status

Description

NW_CHG_UPDT_NONE

No change in network id and controller

NW_CHG_UPDT_NW_ID

Network id has changed. Application needs to refresh the network structure

NW_CHG_UPDT_CTLR

Z-Wave controller has changed. Application needs to call zwnet_get_desc API to refresh controller’s properties.

Attribute

Type

I/O

Description

node_cnt

uint8_t

Number of health check completed nodes

total

uint8_t

Total number of nodes scheduled for health check

Attribute

Type

I/O

Description

sts_cnt

uint8_t

Total number of node health status in the array

sts

zw_health_sts_t []

Node health status array Attribute

Type

I/O

Description

node_id

uint8_t

Node ID

Status category derived from network health value:

NW_HEALTH_XXX

Description

sts_cat

uint8_t

GREEN

Network health is good.

Table 60 – zw_health_prg_t Structure

Table 61 – zw_health_rpt_t Structure

Table 62 – zw_health_sts_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 35 of 212

YELLOW

Network health is acceptable, but latency can be observed occasionally.

RED

Network health is insufficient because frames are dropped.

CRITICAL

Network health is critical because Z-Wave node is not responding at all.

value

uint8_t

Calculated network health value.

Table 63 – Additional Information Associated to Network Op and Status

Additional Information Type, ZWNET_STS_INFO_XXX

Network Operation, ZWNET_OP_XXX

Status OP_XXX SS_START

ADD_NODE

ADD_NODE_PROTOCOL_START

FW_UPDT_PRG

FW_UPDT

FW_UPLOADING

HEALTH_CHK_PRG

HEALTH_CHK

HEALTH_CHK_PROGRESS

HEALTH_CHK_RPT

HEALTH_CHK

HEALTH_CHK_CMPLT

NODE_RESET, RM_NODE, RM_FAILED_ID

DONE, FAILED

NODE_ID

ADD_NODE, RP_NODE, NODE_UPDATE

DONE NW_CHANGE_UPDT

NW_CHANGED, UPDATE

DONE FW_DL_PRG

FW_DOWNLD

FW_DOWNLOADING

Attribute

Type

I/O

Description

user

void *

From zwnet_init

node

zwnoded_t *

Node descriptor of the node that was added, removed, or updated

Status, ZWNET_NODE_XXX

ZWNET_NODE_XXX

Description

ADDED

Node was added. Application can retrieve detailed node information now.

REMOVED

Node was removed.

UPDATED

Node was updated. Application can retrieve updated detailed node information now.

STATUS_ALIVE

Node status has changed to "alive"

STATUS_DOWN

Node status has changed to "down"

STATUS_SLEEP

Node status has changed to "sleeping"

status

uint8_t

RESET

Received notification from node that it has been reset

Table 64 – zwnet_node_fn Parameters

Table 65 – zwnet_appl_fn Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 36 of 212

Attribute

Type

I/O

Description

user

void *

From zwnet_init

Transmission status ZWNET_TX_XXX

Successful.

NO_ACK

Send frame timeout due to no ACK received.

SYS_ERR

System error, the program should exit or restart.

DEST_BUSY

Message has not timed out yet. The destination host may have a long response time (e.g. sleeping node).

tx_sts

uint8_t

NOROUTE

Frame failed to reach destination host.

Table 66 – pl_info_fn Parameters

Attribute

Type

I/O

Description

usr_ctx

void *

User context

lst_ent

struct pl_lst_ent *

Provisioning list entry

Attribute

Type

I/O

Description

user

void *

User context which was passed to zwnet_init

Attribute

Type

I/O

Description

msg

void *

Pointer to text messages

Attribute

Type

I/O

Description

dev_cfg_ct x

void *

User-specified device configuration context. vid

uint16_t

Vendor or Manufacturer ID.

ptype

uint16_t

Product Type ID.

pid

uint16_t

Product ID.

dev_rec

dev_rec_t *

Device record found.

return

intONon-zero on found; zero on not found.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle from zwnet_init

Table 67 – zwnet_net_err_fn Parameters

Table 68 – print_fn Parameter

Table 69 – zwnet_dev_rec_find_fn Parameter

4.2.2 zwnet_exit

Clean up network and save detailed node information into file.

4.2.3 zwnet_reset

Reset the state of the ZIPGW attached controller, losing all network information. Upon completion, it will get the controller’s node information.

Table 70 – zwnet_exit Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 37 of 212

4.3 Network Creation

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle from zwnet_init.

add

uint8_t

Operation 0 – Remove. 1 – Add.

sec2_param

sec2_add_prm_t *

Parameters for adding node with Security 2 protocol. This parameter is ignored when non-security 2 ZIPGW is detected or when removing a node.

incl_on_behalf

intIFlag to indicate enter into inclusion on-behalf (iob) mode; 1=enter into iob mode, 0=normal add node. This parameter is ignored when parameter add = 0 (i.e. remove node).

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

usr_param

void *

User-defined parameter used in callback.

add_node_sec2_fn

Callback to report joining device requested keys and/or status of Device Specific Key (DSK).

dsk

char *

Optional Device Specific Key (DSK) of the joining node for verification. Note that, if this is not NULL, no DSK callback will be executed. The format of the DSK must be as shown in the example: 34028-23669-20938-46346-33746-07431-56821-14553

Attribute

Type

I/O

Description

usr_param

void *

User-supplied parameter when calling zwnet_add or zwnet_fail

cb_param

sec2_add_cb_prm _t *

DSK related callback parameters Attribute

Type

I/O

Description

Callback type as in S2_CB_TYPE_XXX :

XXX

Description

cb_type

uint8_t

REQ_KEY

Joining device requested keys

4.3.1 zwnet_add

Called by the inclusion controller to add/remove an initiating node to/from the network. On successful addition, the new node is queried for its endpoints and interfaces, secure and otherwise. If the interfaces are type sensor, the new node will be configured based on either the settings passed during network initialization or the default values. It should result in callbacks to zwnet_node_fn followed by zwnet_notify_fn.

Table 71 – zwnet_add Parameters

Table 72 – sec2_add_prm_t Structure

Table 73 – add_node_sec2_fn Parameters

Table 74 – sec2_add_cb_prm_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 38 of 212

DSK

Joining device DSK keys

req_key

sec2_keys_req_cb_prm_t

For cb_type=S2_CB_TYPE_REQ_KEY; the joining device requested keys and CSA request

dsk

sec2_dsk_cb_prm_t

For cb_type=S2_CB_TYPE_DSK; the joining device DSK keys

Table 75 – sec2_keys_req_cb_prm_t Structure

Attribute

Type

I/O

Description

req_keys

uint8_t

Requested keys (bit mask) by the joining node.

req_csa

uint8_t

Flag to indicate joining node is requesting Client-side Authentication (CSA).

csa_pin

char [12]

CSA 10-digit PIN to be entered into the joining node if req_csa is non-zero. Example: 34028-23669 (Note: The hyphen is for display purposes, it is not part of the PIN.)

Attribute

Type

I/O

Description

pin_required

uint8_t

Indicate whether the user is required to enter five-digit pin. 1=required; 0=not required.

dsk

char *

Device Specific Key (DSK) of the joining node for user to verify. Note that the first five digits of DSK are missing if pin_required=1. Example of complete DSK: 34028-23669-20938-46346-33746-07431-56821-14553 Example of DSK with first five digits missing:

-23669-20938-46346-33746-07431-56821-14553

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

intI1=accept; 0=reject.

dsk

char *

Complete Device Specific Key (DSK) of the added node if accept=1; else this can be NULL.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Table 76 – sec2_dsk_cb_prm_t Structure

4.3.2 Secure Inclusion

4.3.2.1 zwnet_add_sec2_accept

Accept or reject newly added node into Security 2 mode. This function should be called only after receiving Security 2 DSK callback during add or replace failed node operation.

Table 77 – zwnet_add_sec2_accept Parameters

4.3.2.2 zwnet_add_sec2_grant_key

Grant keys and CSA to the newly added node in Security 2 mode. This function should be called only after receiving Security 2 requested keys callback during add or replace failed node

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 39 of 212

operation. Note that it is possible to not grant any key and yet to accept S2 bootstrapping, i.e.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle

Bit mask of zero or more security 2 granted keys as in SEC_KEY_BITMSK_XXX

XXX

Description

S2_K0

S2: Class key 0 (Unauthenticated devices)

S2_K1

S2: Class key 1 (Authenticated devices)

S2_K2

S2: Class key 2 (Access control devices)

granted_keys

uint8_t

S0: Legacy security network key

grant_csa

uint8_t

Grant client-side authentication (CSA); 1=grant, 0=reject. If joining node didn't request CSA, it is ignored.

accept_s2

uint8_t

Acceptance of S2 bootstrapping process; 1=S2 bootstrapping is accepted and MUST continue, 0=S2 bootstrapping is not accepted and MUST be interrupted

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

dsk

char *

Device Specific Key (DSK). The format of the DSK must be eight groups of five digits separated by '-' as shown in the example: 34028-23669-20938-46346-33746-07431-56821-14553

info

pl_info_t *

Buffer to store additional information of the device (optional). Information type PL_INFO_TYPE_NW_STS must not be used in this function.

info_cnt

uint8_t

Number of additional information stored in "info".

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

Information type, PL_INFO_TYPE_XXX

XXX

Description

PROD_TYPE

Product type

PROD_ID

Product ID

INC_INTV

Smart Start inclusion request interval used by the node

type

uint8_t

UUID16

UUID assigned to the node

granted_keys=0 and accept_s2=1.

Table 78 – zwnet_add_sec2_grant_key Parameters

4.3.3 SmartStart Provisioning

4.3.3.1 zwnet_pl_add

Add a provisioning list entry.

Table 79 – zwnet_pl_add Parameters

Table 80 – pl_info_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 40 of 212

NAME

Device name

LOC

Device location

INCL_STS

Inclusion status of the provisioning list entry

S2_GRNT

S2 keys to be granted

BOOT_MODE

Bootstrapping mode

NW_STS

Network status of the provisioning list entry

info

union

Provisioning list entry information. The union of the following:

name

char [63]

For type PL_INFO_TYPE_NAME; device name string in UTF-8 encoding which must be compliant with the following rules:

 The combined "name" and "loc" strings MUST NOT

be longer than 62 bytes (excluding NUL terminating char)

 The escape sequence "\." (backslash followed by

dot) must be used for encoding the dot character '.'

 MUST NOT contain the underscore character '_'  MUST NOT end with the dash character '-'  MUST be case insensitive

loc

char [63]

For type PL_INFO_TYPE_LOC; device location string in UTF8 encoding with same restrictions as "name" field.

prod_type

pl_prod_type_t

For type PL_INFO_TYPE_PROD_TYPE; product type.

prod_id

pl_prod_id_t

For type PL_INFO_TYPE_PROD_ID; product ID.

interval

uint8_t

For type PL_INFO_TYPE_INC_INTV; Smart Start inclusion request interval in unit of 128 seconds. This field must have value ranging from 5 to 99.

uuid

pl_uuid_t

For type PL_INFO_TYPE_UUID16; UUID assigned to the node as defined by IETF RFC 4122.

nw_sts

pl_nw_sts_t

For type PL_INFO_TYPE_NW_STS; network status of the provisioning list entry.

For type PL_INFO_TYPE_INCL_STS; inclusion status of the provisioning list entry, PL_INCL_STS_XXX.

XXX

Description

PENDING

The node will be included in the network when it issues SmartStart inclusion requests.

incl_sts

uint8_t

PASSIVE

The node is in the Provisioning List, but it has been decided by the supporting or controlling node that the node is unlikely to issue SmartStart inclusion requests in the near future. SmartStart Inclusion requests will be ignored by the Z/IP Gateway. All entries with this status MUST be updated to the

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 41 of 212

“Pending” status (PL_INCL_STS_PENDING) when a Provisioning List Iteration Get Command is received.

IGNORED

SmartStart inclusion requests sent by the node in the Provisioning List entry will be ignored until the status is changed again by a Z/IP Client or controlling node.

grnt_keys

uint8_t

For type PL_INFO_TYPE_S2_GRNT; S2 keys to be granted, see SEC_KEY_BITMSK_XXX.

For type PL_INFO_TYPE_BOOT_MODE; Bootstrapping mode, as in PL_BOOT_MODE_XXX.

XXX

Description

The node MUST manually be set to Learn Mode and follow the S2 bootstrapping instructions (if any).

boot_mod e

uint8_t

SMART_STRT

The node will be included and S2 bootstrapped automatically using the Smart Start functionality.

Table 81 – pl_prod_type_t Structure

Attribute

Type

I/O

Description

generic_cls

uint8_t

Generic device class

specific_cls

uint8_t

Specific device class

icon_type

uint16_t

Installer icon type

Attribute

Type

I/O

Description

manf_id

uint16_t

Manufacturer ID

prod_type

uint16_t

Product type

prod_id

uint16_t

Product ID

app_ver

uint8_t

Application version

app_sub_ver

uint8_t

Application sub version

Attribute

Type

I/O

Description

Presentation format, as in UUID_PRES_XXX.

XXX

Description

32HEX

32 hex digits, no delimiters

16ASCII

16 ASCII chars, no delimiters

SN_32HEX

"sn:" followed by 32 hex digits, no delimiters

SN_16ASCII

"sn:" followed by 16 ASCII chars, no delimiters

pres_fmt

uint16_t

UUID_32HEX

"UUID:" followed by 32 hex digits, no delimiters

Table 82 – pl_prod_id_t Structure

Table 83 – pl_uuid_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 42 of 212

UUID_16ASCII

"UUID:" followed by 16 ASCII chars, no delimiters

RFC4122

RFC4122 compliant presentation (e.g., “58D5E212-165B-4CA0-909BC86B9CEE0111”)

uuid

uint8_t[16]

UUID assigned to the node as defined by IETF RFC 4122.

Table 84 – pl_nw_sts_t Structure

Attribute

Type

I/O

Description

node_id

uint8_t

NodeID that has been assigned to the Provisioning List entry during network inclusion. 0 indicates that the NodeID is not assigned.

network status of the Provisioning List entry, as in PL_NW_STS_XXX.

XXX

Description

NOT_INCL

The node in the Provisioning List is not currently included (added) in the network.

ADDED

The node in the Provisioning List is included in the network and is functional.

status

uint8_t

FAILED

The node in the Provisioning List has been included in the Z-Wave network but is now marked as failing.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

dsk

char *

Device Specific Key (DSK). The format of the DSK must be eight groups of five digits separated by '-' as shown in the example: 34028-23669-20938-46346-33746-07431-56821-14553

pl_info_fn

Callback to report provisioning entry information.

usr_ctx

void *

User context used in callback.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

usr_ctx

void *

User context

lst_ent

pl_lst_ent_t *

Provisioning list entry Attribute

Type

I/O

Description

4.3.3.2 zwnet_pl_get

Get a provisioning list entry information through callback.

Table 85 – zwnet_pl_get Parameters

Table 86 – pl_info_fn Parameters

Table 87 – pl_lst_ent_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 43 of 212

dsk

char [48]

Device Specific Key (DSK). The format of the DSK must be eight groups of five digits separated by '-' as shown in the example: 34028-23669-20938-46346-33746-07431-56821-14553

info

pl_info_t[10]

Information of the device.

info_cnt

uint8_t

Number of information stored in "info". If zero, the dsk is not found in the provisioning list.

4.3.3.3 zwnet_pl_del

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

dsk

char *

Device Specific Key (DSK). The format of the DSK must be eight groups of five digits separated by '-' as shown in the example: 34028-23669-20938-46346-33746-07431-56821-14553

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

pl_list_fn

Callback to report provisioning list entries.

usr_ctx

void *

User context used in callback.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

usr_ctx

void *

User context.

pl_list

pl_lst_ent_t *

Provisioning list. ent_cnt

uint8_t

Number of entries in provisioning list 'pl_list'.

lst_cmplt

intIFlag to indicate whether all the entries in 'pl_list' represent the whole list in ZIPGW. 1=all the entries have been retrieved from ZIPGW; 0=some of the entries were not retrieved due to error.

Attribute

Type

I/O

Description

Net

zwnet_t *

Network handle.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Delete a provisioning list entry.

Table 88 – zwnet_pl_del Parameters

4.3.3.4 zwnet_pl_list_get

Get all provisioning entries through callback.

Table 89 – zwnet_pl_list_get Parameters

Table 90 – pl_list_fn Parameters

4.3.3.5 zwnet_pl_list_del

Delete all provisioning list entries.

Table 91 – zwnet_pl_list_del Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 44 of 212

4.4 Network Management

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

get_dsk_fn

Callback to report ZIPGW DSK when joining another S2 capable Z-Wave network. Note that the callback will not be invoked if the ZIPGW is not S2 capable or this API is invoked to leave a Z-Wave network.

usr_ctx

void *

User context used in callback.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

nodeid

uint8_t

Failed node ID. This parameter is ignored when rplc_on_behalf = 1.

replace

uint8_t

Operation 0 – Remove. 1 – Replace with a new initiating node.

sec2_param

sec2_add_prm_t *

Optional parameters for replacing node with Security 2 protocol. This parameter is ignored when removing failed node (i.e. replace = 0).

rplc_on_behalf

intIFlag to indicate enter into "replace failed node" onbehalf (rob) mode; 1=enter into rob mode, 0=normal replace failed node. This parameter is ignored when parameter replace = 0.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

4.4.1 zwnet_initiate

Indicates willingness to add/remove itself to/from the network or become the new primary. This action is paired with a corresponding zwnet_add or zwnet_migrate from another controller. Upon completion, it will rebuild its internal network structure if it has been added into a new network.

Table 92 – zwnet_initiate Parameters

4.4.2 zwnet_fail

Called by the inclusion controller to replace/remove a failed node in the network. When replaced, information on the node will be refreshed.

Table 93 – zwnet_fail Parameters

4.4.3 zwnet_update

This function updates network topology, routing table, and internal network data structures. As it may take several iterations to complete if there are nodes that are out of direct range, calling of this function should be scheduled at a time of low network activity.

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 45 of 212

4.4.4 zwnet_abort

Attribute

Type

I/O

Description

net

zwnet_t *

network handle from zwnet_init

return

zwnetd_t *

network descriptor Attribute

Type

I/O

Description

uint32_t

Z-Wave Home ID

ctl_id

uint8_t

Z/IP controller node ID

Z/IP controller role. A bit-mask of ZWNET_CTLR_ROLE_XXX :

ZWNET_CTLR_ROLE_PROXY

Support Network Management Proxy

ZWNET_CTLR_ROLE_INCL

Support Network Management Inclusion

ctl_role

uint8_t

ZWNET_CTLR_ROLE_PRI

Support Network Management Primary

Z/IP controller capabilities. A bit-mask of ZWNET_CTLR_CAP_XXX:

ZWNET_CTLR_CAP_S2

Support Security 2 protocol

ZWNET_CTLR_CAP_INC_ON_BEHALF

Support inclusion on-behalf

ZWNET_CTLR_CAP_SMART_START

Support Smart Start

ZWNET_CTLR_CAP_IMA

Support IMA (Z-Wave Network Installation and maintenance)

ctl_cap

uint8_t

ZWNET_CTLR_CAP_MULTICAST

Support multicast addressing

Abort current operation. The user should be aware that aborting certain network operations, such as add, replace, or joining/leaving a Z-Wave network depends on the stage at which the operation is aborted and hence the operation may not be undone completely. For example, once the callback function, zwnet_notify_fn, delivers the status of ADD_NODE_PROTOCOL_DONE, RP_NODE_PROTOCOL_DONE, or INI_PROTOCOL_DONE (for joining a network), the device has already been added to the Z-Wave network, and aborting the operation at this moment still results in the node being added. To undo the operation completely, the user needs to execute the remove node operation manually. Similarly, for leaving a Z-Wave network, if the callback function, zwnet_notify_fn, delivers the status of INI_PROTOCOL_DONE, the Z/IP gateway attached controller has already been removed from the Z-Wave network, and aborting the operation at this moment is considered too late. The user has to manually execute the API zwnet_initiate command to rejoin the Z-Wave network.

4.5 Network Attributes and Traversal

4.5.1 zwnet_get_desc

Get the read-only network descriptor for node enumeration and other purposes.

Table 94 – zwnet_get_desc Parameters

Table 95 – zwnetd_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 46 of 212

ZWNET_CTLR_CAP_IDENTIFY

Capable to identify itself (e.g. blinking a LED)

Z/IP controller Z-Wave role, ZW_ROLE_XXX:

ZW_ROLE_UNKNOWN

Unknown

ZW_ROLE_SIS

SIS

ZW_ROLE_INCLUSION

Inclusion controller

ZW_ROLE_PRIMARY

Primary controller

ctl_zw_role

uint8_t

ZW_ROLE_SECONDARY

Secondary controller

user

void *

User context which was passed to zwnet_init

plt_ctx

void *

Platform context for printing of output text messages

4.5.2 zwnet_version

Attribute

Type

I/O

Description

ver

uint8_t *

Version

subver

uint8_t *

Sub version

patch_ver

uint8_t *

Patch version

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle

noded

zwnoded_t *

Node handle

return

IntOZW_ERR_NONE on success; else ZW_ERR_XXX

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

nodeid

uint8_t

Node ID.

noded

zwnoded_t *

Node descriptor (Can be NULL, if the purpose is to verify the existence of a node).

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle

nodeid

uint8_t

Node ID

Get the home controller API version, subversion and patch version.

Table 96 – zwnet_version Parameters

4.5.3 zwnet_get_node

Get the first node (local controller) in the network.

Table 97 – zwnet_get_node Parameters

4.5.4 zwnet_get_node_ by_id

Get node with specified node ID in the network.

Table 98 – zwnet_get_node_by_id Parameters

4.5.5 zwnet_get_ep_ by_id

Get endpoint with specified node and endpoint ID in the network.

Table 99 – zwnet_get_ep_by_id Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 47 of 212

epid

uint8_t

Endpoint ID

epd

zwepd_t *

Endpoint descriptor (Can be NULL, if the purpose is to verify the existence of an endpoint).

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

4.5.6 zwnet_get_if_ by_id

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle

nodeid

uint8_t

Node ID.

epid

uint8_t

Endpoint ID.

cls

uint16_t

Interface ID (CC).

ifd

zwifd_t *

Interface descriptor (Can be NULL, if the purpose is to verify the existence of an interface).

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle

Buffer (min. size of 233 bytes) to store all the node status. Individual node status (ZWNET_NODE_STS_XXX) can be accessed using the node ID as index to the buffer.

ZWNET_NODE_STS_SLEEP

Node is sleeping.

ZWNET_NODE_STS_DOWN

Node is down.

node_sts_buf

uint8_t *

ZWNET_NODE_STS_UP

Node is alive.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

node_id

uint8_t

Node ID (ranging from 1 to 232).

return

uint8_t

Node status (ZWNET_NODE_STS_XXX).

Get interface with specified node, endpoint and interface id in the network.

Table 100 – zwnet_get_if_by_id Parameters

4.5.7 zwnet_all_node_sts_get

Get all node status.

Table 101 – zwnet_all_node_sts_get Parameters

4.5.8 zwnet_node_sts_get

Get node status.

Table 102 – zwnet_node_sts_get Parameters

4.6 Advanced Network APIs

These are APIs that are not required for normal operation but are provided for special purposes.

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 48 of 212

4.6.1 zwnet_migrate

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

get_dsk_fn

usr_ctx

void *

User context used in callback.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle from zwnet_init. return

void *

User context that was passed as parameter when calling zwnet_init.

This API is called by the primary controller to transfer its primary controller role to another initiating controller. The initiating controller must not be currently part of this network if it runs on older firmware, and a new node will be created with similar effect as with zwnet_add. With current firmware, the initiating controller can be a secondary controller in the network; in this case, no new node is created. Upon completion, the controller invoking this function will become the secondary controller. It will then get node information from the new primary controller and resolve the primary controller node ID into the IPv6 address.

4.6.2 zwnet_initiate_classic

This API is provided mainly for backward compatibility with older Z-Wave controllers that support only classic learn mode. For description and usage, please refer to the previous section, zwnet_initiate.

Table 103 – zwnet_initiate_classic Parameters

4.6.3 zwnet_health_chk

Start network health check on all but sleeping nodes. This is part of the Installation and Maintenance (IMA) utility function. It is recommended that the network health check be run during the period when there are few or no network activities running as the process may take a long time to complete.

4.6.4 zwnet_identify

Instruct the controller to identify itself (for example, by blinking an LED in a specific manner). This API is used to support Z-Wave Plus v2 node (including Z/IP gateway controller node), which must have a visible LED to be used for an Identify function. If the node is itself a light source, e.g., a light bulb, this may be used in place of a dedicated LED.

4.6.5 zwnet_get_user

Get the user context associated with the network handle.

Table 104 – zwnet_get_user Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 49 of 212

4.6.6 zwnet_send_nif

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

noded

zwnoded_t *

Handle of the destination node that will receive the node information frame. NULL for broadcast of NIF.

broadcast

uint8_t

Broadcast flag. 1= broadcast; 0= single cast.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

handle

uint16_t

Handle of the polling request to remove.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

usr_token

uint32_t

User token of the polling request to remove.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle

buf

void *

Buffer that contains the network preference

buf_size

uint16_t

Buffer size in bytes

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

buf

void **

Return buffer that contains the network preference.

buf_size

uint16_t *

Buffer size in bytes.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX

Send node information frame (NIF) to a node or broadcast to the network.

Table 105 – zwnet_send_nif Parameters

4.6.7 zwnet_poll_rm

Remove a polling request.

Table 106 – zwnet_poll_rm Parameters

4.6.8 zwnet_poll_rm_mul

Remove multiple polling requests.

Table 107 – zwnet_poll_rm_mul Parameters

4.6.9 zwnet_pref_set

Store network preference into persistent storage.

Table 108 – zwnet_pref_set Parameters

4.6.10 zwnet_pref_get

Retrieve network preference from persistent storage.

Table 109 – zwnet_pref_get Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 50 of 212

Note: Caller MUST free the return buffer "buf" if the call is successful.

4.6.11 zwnet_client_pref_set

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

client_id

uint32_t

User-defined client ID to identify the preference.

buf

void *

Buffer that contains the client preference.

buf_size

uint16_t

Buffer size in bytes.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

client_id

uint32_t

User-defined client ID to identify the preference.

buf

void **

Return buffer that contains the client preference.

buf_size

uint16_t *

Buffer size in bytes.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX. Note: Caller MUST free the return buffer "buf" if the call is successful.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle.

get_dsk_fn

Callback to report ZIPGW DSK.

usr_ctx

void *

User context used in callback.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

usr_ctx

void *

User context

dsk

char *

ZIPGW DSK string

Store client preference into persistent storage.

Table 110 – zwnet_client_pref_set Parameters

4.6.12 zwnet_client_pref_get

Retrieve client preference from persistent storage.

Table 111 – zwnet_client_pref_get Parameters

4.6.13 zwnet_sec2_get_dsk

Get ZIPGW Security 2 DSK.

Table 112 – zwnet_sec2_get_dsk Parameters

Table 113 – get_dsk_fn Parameters

4.7 Network Utilities APIs

These are APIs that provide IPv4/6 network utilities unrelated to Z-Wave network to ease programmers who are unfamiliar to the IPv4/6 network C APIs.

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 51 of 212

4.7.1 zwnet_ip_aton

Attribute

Type

I/O

Description

addr_str

char *

NULL terminated IPv4 / IPv6 address string.

addr_buf

uint8_t *

Buffer that should be at least 16-bytes long to store the result.

ipv4

int *

Flag to indicate the converted numeric IP address is IPv4 or IPv6. 1=IPv4; 0=IPv6.

return

intOZero on success; non-zero on failure.

Attribute

Type

I/O

Description

addr

uint8_t *

IPv4 / IPv6 address in numerical form.

addr_str

char *

Buffer to store the converted address string.

addr_str_len

intIThe size of the addr_str in bytes.

ipv4

intIFlag to indicate the addr parameter is IPv4 or IPv6. 1=IPv4; 0=IPv6.

return

intOZero on success, non-zero on failure.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle from zwnet_init.

dest_ip

uint8_t*

Destination host address either IPv4 or IPv6 according to use_ipv4 flag

local_ip

uint8_t*

Buffer of 16-byte to store the local address (either IPv4 or IPv6 according to use_ipv4 flag).

use_ipv4

intIFlag to indicate IP address type. 1= IPv4; 0= IPv6.

return

intOZero on success, non-zero on failure.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle from zwnet_init

return

uint16_t

The Z/IP client listening port number.

Utility to convert IPv4 / IPv6 address string to numeric equivalent.

Table 114 – zwnet_ip_aton Parameters

4.7.2 zwnet_ip_ntoa

Utility to convert IPv4 / IPv6 address in numerical form to string equivalent.

Table 115 – zwnet_ip_ntoa Parameters

4.7.3 zwnet_local_addr_get

Utility to get local address that is reachable by destination host.

Table 116 – zwnet_local_addr_get Parameters

4.7.4 zwnet_listen_port_get

Utility to get local Z/IP listening port number.

Table 117 – zwnet_listen_port_get Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 52 of 212

5 Node API

Attribute

Type

I/O

Description

nodeid

uint8_t

Z-Wave Node ID

propty

uint8_t

Properties of the node (bit-mask): NODE_PROPTY_XXX.

Vid

uint16_t

Z-Wave Vendor ID.

type

uint16_t

Vendor type.

Pid

uint16_t

Z-Wave Product ID.

Net

zwnet_t *

Network handle.

dev_id

dev_id_t

Device ID.

proto_ver

uint16_t

Z-Wave Protocol Version.

app_ver

uint16_t

Application Version.

lib_type

uint8_t

Z-Wave Library Type.

5.1 zwnoded_t

This is the descriptor used to access Z-Wave nodes. Only name and location fields are writeable.

Table 118 – zwnoded_t Structure

Table 119 – NODE_PROPTY_XXX

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 53 of 212

NODE_PROPTY_IDENTIFY_CAP

Node is capable of identifying itself (e.g. blinking LED three times).

Table 120 – dev_id_t Structure

Attribute

Type

I/O

Description

Device ID type: DEV_ID_TYPE_XXX, where:

DEV_ID_TYPE_OEM

OEM factory default

DEV_ID_TYPE_SN

Serial number

type

uint8_t

DEV_ID_TYPE_RANDOM

Pseudo random number

Device ID data format: DEV_ID_FMT_XXX, where:

DEV_ID_FMT_UTF

UTF-8

format

uint8_t

DEV_ID_FMT_BIN

Binary and MUST be displayed as hexadecimal, e.g. h’30313233A1

len

uint8_t

Device ID length

dev_id

uint8_t[MAX_DEV_ID_LEN + 1]

Device ID Attribute

Type

I/O

Description

Version type: VER_TYPE_XXX, where

VER_TYPE_SDK

SDK version.

VER_TYPE_APPL_FRW_API

Application framework API version.

VER_TYPE_HOST_INTF

Host interface version; the version of the API exposed to a host CPU.

VER_TYPE_ZWAVE_PROTO

Z-Wave protocol version.

type

uint8_t

VER_TYPE_APPL

Application software version.

major

uint8_t

Major version.

minor

uint8_t

Minor version.

patch

uint8_t

Patch version.

build

uint16_t

Build number. Zero if unused.

Attribute

Type

I/O

Description

noded

zwnoded_t *

Node handle

Table 121 – zwsw_ver_t Structure

5.2 zwnode_get_net

Get handle to the network containing this node.

Table 122 – zwnode_get_net Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 54 of 212

return

zwnet_t *

Network handle

5.3 zwnode_get_next

Attribute

Type

I/O

Description

noded

zwnoded_t *

Node handle.

zwnoded_t *

Next node handle. return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

noded

zwnoded_t *

Node handle. epd

zwepd_t *

Endpoint handle.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

noded

zwnoded_t *

Node handle. return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

noded

zwnoded_t *

Node handle

Get next node in network. The first, i.e., local controller node may be obtained from zwnet_get_node.

Table 123 – zwnode_get_next Parameters

5.4 zwnode_get_ep

Get first endpoint in the node.

Table 124 – zwnode_get_ep Parameters

5.5 zwnode_update

Updates node status and information.

Table 125 – zwnode_update Parameters

5.6 zwnode_identify

Instruct the node to identify itself. This API is to support Z-Wave Plus v2 node, which must have a visible LED to be used for an Identify function. If the node is itself a light source, e.g., a light bulb, this may be used in place of a dedicated LED.

Table 126 – zwnode_identify Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 55 of 212

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

5.7 zwnode_get_ext_ver

Attribut e

Type

I/O

Description noded

zwnoded_t *

Node descriptor.

return

ext_ver_t *

Extended version information if the node supports it; else returns NULL. Note: Caller has to free the returned extended version information.

Attribute

Type

I/O

Description

hw_ver

uint8_t

Hardware version.

fw_cnt

uint8_t

Number of firmwares in the device, excluding the Z-Wave firmware.

fw_ver

uint16_t[]

Firmware versions place holder as indicated in fw_cnt.

Attribut e

Type

I/O

Description noded

zwnoded_t *

Node descriptor.

uint8_t

1=turn on multi command encapsulation; 0=turn off and flush (send) the commands in the buffer.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribut e

Type

I/O

Description noded

zwnoded_t *

Node descriptor.

uint8_t *

state: 1=on; 0=off.

Get extended version information.

Table 127 – zwnode_get_ext_ver Parameters

5.8 Advanced Node APIs

Table 128 – ext_ver_t Structure

These are APIs that should not be used for normal operation but are provided for debugging purposes.

5.8.1 zwnode_mul_cmd_ctl_set

Turn on/off multi command encapsulation capability. By default, if a node supports Multicommand CC, the multi command encapsulation capability is turned on automatically.

Table 129 – zwnode_mul_cmd_ctl_set Parameters

5.8.2 zwnode_mul_cmd_ctl_get

Get the current state of multi command encapsulation.

Table 130 – zwnode_mul_cmd_ctl_get Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 56 of 212

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 57 of 212

6 Endpoint API

Attribute

Type

I/O

Description

generic

uint8_t

Z-Wave Generic device class

specific

uint8_t

Z-Wave Specific device class

epid

uint8_t

Endpoint number

nodeid

uint8_t

Node ID

aggr_ep_cnt

uint8_t

Total number of end point members that are represented by this aggregated end point. Zero means this endpoint is NOT an aggregated end point

aggr_members

uint8_t[126]

Buffer to store the end point members that are represented by this aggregated end point

net

zwnet_t *

Network handle

name

char [33]

User configured name string of the endpoint

loc

char [33]

User configured location string of the endpoint

zwplus_info

zwplus_info_t

Z-Wave Plus information CC

Attribute

Type

I/O

Description

zwplus_ver

uint8_t

Version. Zero indicates this node is non-Z-Wave Plus.

node_type

uint8_t

Node type.

role_type

uint8_t

Role type.

instr_icon

uint16_t

Installer icon type.

usr_icon

uint16_t

User icon type.

Attribute

Type

I/O

Description

epd

zwepd_t *

Endpojnt handle

noded

zwnoded_t *

Node handle return

intOZW_ERR_NONE on success; else ZW_ERR_XXX

This corresponds to Z-Wave channels or instances. The APIs here are mostly accessor functions.

6.1 zwepd_t

This is the read-only descriptor used to access endpoints.

Table 131 – zwepd_t Structure

6.2 zwep_get_node

Get containing node handle.

Table 132 – zwplus_info_t structure

Table 133 – zwep_get_node Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 58 of 212

6.3 zwep_get_next

Attribute

Type

I/O

Description

epd

zwepd_t *

Endpojnt handle.

nxt_epd

zwepd_t *

Next endpoint handle.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

epd

zwepd_t *

Endpojnt handle.

Ifd

zwifd_t *

Interface handle.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

epd

zwepd_t *

Endpojnt handle.

nameloc

zw_nameloc_t *

NULL terminated name and location strings.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

name

char[33]

Node name

loc

char[33]

Node location

Get next endpoint in node.

Table 134 – zwep_get_next Parameters

6.4 zwep_get_if

Get first interface in endpoint.

Table 135 – zwep_get_if Parameters

Note: Caller must free ifd->data if ifd->data_cnt is greater than zero.

6.5 zwep_nameloc_set

Set endpoint name and location string for device regardless of whether the endpoint has Node Naming And Location interface. If it does, the strings will be sent to the interface physically for storage in the device.

Table 136 – zwep_nameloc_set Parameters

Table 137 – zw_nameloc_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 59 of 212

7 Interface API

Attribute

Type

I/O

Description

cls

uint8_t

CC.

ver

uint8_t

CC version. Can be upgraded by device database.

real_ver

uint8_t

Real Version of the CC that the device supports.

Properties of the interface (bit-mask): IF_PROPTY_XXX where:

IF_PROPTY_SECURE

Interface can be accessed securely bit-mask.

IF_PROPTY_UNSECURE

Interface can be accessed insecurely bit-mask.

IF_PROPTY_HIDDEN

Interface is hidden. NOTE: This property is for internal use only; user application MUST NOT use this.

IF_PROPTY_HIDDEN_POLL

Interface is hidden but device polling is enabled. NOTE: This property is for internal use only; user application MUST NOT use this.

IF_PROPTY_ALRM_EVT_CLR

Interface is capable to sent event clear notification. NOTE: This bitmask is only valid for Alarm/Notification CC.

IF_PROPTY_BSNSR_EVT_CLR

Interface is capable of sending event clear. NOTE: This bit-mask is only valid for binary sensor CC.

propty

uint8_t

IF_PROPTY_ALRM_SNSR_EVT_CLR

Interface is capable of sending event clear. NOTE: This bit-mask is only valid for the Alarm Sensor CC.

epid

uint8_t

Endpoint number.

nodeid

uint8_t

Node ID.

This corresponds to Z-Wave CCs coupled with the corresponding Version CC information. Some of the CCs, such as security CC, multi-channel CC, and multi-command CC, are handled transparently. Basic CC is added automatically to all endpoints even if it is not listed in the endpoint’s "multichannel capability report". Individual CCs are categorized into Network, Management, Transport and Application CCs. All Transport CCs are handled by ZIPGW.

7.1 zwifd_t

This is the read-only descriptor used to access interfaces.

Table 138 – zwifd_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 60 of 212

net

zwnet_t *

Network handle.

7.2 zwif_get_ep

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

epd

zwepd_t *

Endpoint handle.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

nxt_ifd

zwifd_t *

Next interface handle.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

cmd

uint8_t *

Command packet.

len

intILength of cmd in bytes.

tx_cmplt_cb_t

Completion callback function.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

……I

Parameters of zwif_xxx.

poll_req

zwpoll_req_t *

I/O

Poll request.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Get containing endpoint.

Table 139 – zwif_get_ep Parameters

7.3 zwif_get_next

Get next interface in endpoint.

Table 140 – zwif_get_next Parameters

Note: Caller must free nxt_ifd->data if nxt_ifd->data_cnt is greater than zero.

7.4 zwif_exec

Execute a command on an interface (intended for automation).

Table 141 – zwif_exec Parameters

7.5 zwif_xxx_poll

Polling variant of zwif_xxx_get API. This is meant for the interfaces that follow to perform a continuous poll instead of a single get.

Table 142 – zwif_xxx_poll Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 61 of 212

Table 143 – zwpoll_req_t Structure

Attribute

Type

I/O

Description

usr_token

uint32_t

User-defined token to facilitate deletion of multiple polling requests.

interval

uint16_t

Polling interval in seconds; zero = the smallest possible interval.

poll_cnt

uint16_t

Number of times to poll; zero = unlimited times (i.e. repetitive polling).

cmplt_cb

zwpoll_cmplt_fn

Polling completion callback. NULL if callback is not required.

usr_param

void *

User parameter of polling completion callback.

handle

uint16_t

Handle if the request is accepted into the polling queue. The handle can be used to facilitate deletion of the polling request.

Attribute

Type

I/O

Description

net

zwnet_t *

Network handle. handle

uint16_t

Handle of the polling request.

usr_token

uint32_t

User-defined token to facilitate deletion of multiple polling requests.

usr_param

void *

User parameter.

Table 144 – zwpoll_cmplt_fn Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 62 of 212

8 Management CCs Based Interfaces

Attribute

Type

I/O

Description

ifd

zwifd_t *

Group interface handle.

zwrep_group_sup_fn

Maximum number of groupings report callback function.

cache

intIFlag: to get data from cached only. If set, no fetching from real device when cache unavailable.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Group interface handle.

max_grp

uint8_t

Maximum number of groups.

valid

intIValidity of the report. If 1 the report is valid; else this report contains no data and should be ignored.

Attribute

Type

I/O

Description

ifd

zwif_t *

Group interface handle.

zwrep_group_actv_fn

Current active group report callback function.

return

IntOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Group interface handle

group

uint8_t

Current active group

Manufacturer Specific, Node Naming and Location, Z-Wave Plus Info, and Version CCs are handled in the Node & Endpoint APIs.

8.1 Group Interface API

This corresponds to the Association & Multichannel Association CC. Lifelines are automatically setup and other associations can be preconfigured via the Device Database, rather than by using these APIs.

8.1.1 zwif_group_sup_get

Get information on the maximum number of groupings the given node supports through report callback function.

Table 145 – zwif_group_sup_get Parameters

Table 146 – zwrep_group_sup_fn Parameters

8.1.2 zwif_group_actv_get

Get information on the current active group from a node through report callback function.

Table 147 – zwif_group_actv_get Parameters

Table 148 – zwrep_group_actv_fn Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 63 of 212

8.1.3 zwif_group_get

Attribute

Type

I/O

Description

ifd

zwifd_t *

Group interface handle.

group

uint8_t

Group ID.

zwrep_group_fn

Endpoint list report callback function.

flag

intIFlag, see ZWIF_GET_BMSK_XXX.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Group interface handle.

group

uint8_t

Group identifier.

max_cnt

uint8_t

Maximum number of members the grouping identifier above supports.

cnt

uint8_t

Number of end points in this report.

grp_member

grp_member_t *

An array of cnt group members in the grouping. Note that the group members may contain non-existence node/endpoint.

time_t

Time stamp. If this is zero, the callback has no data and hence other parameter values should be ignored.

Attribute

Type

I/O

Description

node_id

uint8_t

Node ID

ep_id

uint8_t

Endpoint id. Value of 255 denotes node association; other values denote endpoint association.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Group interface handle.

group

uint8_t

Group ID.

zwepd_t *

An array of recipient endpoints to be added into the grouping.

cnt

uint8_t

Number of endpoints in the array "ep".

zwif_grp_rr_fn

Completion callback function (optional). NULL if callback is not required.

user_prm

void *

User parameter for the completion callback function (optional). NULL if not in use.

return

intOZero on success and completion callback will be invoked upon completion of return route assignments; positive return code (>0, e.g. ZW_ERR_QUEUED) will be returned if the command is

Get group members information on specified group through zwrep_group_fn report callback function.

Table 149 – zwif_group_get Parameters

Table 150 – zwrep_group_fn Parameters

Table 151 – grp_member_t structure

8.1.4 zwif_group_add

Add endpoints to this group and its containing node’s return routes. It is recommended to add all endpoints with one call to ensure return routes are set up correctly.

Table 152 – zwif_group_add Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 64 of 212

queued and NO completion callback will be invoked; else negative return code (ZW_ERR_XXX) will be returned on error.

Table 153 – zwif_grp_rr_fn Parameters

Attribute

Type

I/O

Description

ifd

zwifd_t *

Group interface handle.

status

uint8_t

status, RRA_XXX

user_prm

void *

User parameter

Return route assignment status

Description

RRA_OK

Successfully assigned return routes

RRA_TX_NO_ACK

No acknowledgement of transmission is received before timeout

RRA_TX_FAIL

Not possible to transmit data because the Z-Wave network is busy

RRA_FAIL

Operation failed

Attribute

Type

I/O

Description

ifd

zwif_t *

Group interface handle.

group

uint8_t

Group ID.

grp_member

grp_member_t *

An array of cnt members to be removed from the grouping. Node association should be indicated by ep_id=255.

cnt

uint8_t

The number of members in the array grp_member. If cnt is zero, all the members in the group may be removed.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwif_t *

Group interface handle.

grp_info

if_grp_info_dat_t **

Grouping information if success; NULL on failure. return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

group_cnt

uint16_t

Number of supported groups.

valid_grp_cnt

uint16_t

Number of valid group information in grp_info[].

dynamic

uint8_t

Flag to indicate the group information is dynamic. 1=dynamic; 0=static.

8.1.5 zwif_group_del

Remove endpoints from this group.

Table 155 – zwif_group_del Parameters

Table 154 – RRA_XXX

8.1.6 zwif_group_info_get

Get detailed group information.

Table 156 – zwif_group_info_get Parameters

Table 157 – if_grp_info_dat_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 65 of 212

grp_info

zw_grp_info_t *[]

Place holder for storing pointers to group information. Attribute

Type

I/O

Description

grp_num

uint8_t

Group number

cmd_ent_cnt

uint8_t

Number of entries in command list (cmd_lst)

profile

uint16_t

Profile

evt_code

uint16_t

Event code

name

char [43]

NULL terminated group name string in UTF-8

cmd_lst

grp_cmd_ent_t []

Place holder for command list Attribute

Type

I/O

Description

cls

uint16_t

cmd

uint8_t

Command

8.1.7 zwif_group_info_free

Attribute

Type

I/O

Description

grp_info

if_grp_info_dat_t *

Grouping information returned by zwif_group_info_get() Attribute

Type

I/O

Description

ifd

zwifd_t *

Group command configuration interface handle.

zwrep_grp_cmd_sup_fn

Report callback function.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Group command configuration interface handle.

cmd_cap

zwgrp_cmd_cap_t *

Command records supporting capabilities.

Free group information.

Table 158 – zw_grp_info_t Structure

Table 159 – grp_cmd_ent_t Structure

Table 160 – zwif_group_info_free Parameters

8.2 Group Command Interface API

This corresponds to the Z-Wave association command configuration CC used to specify commands in groups within a node.

8.2.1 zwif_group_cmd_sup_get

Get information on command records supporting capabilities through report callback function.

Table 161 – zwif_group_cmd_sup_get Parameters

Table 162 – zwrep_grp_cmd_sup_fn Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 66 of 212

Table 163 – zwgrp_cmd_cap_t structure

Attribute

Type

I/O

Description

configurable

uint8_t

1=command record is configurable, 0=not configurable type.

config_type

uint8_t

Configuration type: 1=value type (only support Basic Set command). 0=command type (support any command).

max_len

uint8_t

Maximum command length that can be set.

free_rec

uint16_t

Number of free command records that can be set.

total_rec

uint16_t

Total number of command records supported.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Group command configuration interface handle.

group

uint8_t

Grouping identifier.

nodeid

uint8_t

Node ID of the node within the grouping specified.

zwrep_grp_cmd_fn

Report callback function.

Return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Group command configuration interface handle.

group

uint8_t

Grouping identifier.

nodeid

uint8_t

Node ID of the node within the grouping specified.

cmd_buf

uint8_t *

Command and parameters.

len

uint8_t

Length of cmd_buf.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Group command configuration interface handle.

group

uint8_t

Grouping identifier.

node

uint8_t

Node within the grouping specified that should receive the command specified in cmd_buf.

cmd_buf

uint8_t *

Command and parameters.

len

uint8_t

Length of cmd_buf.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

8.2.2 zwif_group_cmd_get

Get command record for a node within a given grouping identifier through report callback function.

Table 164 – zwif_group_cmd_get Parameters

Table 165 – zwrep_grp_cmd_fn Parameters

8.2.3 zwif_group_cmd_set

Specify which command should be sent to a node within a given group.

Table 166 – zwif_group_cmd_set Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 67 of 212

8.3 Battery Interface API

Attribute

Type

I/O

Description

ifd

zwifd_t *

Battery interface handle.

rpt_cb

zwrep_batt_lvl_fn

Report callback function.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Battery interface handle.

data

zwbatt_dat_t *

Battery Level and status.

time_t

Time stamp. If this is zero, the callback has no data and hence other parameter values should be ignored.

Attribute

Type

I/O

Description

level

uint8_t

Battery level 0x00..0x64 MUST indicate the battery percentage level from 0 to 100%. Level 0xFF MUST indicate a low-battery warning.

sts_valid

uint8_t

Indicate whether the following battery status fields are valid. 1=valid; 0=invalid.

Battery status

rechargeable

uint8_t

Flag to indicate if the battery is rechargeable. 1=rechargeable; 0=non-rechargeable

charge_sts

uint8_t

Charging status if battery is rechargeable, BATT_STS_XXX

bkup_batt

uint8_t

Flag to indicate if the battery is utilized for back-up purposes of a main powered connected device. 1=backup; 0=battery is used for primary means of power

overheat

uint8_t

Flag to indicate if overheating is detected. 1=overheating; 0=operating within the normal temperature range

low_fluid

uint8_t

Flag to indicate if the battery fluid is low and should be refilled. 1=low; 0=normal

rechg_req

uint8_t

Status to indicate if the battery needs to be recharged (for rechargeable battery) or replaced (for non-rechargeable battery), BATT_RECHG_XXX

disconnect

uint8_t

Flag to indicate if the battery is currently disconnected or removed from the node. 1=disconnected and the node is running on an alternative power source; 0=connected

This corresponds to the Z-Wave battery CC.

8.3.1 zwif_battery_rpt_set

Setup a battery report callback function. Note that the report battery level 0x00..0x64 indicates the battery percentage level from 0 to 100%. Level 0xFF indicates a low-battery warning.

Table 167 – zwif_battery_rpt_set Parameters

Table 168 – zwrep_batt_lvl_fn Parameters

Table 169 – zwbatt_dat_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 68 of 212

low_temp_sts

uint8_t

Flag to indicate if battery of a device has stopped charging due to low temperature, BAT_LO_TEMP_STS_XXX

Table 170 – BATT_STS_XXX

Battery charging status

Description

BATT_STS_DISCHARGE

Discharging

BATT_STS_CHARGE

Charging

BATT_STS_MAINTAIN

Maintaining

Battery recharge or replace request

Description

BATT_RECHG_NONE

No recharge or replace battery is needed

BATT_RECHG_SOON

Recharge or replace battery soon

BATT_RECHG_NOW

Recharge or replace battery now

Battery low temperature status

Description

BATT_LO_TEMP_STS_UNKNOWN

Unknown

BATT_LO_TEMP_STS_NOT_CHARGING

Battery is not charging due to low temperature

BATT_LO_TEMP_STS_OPERATIONAL

Battery is operational

Attribute

Type

I/O

Description

ifd

zwifd_t *

Battery interface handle.

flag

intIFlag, see ZWIF_GET_BMSK_XXX.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

rpt_cb

zwrep_batt_health_fn

Report callback function.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

data

zwbatt_health_t *

Battery health status

time_t

Time stamp. If this is zero, the callback has no data and hence other parameter values should be ignored.

Attribute

Type

I/O

Description

Table 171 – BATT_RECHG_XXX

Table 172 – BATT_LO_TEMP_XXX

8.3.2 zwif_battery_get

Get battery level through report callback function.

Table 173 – zwif_battery_get Parameters

8.3.3 zwif_battery_health_rpt_set

Set up a battery health report callback function.

Table 174 – zwif_battery_health_rpt_set Parameters

Table 175 – zwrep_batt_health_fn Parameters

Table 176 – zwbatt_health_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 69 of 212

max_cap

uint8_t

The percentage indicating the maximum capacity of the battery. Values in the range 0x00..0x64 indicate the maximum capacity of the battery in the percentage level from 0 to 100%. Value of 0xFF indicates the maximum capacity of the battery is unknown

precision

uint8_t

Decimal places of the battery temperature value. E.g. the decimal value 1025 with precision 2 is equal to 10.25

unit

uint8_t

Unit used in battery temperature. 0=Celsius; other values are reserved

size

uint8_t

Battery temperature data size: 0, 1, 2 or 4 bytes. Value 0 indicates the battery temperature is unknown

data

uint8_t [4]

Battery temperature data (a signed number) with the first byte is the most significant byte

8.3.4 zwif_battery_health_get

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

flag

intIFlag, see ZWIF_GET_BMSK_XXX.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

rpt_cb

zwrep_time_fn

Report callback function.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

hour

uint8_t

Hour (in 24 hours format).

minute

uint8_t

Minute.

second

uint8_t

Second.

rtc_fail

intIFlag to indicate if RTC oscillator has been stopped and hence the advertised time might be inaccurate. 1=stopped; 0=running or node does not support this feature.

Get battery health report through report callback.

Table 177 – zwif_battery_health_get Parameters

8.4 Time and Date Interface API

This corresponds to the Z-Wave Time CC.

8.4.1 zwif_time_rpt_set

Set up a current local time report callback function.

Table 178 – zwif_time_rpt_set Parameters

Table 179 – zwrep_time_fn Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 70 of 212

8.4.2 zwif_time_get

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

rpt_cb

zwrep_date_fn

Report callback function.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle

year

uint16_t

Year (example: 2018)

month

uint8_t

Month

day

uint8_t

Day

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

rpt_cb

zwrep_tz_dst_fn

Report callback function.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

tz_info

tmzone_info_t *

Time zone info. dst_info

dst_info_t *

Daylight Saving Time info.

Get current local time through report callback.

Table 180 – zwif_time_get Parameters

8.4.3 zwif_date_rpt_set

Set up a current date report callback function.

Table 181 – zwif_date_rpt_set Parameters

Table 182 – zwrep_date_fn Parameters

8.4.4 zwif_date_get

Get current date adjusted according to the local time zone and Daylight Saving Time through report callback.

Table 183 – zwif_date_get Parameters

8.4.5 zwif_tz_dst_rpt_set

Set up a time zone and Daylight Saving Time information report callback function.

Table 184 – zwif_tz_dst_rpt_set Parameters

Table 185 – zwrep_tz_dst_fn Parameters

Table 186 – tmzone_info_t Structure

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 71 of 212

Attribute

Type

I/O

Description

sign

intOSign (plus or minus) to apply to the hour and minute fields. 0 = Plus sign (positive offset from UTC); 1 = Minus sign (negative offset from UTC).

hour

uint8_t

Hour offset.

minute

uint8_t

Minute offset.

Table 187 – dst_info_t Structure

Attribute

Type

I/O

Description

sign

intOSign (plus or minus) for the minute_offset field to apply to the current time while in the Daylight Saving Time. 0 = Plus sign (positive offset from current time); 1 = Minus sign (negative offset from current time).

minute_offset

uint8_t

Minute offset.

month_start

uint8_t

Month of the year when Daylight Saving Time starts. Range

1..12 (representing respectively January...December).

day_start

uint8_t

Day of the month when DST starts. Range 1..31.

hour_start

uint8_t

Hour of the day when DST starts. Range 0..23.

month_end

uint8_t

Month of the year when DST ends. Range 1..12 (representing respectively January...December).

day_end

uint8_t

Day of the month when DST ends. Range 1..31.

hour_end

uint8_t

Hour of the day when DST ends. Range 0..23.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Interface handle.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Firmware update interface handle.

zwrep_fw_info_fn

Report callback function.

return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

8.4.6 zwif_tz_dst_get

Get time zone and Daylight Saving Time information through report callback.

Table 188 – zwif_tz_dst_get Parameters

8.5 Firmware Update Interface API

This corresponds to the Firmware Update Meta Data CC.

8.5.1 zwif_fw_info_get

Get firmware information through report callback.

Table 189 – zwif_fw_info_get Parameters

Table 190 – zwrep_fw_info_fn Parameters

INS14416-13 Z-Ware SDK 7.14.x Library C API Reference Manual 2020-07-07

silabs.com | Building a more connected world.

Page 72 of 212

ifd

zwifd_t *

Firmware update interface handle.

fw_info

zwfw_info_t *

firmware information.

Table 191 – zwfw_info_t structure

Attribute

Type

I/O

Description

vid

uint16_t

Vendor/Manufacturer ID.

zw_fw_id

uint16_t

Z-Wave firmware ID.

chksum

uint16_t

CRC-CCITT checksum of Z-Wave firmware.

max_frag_sz

uint16_t

Maximum meta data fragment size for firmware update.

fixed_frag_sz

uint8_t

Flag to indicate whether the max_frag_sz is fixed, i.e. firmware update request MUST use the given size. 1=fixed size; 0=variable size.

upgrade_flg

uint8_t

Firmware upgradable flag. 0= Firmware is not upgradable; 0xFF= Firmware is upgradable.

hw_ver_valid

uint8_t

Flag to indicate whether the hw_ver is valid. 1=valid; 0=invalid.

hw_ver

uint8_t

Hardware version.

func_normally

uint8_t

To indicate whether other CCs function normally during firmware update image transfer. 2=function normally; 1=certain CCs will not function; 0=this information is unavailable

activation

uint8_t

To indicate whether node supports the subsequent activation of firmware after downloading. 2=support; 1=not support; 0=this information is unavailable

other_fw_cnt

uint8_t

Number of other firmware IDs.

other_fw_id

uint16_t *

Pointer to array of other firmware IDs with the count given by other_fw_cnt.

Attribute

Type

I/O

Description

ifd

zwifd_t *

Firmware update interface handle.

req

zwfw_updt_req_t *

Firmware update request. return

intOZW_ERR_NONE on success; else ZW_ERR_XXX.

Attribute

Type

I/O

Description

vid

uint16_t

Vendor/Manufacturer ID the firmware is intended for.

fw_id

uint16_t

Firmware ID the firmware is intended for.

hw_ver

uint8_t

Hardware version the firmware is intended for; zero if inapplicable.

8.5.2 zwif_fw_updt_req

Request firmware update. Caller should call zwif_fw_info_get() first before calling this function.

Table 192 – zwif_fw_updt_req Parameters

Table 193 – zwfw_updt_req_t Structure

Z-Wave SDK 7.14.x Reference Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

1 Introduction

1.1 Purpose

1.2 Audience and Prerequisites

2 Error Codes

3 Device Database API

3.1 zwdev_cfg_load

3.2 zwdev_cfg_free

3.3 zwdev_global_sett_free

3.4 zwdev_cfg_find

4 Network API

4.1 Discovering ZIPGWs

4.1.1 zwnet_gw_discvr_start

4.1.2 zwnet_gw_discvr_stop

4.2 Network Initialization and Clean up

4.2.1 zwnet_init

4.2.2 zwnet_exit

4.2.3 zwnet_reset

4.3 Network Creation

4.3.1 zwnet_add

4.3.2 Secure Inclusion

4.3.2.1 zwnet_add_sec2_accept

4.3.2.2 zwnet_add_sec2_grant_key

4.3.3 SmartStart Provisioning

4.3.3.1 zwnet_pl_add

4.3.3.2 zwnet_pl_get

4.3.3.3 zwnet_pl_del

4.3.3.4 zwnet_pl_list_get

4.3.3.5 zwnet_pl_list_del

4.4 Network Management

4.4.1 zwnet_initiate

4.4.2 zwnet_fail

4.4.3 zwnet_update

4.4.4 zwnet_abort

4.5 Network Attributes and Traversal

4.5.1 zwnet_get_desc

4.5.2 zwnet_version

4.5.3 zwnet_get_node

4.5.4 zwnet_get_node_ by_id

4.5.5 zwnet_get_ep_ by_id

4.5.6 zwnet_get_if_ by_id

4.5.7 zwnet_all_node_sts_get

4.5.8 zwnet_node_sts_get

4.6 Advanced Network APIs

4.6.1 zwnet_migrate

4.6.2 zwnet_initiate_classic

4.6.3 zwnet_health_chk

4.6.4 zwnet_identify

4.6.5 zwnet_get_user

4.6.6 zwnet_send_nif

4.6.7 zwnet_poll_rm

4.6.8 zwnet_poll_rm_mul

4.6.9 zwnet_pref_set

4.6.10 zwnet_pref_get

4.6.11 zwnet_client_pref_set

4.6.12 zwnet_client_pref_get

4.6.13 zwnet_sec2_get_dsk

4.7 Network Utilities APIs

4.7.1 zwnet_ip_aton

4.7.2 zwnet_ip_ntoa

4.7.3 zwnet_local_addr_get

4.7.4 zwnet_listen_port_get

5 Node API

5.1 zwnoded_t

5.2 zwnode_get_net

5.3 zwnode_get_next

5.4 zwnode_get_ep

5.5 zwnode_update

5.6 zwnode_identify

5.7 zwnode_get_ext_ver

5.8 Advanced Node APIs

5.8.1 zwnode_mul_cmd_ctl_set

5.8.2 zwnode_mul_cmd_ctl_get

6 Endpoint API

6.1 zwepd_t

6.2 zwep_get_node

6.3 zwep_get_next