Silicon Labs Z-Wave 500 Series SDK Contents v6.81.01 Reference guide

Brand: Silicon Labs

Model: Z-Wave 500 Series SDK Contents v6.81.01

Type: Reference guide

CONFIDENTIAL

Instruction

Z-Wave 500 Series SDK Contents v6.81.01

Document No.:

INS13933

Version:

Description:

Written By:

JFR;COLSEN;TRO;BBR

Date:

2018-03-06

Reviewed By:

JFR;TRO;ABR;EFH;SSE;COLSEN;JKA;LTHOMSEN

Restrictions:

Partners Only

Approved by:

Date CET Initials Name Justification

2018-03-06 14:02:00 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.

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page ii of vi

CONFIDENTIAL

REVISION RECORD

Doc.

Rev

Date

Pages affected

Brief description of changes

20170227

COLSEN

ALL

Initial draft based on INS13477-8 Z-Wave 500 Series SDK Contents

v6.71.01

20170510

COLSEN

Section 4.1.4

Changed triple press to press for learn mode.

20170524

TRO

Section 4.5.4

Change button interface

20170623

TRO

Section 4.3.1

Added sensor type variants

20170719

JFR

Section 3 & 4

Removed intermediate apps

20170728

JFR

Section 4.1.3

Changed Version CC version from 2 to 3.

20170801

TRO

Section 4.10.4

Remove LED indication from Wall Controller

20170803

TRO

Section 4

Add documentation states a Security Enabled Z-Wave Controller must be

used in order to fully utilize the product.

20170804

TRO

Section 4.6

Remove module ZDB5202 from Power strip

20170825

TRO

Section 4.10

Wall Controller support ZDB5101

20170904

COLSEN

Section 4.10.1

Removed Switch and Switch Multilevel from Wall Controller NIFs.

20171121

JFR

Section 4.5.1

Section 4.1.3

Section 4.1.3, 4.5 &

4.6

Section 3.1 & 3.4.1

Added Basic CC to list of command classes.

Changed Central Scene CC version from 2 to 3.

Added information about supported mode of Notification.

Added MyProductPlus binaries

20171127

COLSEN

4.1.3, 4.5 & 4.6

Added information about supported mode of Notification.

20171211

COLSEN

Updated support of Supervision in NIF tables.

20180130

COLSEN

4.2.4

Update buttons table for Door Lock.

20180215

COLSEN

4.6.3, 4.10.3

Updated endpoint lifelines.

20180222

COLSEN

4.1.5

Squashed “Documentation related to devices from multiple manufacturers”

to be one section applying for all applications.

20180222

COLSEN

4.6.4

Updated description of button S6 for Power Strip (Overload detection).

20180306

BBR

All

Added Silicon Labs template

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page iii of vi

CONFIDENTIAL

Table of Contents

1 ABBREVIATIONS ................................................................................................................................. 1

2 INTRODUCTION ................................................................................................................................... 3

2.1 Purpose .............................................................................................................................................. 3

2.2 Audience and prerequisites ................................................................................................................ 3

3 SOFTWARE COMPONENTS ............................................................................................................... 4

3.1 Directory Structure SDK 6.8x.0x ........................................................................................................ 4

3.2 Boards Supported .............................................................................................................................. 6

3.3 Z-Wave ............................................................................................................................................... 7

3.3.1 Include ...................................................................................................................................... 7

3.3.2 I/O Defines ............................................................................................................................... 8

3.3.3 Libraries.................................................................................................................................... 8

3.3.3.1 Bootloader ........................................................................................................................ 9

3.3.3.2 Bridge Controller.............................................................................................................10

3.3.3.3 Portable Controller .........................................................................................................10

3.3.3.4 Static Controller ..............................................................................................................10

3.3.3.5 Static Controller Single ...................................................................................................10

3.3.3.6 Enhanced 232 Slave ......................................................................................................11

3.3.3.7 Production Test DUT ......................................................................................................11

3.3.3.8 Production Test Generator .............................................................................................11

3.3.3.9 Routing Slave .................................................................................................................11

3.3.3.10 External non-volatile memory .........................................................................................12

3.3.3.11 Variable initialization .......................................................................................................12

3.3.3.12 Library S2 .......................................................................................................................12

3.3.3.13 RF frequency ..................................................................................................................12

3.4 ProductPlus ......................................................................................................................................13

3.4.1 Bin ..........................................................................................................................................13

3.4.1.1 DoorLockKeyPad ...........................................................................................................13

3.4.1.2 MyProductPlus ...............................................................................................................14

3.4.1.3 PowerStrip ......................................................................................................................15

3.4.1.4 ProdTestDUT ..................................................................................................................15

3.4.1.5 ProdTestGen ..................................................................................................................15

3.4.1.6 SensorPIR ......................................................................................................................15

3.4.1.7 SerialAPI_Controller_Bridge ..........................................................................................16

3.4.1.8 SerialAPI_Controller_Portable .......................................................................................16

3.4.1.9 SerialAPI_Controller_Static ............................................................................................17

3.4.1.10 SerialAPI_Controller_Static_Single ................................................................................17

3.4.1.11 SerialAPI_Slave_Enhanced_232 ...................................................................................18

3.4.1.12 SerialAPI_Slave_Routing ...............................................................................................18

3.4.1.13 SwitchOnOff ...................................................................................................................18

3.4.1.14 WallController .................................................................................................................19

3.4.2 ApplicationCommandHandlers ..............................................................................................20

3.4.3 ApplicationUtilities ..................................................................................................................22

3.4.4 DoorLockKeyPad ...................................................................................................................23

3.4.5 MyProductPlus .......................................................................................................................23

3.4.6 PowerStrip ..............................................................................................................................23

3.4.7 SensorPIR ..............................................................................................................................23

3.4.8 SerialAPIPlus .........................................................................................................................23

3.4.9 SwitchOnOff ...........................................................................................................................24

3.4.10 WallController .........................................................................................................................24

3.5 Tools .................................................................................................................................................25

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page iv of vi

CONFIDENTIAL

3.5.1 FixBootCRC ...........................................................................................................................25

3.5.2 FixPatchCRC .........................................................................................................................25

3.5.3 HexTools ................................................................................................................................25

3.5.4 IMAToolBox ............................................................................................................................25

3.5.5 IncDep ....................................................................................................................................25

3.5.6 KeypairGeneration .................................................................................................................25

3.5.7 Make .......................................................................................................................................25

3.5.8 Mergehex ...............................................................................................................................25

3.5.9 Python ....................................................................................................................................26

3.5.10 TextTools................................................................................................................................26

3.5.11 uVisionProjectGenerator ........................................................................................................26

4 Z-WAVE PLUS APPLICATIONS ........................................................................................................27

4.1 Z-Wave Plus Framework ..................................................................................................................28

4.1.1 Application Command Handlers ............................................................................................29

4.1.2 Transport Layer ......................................................................................................................29

4.1.3 Supported command classes .................................................................................................30

4.1.4 General user interface ............................................................................................................30

4.1.5 Documentation related to devices from multiple manufacturers ............................................30

4.2 Door Lock Key Pad ..........................................................................................................................31

4.2.1 Announced Command Classes in NIF ...................................................................................32

4.2.2 Basic Command Class mapping ............................................................................................32

4.2.3 Association groups .................................................................................................................33

4.2.4 Usage of buttons on ZDP03A ................................................................................................33

4.2.5 LED status on ZDP03A ..........................................................................................................33

4.2.6 Firmware update and external NVM ......................................................................................33

4.2.7 Z-Wave Certification ...............................................................................................................34

4.3 My Product Plus ...............................................................................................................................35

4.3.1 My Product Plus sensor type variants ....................................................................................35

4.3.2 Announced Command Classes in NIF ...................................................................................35

4.3.3 Basic Command Class mapping ............................................................................................36

4.3.4 Association groups .................................................................................................................37

4.3.5 MyProduct Files .....................................................................................................................37

4.3.6 Firmware update and external NVM ......................................................................................38

4.3.7 Z-Wave Certification ...............................................................................................................38

4.4 Switch On/Off ...................................................................................................................................39

4.4.1 Announced Command Classes in NIF ...................................................................................40

4.4.2 Basic Command Class mapping ............................................................................................40

4.4.3 Association groups .................................................................................................................40

4.4.4 Usage of buttons on ZDP03A ................................................................................................41

4.4.5 LED status on ZDP03A ..........................................................................................................41

4.4.6 Firmware update and external NVM ......................................................................................41

4.4.7 Z-Wave Certification ...............................................................................................................41

4.5 Sensor PIR .......................................................................................................................................42

4.5.1 Announced Command Classes in NIF ...................................................................................43

4.5.2 Basic Command Class mapping ............................................................................................43

4.5.3 Association groups .................................................................................................................44

4.5.4 Usage of buttons on ZDP03A ................................................................................................44

4.5.5 LED status on ZDP03A ..........................................................................................................44

4.5.6 Z-Wave Certification ...............................................................................................................44

4.6 Power Strip .......................................................................................................................................45

4.6.1 Announced Command Classes in NIF ...................................................................................46

4.6.2 Basic Command Class mapping ............................................................................................47

4.6.3 Association groups .................................................................................................................48

4.6.4 Usage of buttons on ZDP03A ................................................................................................49

4.6.5 LED status on ZDP03A ..........................................................................................................49

4.6.6 Z-Wave Certification ...............................................................................................................49

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page v of vi

CONFIDENTIAL

4.7 Production Test DUT ........................................................................................................................50

4.7.1 Production Test DUT Files .....................................................................................................51

4.8 Production Test Generator ...............................................................................................................52

4.8.1 Production Test Generator Files ............................................................................................54

4.9 Serial API Applications .....................................................................................................................54

4.10 Wall Controller ..................................................................................................................................55

4.10.1 Announced Command Classes in NIF ...................................................................................56

4.10.2 Basic Command Class mapping ............................................................................................58

4.10.3 Association groups .................................................................................................................59

4.10.4 Usage on ZDP03A .................................................................................................................61

4.10.5 How to configure associations to Wall Controller...................................................................61

4.10.5.1 Non-multi-channel encapsulated configuration ..............................................................62

4.10.5.2 Encapsulated configuration ............................................................................................63

4.10.6 Z-Wave Certification ...............................................................................................................63

5 DEVELOPMENT COMPONENTS ......................................................................................................64

5.1 Z-Wave Development Platform ZDP03A .........................................................................................64

5.2 Hardware development components for 500 Series ........................................................................65

REFERENCES ...........................................................................................................................................66

INDEX .........................................................................................................................................................67

List of Figures

Figure 1, Z-Wave Plus Application Framework. ........................................................................................ 28

Figure 2. Prod_Test_DUT test program flow. ............................................................................................ 50

Figure 3. Wall Controller endpoints/buttons on ZDP03A. .......................................................................... 58

Figure 4. The Z-Wave Development Platform ZDP03A. ........................................................................... 64

List of Tables

Table 1. 500 Series development boards hex files naming......................................................................... 6

Table 2. Functionality covered by the Z-Wave Plus applications. ............................................................. 27

Table 3. Door Lock Key Pad command classes announced in NIF depending on state .......................... 32

Table 4. Door Lock Key Pad buttons interface .......................................................................................... 33

Table 5. Door Lock Key Pad LED status interface .................................................................................... 33

Table 6. Door Lock Key Pad external NVM data backward compatibility ................................................. 34

Table 7. My Product Plus command classes announced in NIF depending on state. .............................. 36

Table 8. My Product Plus external NVM data backward compatibility ...................................................... 38

Table 9. On/Off Switch Command Classes announced in NIF depending on state ................................. 40

Table 10. On/Off Switch push buttons interface ........................................................................................ 41

Table 11. On/Off Switch LED status interface ........................................................................................... 41

Table 12. PIR Sensor command classes announced in NIF depending on state ..................................... 43

Table 13. PIR Sensor buttons interface..................................................................................................... 44

Table 14. PIR Sensor LED status interface ............................................................................................... 44

Table 15. Power Strip command classes announced in NIF depending on state ..................................... 46

Table 16. Power Strip push buttons interface ........................................................................................... 49

Table 17. Power Strip LED status interface .............................................................................................. 49

Table 18. Production Test Generator LED interface ................................................................................. 52

Table 19. Wall Controller command classes announced in NIF depending on state ................................ 56

Table 20. Wall Controller push buttons interface ...................................................................................... 61

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page vi of vi

CONFIDENTIAL

Table 21. 500 Series development boards and interfaces ........................................................................ 65

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 1 of 67

CONFIDENTIAL

1 ABBREVIATIONS

Abbreviation

Explanation

ACK

Acknowledge

AES

The Advanced Encryption Standard is a symmetric block cipher algorithm.

AGI

Association Group Information command class

ANZ

Australia/New Zealand

API

Application Programming Interface

ASIC

Application Specific Integrated Circuit

Command Class

CSA

Client-Side Authentication

DLL

Dynamic Link Library

DUT

Device Under Test

ERTT

Enhanced Reliability Test Tool

Europe

GNU

An organization devoted to the creation and support of Open Source software

HEX

S-Record hex file extension (*.hex) for programs to be downloaded the first time using

a programmer because it contains both bootloader and Firmware Update Meta Data

Command Class implementation. The bootloader can support S-Record hex file or

compressed hex file format.

Hong Kong

Hardware

Israel

IMA

Installation and Maintenance Application that typical resides on the gateway

India

Infrared

Japan

South Korea

LBT

Listen Before Talk

Malaysia

NVM

Non-volatile memory

OTA

Over the air (e.g. making a firmware update wireless). Also used as S-Record hex file

extension (*.ota) for programs to be sent over the air achieving a firmware update of

the device in question. The device must of course have a bootloader supporting the S-

Record hex file format.

OTW

Over the wire (e.g. making a firmware update via the serial API interface)

OTZ

Used as compressed hex file extension (*.otz) for programs to be sent over the air

(OTA) achieving a firmware update of the device in question. The device must of

course have a bootloader supporting the compressed hex file format.

Radio Frequency

RSSI

Received Signal Strength Indicator

Russia

Security Command Class

Security 2 Command Class

SDK

Z-Wave Software Developer’s Kit includes software and related software

documentation.

SSA

Server-Side Authentication

Test Interface for test and debugging purposes.

UPnP

Universal Plug and Play

United States

USB

Universal Serial Bus

UZB

USB v2.0 full speed low power CDC-ACM compliant Z-Wave adapter

VCP

Virtual COM Port

XML

eXtensible Markup Language

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 2 of 67

CONFIDENTIAL

Abbreviation

Explanation

ZDK

Z-Wave Developer’s Kit includes hardware, software and documentation.

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 3 of 67

CONFIDENTIAL

2 INTRODUCTION

2.1 Purpose

The purpose of this document is to describe the contents on the Z-Wave Software Developer’s Kit (SDK).

Document contains also a description of all embedded applications including user guide or reference to

relevant document.

2.2 Audience and prerequisites

The audience is Z-Wave Partners.

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 4 of 67

CONFIDENTIAL

3 SOFTWARE COMPONENTS

The Z-Wave development software packet consists of a protocol part, applications and a number of tools

used for developing and building the code.

3.1 Directory Structure SDK 6.8x.0x

The development software is organized in the following directory structure:

- ProductPlus

- ApplicationCommandHandlers

- ApplicationUtilities

- Bin

- DoorLockKeyPad

- MyProductPlus

- PowerStrip

- ProdTestDUT

- ProdTestGen

- SensorPIR

- SerialAPI_Controller_Bridge

- SerialAPI_Controller_Portable

- SerialAPI_Controller_Static

- SerialAPI_Controller_Static_Single

- SerialAPI_Slave_Enhanced_232

- SerialAPI_Slave_Routing

- SwitchOnOff

- WallController

- DoorLockKeyPad

- MyProductPlus

- PowerStrip

- ProdTestDUT

- ProdTestGen

- SensorPIR

- SerialAPIPlus

- SwitchOnOff

- WallController

- Tools

- FixBootCRC

- FixPatchCRC

- HexTools

- IMAToolbox

- PC

- Source

- IncDep

- KeypairGeneration

- Make

- Mergehex

- Python

- TextTools

- sed-1-4-5

- uVisionProjectGenerator

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 5 of 67

CONFIDENTIAL

- Z-Wave

- include

- IO_defines

- lib

- bootloader_ZW050x

- controller_bridge_ZW050x

- controller_bridge_ZW050x_3CH

- controller_portable_ZW050x

- controller_portable_ZW050x_3CH

- controller_static_single_ZW050x

- controller_static_single_ZW050x_3CH

- controller_static_ZW050x

- controller_static_ZW050x_3CH

- ext_nvm

- init_vars

- lib2

- rf_freq

- slave_enhanced_232_ZW050x

- slave_enhanced_232_ZW050x_3CH

- slave_prodtest_dut_ZW050x

- slave_prodtest_dut_ZW050x_3CH

- slave_prodtest_gen_ZW050x

- slave_prodtest_gen_ZW050x_3CH

- slave_routing_ZW050x

- slave_routing_ZW050x_3CH

This directory structure contains all the tools and applications needed, except the recommended Keil

software, which must be purchased separately. More information about where and how to buy the Keil

software development components are described in [12].

Note! Recommending leaving the directory structure as is due to compiler and linker issues.

The majority of the above mentioned Z-Wave specific tools and application are briefly described in the

following sections.

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 6 of 67

CONFIDENTIAL

3.2 Boards Supported

The SDK support a number of different boards as shown in the table below.

Table 1. 500 Series development boards hex files naming

Development board

Module/chip used

Hex file name

ZDB5101

ZM5101

*_ZW050x_y*.hex

*_ZW050x_USBVCP_y*.hex

ZDB3502

SD3502

*_ZW050x_y*.hex

*_ZW050x_USBVCP_y*.hex

ZDB5202

ZM5202/SD3502

(300 series interface)

*_ZW050x_y*.hex

(See note below)

Note: USBVCP hex files do not support ZM5202. Calibration hex files for Z-Wave have dedicated

ZM5202 hex files.

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 7 of 67

CONFIDENTIAL

3.3 Z-Wave

The Z-Wave header files and libraries are the software files needed for building a Z-Wave enabled

product. The files are organized in directories used for building Z-Wave controllers and slaves

respectively.

3.3.1 Include

The Z-Wave\include directory contains Z-Wave header files needed for interfacing to the Z-Wave

protocol and hardware peripherals that reside on the 500 Series Single Chip.

The Z-Wave protocol related header files are as follows:

ZW_controller_api.h

Portable Controller interface. This header should be used together

with the Controller Library.

Macro defines.

Include all necessary header files.

ZW_controller_bridge_api.h

Bridge controller interface. This header should be used together

with the Bridge Controller Library.

Macro defines.

Includes all necessary header files.

ZW_controller_static_api.h

Static Controller interface. This header should be used together

with the Static Controller Library.

Macro defines.

Includes all necessary header files.

ZW_sensor_api.h

Sensor interface.

Macro defines.

Includes all other necessary header files.

ZW_slave_32_api.h

Slave interface for ZMXXXX-RE Z-Wave module.

Macro defines.

Include all header files.

ZW_slave_api.h

Slave interface.

Macro defines.

Includes all other necessary header files.

ZW_slave_routing_api.h

Routing and Enhanced 232 slave nodes interface.

Macro definitions.

Includes all other necessary header files.

ZW_basis_api.h

Z-Wave  Application general software interface.

Interface to common Z-Wave functions.

ZW_transport_api.h

Transfer of data via Z-Wave protocol.

ZW_classcmd.h

Defines for device and command classes used to obtain

interoperability between Z-Wave enabled products from different

vendors, for a detailed description refer to [4], [5], [6], [7], [8], [15],

[16] and [11].

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 8 of 67

CONFIDENTIAL

The hardware peripherals related header files are as follows:

config_lib.h

This header file contains defines for library version in a generalized

way.

ISD51.h

This header file contains defines and functions for the In-System

Debugger for 8051 based microcontrollers modified for Silicon Labs

ZW050x.

ZW_adcdriv_api.h

This header file contains defines and functions interfacing to the 500

Series Single Chip built-in analog to digital converter.

ZW_aes_api.h

This header file contains defines and functions interfacing to the 500

Series Single Chip built-in AES-128 engine.

…

See comments in header files.

ZW050x.h

Inventra 8051 SFR defines for the Z-Wave ZW050x RF transceiver.

3.3.2 I/O Defines

The Z-Wave\IO_defines directory contains hardware definition files needed for building an application

e.g. the development controller application.

AppRFSetup.c

This file defines the normal and low power transmission levels.

Change levels here if necessary.

ZW_app_version.a51

Makes the version for the application accessible from the library file

during linking.

ZW_evaldefs.h

This file contains definitions of the connector pins on the controller

board.

ZW_L51_BANK.a51

This file enables code bank switching.

ZW_pindefs.h

This file contains definitions of the connector pins on the Z-Wave

module, and macros for accessing the I/O pins. Refer to [10]

regarding a detail description.

ZW_portdefs.h

This file contains I/O port initialization vectors on the Z-Wave ASIC.

ZW_segment_tail.a51

This file enables use of XDATA located in SRAM part of the code

area.

ZW_strings_rf050x.h/c

Attributes for RF table.

3.3.3 Libraries

The Z-Wave\lib directory structure contains all the supported libraries.

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 9 of 67

CONFIDENTIAL

3.3.3.1 Bootloader

The lib\bootloader_ZW050x directory contains a bootloader that is used in connection with OTA firmware

update. The directory contains the following file:

ZW_bootloader_ZW050x.lib

This file is linked together with the Z-Wave

protocol and API library.

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 10 of 67

CONFIDENTIAL

3.3.3.2 Bridge Controller

The lib\controller_bridge_ZW050x… directory contains all files needed for building a non-secure Z-Wave

bridge controller application. The directory contains the following files:

ZW_controller_bridge_ZW050x.lib

ZW_controller_bridge_ZW050x_3CH.lib

These files are the compiled Z-Wave protocol and

API library for a 500 Series based module that a

Z-Wave bridge controller application should be

linked together with. JP and KR use the 3CH

variant.

3.3.3.3 Portable Controller

The lib\controller_portable_ZW050x… directory contains all files needed for building a non-secure

Z-Wave controller application. The directory contains the following files:

ZW_controller_portable_ZW050x.lib

ZW_controller_portable_ZW050x_3CH.lib

These files are the compiled Z-Wave protocol

and API library for a 500 Series based module

that a Z-Wave portable controller application

should be linked together with. JP and KR use

the 3CH variant.

3.3.3.4 Static Controller

The lib\controller_static_ZW050x… directory contains all files needed for building a non-secure Z-Wave

static controller application. The directory contains the following files:

ZW_controller_static_ZW050x.lib

ZW_controller_static_ZW050x_3CH.lib

These files are the compiled Z-Wave protocol and

API library for a 500 Series based module that a

Z-Wave static controller application should be

linked together with. JP and KR use the 3CH

variant.

3.3.3.5 Static Controller Single

The lib\controller_static_single_ZW050x… directory contains all files needed for building a Z-Wave static

single controller application. ERTT application uses this library because it supports suppression of

retransmission. Notice that the PC based Controller now supports the ERTT functionality.

WARNING: Do not use this library in product applications

The directory contains the following files:

ZW_controller_static_single_ZW050x.lib

ZW_controller_static_single_ZW050x_3CH.lib

These files are the compiled Z-Wave

protocol and API library for a 500 Series

based module that a Z-Wave static

controller single application should be

linked together with. JP and KR use the

3CH variant.

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 11 of 67

CONFIDENTIAL

3.3.3.6 Enhanced 232 Slave

The lib\slave_enhanced_232_ZW050x… directory contains all files needed for building a non-secure

and secure S0/S2 Z-Wave enhanced 232 slave node application. The directory contains the following

files:

ZW_slave_enhanced_232_ZW050x.lib

ZW_slave_enhanced_232_ZW050x_3CH.lib

These files are the compiled Z-Wave

protocol and API library for a 500 Series

based module that a Z-Wave enhanced 232

slave application should be linked together

with. JP and KR use the 3CH variant.

3.3.3.7 Production Test DUT

The lib\slave_prodtest_dut_ZW050x… directory contains all files needed for building a production test

DUT application on a Z-Wave module. The directory contains the following files:

ZW_slave_prodtest_dut_ZW050x.lib

ZW_slave_prodtest_dut_ZW050x_3CH.lib

These files are the compiled Z-Wave protocol

and API library for a 500 Series based module

modules that a Z-Wave production test DUT

application should be linked together with. JP

and KR use the 3CH variant.

3.3.3.8 Production Test Generator

The lib\slave_prodtest_gen_ZW050x… directory contains all files needed for building a production test

generator application on a Z-Wave module. The directory contains the following files:

ZW_slave_prodtest_gen_ZW050x.lib

ZW_slave_prodtest_gen_ZW050x_3CH.lib

These files are the compiled Z-Wave protocol

and API library for a 500 Series based module

modules that a Z-Wave production test

generator application should be linked

together with. JP and KR use the 3CH variant.

3.3.3.9 Routing Slave

The lib\slave_routing_ZW050x… directory contains all files needed for building a non-secure Z-Wave

routing slave node application on a Z-Wave module. The directory contains the following files:

ZW_slave_routing_ZW050x.lib

ZW_slave_routing_ZW050x_3CH.lib

These files are the compiled Z-Wave protocol and

API library for a 500 Series based module that a

Z-Wave routing slave application should be linked

together with. JP and KR use the 3CH variant.

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 12 of 67

CONFIDENTIAL

3.3.3.10 External non-volatile memory

The lib\ext_nvm directory contains external non-volatile memory (NVM) drivers, which can be used to

substitute default driver in library.

The default driver uses SPI1 and P2.5 to access external NVM. The driver adapt automatically to the

external NVM in question or uses data in NVR. Regarding supported NVMs, refer to [17]

WARNING: Currently it is not possible to substitute default driver in library/bootloader by linking one of

the object files.

3.3.3.11 Variable initialization

The lib\init_vars directory contains an init_vars.obj object file, which replaces the standard Keil

initialization procedure. This reduces the time to detect whether a wakeup beam is present or not by

postponing initialization. Initialization happens only in case the wakeup beam is addressed to the node in

question.

3.3.3.12 Library S2

The lib\libs2 directory contains the S2 Security-specific libraries. These libraries are linked into all S2

enabled targets.

The directory contains the following files:

LIBS2CRYPTO.LIB: Cryptographic functions used by S2.

LIBS2_SLAVE.LIB: S2 transport system and inclusion state machine for slave libraries.

3.3.3.13 RF frequency

The lib\rf_freq directory contains all the possible RF initialization object files ZW_rf_050x_xx.obj:

 ZW_rf_050x_ALL.obj – Contains all frequencies (Used by Zniffer and Production Test

Generator)

 ZW_rf_050x_ANZ.obj – Australia/New Zealand

 ZW_rf_050x_CN.obj – China

 ZW_rf_050x_EU.obj – Europe

 ZW_rf_050x_HK.obj – Hong Kong

 ZW_rf_050x_IL.obj – Israel

 ZW_rf_050x_IN.obj – India

 ZW_rf_050x_JP.obj – Japan

 ZW_rf_050x_KR.obj – South Korea

 ZW_rf_050x_MY.obj – Malaysia

 ZW_rf_050x_RU.obj – Russia

 ZW_rf_050x_US.obj – US

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 13 of 67

CONFIDENTIAL

3.4 ProductPlus

The ProductPlus directory contains Z-Wave Plus applications for a number of different product examples.

Both source code and precompiled files ready for download are supplied.

3.4.1 Bin

The ProductPlus\Bin directory structure contains the precompiled code of the Z-Wave Plus applications

and the hex files needed to download to the Z-Wave 500 Series Single Chip via the Z-Wave

Programmer.

The table in section 3.1 show the hex files naming for Z-Wave Development Boards used in conjunction

with the Z-Wave Development Platform ZDP03A. Refer to section 5.1 regarding RS232 and USB

numbering on ZDP03A. Refer to section 3.3.3.11 regarding frequency notation y.

3.4.1.1 DoorLockKeyPad

The ProductPlus\Bin\DoorLockKeyPad directory contains all files needed for running a Z-Wave Plus

Door Lock with Keypad (both non-secure and secure S0/S2) application on a Z-Wave module. The Z-

Wave Plus application is based on the enhanced 232 slave library. The directory contains the following

files:

DoorLockKeyPad_slave_enhanced_232_OTA_SSA

_ZW050x_y_TI_WITH_BOOTLOADER.hex

Door Lock with Keypad hex files for y frequency

versions. Download this file first time using

ZwaveProgrammer because it contains both

bootloader supporting OTZ hex files and

Firmware Update Meta Data CC implementation.

The OTW functionality requires an external NVM

equal to or bigger than 128 KB. TI denotes that

Test Interface is enabled. SSA denotes that

server-side authentication is used, which is the

highest security level in S2.

DoorLockKeyPad_slave_enhanced_232_OTA_SSA

_ZW050x_y_TI.otz

Door Lock with Keypad OTZ hex files for y

frequency versions. Download this file over the

air (OTA) subsequent because it contains not the

bootloader.

DoorLockKeyPad_slave_enhanced_232_OTA_CSA

_ZW050x_y_TI_WITH_BOOTLOADER.hex

Door Lock with Keypad hex files for y frequency

versions. Download this file first time using

ZwaveProgrammer because it contains both

bootloader supporting OTZ hex files and

Firmware Update Meta Data CC implementation.

The OTW functionality requires an external NVM

equal to or bigger than 128 KB. TI denotes that

Test Interface is enabled. CSA denotes that

client-side authentication, which is used when

upgrading devices to support S2.

DoorLockKeyPad_slave_enhanced_232_OTA_CSA

_ZW050x_y_TI.otz

Door Lock with Keypad OTZ hex files for y

frequency versions. Download this file over the

air (OTA) subsequent because it contains not the

bootloader.

INS13933-3 Z-Wave 500 Series SDK Contents v6.81.01 2018-03-06

silabs.com | Building a more connected world.

Page 14 of 67

CONFIDENTIAL

3.4.1.2 MyProductPlus

The ProductPlus\Bin\MyProductPlus directory contains all files needed to develop a Z-Wave Plus

application (both non-secure and secure S0/S2) using a minimum framework. MyProductPlus application

supports three different types of devices:

 Always on device.

 Battery device supporting Battery CC

 Battery device supporting Battery and Wake Up CC

The MyProductPlus application is missing device type specific command classes before it is a real

device. Application is based on the enhanced 232 slave library. The directory contains the following files:

MyProductPlus_slave_enhanced

_232_OTA_ZW050x_y_WITH_BOOTLOADER.hex

MyProductPlus (Always on device) hex files for y

frequency versions. Download this file first time

using ZwaveProgrammer because it contains

both bootloader supporting OTZ hex files and

Firmware Update Meta Data CC implementation.

The OTW functionality requires an external NVM

equal to or bigger than 128 KB.

MyProductPlus _slave_enhanced

_232_OTA_ZW050x_y.otz

MyProductPlus OTZ hex files for y frequency

versions. Download this file over the air (OTA)

subsequent because it contains not the

bootloader.

MyProductPlus_Battery_slave_enhanced

_232_OTA_ZW050x_y_WITH_BOOTLOADER.hex

MyProductPlus (Battery device supporting

Battery CC) hex files for y frequency versions.

Download this file first time using

ZwaveProgrammer because it contains both

bootloader supporting OTZ hex files and

Firmware Update Meta Data CC implementation.

The OTW functionality requires an external NVM

equal to or bigger than 128 KB.

MyProductPlus_Battery_slave_enhanced

_232_OTA_ZW050x_y.otz

MyProductPlus OTZ hex files for y frequency

versions. Download this file over the air (OTA)

subsequent because it contains not the

bootloader.

MyProductPlus_Battery_wakeUp_slave_enhanced

_232_OTA_ZW050x_y_WITH_BOOTLOADER.hex

MyProductPlus (Battery device supporting

Battery and Wake Up CC) hex files for y

frequency versions. Download this file first time

using ZwaveProgrammer because it contains

both bootloader supporting OTZ hex files and

Firmware Update Meta Data CC implementation.

The OTW functionality requires an external NVM

equal to or bigger than 128 KB.

MyProductPlus_Battery_wakeUp_slave_enhanced

_232_OTA_ZW050x_y.otz

MyProductPlus OTZ hex files for y frequency

versions. Download this file over the air (OTA)

subsequent because it contains not the

bootloader.

Page is loading ...

Silicon Labs Z-Wave 500 Series SDK Contents v6.81.01 Reference guide

Silicon Labs Z-Wave 500 Series SDK Contents v6.81.01 Reference guide

Silicon Labs Z-Wave 500 Series SDK Contents v6.81.01 Reference guide

Related papers

Other documents