Silicon Labs Z-Ware Library User Manual
Instruction
Description:
Z-Ware Library & C API
Date CET Initials Name Justification
2018-05-02 15:24:27 NTJ Niels Thybo 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.
Z-Ware Library User Guide
Document No.: INS14129
Version: 2
Written By: DCHOW;SAMBAT;YANYAN
Date: 2017-12-26
Reviewed By: YANYAN;KSUNDARAM;CRASMUSSEN
Restrictions: Partners Only
Approved by:
silabs.com | Building a more connected world.
Page ii of xxii
Doc. Ver.
Date
By
Pages affected
Brief description of changes
1
20171006
DCHOW
ALL
- Cloned from INS13172-9
- Support Smart Start and provisioning list management.
20171103
DCHOW
120-123
- v8.04
Parameters, zwif_prot_tmout_get Parameters
2
20180215
DCHOW
ALL
- v8.12
to support building of applications
xplain certain network operations cannot be
"ZW_ALRM_EVT_XXX", "ZW_ALRM_STS_XXX"
3
20180308
BBR
All
Added Silicon Labs template
4
20180418
SNA
105
Fixed zwif_battery_rpt_set doc
5
20180426
SNA
172
Updated platform memory requirements
INS14129-5 Z-Ware Library User Guide 2018-05-02
REVISION RECORD
- v8.03
-
Modified table ZW_SENSOR_TYPE_XXX, ZW_SENSOR_UNIT_XXX_YYY to fix
TO#07866
- Modified tables zwnet_notify_fn Parameters, zwnet_sts_t structure, zwnetd_t
structure, zwnet_init_t structure, zwconfig_t structure, ZW_THRMO_MD_XXX,
zwrep_thrmo_md_fn Parameters, zwif_thrmo_md_set Parameters,
ZW_THRMO_OP_STA_XXX,
Controlled Z Wave CCs, Node Update endpoint get/set CCs.
- Added tables zw_health_prg_t structure, zw_health_rpt_t structure,
zw_health_sts_t structure, pl_info_fn Parameters.
- Added sections Command Class Configuration, Smart Start, Network Health Check.
- Changed prekit whitelist APIs zwnet_wl_xxx to provisioning list APIs zwnet_pl_xxx
- Updated REFERENCES
- Support COMMAND_CLASS_CONFIGURATION version 2
- Support COMMAND_CLASS_THERMOSTAT_OPERATING_STATE version 2
- Support COMMAND_CLASS_THERMOSTAT_MODE version 3
- Modified tables zwrep_prot_fn Parameters, zwif_prot_get Parameters,
zwrep_prot_ec_fn Parameters, zwif_prot_ec_get Parameters, zwrep_prot_tmout_fn
- Modified tables Controlled CCs, Multi-level Sensor Type: ZW_SENSOR_TYPE_XXX,
Multi-level Sensor Unit, ZW_SENSOR_UNIT_XXX_YYY, ZW_ERR_XXX, if_rec_config_t,
zwrep_csc_cfg_fn Parameters, pl_info_t, pl_uuid_t, Node Update endpoint get/set
CCs
- Added tables if_rec_cfg_set_t, if_rec_cfg_info_t, pl_nw_sts_t
- Modified section JSON File Format with configuration parameter information.
- Modified section Building of sample applications
that link with shared libraries.
- Modified section Ubuntu Linux and added sections BBB and RPi3 to support
building of shared libraries.
- Added section Installation of sample applications, zwif_config_prm_reset,
zwif_config_info_get, zwif_config_info_free
- Added text in section zwnet_abort to e
undone completely at certain stage
- Added figure in section S2 on interaction between Z-Ware library & client
- Support COMMAND_CLASS_NOTIFICATION version 8
- Modified tables "Z Wave Alarm//Notification Type","ZW_ALRM_XXX",
silabs.com | Building a more connected world.
Page iii of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table of Contents
1 INTRODUCTION ...................................................................................................................... 1
1.1 Purpose ............................................................................................................................................. 1
1.2 Audience and prerequisites ........................................................................................................... 1
2 FEATURES .............................................................................................................................. 2
2.1 Role ................................................................................................................................................... 2
2.2 Network Operations ........................................................................................................................ 3
2.3 Device Control .................................................................................................................................. 3
2.4 CC Support ....................................................................................................................................... 4
2.5 Network Initialization ....................................................................................................................... 6
2.6 Node Update .................................................................................................................................... 7
2.7 Network Update ............................................................................................................................... 8
2.8 Background Polling ......................................................................................................................... 8
2.9 Post-Set Polling ............................................................................................................................... 9
2.10 Command Class Configuration ..................................................................................................... 9
3 TYPICAL USAGE .................................................................................................................. 10
3.1 Network Initialization .....................................................................................................................10
3.2 Network creation and tear down .................................................................................................10
3.3 Portal Usage ...................................................................................................................................11
3.3.1 Portal Initialization ...............................................................................................................11
3.3.2 Portal Shutdown ..................................................................................................................11
3.3.3 Portal Client Profile Management .....................................................................................12
3.4 Interface monitor/control ...............................................................................................................12
3.5 Node identification .........................................................................................................................13
3.6 Grouping .........................................................................................................................................14
3.7 Sleeping nodes ..............................................................................................................................14
3.8 Firmware update ............................................................................................................................14
3.9 Polling facility ..................................................................................................................................15
3.10 Device specific configuration and information database .........................................................15
3.11 Network and client preference storage ......................................................................................15
3.12 Security 2 (S2) ...............................................................................................................................16
3.13 SmartStart .......................................................................................................................................17
3.14 Network Health Check ..................................................................................................................17
4 API .......................................................................................................................................... 19
4.1 Error Codes ....................................................................................................................................19
4.2 Portal API ........................................................................................................................................21
4.2.1 zwportal_init .........................................................................................................................21
4.2.2 zwportal_shutdown .............................................................................................................23
4.2.3 zwportal_exit ........................................................................................................................23
4.2.4 zwportal_clnt_conn_close ..................................................................................................23
4.2.5 zwportal_clnt_add ...............................................................................................................23
silabs.com | Building a more connected world.
Page iv of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
4.2.6 zwportal_clnt_rm .................................................................................................................23
4.2.7 zwportal_clnt_find................................................................................................................24
4.2.8 zwportal_clnt_list_free ........................................................................................................24
4.2.9 zwportal_clnt_list_get .........................................................................................................24
4.3 Device Database API ....................................................................................................................25
4.3.1 zwdev_cfg_load ...................................................................................................................25
4.3.2 zwdev_cfg_free....................................................................................................................41
4.3.3 zwdev_global_sett_free ......................................................................................................41
4.3.4 zwdev_cfg_find ....................................................................................................................41
4.3.5 JSON File Format ................................................................................................................42
4.4 Network API ....................................................................................................................................49
4.4.1 zwnet_gw_discvr_start .......................................................................................................50
4.4.2 zwnet_gw_discvr_stop .......................................................................................................50
4.4.3 zwnet_ip_aton ......................................................................................................................51
4.4.4 zwnet_ip_ntoa ......................................................................................................................51
4.4.5 zwnet_local_addr_get .........................................................................................................51
4.4.6 zwnet_listen_port_get .........................................................................................................51
4.4.7 zwnet_init ..............................................................................................................................52
4.4.8 zwnet_exit .............................................................................................................................59
4.4.9 zwnet_get_desc ...................................................................................................................59
4.4.10 zwnet_add ............................................................................................................................60
4.4.11 zwnet_fail ..............................................................................................................................61
4.4.12 zwnet_migrate......................................................................................................................62
4.4.13 zwnet_initiate .......................................................................................................................62
4.4.14 zwnet_initiate_classic .........................................................................................................62
4.4.15 zwnet_update .......................................................................................................................63
4.4.16 zwnet_abort ..........................................................................................................................63
4.4.17 zwnet_reset ..........................................................................................................................63
4.4.18 zwnet_health_chk................................................................................................................63
4.4.19 zwnet_get_node ..................................................................................................................63
4.4.20 zwnet_get_node_ by_id .....................................................................................................64
4.4.21 zwnet_get_ep_ by_id ..........................................................................................................64
4.4.22 zwnet_get_if_ by_id ............................................................................................................64
4.4.23 zwnet_get_user ...................................................................................................................65
4.4.24 zwnet_send_nif ....................................................................................................................65
4.4.25 zwnet_all_node_sts_get .....................................................................................................65
4.4.26 zwnet_node_sts_get ...........................................................................................................65
4.4.27 zwnet_poll_rm ......................................................................................................................66
4.4.28 zwnet_poll_rm_mul .............................................................................................................66
4.4.29 zwnet_pref_set ....................................................................................................................66
4.4.30 zwnet_pref_get ....................................................................................................................66
4.4.31 zwnet_client_pref_set .........................................................................................................67
4.4.32 zwnet_client_pref_get .........................................................................................................67
4.4.33 zwnet_add_sec2_accept ....................................................................................................67
4.4.34 zwnet_add_sec2_grant_key ..............................................................................................67
silabs.com | Building a more connected world.
Page v of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
4.4.35 zwnet_sec2_get_dsk ..........................................................................................................68
4.4.36 zwnet_pl_add .......................................................................................................................68
4.4.37 zwnet_pl_get ........................................................................................................................71
4.4.38 zwnet_pl_del ........................................................................................................................72
4.4.39 zwnet_pl_list_get .................................................................................................................72
4.4.40 zwnet_pl_list_del .................................................................................................................72
4.5 Node API .........................................................................................................................................73
4.5.1 zwnoded_t ............................................................................................................................73
4.5.2 zwnode_get_net ..................................................................................................................74
4.5.3 zwnode_get_next ................................................................................................................74
4.5.4 zwnode_get_ep ...................................................................................................................74
4.5.5 zwnode_update ...................................................................................................................75
4.5.6 zwnode_cmd_q_ena_set ...................................................................................................75
4.5.7 zwnode_cmd_q_ena_get ...................................................................................................75
4.5.8 zwnode_cmd_q_cancel ......................................................................................................75
4.5.9 zwnode_cmd_q_get ............................................................................................................75
4.5.10 zwnode_mul_cmd_ctl_set ..................................................................................................76
4.5.11 zwnode_mul_cmd_ctl_get .................................................................................................76
4.5.12 zwnode_get_ext_ver ...........................................................................................................76
4.6 Endpoint API ..................................................................................................................................77
4.6.1 zwepd_t .................................................................................................................................77
4.6.2 zwep_get_node ...................................................................................................................77
4.6.3 zwep_get_next .....................................................................................................................78
4.6.4 zwep_get_if ..........................................................................................................................78
4.6.5 zwep_nameloc_set .............................................................................................................78
4.7 Interface API ...................................................................................................................................78
4.7.1 zwifd_t ...................................................................................................................................79
4.7.2 zwif_get_ep ..........................................................................................................................79
4.7.3 zwif_get_next .......................................................................................................................80
4.7.4 zwif_exec ..............................................................................................................................80
4.7.5 zwif_xxx_poll ........................................................................................................................80
4.8 Basic Interface API ........................................................................................................................81
4.8.1 zwif_basic_rpt_set ...............................................................................................................81
4.8.2 zwif_basic_get .....................................................................................................................82
4.8.3 zwif_basic_set......................................................................................................................82
4.9 Group Interface API ......................................................................................................................82
4.9.1 zwif_group_sup_get ............................................................................................................82
4.9.2 zwif_group_actv_get ...........................................................................................................83
4.9.3 zwif_group_get ....................................................................................................................83
4.9.4 zwif_group_add ...................................................................................................................84
4.9.5 zwif_group_del .....................................................................................................................84
4.9.6 zwif_group_info_get ............................................................................................................84
4.9.7 zwif_group_info_free ..........................................................................................................85
4.10 Switch Interface API ......................................................................................................................85
4.10.1 zwif_switch_rpt_set .............................................................................................................85
silabs.com | Building a more connected world.
Page vi of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
4.10.2 zwif_switch_get....................................................................................................................86
4.10.3 zwif_switch_set ....................................................................................................................87
4.11 Level Interface API ........................................................................................................................87
4.11.1 zwif_level_rpt_set ................................................................................................................87
4.11.2 zwif_level_sup_get ..............................................................................................................88
4.11.3 zwif_level_sup_cache_get .................................................................................................89
4.11.4 zwif_level_get ......................................................................................................................89
4.11.5 zwif_level_set .......................................................................................................................89
4.11.6 zwif_level_start ....................................................................................................................90
4.11.7 zwif_level_stop ....................................................................................................................90
4.12 Binary Sensor Interface API.........................................................................................................91
4.12.1 zwif_bsensor_rpt_set ..........................................................................................................91
4.12.2 zwif_bsensor_get ................................................................................................................91
4.12.3 zwif_bsensor_sup_get ........................................................................................................91
4.12.4 zwif_bsensor_sup_cache_get ...........................................................................................92
4.13 Sensor Interface API .....................................................................................................................92
4.13.1 zwif_sensor_rpt_set ............................................................................................................92
4.13.2 zwif_sensor_get ...................................................................................................................95
4.13.3 zwif_sensor_sup_get ..........................................................................................................96
4.13.4 zwif_sensor_unit_get ..........................................................................................................96
4.13.5 zwif_sensor_unit_cache_get .............................................................................................97
4.13.6 zwif_sensor_sup_cache_get .............................................................................................97
4.14 Group Command Interface API ...................................................................................................97
4.14.1 zwif_group_cmd_sup_get ..................................................................................................97
4.14.2 zwif_group_cmd_get ...........................................................................................................98
4.14.3 zwif_group_cmd_set ...........................................................................................................99
4.15 Wake Up Interface API .................................................................................................................99
4.15.1 zwif_wakeup_get .................................................................................................................99
4.15.2 zwif_wakeup_set ...............................................................................................................100
4.16 Configuration Interface API ........................................................................................................100
4.16.1 zwif_config_rpt_set ...........................................................................................................100
4.16.2 zwif_config_get ..................................................................................................................101
4.16.3 zwif_config_set ..................................................................................................................101
4.16.4 zwif_config_bulk_rpt_set ..................................................................................................101
4.16.5 zwif_config_bulk_get ........................................................................................................102
4.16.6 zwif_config_bulk_set .........................................................................................................102
4.16.7 zwif_config_prm_reset ......................................................................................................102
4.16.8 zwif_config_info_get .........................................................................................................103
4.16.9 zwif_config_info_free ........................................................................................................104
4.17 Pulse Meter Interface API ..........................................................................................................104
4.17.1 zwif_pulsemeter_rpt_set ..................................................................................................104
4.17.2 zwif_pulsemeter_get .........................................................................................................105
4.18 Battery Interface API ...................................................................................................................105
4.18.1 zwif_battery_rpt_set ..........................................................................................................105
4.18.2 zwif_battery_get ................................................................................................................105
silabs.com | Building a more connected world.
Page vii of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
4.19 AV Interface API ..........................................................................................................................106
4.19.1 zwif_av_set .........................................................................................................................106
4.19.2 zwif_av_caps......................................................................................................................106
4.20 Meter Interface API .....................................................................................................................107
4.20.1 zwif_meter_rpt_set ............................................................................................................107
4.20.2 zwif_meter_get ..................................................................................................................108
4.20.3 zwif_meter_sup_get ..........................................................................................................108
4.20.4 zwif_meter_sup_cache_get .............................................................................................109
4.20.5 zwif_meter_reset ...............................................................................................................110
4.20.6 zwif_meter_set_admin ......................................................................................................110
4.20.7 zwif_meter_get_desc ........................................................................................................110
4.21 Door Lock Interface API .............................................................................................................111
4.21.1 zwif_dlck_op_rpt_set ........................................................................................................111
4.21.2 zwif_dlck_op_get ...............................................................................................................112
4.21.3 zwif_dlck_op_set ...............................................................................................................112
4.21.4 zwif_dlck_cfg_set ..............................................................................................................112
4.21.5 zwif_dlck_cfg_get ..............................................................................................................113
4.22 User Code Interface API ............................................................................................................113
4.22.1 zwif_usrcod_get .................................................................................................................114
4.22.2 zwif_usrcod_set .................................................................................................................114
4.22.3 zwif_usrcod_sup_get ........................................................................................................114
4.22.4 zwif_usrcod_sup_cache_get ...........................................................................................115
4.23 Alarm/Notification Interface API ................................................................................................115
4.23.1 zwif_alrm_rpt_set ..............................................................................................................115
4.23.2 zwif_alrm_get .....................................................................................................................124
4.23.3 zwif_alrm_set .....................................................................................................................124
4.23.4 zwif_alrm_sup_get ............................................................................................................124
4.23.5 zwif_alrm_sup_cache_get ...............................................................................................125
4.23.6 zwif_alrm_sup_evt_get .....................................................................................................125
4.23.7 zwif_alrm_sup_evt_cache_get ........................................................................................126
4.23.8 zwif_alrm_vtype_sup_get ................................................................................................126
4.24 Thermostat Fan Mode Interface API ........................................................................................126
4.24.1 zwif_thrmo_fan_md_rpt_set ............................................................................................126
4.24.2 zwif_thrmo_fan_md_get ...................................................................................................127
4.24.3 zwif_thrmo_fan_md_set ...................................................................................................128
4.24.4 zwif_thrmo_fan_md_sup_get ..........................................................................................128
4.24.5 zwif_thrmo_fan_md_sup_cache_get .............................................................................128
4.25 Thermostat Fan State Interface API .........................................................................................129
4.25.1 zwif_thrmo_fan_sta_rpt_set ............................................................................................129
4.25.2 zwif_thrmo_fan_sta_get ...................................................................................................130
4.26 Thermostat Mode Interface API ................................................................................................130
4.26.1 zwif_thrmo_md_rpt_set ....................................................................................................130
4.26.2 zwif_thrmo_md_get ...........................................................................................................131
4.26.3 zwif_thrmo_md_set ...........................................................................................................131
4.26.4 zwif_thrmo_md_sup_get ..................................................................................................132
silabs.com | Building a more connected world.
Page viii of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
4.26.5 zwif_thrmo_md_sup_cache_get .....................................................................................132
4.27 Thermostat Operating State Interface API ..............................................................................132
4.27.1 zwif_thrmo_op_sta_rpt_set ..............................................................................................132
4.27.2 zwif_thrmo_op_sta_get ....................................................................................................133
4.27.3 zwif_thrmo_op_sta_log_sup_get ....................................................................................133
4.27.4 zwif_thrmo_op_sta_log_sup_cache_get .......................................................................134
4.27.5 zwif_thrmo_op_sta_log_rpt_set ......................................................................................134
4.27.6 zwif_thrmo_op_sta_log_get .............................................................................................135
4.28 Thermostat Setback Interface API ............................................................................................135
4.28.1 zwif_thrmo_setb_rpt_set ..................................................................................................135
4.28.2 zwif_thrmo_setb_get .........................................................................................................136
4.28.3 zwif_thrmo_setb_set .........................................................................................................136
4.29 Thermostat Setpoint Interface API ............................................................................................137
4.29.1 zwif_thrmo_setp_rpt_set ..................................................................................................137
4.29.2 zwif_thrmo_setp_get .........................................................................................................138
4.29.3 zwif_thrmo_setp_set .........................................................................................................138
4.29.4 zwif_thrmo_setp_sup_get ................................................................................................138
4.29.5 zwif_thrmo_setp_sup_cache_get ...................................................................................139
4.29.6 zwif_thrmo_setp_sup_range_get ....................................................................................139
4.29.7 zwif_thrmo_setp_sup_range_cache_get .......................................................................139
4.30 Clock Interface API ......................................................................................................................140
4.30.1 zwif_clock_rpt_set .............................................................................................................140
4.30.2 zwif_clock_get....................................................................................................................140
4.30.3 zwif_clock_set ....................................................................................................................141
4.31 Climate Control Schedule Interface API ..................................................................................141
4.31.1 zwif_clmt_ctl_schd_rpt_set ..............................................................................................141
4.31.2 zwif_clmt_ctl_schd_get ....................................................................................................142
4.31.3 zwif_clmt_ctl_schd_set .....................................................................................................142
4.31.4 zwif_clmt_ctl_schd_chg_rpt_set .....................................................................................142
4.31.5 zwif_clmt_ctl_schd_chg_get ............................................................................................143
4.31.6 zwif_clmt_ctl_schd_ovr_rpt_set ......................................................................................143
4.31.7 zwif_clmt_ctl_schd_ovr_get .............................................................................................143
4.31.8 zwif_clmt_ctl_schd_ovr_set .............................................................................................144
4.32 Protection Interface API ..............................................................................................................144
4.32.1 zwif_prot_rpt_set ...............................................................................................................144
4.32.2 zwif_prot_get ......................................................................................................................145
4.32.3 zwif_prot_set ......................................................................................................................145
4.32.4 zwif_prot_sup_get .............................................................................................................145
4.32.5 zwif_prot_sup_cache_get ................................................................................................146
4.32.6 zwif_prot_ec_rpt_set .........................................................................................................146
4.32.7 zwif_prot_ec_get ...............................................................................................................147
4.32.8 zwif_prot_ec_set................................................................................................................147
4.32.9 zwif_prot_tmout_rpt_set ...................................................................................................147
4.32.10 zwif_prot_tmout_get..........................................................................................................148
4.32.11 zwif_prot_tmout_set ..........................................................................................................148
silabs.com | Building a more connected world.
Page ix of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
4.33 Status Interface API ....................................................................................................................148
4.33.1 zwif_appl_busy_rpt_set ....................................................................................................148
4.33.2 zwif_appl_reject_rpt_set ..................................................................................................149
4.34 Indicator Interface API ................................................................................................................149
4.34.1 zwif_ind_rpt_set .................................................................................................................149
4.34.2 zwif_ind_get .......................................................................................................................150
4.34.3 zwif_ind_set........................................................................................................................150
4.35 Firmware Update Interface API .................................................................................................150
4.35.1 zwif_fw_info_get ................................................................................................................150
4.35.2 zwif_fw_updt_req ..............................................................................................................151
4.36 ZIPGW Interface API ..................................................................................................................153
4.36.1 zwif_gw_mode_set............................................................................................................153
4.36.2 zwif_gw_mode_get ...........................................................................................................154
4.36.3 zwif_gw_cfg_lock ..............................................................................................................155
4.36.4 zwif_gw_unsolicit_set .......................................................................................................155
4.36.5 zwif_gw_unsolicit_get .......................................................................................................155
4.37 Z/IP Portal Interface API .............................................................................................................156
4.37.1 zwif_gw_cfg_set ................................................................................................................156
4.37.2 zwif_gw_cfg_get ................................................................................................................156
4.38 Power level Interface API ...........................................................................................................157
4.38.1 zwif_power_level_rpt_set .................................................................................................157
4.38.2 zwif_power_level_get .......................................................................................................157
4.38.3 zwif_power_level_set ........................................................................................................158
4.38.4 zwif_power_level_test_rpt_set ........................................................................................158
4.38.5 zwif_power_level_test_get ...............................................................................................158
4.38.6 zwif_power_level_test_set ...............................................................................................159
4.39 Central Scene Interface API ......................................................................................................159
4.39.1 zwif_csc_rpt_set ................................................................................................................159
4.39.2 zwif_csc_sup_get ..............................................................................................................160
4.39.3 zwif_csc_cfg_rpt_set ........................................................................................................162
4.39.4 zwif_csc_cfg_get ...............................................................................................................162
4.39.5 zwif_csc_cfg_set ...............................................................................................................162
4.40 Alarm Sensor Interface API .......................................................................................................163
4.40.1 zwif_alrm_snsr_rpt_set ....................................................................................................163
4.40.2 zwif_alrm_snsr_get ...........................................................................................................164
4.40.3 zwif_alrm_snsr_sup_get ..................................................................................................164
4.40.4 zwif_alrm_snsr_sup_cache_get ......................................................................................164
4.41 Barrier Operator Interface API ...................................................................................................165
4.41.1 zwif_barrier_rpt_set ..........................................................................................................165
4.41.2 zwif_barrier_get .................................................................................................................165
4.41.3 zwif_barrier_set .................................................................................................................166
4.41.4 zwif_barrier_notif_sup_get ...............................................................................................166
4.41.5 zwif_barrier_notif_sup_cache_get ..................................................................................167
4.41.6 zwif_barrier_notif_rpt_set .................................................................................................167
4.41.7 zwif_barrier_notif_cfg_get ................................................................................................167
silabs.com | Building a more connected world.
Page x of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
4.41.8 zwif_barrier_notif_cfg_set ................................................................................................168
4.42 Color Switch Interface API .........................................................................................................168
4.42.1 zwif_color_sw_rpt_set ......................................................................................................168
4.42.2 zwif_color_sw_get .............................................................................................................169
4.42.3 zwif_color_sw_set .............................................................................................................169
4.42.4 zwif_color_sw_start ...........................................................................................................170
4.42.5 zwif_color_sw_stop ...........................................................................................................170
4.42.6 zwif_color_sw_sup_get ....................................................................................................170
4.42.7 zwif_color_sw_sup_cache_get .......................................................................................171
5 SYSTEM REQUIREMENTS ................................................................................................ 172
5.1 Target Platform ............................................................................................................................172
5.2 Build System ................................................................................................................................172
5.3 Build System Setup .....................................................................................................................173
5.3.1 Target Platform Ubuntu Linux .........................................................................................173
5.3.2 Target Platform BeagleBone Black and Raspberry Pi 3 .............................................173
6 BUILD & INSTALL............................................................................................................... 174
6.1 Ubuntu Linux ................................................................................................................................174
6.2 BeagleBone Black .......................................................................................................................175
6.3 Raspberry Pi 3 .............................................................................................................................175
7 SAMPLE APPLICATIONS (CE ONLY)............................................................................... 176
7.1 Getting Started .............................................................................................................................176
7.1.1 Prerequisites ......................................................................................................................176
7.1.2 Building of sample applications .......................................................................................176
7.1.3 Installation of sample applications ..................................................................................176
7.1.4 Configuration ......................................................................................................................177
7.2 Running Sample Applications ....................................................................................................177
7.2.1 ZIPGW Discovery ..............................................................................................................177
7.2.2 Reset Z/IP Network ...........................................................................................................178
7.2.3 Add Node into a Network .................................................................................................178
7.2.3.1 ZIPGW that supports Security 2 (S2) .....................................................................179
7.2.3.2 ZIPGW that does not support Security 2 (S2) .......................................................179
7.2.4 Remove Node from a Network ........................................................................................179
7.2.5 Binary Switch .....................................................................................................................180
7.2.6 Basic ....................................................................................................................................181
7.2.7 Binary Sensor ....................................................................................................................181
8 SOURCE CODE DOCUMENTATION ................................................................................. 183
8.1 Manual Generation of Documentation .....................................................................................183
8.2 Auto Generation of Documentation in Ubuntu Linux..............................................................183
REFERENCES ........................................................................................................................... 184
silabs.com | Building a more connected world.
Page xi of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table of Tables
Table 1 – Z-Wave example Device and Descriptors ........................................................................... 2
Table 2 – ZIPGW Versions vs Features as used by Z-Ware ............................................................. 2
Table 3 – Controlled Z-Wave CCs ......................................................................................................... 3
Table 4: ZIPGW SDK 2.8x Supported Z-Wave CCs ........................................................................... 4
Table 5: ZIPGW SDK 2.1x Supported Z-Wave CCs ........................................................................... 5
Table 6: ZIPGW SDK 2.0x Supported Z-Wave CCs ........................................................................... 5
Table 7 – Node Update get/set CCs ...................................................................................................... 8
Table 8 – Node Update endpoint get/set CCs ..................................................................................... 8
Table 9 – Network scanning APIs ........................................................................................................ 10
Table 10 – Network initialization API ................................................................................................... 10
Table 11 – Network creation and tear down APIs ............................................................................. 11
Table 12 – Portal initialization API ....................................................................................................... 11
Table 13 – Portal shut down APIs ........................................................................................................ 11
Table 14 – Portal client profile management APIs ............................................................................ 12
Table 15 – Interface Control APIs ........................................................................................................ 12
Table 16 – Node identification APIs ..................................................................................................... 13
Table 17 – Grouping APIs ..................................................................................................................... 14
Table 18 – Command Queuing APIs ................................................................................................... 14
Table 19 – Firmware update APIs ........................................................................................................ 15
Table 20 – Polling facility APIs ............................................................................................................. 15
Table 21 – Device specific configuration and information database APIs ..................................... 15
Table 22 – Network and client preference storage APIs .................................................................. 15
Table 23 – Security 2 APIs .................................................................................................................... 16
Table 24 – Smart Start provisioning list management APIs ............................................................. 17
Table 25 – Network health check API ................................................................................................. 18
Table 26 – Error Codes, ZW_ERR_XXX ............................................................................................ 19
Table 27 – Low-level Library Error Codes .......................................................................................... 20
Table 28 – zwportal_init Parameters ................................................................................................... 21
Table 29 – zwportal_init_t structure ..................................................................................................... 22
Table 30 – clnt_prof_t structure ............................................................................................................ 22
Table 31 – zwportal_cb_t Parameters ................................................................................................. 22
Table 32 – zwportal_shutdown Parameters ....................................................................................... 23
Table 33 – zwportal_exit Parameters .................................................................................................. 23
Table 34 – zwportal_clnt_conn_close Parameters ............................................................................ 23
Table 35 – zwportal_clnt_add Parameters ......................................................................................... 23
Table 36 – zwportal_clnt_rm Parameters ........................................................................................... 23
Table 37 – zwportal_clnt_find Parameters ......................................................................................... 24
Table 38 – zwportal_clnt_list_free Parameters .................................................................................. 24
Table 39 – clnt_prof_lst structure ......................................................................................................... 24
Table 40 – zwportal_clnt_list_get Parameters ................................................................................... 24
Table 41 – zwdev_cfg_load Parameters ............................................................................................. 25
Table 42 – dev_rec_t structure ............................................................................................................. 25
Table 43 – DEV_XXX meaning & values ............................................................................................ 25
silabs.com | Building a more connected world.
Page xii of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table 44 – ep_rec_t structure ............................................................................................................... 26
Table 45 – redir_rec_t structure ........................................................................................................... 26
Table 46 – if_rec_t structure ................................................................................................................. 26
Table 47 – Interface Types: IF_REC_TYPE_XXX ............................................................................ 27
Table 48 – rec union ............................................................................................................................... 27
Table 49 – if_rec_grp_t structure ......................................................................................................... 27
Table 50 – if_rec_config_t structure .................................................................................................... 27
Table 51 – if_rec_cfg_set_t structure .................................................................................................. 28
Table 52 – if_rec_cfg_info_t structure ................................................................................................. 28
Table 53 – if_rec_bsnsr_t structure ..................................................................................................... 28
Table 54 – if_rec_bsnsr_match_t structure ........................................................................................ 28
Table 55 – if_rec_thrmo_setp_t structure ........................................................................................... 29
Table 56 – zwsetp_temp_range_t structure ....................................................................................... 29
Table 57 – Binary Sensor Types: ZW_BSENSOR_TYPE_XXX ..................................................... 29
Table 58 – Multi-level Sensor Type: ZW_SENSOR_TYPE_XXX ................................................... 29
Table 59 – Multi-level Sensor Unit ....................................................................................................... 31
Table 60 – Meter Type ........................................................................................................................... 34
Table 61 – Meter Supported Unit Bit-mask......................................................................................... 34
Table 62 – Z-Wave Alarm//Notification Type ...................................................................................... 34
Table 63 – Z-Wave Alarm/Notification Event ..................................................................................... 35
Table 64 – Z-Wave Alarm/Notification Event Parameter Type ........................................................ 38
Table 65 – Alarm Sensor Type ............................................................................................................. 38
Table 66 – if_rec_snsr_t structure ........................................................................................................ 39
Table 67 – if_rec_meter_t structure ..................................................................................................... 39
Table 68 – if_rec_alarm_match_t structure ........................................................................................ 39
Table 69 – if_rec_alarm_result_t structure ......................................................................................... 39
Table 70 – if_rec_alarm_rev_match_t structure ................................................................................ 40
Table 71 – if_rec_basic_match_t structure ......................................................................................... 40
Table 72 – if_rec_alrm_snsr_match_t structure................................................................................. 40
Table 73 – dev_cfg_error_t structure .................................................................................................. 40
Table 74 – zwdev_cfg_free Parameters ............................................................................................. 41
Table 75 – zwdev_global_sett_free Parameters ............................................................................... 41
Table 76 – zwdev_cfg_find Parameters .............................................................................................. 41
Table 77 – dev_rec_srch_key_t structure ........................................................................................... 41
Table 78 – zwnet_gw_discvr_start Parameters ................................................................................. 50
Table 79 – zwnet_gw_discvr_cb_t Parameters ................................................................................. 50
Table 80 – zwnet_gw_discvr_stop Parameters ................................................................................. 50
Table 81 – zwnet_ip_aton Parameters ................................................................................................ 51
Table 82 – zwnet_ip_ntoa Parameters ................................................................................................ 51
Table 83 – zwnet_local_addr_get Parameters................................................................................... 51
Table 84 – zwnet_listen_port_get Parameters................................................................................... 52
Table 85 – zwnet_init Parameters ........................................................................................................ 52
Table 86 – zwnet_init_t structure ......................................................................................................... 52
Table 87 – dev_cfg_usr_t structure ..................................................................................................... 54
Table 88 – zwnet_dev_rec_find_fn Parameters ................................................................................ 54
silabs.com | Building a more connected world.
Page xiii of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table 89 – dev_global_sett_t structure ............................................................................................... 54
Table 90 – zwnet_xxx generic Parameters......................................................................................... 54
Table 91 – zwnet_unhandled_cmd_fn Parameters ........................................................................... 54
Table 92 – sup_cmd_cls_t structure .................................................................................................... 55
Table 93 – zwnet_notify_fn Parameters .............................................................................................. 55
Table 94 – zwnet_sts_t structure ......................................................................................................... 56
Table 95 – zw_health_prg_t structure ................................................................................................. 57
Table 96 – zw_health_rpt_t structure .................................................................................................. 57
Table 97 – zw_health_sts_t structure .................................................................................................. 57
Table 98 – zwnet_node_fn Parameters .............................................................................................. 58
Table 99 – zwnet_appl_fn Parameters ................................................................................................ 58
Table 100 – pl_info_fn Parameters ...................................................................................................... 58
Table 101 – zwnet_net_err_fn Parameters ........................................................................................ 58
Table 102 – print_fn Parameter ............................................................................................................ 58
Table 103 – zwnet_dev_rec_find_fn Parameter ................................................................................ 58
Table 104 – zwnet_exit Parameters .................................................................................................... 59
Table 105 – zwnet_get_desc Parameters .......................................................................................... 59
Table 106 – zwnetd_t structure ............................................................................................................ 59
Table 107 – zwnet_add Parameters .................................................................................................... 60
Table 108 – sec2_add_prm_t structure............................................................................................... 60
Table 109 – add_node_sec2_fn Parameters ..................................................................................... 60
Table 110 – sec2_add_cb_prm_t structure ........................................................................................ 61
Table 111 – sec2_keys_req_cb_prm_t structure............................................................................... 61
Table 112 – sec2_dsk_cb_prm_t structure......................................................................................... 61
Table 113 – zwnet_fail Parameters ..................................................................................................... 61
Table 114 – zwnet_initiate Parameters ............................................................................................... 62
Table 115 – zwnet_initiate_classic Parameters ................................................................................. 63
Table 116 – zwnet_get_node Parameters .......................................................................................... 64
Table 117 – zwnet_get_node_by_id Parameters .............................................................................. 64
Table 118 – zwnet_get_ep_by_id Parameters................................................................................... 64
Table 119 – zwnet_get_if_by_id Parameters ..................................................................................... 64
Table 120 – zwnet_get_user Parameters ........................................................................................... 65
Table 121 – zwnet_send_nif Parameters ........................................................................................... 65
Table 122 – zwnet_all_node_sts_get Parameters ............................................................................ 65
Table 123 – zwnet_node_sts_get Parameters................................................................................... 65
Table 124 – zwnet_poll_rm Parameters ............................................................................................. 66
Table 125 – zwnet_poll_rm_mul Parameters ..................................................................................... 66
Table 126 – zwnet_pref_set Parameters ............................................................................................ 66
Table 127 – zwnet_pref_get Parameters ............................................................................................ 66
Table 128 – zwnet_client_pref_set Parameters................................................................................. 67
Table 129 – zwnet_client_pref_get Parameters ................................................................................ 67
Table 130 – zwnet_add_sec2_accept Parameters ........................................................................... 67
Table 131 – zwnet_add_sec2_grant_key Parameters ..................................................................... 67
Table 132 – zwnet_sec2_get_dsk Parameters .................................................................................. 68
Table 133 – get_dsk_fn Parameters .................................................................................................... 68
silabs.com | Building a more connected world.
Page xiv of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table 134 – zwnet_pl_add Parameters............................................................................................... 68
Table 135 – pl_info_t structure ............................................................................................................. 68
Table 136 – pl_prod_type_t structure .................................................................................................. 70
Table 137 – pl_prod_id_t structure ...................................................................................................... 70
Table 138 – pl_uuid_t structure ............................................................................................................ 70
Table 139 – pl_nw_sts_t structure ....................................................................................................... 71
Table 140 – zwnet_pl_get Parameters ................................................................................................ 71
Table 141 – pl_info_fn Parameters ...................................................................................................... 71
Table 142 – pl_lst_ent_t structure ........................................................................................................ 71
Table 143 – zwnet_pl_del Parameters ................................................................................................ 72
Table 144 – zwnet_pl_list_get Parameters......................................................................................... 72
Table 145 – pl_list_fn Parameters ....................................................................................................... 72
Table 146 – zwnet_pl_list_del Parameters ......................................................................................... 73
Table 147 – zwnoded_t structure ......................................................................................................... 73
Table 148 – NODE_PROPTY_XXX .................................................................................................... 73
Table 149 – dev_id_t structure ............................................................................................................. 74
Table 150 – zwnode_get_net Parameters .......................................................................................... 74
Table 151 – zwnode_get_next Parameters ........................................................................................ 74
Table 152 – zwnode_get_ep Parameters ........................................................................................... 74
Table 153 – zwnode_update Parameters ........................................................................................... 75
Table 154 – zwnode_cmd_q_ena_set Parameters ........................................................................... 75
Table 155 – zwnode_cmd_q_ena_get Parameters........................................................................... 75
Table 156 – zwnode_cmd_q_ena_cancel Parameters ..................................................................... 75
Table 157 – zwnode_cmd_q_get Parameters ................................................................................... 76
Table 158 – zwnode_mul_cmd_ctl_set Parameters ......................................................................... 76
Table 159 – zwnode_mul_cmd_ctl_get Parameters ......................................................................... 76
Table 160 – zwnode_get_ext_ver Parameters .................................................................................. 76
Table 161 – ext_ver_t structure ............................................................................................................ 76
Table 162 – zwepd_t structure ............................................................................................................. 77
Table 163 – zwplus_info_t structure .................................................................................................... 77
Table 164 – zwep_get_node Parameters ........................................................................................... 77
Table 165 – zwep_get_next Parameters ............................................................................................ 78
Table 166 – zwep_get_if Parameters .................................................................................................. 78
Table 167 – zwep_nameloc_set Parameters ..................................................................................... 78
Table 168 – zw_nameloc_t structure ................................................................................................... 78
Table 169 – zwifd_t structure ................................................................................................................ 79
Table 170 – zwif_get_ep Parameters .................................................................................................. 79
Table 171 – zwif_get_next Parameters ............................................................................................... 80
Table 172 – zwif_exec Parameters ...................................................................................................... 80
Table 173 – zwif_xxx_poll Parameters ................................................................................................ 80
Table 174 – zwpoll_req_t structure ...................................................................................................... 80
Table 175 – zwpoll_cmplt_fn Parameters ........................................................................................... 81
Table 176 – zwif_basic_rpt_set Parameters ..................................................................................... 81
Table 177 – zwrep_basic_fn Parameters ........................................................................................... 81
Table 178 – zwbasic_t structure ........................................................................................................... 81
silabs.com | Building a more connected world.
Page xv of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table 179 – zwif_basic_get Parameters ............................................................................................. 82
Table 180 – zwif_basic_set Parameters ............................................................................................. 82
Table 181 – zwif_group_sup_get Parameters ................................................................................... 82
Table 182 – zwrep_group_sup_fn Parameters .................................................................................. 83
Table 183 – zwif_group_actv_get Parameters................................................................................... 83
Table 184 – zwrep_group_actv_fn Parameters ................................................................................. 83
Table 185 – zwif_group_get Parameters ............................................................................................ 83
Table 186 – zwrep_group_fn Parameters .......................................................................................... 83
Table 187 – grp_member_t structure .................................................................................................. 84
Table 188 – zwif_group_add Parameters ........................................................................................... 84
Table 189 – zwif_group_del Parameters ............................................................................................ 84
Table 190 – zwif_group_info_get Parameters ................................................................................... 84
Table 191 – if_grp_info_dat_t structure .............................................................................................. 85
Table 192 – zw_grp_info_t structure ................................................................................................... 85
Table 193 – grp_cmd_ent_t structure .................................................................................................. 85
Table 194 – zwif_group_info_free Parameters .................................................................................. 85
Table 195 – zwif_switch_rpt_set Parameters..................................................................................... 86
Table 196 – zwrep_switch_fn Parameters .......................................................................................... 86
Table 197 – zwswitch_t structure ......................................................................................................... 86
Table 198 – zwif_switch_get Parameters ........................................................................................... 86
Table 199 – ZWIF_GET_BMSK_XXX ................................................................................................. 86
Table 200 – zwif_switch_set Parameters ........................................................................................... 87
Table 201 – zw_postset_fn Parameters .............................................................................................. 87
Table 202 – zwif_level_rpt_set Parameters ....................................................................................... 87
Table 203 – zwrep_level_fn Parameters ............................................................................................ 88
Table 204 – zwlevel_dat_t structure .................................................................................................... 88
Table 205 – zwif_level_sup_get Parameters ..................................................................................... 88
Table 206 – zwrep_lvl_sup_fn Parameters ........................................................................................ 88
Table 207 – zwif_level_sup_cache_get Parameters ......................................................................... 89
Table 208 – zwif_level_get Parameters .............................................................................................. 89
Table 209 – zwif_level_set Parameters .............................................................................................. 89
Table 210 – zwif_level_start Parameters ............................................................................................ 90
Table 211 – zwlevel_t structure ............................................................................................................ 90
Table 212 – zwif_level_stop Parameters ............................................................................................ 90
Table 213 – zwif_bsensor_rpt_set Parameters ................................................................................. 91
Table 214 – zwrep_bsensor_fn Parameters....................................................................................... 91
Table 215 – zwif_bsensor_get Parameters ........................................................................................ 91
Table 216 – zwif_bsensor_sup_get Parameters ............................................................................... 91
Table 217 – zwrep_bsensor_sup_fn Parameters .............................................................................. 92
Table 218 – zwif_bsensor_sup_cache_get Parameters ................................................................... 92
Table 219 – zwif_sensor_rpt_set Parameters .................................................................................... 92
Table 220 – zwrep_sensor_fn Parameters ......................................................................................... 92
Table 221 – zwsensor_t structure ........................................................................................................ 93
Table 222 – ZW_SENSOR_TYPE_XXX, ZW_SENSOR_UNIT_XXX_YYY ................................. 93
Table 223 – zwif_sensor_get Parameters .......................................................................................... 95
silabs.com | Building a more connected world.
Page xvi of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table 224 – zwif_sensor_sup_get Parameters .................................................................................. 96
Table 225 – zwrep_sensor_sup_fn Parameters ................................................................................ 96
Table 226 – zwif_sensor_unit_get Parameters .................................................................................. 96
Table 227 – zwrep_sensor_unit_fn Parameters ................................................................................ 96
Table 228 – zwif_sensor_unit_cache_get Parameters ..................................................................... 97
Table 229 – zwif_sensor_sup_cache_get Parameters ..................................................................... 97
Table 230 – if_sensor_data_t structure ............................................................................................... 97
Table 231 – zwif_group_cmd_sup_get Parameters .......................................................................... 98
Table 232 – zwrep_grp_cmd_sup_fn Parameters............................................................................. 98
Table 233 – zwgrp_cmd_cap_t structure ............................................................................................ 98
Table 234 – zwif_group_cmd_get Parameters .................................................................................. 98
Table 235 – zwrep_grp_cmd_fn Parameters ..................................................................................... 98
Table 236 – zwif_group_cmd_set Parameters................................................................................... 99
Table 237 – zwif_wakeup_get Parameters ........................................................................................ 99
Table 238 – zwrep_wakeup_fn Parameters ....................................................................................... 99
Table 239 – zwif_wakeup_t structure .................................................................................................. 99
Table 240 – zwif_wakeup_set Parameters ....................................................................................... 100
Table 241 – zwif_config_rpt_set Parameters .................................................................................. 100
Table 242 – zwrep_config_fn Parameters ........................................................................................ 100
Table 243 – zwconfig_t structure ....................................................................................................... 100
Table 244 – zwif_c onfig_get Parameters .......................................................................................... 101
Table 245 – zwif_config_set Parameters .......................................................................................... 101
Table 246 – zwif_config_bulk_rpt_set Parameters ........................................................................ 101
Table 247 – zwrep_cfg_bulk_fn Parameters .................................................................................... 101
Table 248 – zwcfg_bulk_t structure ................................................................................................... 101
Table 249 – zwif_config_bulk_get Parameters ................................................................................ 102
Table 250 – zwif_config_bulk_set Parameters ................................................................................ 102
Table 251 – zwif_config_prm_reset Parameters ............................................................................. 102
Table 252 – zwif_c onfig_i nfo_get Parameters ................................................................................. 103
Table 253 – zwcfg_info_cap_t structure ........................................................................................... 103
Table 254 – zwcfg_info_t structure .................................................................................................... 103
Table 255 – gen_dat_u union ............................................................................................................. 104
Table 256 – zwif_config_info_free Parameters ................................................................................ 104
Table 257 – zwif_pulsemeter_rpt_set Parameters ......................................................................... 104
Table 258 – zwrep_pulsemeter_fn Parameters .............................................................................. 105
Table 259 – zwif_pulsemeter_get Parameters................................................................................. 105
Table 260 – zwif_battery_rpt_set Parameters ................................................................................ 105
Table 261 – zwrep_ts_fn Parameters ................................................................................................ 105
Table 262 – zwif_battery_get Parameters ........................................................................................ 105
Table 263 – zwif_av_set Parameters ................................................................................................ 106
Table 264 – zwif_av_caps Parameters ............................................................................................. 106
Table 265 – zwrep_av_fn Parameters............................................................................................... 106
Table 266 – zwif_meter_rpt_set Parameters .................................................................................. 107
Table 267 – zwrep_meter_fn Parameters......................................................................................... 107
Table 268 – zwmeter_dat_t structure ................................................................................................ 107
silabs.com | Building a more connected world.
Page xvii of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table 269 – ZW_METER_TYPE_XXX and ZW_METER_UNIT_XXX ......................................... 107
Table 270 – zwif_meter_get Par ameters .......................................................................................... 108
Table 271 – zwif_meter_sup_get Parameters ................................................................................. 108
Table 272 – zwrep_meter_sup_fn Parameters ................................................................................ 108
Table 273 – zwmeter_cap_t structure ............................................................................................... 109
Table 274 – ZW_METER_SUP_UNIT_XXX .................................................................................... 109
Table 275 – zwif_meter_sup_cache_get Parameters ..................................................................... 109
Table 276 – zwif_meter_reset Parameters ....................................................................................... 110
Table 277 – zwif_meter_set_admin Parameters ............................................................................. 110
Table 278 – zwif_meter_get_desc Parameters ............................................................................... 110
Table 279 – zwrep_meterd_fn Parameters ...................................................................................... 110
Table 280 – zwmeter_t structure ........................................................................................................ 110
Table 281 – zwif_dlck_op_rpt_set Parameters ............................................................................... 111
Table 282 – zwrep_dlck_op_fn Parameters ..................................................................................... 111
Table 283 – zwdlck_op_t structure ................................................................................................... 111
Table 284 – ZW_DOOR_XXX ............................................................................................................ 111
Table 285 – ZW_COND_XXX_MASK ............................................................................................... 112
Table 286 – zwif_dlck_op_get Parameters ...................................................................................... 112
Table 287 – zwif_dlck_op_set Parameters ....................................................................................... 112
Table 288 – zwif_dlck_cfg_set Parameters ..................................................................................... 112
Table 289 – zwdlck_cfg_t structure .................................................................................................. 113
Table 290 – zwif_d l ck_cfg_get P arameters ...................................................................................... 113
Table 291 – zwrep_dlck_cfg_fn Parameters ................................................................................... 113
Table 292 – zwif_usrcod_get Parameters ........................................................................................ 114
Table 293 – zwrep_usr_cod_fn Parameters .................................................................................... 114
Table 294 – zwusrcod_t structure ...................................................................................................... 114
Table 295 – zwif_usrcod_set Parameters ........................................................................................ 114
Table 296 – zwif_usrcod_sup_get Parameters ................................................................................ 114
Table 297 – zwrep_usr_sup_fn Parameters .................................................................................... 115
Table 298 – zwif_usrcod_sup_cache_get Parameters ................................................................... 115
Table 299 – zwif_alrm_rpt_set Parameters ..................................................................................... 115
Table 300 – zwrep_alrm_fn Parameters ........................................................................................... 115
Table 301 – zwalrm_t stru cture ......................................................................................................... 115
Table 302 – ZW_ALRM_STS_XXX ................................................................................................... 116
Table 303 – ZW_ALRM_XXX ............................................................................................................. 117
Table 304 – ZW_ALRM_EVT_XXX ................................................................................................... 117
Table 305 – zwif_alrm_get Parameters ............................................................................................ 124
Table 306 – zwif_alrm_set Parameters ............................................................................................. 124
Table 307 – zwif_alrm_sup_get Parameters ................................................................................... 124
Table 308 – zwrep_alrm_sup_fn Parameters ................................................................................. 125
Table 309 – zwif_alrm_sup_cache_get Parameters ....................................................................... 125
Table 310 – zwif_alrm_sup_evt_get Parameters ........................................................................... 125
Table 311 – zwrep_alrm_evt_fn Parameters .................................................................................. 126
Table 312 – zwif_alrm_sup_evt_cache_get Parameters ............................................................... 126
Table 313 – zwif_alrm_vtype_sup_get Parameters ....................................................................... 126
silabs.com | Building a more connected world.
Page xviii of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table 314 – zwif_thrmo_fan_md_rpt_set Parameters .................................................................... 126
Table 315 – zwrep_thrmo_fan_md_fn Parameters ......................................................................... 127
Table 316 – ZW_THRMO_FAN_MD_XXX ....................................................................................... 127
Table 317 – zwif_thrmo_fan_md_get Parameters ........................................................................... 127
Table 318 – zwif_thrmo_fan_md_set Parameters ........................................................................... 128
Table 319 – zwif_thrmo_fan_md_sup_get Parameters .................................................................. 128
Table 320 – zwrep_thrmo_fan_md_sup_fn Parameters ................................................................ 128
Table 321 – zwif_thrmo_fan_md_sup_cache_get Parameters ..................................................... 129
Table 322 – zwif_thrmo_fan_sta_rpt_set Parameters .................................................................... 129
Table 323 – zwrep_thrmo_fan_sta_fn Parameters ......................................................................... 129
Table 324 – ZW_THRMO_FAN_STA_XXX ..................................................................................... 129
Table 325 – zwif_thrmo_fan_sta_get Parameters ........................................................................... 130
Table 326 – zwif_thrmo_md_rpt_set Parameters ............................................................................ 130
Table 327 – zwrep_thrmo_md_fn Parameters ................................................................................. 130
Table 328 – ZW_THRMO_MD_XXX ................................................................................................. 130
Table 329 – zwif_thrmo_md_get Parameters .................................................................................. 131
Table 330 – zwif_thrmo_md_set Parameters................................................................................... 131
Table 331 – zwif_thrmo_md_sup_get Parameters .......................................................................... 132
Table 332 – zwrep_thrmo_md_sup_fn Parameters ........................................................................ 132
Table 333 – zwif_thrmo_md_sup_cache_get Parameters ............................................................. 132
Table 334 – zwif_thrmo_op_sta_rpt_set Parameters ..................................................................... 132
Table 335 – zwrep_thrmo_op_sta_fn Parameters .......................................................................... 133
Table 336 – ZW_THRMO_OP_STA_XXX ........................................................................................ 133
Table 337 – zwif_thrmo_op_sta_get Parameters ............................................................................ 133
Table 338 – zwif_thrmo_op_sta_log_sup_get Parameters ............................................................ 133
Table 339 – zwrep_thrmo_op_sta_log_sup_fn Parameters .......................................................... 134
Table 340 – zwif_thrmo_op_sta_log_sup_cache_get Parameters ............................................... 134
Table 341 – zwif_thrmo_op_sta_log_rpt_set Parameters .............................................................. 134
Table 342 – zwrep_thrmo_op_sta_log_fn Parameters ................................................................... 134
Table 343 – zwthrmo_op_sta_log_t structure ................................................................................. 135
Table 344 – zwif_thrmo_op_sta_log_get Parameters .................................................................... 135
Table 345 – zwif_thrmo_setb_rpt_set Parameters .......................................................................... 135
Table 346 – zwrep_thrmo_setb_fn Parameters ............................................................................... 135
Table 347 – ZW_THRMO_SETB_TYP_XXX ................................................................................... 136
Table 348 – ZW_THRMO_SETB_STA_XXX ................................................................................... 136
Table 349 – zwif_thrmo_setb_get Parameters ................................................................................ 136
Table 350 – zwif_thrmo_setb_set Parameters................................................................................. 136
Table 351 – zwif_thrmo_setp_rpt_set Parameters .......................................................................... 137
Table 352 – zwrep_thrmo_setp_fn Parameters ............................................................................... 137
Table 353 – zwsetp_t structure ......................................................................................................... 137
Table 354 – ZW_THRMO_SETP_TYP_XXX ................................................................................... 137
Table 355 – ZW_THRMO_SETP_UNIT_XXX ................................................................................. 138
Table 356 – zwif_thrmo_setp_get Parameters ................................................................................ 138
Table 357 – zwif_thrmo_setp_set Parameters................................................................................. 138
Table 358 – zwif_thrmo_setp_sup_get Parameters ........................................................................ 138
silabs.com | Building a more connected world.
Page xix of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table 359 – zwrep_thrmo_setp_sup_fn Parameters ...................................................................... 138
Table 360 – zwif_thrmo_setp_sup_cache_get Parameters ........................................................... 139
Table 361 – zwif_thrmo_setp_sup_range_get Parameters ........................................................... 139
Table 362 – zwrep_thrmo_setp_range_fn Parameters .................................................................. 139
Table 363 – zwif_thrmo_setp_sup_range_cache_get Parameters .............................................. 139
Table 364 – zwif_clock_rpt_set Parameters..................................................................................... 140
Table 365 – zwrep_clock_fn Parameters .......................................................................................... 140
Table 366 – ZW_CLOCK_XXX .......................................................................................................... 140
Table 367 – zwif_clo ck_get Parameters ........................................................................................... 140
Table 368 – zwif_clock_set Parameters ........................................................................................... 141
Table 369 – zwif_clmt_ctl_schd_rpt_set Parameters ..................................................................... 141
Table 370 – zwrep_clmt_ctl_schd_fn Parameters ........................................................................... 141
Table 371 – zwcc_shed_t structure .................................................................................................. 141
Table 372 – zwcc_shed_swpt_t structure ......................................................................................... 142
Table 373 – zwif_clmt_ctl_schd_get Parameters ............................................................................ 142
Table 374 – zwif_clmt_ctl_schd_set Parameters ............................................................................ 142
Table 375 – zwif_clmt_ctl_schd_chg_rpt_set Parameters ............................................................. 142
Table 376 – zwrep_clmt_ctl_schd_chg_fn Parameters .................................................................. 142
Table 377 – zwif_clmt_ctl_schd_chg_get Parameters ................................................................... 143
Table 378 – zwif_clmt_ctl_schd_ovr_rpt_set Parameters .............................................................. 143
Table 379 – zwrep_clmt_ctl_schd_ovr_fn Parameters ................................................................... 143
Table 380 – zwcc_shed_t structure .................................................................................................. 143
Table 381 – zwif_clmt_ctl_schd_ovr_get Parameters .................................................................... 143
Table 382 – zwif_clmt_ctl_schd_ovr_set Parameters ..................................................................... 144
Table 383 – zwif_prot_rpt_set Parameters ....................................................................................... 144
Table 384 – zwrep_prot_fn Parameters ............................................................................................ 144
Table 385 – ZW_LPROT_XXX ........................................................................................................... 144
Table 386 – ZW_RFPROT_XXX ........................................................................................................ 145
Table 387 – zwif_prot_get Parameters ............................................................................................. 145
Table 388 – zwif_prot_set Parameters .............................................................................................. 145
Table 389 – zwif_prot_sup_get Parameters ..................................................................................... 145
Table 390 – zwrep_prot_sup_fn Parameters ................................................................................... 146
Table 391 – zwprot_sup_t structure .................................................................................................. 146
Table 392 – zwif_prot_sup_cache_get Parameters ........................................................................ 146
Table 393 – zwif_prot_ec_rpt_set Parameters ................................................................................ 146
Table 394 – zwrep_prot_ec_fn Parameters ..................................................................................... 146
Table 395 – zwif_prot_ec_get Parameters ....................................................................................... 147
Table 396 – zwif_prot_ec_set Parameters ....................................................................................... 147
Table 397 – zwif_prot_tmout_rpt_set Parameters ........................................................................... 147
Table 398 – zwrep_prot_tmout_fn Parameters ................................................................................ 147
Table 399 – zwif_prot_tmout_get Parameters ................................................................................. 148
Table 400 – zwif_prot_tmout_set Parameters ................................................................................. 148
Table 401 – zwif_appl_busy_rpt_set Parameters ........................................................................... 148
Table 402 – zwrep_appl_busy_fn Parameters................................................................................. 148
Table 403 – ZW_BSY_STS_XXX ...................................................................................................... 149
silabs.com | Building a more connected world.
Page xx of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table 404 – zwif_appl_reject_rpt_set Parameters .......................................................................... 149
Table 405 – zwrep_appl_reject_fn Parameters ............................................................................... 149
Table 406 – ZW_RJ_STS_XXX ......................................................................................................... 149
Table 407 – zwif_ind_rpt_set Parameters ........................................................................................ 149
Table 408 – zwrep_fn Parameters ..................................................................................................... 150
Table 409 – zwif_ind_get Parameters ............................................................................................... 150
Table 410 – zwif_ind_set Parameters ............................................................................................... 150
Table 411 – zwif_fw_inf o_get Pa rameters ........................................................................................ 150
Table 412 – zwrep_fw_info_fn Parameters ...................................................................................... 151
Table 413 – zwfw_info_t structure ..................................................................................................... 151
Table 414 – zwif_fw_updt_req Parameters ...................................................................................... 151
Table 415 – zwfw_updt_req_t structure ............................................................................................ 151
Table 416 – zwrep_fw_updt_sts_fn Parameters ............................................................................. 152
Table 417 – ZW_FW_UPDT_ERR_XXX .......................................................................................... 152
Table 418 – zwrep_fw_updt_cmplt_fn Parameters ......................................................................... 152
Table 419 – ZW_FW_UPDT_CMPLT_XXX ..................................................................................... 152
Table 420 – zwrep_fw_tgt_restart_fn Parameters ........................................................................... 153
Table 421 – ZW_FW_UPDT_ RESTART_XXX ............................................................................... 153
Table 422 – zwif_gw_mode_set Parameters ................................................................................... 153
Table 423 – zwgw_portal_prof_t structure ........................................................................................ 154
Table 424 – zwif_gw_mode_get Parameters ................................................................................... 154
Table 425 – zwrep_gw_mode_fn Parameters ................................................................................. 154
Table 426 – zwif_gw_mode_get Parameters ................................................................................... 155
Table 427 – zwif_gw_unsolicit_set Parameters ............................................................................... 155
Table 428 – zwif_gw_unsolicit_get Parameters............................................................................... 155
Table 429 – zwrep_gw_unsolicit_fn Parameters ............................................................................. 155
Table 430 – zwif_gw_cfg_set Parameters ........................................................................................ 156
Table 431 – zwportal_cfg_t structure ................................................................................................ 156
Table 432 – zwrep_cfg_st s_fn Parameters ...................................................................................... 156
Table 433 – zwif_gw_mode_get Parameters ................................................................................... 157
Table 434 – zwrep_gw_cfg_fn Parameters ...................................................................................... 157
Table 435 – zwif_power_level_rpt_set Parameters ....................................................................... 157
Table 436 – zwrep_power_level_fn Parameters ............................................................................. 157
Table 437 – zwif_power_level_get Parameters ............................................................................... 157
Table 438 – zwif_power_level_set Parameters ............................................................................... 158
Table 439 – zwif_power_level_test_rpt_set Parameters ............................................................... 158
Table 440 – zwrep_power_level_test_fn Parameters ..................................................................... 158
Table 441 – POWERLEVEL_TEST_XXX ......................................................................................... 158
Table 442 – zwif_power_level_test_get Parameters ...................................................................... 159
Table 443 – zwif_power_level_test_set Parameters ....................................................................... 159
Table 444 – zwif_csc_rpt_set Parameters ........................................................................................ 159
Table 445 – zwrep_csc_fn Parameters ............................................................................................. 159
Table 446 – zwcsc_notif_t structure ................................................................................................. 159
Table 447 – ZW_CSC_KEY_ATTRIB_XXX ..................................................................................... 160
Table 448– zwif_ csc_sup_get Pa rameters ....................................................................................... 160
silabs.com | Building a more connected world.
Page xxi of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table 449 – zwrep_csc_sup_fn Parameters .................................................................................... 161
Table 450– zwif_csc_cfg_rpt_set Parameters ................................................................................. 162
Table 451 – zwrep_csc_cfg_fn Parameters ..................................................................................... 162
Table 452– zwif_csc_cfg_get Parameters ........................................................................................ 162
Table 453– zwif_csc_cfg_set Parameters ........................................................................................ 162
Table 454 – zwif_alrm_snsr_rpt_set Parameters ............................................................................ 163
Table 455 – zwrep_alrm_snsr_fn Parameters ................................................................................. 163
Table 456 – zw_alrm_snsr_t structure ............................................................................................. 163
Table 457 – ZW_ALRM_SNSR_TYPE_XXX ................................................................................... 163
Table 458 – zwif_alrm_snsr_get Parameters ................................................................................... 164
Table 459 – zwif_alrm_snsr_sup_get Parameters .......................................................................... 164
Table 460 – zwrep_alrm_snsr_sup_fn Parameters ......................................................................... 164
Table 461 – zwif_alrm_snsr_sup_cache_get Parameters ............................................................. 164
Table 462 – zwif_barrier_rpt_set Parameters .................................................................................. 165
Table 463 – zwrep_barrier_fn Parameters ....................................................................................... 165
Table 464 – ZW_BAR_STA_XXX ...................................................................................................... 165
Table 465 – zwif_barrier_get Parameters ......................................................................................... 165
Table 466 – zwif_barrier_set Parameters ......................................................................................... 166
Table 467 – zwif_barrier_notif_sup_get Parameters ...................................................................... 166
Table 468 – zwrep_barrier_notif_sup_fn Parameters ..................................................................... 166
Table 469 – ZW_BAR_NOTIF_TYP_XXX ........................................................................................ 166
Table 470 – zwif_barrier_notif_sup_cache_get Parameters ......................................................... 167
Table 471 – zwif_barrier_notif_rpt_set Parameters ........................................................................ 167
Table 472 – zwrep_barrier_subsys_fn Parameters......................................................................... 167
Table 473 – zwif_barrier_notif_cfg_get Parameters ....................................................................... 167
Table 474 – zwif_barrier_notif_cfg_set Parameters ........................................................................ 168
Table 475 – zwif_color_sw_rpt_set Parameters .............................................................................. 168
Table 476 – zwrep_color_sw_get_fn Parameters ........................................................................... 168
Table 477 – zwcolor_t structure ........................................................................................................ 168
Table 478 – COL_SW_COMP_ID_XXX ........................................................................................... 169
Table 479 – zwif_color_sw_get Parameters..................................................................................... 169
Table 480 – zwif_color_sw_set Parameters ..................................................................................... 169
Table 481 – zwif_color_sw_start Parameters .................................................................................. 170
Table 482 – zwcol_ctl_t structure ...................................................................................................... 170
Table 483 – COL_SW_LVL_XXX ...................................................................................................... 170
Table 484 – zwif_color_sw Parameters ............................................................................................ 170
Table 485 – zwif_color_sw_sup_get Parameters ............................................................................ 170
Table 486 – zwrep_color_sw_sup_fn Parameters .......................................................................... 171
Table 487 – zwif_color_sw_sup_cache_get Parameters ............................................................... 171
Table 488 – Base memory requirement ............................................................................................ 172
Table 489 – Per node memory requirement ..................................................................................... 172
Table 490 – Per Z-Wave network memory requirement ................................................................. 172
Table 491 – Build System Requirements .......................................................................................... 172
Table 492 – Files .................................................................................................................................. 174
Table 493 – Configuration file entries ................................................................................................ 177
silabs.com | Building a more connected world.
Page xxii of xxii
INS14129-5 Z-Ware Library User Guide 2018-05-02
silabs.com | Building a more connected world.
Page 1 of 184
INS14129-5 Z-Ware Library User Guide 2018-05-02
1 INTRODUCTION
1.1 Purpose
The Z-Ware Library is a Z/IP (Z-Wave for Internet Protocol) Gateway (ZIPGW) client and abstracts
Z-Wave Command Classes (CC) into controllable and monitorable interfaces over a C API (Application
Programming Interface) for easier development and certification of Z-Wave controller applications.
One such Z-Ware Library Client is the Z-Ware Web Server.
The Library can be compiled into Consumer Electronics (CE) or Portal mode. In Portal mode, multiple
ZIPGWs connect to the Library over TCP (Transmission Control Protocol) encrypted with TLS (Transport
Layer Security) where the Library Client is expected to run in the Cloud. In CE mode, the Library
connects to the ZIPGW via UDP (User Datagram Protocol) encrypted with DTLS (Datagram TLS) where
the Library Client is expected to run in the home.
This document describes the Library usage and API with clear differentiation between CE & Portal
modes where applicable.
1.2 Audience and prerequisites
This document is for Z-Wave Partners and assumes they are already comfortable with the Z-Wave
protocol and network installation. As such the document does not go into detail on these matters.
References are also made to the Device and Command Classes and the Z/IP API which are what this API
is built upon.
silabs.com | Building a more connected world.
Page 2 of 184
Node
Power strip
Endpoints
Power point
Power point
Interfaces
Switch
Meter
Switch
Meter
ZIPGW SDK
Mailbox
Security
N/W
Health
Smart Start
2.0x
Unused
S0
N.A.
N.A.
2.1x
Used
S0, S2
N.A.
N.A.
2.8x
Used
S0, S2
Used
Used
INS14129-5 Z-Ware Library User Guide 2018-05-02
2 FEATURES
The API deals with Z-Wave through descriptors for networks, nodes, endpoints and interfaces. A
Z-Wave Home Area Network (HAN) is uniquely identified by a Home ID encapsulated in a network
descriptor.
Nodes are Z-Wave devices in this HAN uniquely identified by a Node ID encapsulated in a node
descriptor. These nodes can be composite devices having multiple endpoints for e.g. a power strip with
multiple separately controllable power points. Each power point may have multiple interfaces allowing
control and/or monitoring, for e.g. a switch to set on and off; and perhaps a meter providing power
consumption information.
Table 1 – Z-Wave example Device and Descriptors
The API views the network through a ZIPGW attached controller which itself is a node in the network.
There can be multiple controllers in a network but only one primary, while the other nodes function as
slave that may be controlled or monitored by these controllers. The primary may serve as an inclusion
server in which case all secondary (i.e. non primary) controllers can also perform network maintenance
such as adding or removing nodes through the primary.
2.1 Role
Z-Ware is a Z-Wave Plus Security Enabled device in the Static PC Controller class, that is mainly used in
the role of a Static Update Controller (SUC) Identity Server (SIS), and the Z-Wave Plus role of a Central
Static Controller.
As a Z/IP secure remote client, it works in conjunction with a ZIPGW. Z-Ware sets itself as the (first)
unsolicited IP address of the ZIPGW that it is connected with. Z-Ware works with different versions of
ZIPGWs using the following features:
Table 2 – ZIPGW Versions vs Features as used by Z-Ware
silabs.com | Building a more connected world.
Page 3 of 184
CC
Ver
CC
Ver
ALARM_SENSOR
1
NW_MGMT_INCLUSION
3
APPLICATION_STATUS
1
NW_MGMT_INSTALLATION_MAINTENANCE*
1
ASSOCIATION
2
NW_MGMT_PROXY
2
ASSOCIATION_CMD_CFG
1
POWERLEVEL
1
ASSOCIATION_GRP_INFO
3
PROTECTION
2
BARRIER_OPERATOR
1
SECURITY
1
BASIC
2
SECURITY 2*
1
BATTERY
1
SENSOR_BINARY
2
CENTRAL_SCENE
3
SENSOR_MULTILEVEL
11
CLIMATE_CONTROL_SCHEDULE
1
SIMPLE_AV_CONTROL
1
CLOCK
1
SUPERVISION
1
INS14129-5 Z-Ware Library User Guide 2018-05-02
2.2 Network Operations
Z-Ware supports Inclusion, Exclusion, Reset (Set Default), Replace/Remove Failed Node, and Send NIF
(Node Information Frame). If it is assigned a primary controller role, it will always upgrade itself to an
SIS unless there is an SUC already present. Hence it cannot initiate controller shift as a primary.
Z-Ware supports Set Learn mode but this can only be performed when Z-Ware is not already in a
network and will typically make Z-Ware an Inclusion or Secondary Controller, in which case, some of its
facilities will not be available. Controller replication (Copy) is achieved through Inclusion and Set Learn
Mode.
Additionally it also supports Update Node and Update Network. Z-Ware discovers a Z-Wave node’s
capabilities during inclusion through a series of comprehensive queries. This process may take some
time, especially for a secure Frequently Listening Routing Slave (FLIRs) device. This operation may be
aborted at any time. Node Update re-queries the information that was obtained during inclusion. This
allows discovering any changes that were not made through this Z-Ware. Network Update requests
topology from an SUC if available, and then performs neighbor update if available or node update to
every node it is aware of.
Z-Ware supports SmartStart which uses a configurable provisioning list of devices to allow Z-Wave
network wide inclusion without having to manually configure a new node into Z-Wave learn mode. The
availability of this feature is dependent on the underlying ZIPGW and protocol.
2.3 Device Control
Z-Ware can be operated in any Z-Wave network with other Z-Wave certified devices from other
manufacturers. All non-battery operated nodes within the network will act as repeaters regardless of
vendor to increase reliability of the network.
Z-Ware is able to control/monitor Z-Wave-certified device of different categories from various vendors
through their CCs. CCs that are automatically handled are not exposed to the user. Z-Ware controls the
following CCs:
Table 3 – Controlled Z-Wave CCs
silabs.com | Building a more connected world.
Page 4 of 184
CONFIGURATION
4
SWITCH_ALL
1
CRC16_ENCAP
1
SWITCH_BINARY
2
DEVICE_RESET_LOCALLY
1
SWITCH_COLOR
3
DOOR_LOCK
3
SWITCH_MULTILEVEL
4
FIRMWARE_UPDATE_MD
5
THERMOSTAT_FAN_MODE
4
INDICATOR
1
THERMOSTAT_FAN_STATE
2
MANUFACTURER_SPECIFIC
2
THERMOSTAT_MODE
3
METER
3
THERMOSTAT_OPERATING_STATE
2
METER_PULSE
1
THERMOSTAT_SETBACK
1
METER_TBL_MONITOR
1
THERMOSTAT_SETPOINT
3
MULTI_CHANNEL
4
USER_CODE
1
MULTI_CHANNEL_ASSOCIATION
3
VERSION
2
MULTI_CMD
1
WAKE_UP
2
NO_OPERATION
1
ZIP 3 NODE_NAMING
1
ZIP_GATEWAY
1
NODE_PROVISIONING*
1
ZIP_ND
1
NOTIFICATION/ALARM
8
ZIP_PORTAL
1
NW_MGMT_BASIC
2
ZWAVEPLUS_INFO
2
CC
Ver
Not
Non-secure
Securely added
Non-Secure
Secure
APPLICATION_STATUS
1 X X X
ASSOCIATION *
2 X X
X ASSOCIATION_GRP_INFO *
3 X X
X
CRC_16_ENCAP
1 X X X
DEVICE_RESET_LOCALLY *
1 X X X
FIRMWARE_UPDATE_MD
5 X
INCLUSION_CONTROLLER **
1 X X X
MANUFACTURER_SPECIFIC
2 X X
MULTI_CMD *
1 X X
X NODE PROVISIONING
1 X
NW_MGMT_BASIC
2 X
NW_MGMT_INCLUSION **
2 X
INS14129-5 Z-Ware Library User Guide 2018-05-02
* Security 2, Network Management Installation Maintenance & Node Provisioning CCs only controlled if
the underlying ZIPGW supports them.
2.4 CC Support
Z-Ware does nothing on receiving Basic CC Set or Get. Z-Ware supports only 1 Association group
supporting 1 node for Lifeline. This node will receive the Device Reset Locally command.
For easier reference during certification the associated ZIPGW supported CCs are tabularized below.
Table 4: ZIPGW SDK 2.8x Supported Z-Wave CCs
added
added
silabs.com | Building a more connected world.
Page 5 of 184
NW_MGMT_INSTALLATION_MAINTENANCE
1 X
NW_MGMT_PROXY
2 X
POWERLEVEL
1 X X
SECURITY
1
X X
SECURITY_2
1 X X X
SUPERVISION
1 X X X
TRANSPORT_SERVICE
2 X X X
VERSION
2 X X
ZWAVEPLUS_INFO
2 X X X
CC
Ver
Not
Non-secure
Securely added
Non-Secure
Secure
APPLICATION_STATUS
1 X X X
ASSOCIATION *
2 X X
X ASSOCIATION_GRP_INFO *
3 X X
X CRC_16_ENCAP
1 X X X
DEVICE_RESET_LOCALLY *
1 X X X
FIRMWARE_UPDATE_MD
5 X
INCLUSION_CONTROLLER **
1 X X X
MANUFACTURER_SPECIFIC
2 X X
MULTI_CMD *
1 X X
X NW_MGMT_BASIC
2 X
NW_MGMT_INCLUSION **
2 X
NW_MGMT_INSTALLATION_MAINTENANCE
1 X
NW_MGMT_PROXY
2 X
POWERLEVEL
1 X
SECURITY
1 X X X
SECURITY_2
1 X X X
SUPERVISION
1 X X X
TRANSPORT_SERVICE
2 X X X
VERSION
2 X X
ZWAVEPLUS_INFO
2 X X X
Ver
Not
Non Secure
Securely Added
Non Secure
Secure
SECURITY
1 X X X
TRANSPORT SERVICE
2 X X X
CRC16
1 X X X
MULTI CMD *
1 X X X
NW MGMT BASIC
2 X
NW MGMT INCLUSION **
2 X
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table 5: ZIPGW SDK 2.1x Supported Z-Wave CCs
added
added
CC
Table 6: ZIPGW SDK 2.0x Supported Z-Wave CCs
Added
Added
silabs.com | Building a more connected world.
Page 6 of 184
Ver
Not
Non Secure
Securely Added
Non Secure
Secure
NW MGMT PROXY
2 X
NW MGMT INSTALLATION MAINTENANCE
1 X
DEVICE RESET LOCALLY *
1 X X X
ZIP 3 X ZIP PORTAL
1 X
ZIP GATEWAY
1 X
ZIP NAMING
1 X
FIRMWARE UPDATE MD
5 X
MAILBOX
1 X
POWER LEVEL
1 X
APPLICATION STATUS
1 X X X
ZWAVEPLUS INFO
2 X X X
MANUFACTURER SPECIFIC
2 X
VERSION
2 X
ASSOCIATION *
2 X X X
ASSOCIATION GRP INFO *
3 X X X
INS14129-5 Z-Ware Library User Guide 2018-05-02
CC
Added
Added
* ASSOCIATION, ASSOCIATION_GRP_INFO, MULTI_CMD & DEVICE_RESET_LOCALLY CCs are added by Z-
Ware to the ZIPGW NIF
** INCLUSION_CONTROLLER & NW_MGMT_INCLUSION CCs are only present if the ZIPGW is an
inclusion controller.
2.5 Network Initialization
The following steps are carried out during network initialization:
1. Get ZIPGW’s Z-Wave Home ID, Node ID & Home Area Network (HAN) IP address.
2. Get ZIPGW attached controller’s cached node information.
3. Get CC versions present in the ZIPGW cached node information to create corresponding Z-Ware
interfaces.
4. Get ZIPGW’s hardware and firmware versions if VERSION CC is version 2 or higher.
5. Get ZIPGW’s manufacturer, product type and product id if MANUFACTURER_SPECIFIC CC presents.
6. Get node list of the HAN.
7. Turn on mailbox for ZIPGW SDK v2.1x and above. This will enable multi-client support and receive
wake up notification from device through mailbox ACK message.
8. Get ZIPGW dynamic DSK key for adding new node.
9. Set supported CCs in the ZIPGW attached controller’s NIF
10. For Portal version, set unsolicited destination address. For CE version, get unsolicited destination
address and if its IPv6 address is all zeroes, set it to the Z/IP client IPv6 address.
11. Resolve all the nodes in node list into corresponding HAN IPv6 addresses.
12. Perform Node Update (see 2.6) through HAN network for nodes that are not loaded with detailed
node information from persistent storage.
silabs.com | Building a more connected world.
Page 7 of 184
INS14129-5 Z-Ware Library User Guide 2018-05-02
2.6 Node Update
The following steps are carried out to acquire detailed node information based on the CCs present at
node and endpoint levels:
1. Get cached node information of the node of interest from the ZIPGW.
2. Assign the ZIPGW attached controller’s Z-Wave Return Route to the node.
3. Get CC versions of each CC listed in the node information.
4. Get library, protocol and application versions.
5. Get node’s hardware and firmware versions if Version CC version is 2 or higher.
6. Get MANUFACTURER_SPECIFIC CC Manufacturer ID, Product Type and Product ID. Based on these,
get device category from the device setting database. Get Device Serial Number if supported.
7. If the node has just been added into the network, set the WAKEUP CC notification receiving Node ID
to SIS with/without changing the wakeup interval. The wakeup interval will be changed if global
setting for wakeup interval is non-zero in device database.
8. For each endpoint in the node :a) Get security supported CCs at the endpoint if the node is included securely
b) Get version of CCs at the endpoint
c) If the node has just been added into the network, set device specific configuration parameters
based on Device Database
d) Get CONFIGURATION CC parameter number property if CC version is 3 or higher
e) Get ASSOCIATION CC’s maximum supported group. If the node has just been added into the
network, and group 1 is “Lifeline”, set SIS node id into group 1
f) Get Central Scene CC number of supported scenes. . If the node has just been added into the
network, and Central Scene CC version is 3 and greater, then set it to slow refresh.
g) Get Z-Wave Plus Information
h) Get Multilevel Sensor CC supported types, units and current value
i) Get ASSOCIATION GROUP INFORMATION CC details
j) Get Thermostat Fan Operating Mode CC supported modes, Thermostat Mode CC supported
and current mode, Thermostat Setpoint CC supported and current type and also temperature
range, Thermostat Operating State CC current state
k) Get Multilevel Switch CC supported types and current value
l) Get Simple AV CC supported controls
m) Get Alarm/Notification CC supported types & events
n) Get Protection CC supported states
o) Get User Code CC maximum supported codes
p) Get Meter CC capabilities & descriptor
q) Get Binary Sensor CC supported types & current value
r) Get Door Lock CC current state
s) Get Alarm Sensor CC supported types & current value
t) Get Barrier Operator CC current state
u) Get Color Switch CC supported components & current values
v) Get Binary Switch CC current state
w) Get Battery CC current level
x) Get Node Naming CC current name and location
silabs.com | Building a more connected world.
Page 8 of 184
CC
Ver
CC
Ver
VERSION
2
MANUFACTURER_SPECIFIC
2
WAKE_UP
2
CC
Ver
CC
Ver
ASSOCIATION
2
SENSOR_BINARY
2
ASSOCIATION_GRP_INFO
3
SENSOR_MULTILEVEL
11
BARRIER_OPERATOR
1
SIMPLE_AV_CONTROL
1
BATTERY
1
SWITCH_BINARY
1
CENTRAL_SCENE
3
SWITCH_COLOR
3
CLOCK
1
SWITCH_MULTILEVEL
3
CONFIGURATION
4
THERMOSTAT_FAN_MODE
1
DOOR_LOCK
1
THERMOSTAT_FAN_STATE
2
METER
3
THERMOSTAT_MODE
3
METER_TBL_MONITOR
1
THERMOSTAT_OPERATING_STATE
2
MULTI_CHANNEL_ASSOCIATION
3
THERMOSTAT_SETPOINT
3
NODE_NAMING
1
USER_CODE
1
NOTIFICATION/ALARM
7
VERSION
2
PROTECTION
2
INS14129-5 Z-Ware Library User Guide 2018-05-02
Table 7 – Node Update get/set CCs
Table 8 – Node Update endpoint get/set CCs
2.7 Network Update
The following steps are carried out to update the network:
1. Repeat steps 1 to 4 of Network Initialization (see 2.5 Network Initialization).
2. Request network update by using the command:
NETWORK_MANAGEMENT_BASIC CC-> NETWORK_UPDATE_REQUEST
3. Get node list of the HAN.
4. Resolve all the nodes in node list into corresponding HAN IPv6 addresses.
5. Request node neighbor update for each of the node in the node list. Repeat for up to 3
iterations if the request node neighbor update failed for some nodes that may be out-of-range.
6. Perform Node Update for each node in network (See 2.6 Node Update).
2.8 Background Polling
Z-Ware Library performs automatic background polling to cache device supported interface details (e.g.
supported sensor types and units) and device values (e.g. sensor readings for each supported type). For
always-on devices, polling is carried out for all relevant interfaces in a device followed by an interval of
10 seconds before the next device is polled. For FLIRS (Frequently Listening Routing Slave) devices,
polling is carried out only every 12 hours per device so as not to run the device’s batteries out. For
sleeping devices, polling is carried out whenever they wake up. As sleeping devices will go to sleep
mode when they don’t receive any Z-Wave messages, this type of polling has higher priority than the
Loading...