Silicon Laboratories Z-Wave 700, How To Use Manual

Page 1: ...NOBRIOT COLSEN KEWAHID Restrictions Approved by 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 ...

Page 2: ... 1 5 1 2 5 2 4 5 3 1 Clarified reset to factory default Removed Association Group having ID 2 from Door Lock Key Pad Removed Trigger association group 3 Multilevel Switch Set from Wall Controller Removed Basic CC as supported from Wall Controller Updated button actions for Sensor PIR Updated association group description wrt door lock configuration operation and user code Removed Security CC S0 as...

Page 3: ...work 13 4 4 Libraries 14 4 5 Association Groups and Endpoints 14 4 6 Security 15 5 Z WAVE PLUS V2 APPLICATIONS 16 5 1 Overview of Z Wave certified Applications 16 5 1 1 General User Interface 18 5 1 2 SmartStart 19 5 2 Door Lock 20 5 2 1 Supported Command Classes 21 5 2 2 Basic Command Class Mapping 22 5 2 3 Association Groups 22 5 2 4 Usage of Buttons and LED Status 23 5 2 5 Firmware Update 23 5 ...

Page 4: ...e Update 35 5 4 6 Z Wave Certification 35 5 5 Switch On Off 36 5 5 1 Supported Command Classes 37 5 5 2 Basic Command Class mapping 38 5 5 3 Association Groups 38 5 5 4 Usage of Buttons and LED Status 39 5 5 5 Firmware Update 39 5 5 6 Z Wave Certification 39 5 6 Wall Controller 40 5 6 1 Supported Command Classes 41 5 6 2 Basic Command Class mapping 42 5 6 3 Association Groups 43 5 6 4 Usage of but...

Page 5: ... 23 Table 8 Power Strip Supported Command Classes 25 Table 9 Power Strip Endpoint 1 Supported Command Classes 26 Table 10 Power Strip Endpoint 2 Supported Command Classes 27 Table 11 Basic Command Class mapping for Power Strip 28 Table 12 Association Groups Available in Power Strip Root Device 28 Table 13 Association Groups Available in Power Strip Endpoint 1 29 Table 14 Association Groups Availab...

Page 6: ...g Slave RSS Reporting Sleeping Slave S0 Security 0 Command Class S2 Security 2 Command Class SDK Software Development Kit ZAF Z Wave Plus v2 Application Framework 2 INTRODUCTION 2 1 Purpose The purpose of this document is to describe how to use the Z Wave certified applications which comes as part of the Z Wave SDK 7 11 2 2 Audience and Prerequisites The audience is Z Wave Developers It is assumed...

Page 7: ...kit and the needed software to start developing Z Wave devices For a guide in how to setup and connect the hardware refer to 10 3 1 Hardware Needed The Z Wave development kit contains the following WSTK Main Development Board 2 pcs BRD4200A Radio Board with ZGM130S intended end device development 2 pcs BRD8029A EXP Board 2 pcs UZB7 Controller USB Dongle Zniffer USB Dongle Figure 1 Content of the Z...

Page 8: ...s and breakout pads for attaching the Z Wave development board Figure 2 Main Development Board 3 1 2 Z Wave Development Radio Boards Two Z Wave Development Radio Boards targeted for end device development are included in the kit Another radio board targeted for controller development can be purchased as an add on to the kit Figure 3 Z Wave Development Radio Boards Left BRD4200A Right 4201A The pos...

Page 9: ...k can be added and controlled via the SAW0 and SAW1 output pins for operation in different regions This means No SAW End devices and gateways without LTE modem embedded no SAW filter is recommend Gateways on EU frequency with LTE modem embedded no SAW filter is recommend SAW recommended Gateways with LTE embedded on U and H related frequencies using a SAW filter is recommend 3 1 4 EXP Board The EX...

Page 10: ...278 4 How to Use Certified Apps in Z Wave 700 2019 03 22 silabs com Building a more connected world Page 10 of 45 BTN0 and BTN1 on the expansion board are wired in parallel with PB0 and PB1 on the mainboard ...

Page 11: ...tudio Figure 5 Simplicity Studio IDE for Developing Z Wave Devices Download the installer from silabs com where you will also find additional training material for how to develop compile debug and measure energy consumption When connecting the development board with the Z Wave Radio Development Board attached the IDE will auto discover the hardware and show the available Z Wave certified applicati...

Page 12: ...uring easy development Specifications have been updated to the Z Wave Plus v2 to ensure interoperability between all Z Wave products and vendors and backward compatibility with all existing products Z Wave 700 devices work seamlessly with the world s largest ecosystem of interoperable smart products 4 2 Z Wave Plus v2 Specification Each product must follow the Z Wave Plus v2 specification to be ab...

Page 13: ...ant products The framework is described in full detail in 9 It is strongly recommended that you read this document before developing your own Z Wave Application A short outline can be read here to give the overview The ZAF consists of three blocks Transport Layer This layer handles all communication with the protocol which includes single cast multicast Multi Channel encapsulation delivery of bund...

Page 14: ... this beam it immediately fully wakes up If the device does not hear a Beam it goes back to full sleep for another period until it partially awakes again and listens for a beam It is this partially awake mode combined with the special beam that provides for battery lives on par with fully sleeping devices while providing communications latencies of around one second Example uses are door locks 4 5...

Page 15: ...but also dictates the rules applying to authentication of a new node during inclusion The S2 Access Control class is the most trusted class intended for access control devices like door locks and garage doors The S2 Authenticated class is used for all normal household devices such as sensors and light dimmers The S2 Unauthenticated class is the least trusted class and is only intended for the most...

Page 16: ...Strip Shows an extension block implementation to turn on a number of devices that are connected to power Examples include lights appliances etc Sensor PIR Shows a presence movement detector implementation for controlling other devices and for sending notifications Switch On Off Shows a switch implementation to turn on any device that is connected to power Examples include lights appliances etc Wal...

Page 17: ... 1 Functionality Covered by the Z Wave Plus v2 Applications Functionality Door Lock Power Strip Sensor PIR Switch On Off Wall Controller Role Type Always On Slave Reporting Sleeping Slave Listening Sleeping Slave Multi channel Endpoints Security S2 Access S2 Authenticated S2 Unauthenticated S0 Main functionality Binary Switch Central Scene Door Lock Firmware Update Multilevel Switch Notification U...

Page 18: ...scription RST Press Resets the firmware of an application like losing power All volatile memory will be cleared Press Enter learn mode sending node info frame to add remove the device Removing the device from a network will reset it BTN1 Hold for at least 5 seconds and release Perform a reset to factory default operation of device and a Device Reset Locally Notification Command is sent via Lifelin...

Page 19: ... applications are not labeled with a QR Code However QR Code are generated internally in the 700 SoC and can be retrieved via Simplicity Studio Right click on your connected hardware in the Debug Adapters section in Simplicity Studio Then right click and select Device Configuration From this menu select Z Wave Device Settings Figure 7 QR Code image and value In this view the entire QR Code Value a...

Page 20: ...based on Role Type Listening Sleeping Slave LSS FLiRS Supporting Device Type Actuator Device Type Lock Generic Type Entry Control Specific Type Door Lock Requested security keys S0 and S2_ACCESS The Door Lock features depends on the security level The full set of features only work when securely added to a network by a controller supporting security Graphical representation Icon Types Not implemen...

Page 21: ...ed Security Class Association 2 S0 or Access Control Association Group Info 3 S0 or Access Control Basic 2 S0 or Access Control Battery 1 S0 or Access Control Device Reset Locally 1 S0 or Access Control Door Lock 4 S0 or Access Control Firmware Update Meta Data 5 S0 or Access Control Indicator 3 S0 or Access Control Manufacture Specific 2 S0 or Access Control Multi Channel Association 3 S0 or Acce...

Page 22: ...eration Report Door Lock Mode 5 2 3 Association Groups Table 5 shows the available association groups including supported command classes Table 5 Association Groups Available in Door Lock ID Name Node count Description 1 Lifeline 5 Supports the following command classes Device Reset Locally triggered upon reset Battery Triggered upon low battery Door Lock Triggered upon a change in door lock confi...

Page 23: ...ser code is hard coded with the value of the default user code of the application The default user code is 1234 A valid user code entry i e button press toggles the Door Lock Mode between Secured and Unsecured If the user code for user ID 1 is changed to something else than the default user code the Door Lock Mode can no longer be toggled by pressing this button Table 7 Door Lock LED Status Interf...

Page 24: ...tion is based on Role Type Always On Slave AOS Supporting Device Type Actuator Device Type Binary Switch Generic Type Switch Binary Specific Type Not Used Requested security keys S0 S2_UNAUTHENTICATED and S2_AUTHENTICATED Endpoint 1 Device Type Binary Switch Endpoint 1 Generic Type Switch Binary Endpoint 1 Specific Type Not Used Endpoint 2 Device Type Multilevel Switch Endpoint 2 Generic Type Swit...

Page 25: ... Basic 2 Highest Granted Security Class Device Reset Locally 1 Highest Granted Security Class Firmware Update Meta Data 5 Highest Granted Security Class Indicator 3 Highest Granted Security Class Manufacture Specific 2 Highest Granted Security Class Multi Channel 4 Highest Granted Security Class Multi Channel Association 3 Highest Granted Security Class Notification 8 Highest Granted Security Clas...

Page 26: ...on Required Security Class Association 2 Highest Granted Security Class Association Group Info 3 Highest Granted Security Class Basic 2 Highest Granted Security Class Multi Channel Association 3 Highest Granted Security Class Notification 8 Highest Granted Security Class Security 0 1 None Security 2 1 None Supervision 1 None Switch Binary 2 Highest Granted Security Class Z Wave Plus Info 2 None ...

Page 27: ...2 Supported Command Classes Command Class Version Required Security Class Association 2 Highest Granted Security Class Association Group Info 3 Highest Granted Security Class Basic 2 Highest Granted Security Class Multi Channel Association 3 Highest Granted Security Class Notification 8 Highest Granted Security Class Security 0 1 None Security 2 1 None Supervision 1 None Switch Multilevel 2 Highes...

Page 28: ...ort Value Duration 5 3 3 Association Groups Table 12 Table 13 and Table 14 show the available association groups Backwards compatibility for non Multi Channel devices forces the root device AGI table to contain all the association groups mentioned in each of the endpoints AGI tables except from group 1 the Lifeline group Association groups for Root Device Table 12 Association Groups Available in P...

Page 29: ...n Power Strip Endpoint 1 ID Name Node count Description 1 Lifeline 0 Mirror of root device but without node count 2 alarm EP 1 5 Notification report on overload Association groups for Endpoint 2 Table 14 Association Groups Available in Power Strip Endpoint 2 ID Name Node count Description 1 Lifeline 0 Mirror of root device but without node count 2 alarm EP 2 5 Notification report on overload ...

Page 30: ...h button turn light on off and holding push button perform dimming of light toggle up down BTN3 Key press Toggles the transmission of an Overload detected notification The first transmission when enabled will always be the first in the following list The notifications will be transmitted in the following pattern 1 Notification from endpoint 1 Overload detected 2 Notification from endpoint 1 No eve...

Page 31: ...e 31 of 45 5 3 5 Firmware Update This section will describe backward compatibility when upgrading the Power Strip application from one SDK to a newer version SDK 7 11 is the first SDK running on Z Wave 700 5 3 6 Z Wave Certification The Power Strip passes certification with certification number ZC12 19030003 ...

Page 32: ...ns The Sensor PIR application is based on Role Type Reporting Sleeping Slave RSS Supporting Device Type Data reporting Device Type Notification sensor Generic Type Sensor Notification Specific Type Notification Sensor Requested security keys S2_UNAUTHENTICATED and S2_AUTHENTICATED Graphical representation Icon Types Sensor PIR transmits the following notification types events Home Security o Motio...

Page 33: ...ranted Security Class Battery 1 Highest granted Security Class Device Reset Locally 1 Highest granted Security Class Firmware Update Meta Data 5 Highest granted Security Class Indicator 3 Highest granted Security Class Manufacture Specific 2 Highest Granted Security Class Multi Channel Association 3 Highest granted Security Class Notification 8 Highest granted Security Class Powerlevel 1 Highest g...

Page 34: ...pports the following command classes Device Reset Locally triggered upon reset Battery triggered upon low battery Notification triggered upon a movement detection simulated by button BTN2 After a while a cancel notification will be issued Indicator Report Triggered when LED1 changes state 2 Basic Set 1 Upon a movement detection simulated by button BTN2 nodes associated in this group will first rec...

Page 35: ...ton Action Description BTN0 Hold for at least 1 second and release Sends Battery Report only if device is not sleeping BTN2 Hold for at least 1 second and release Simulates a Motion detected Hw reset reset Sends Wake Up Notification 5 4 5 Firmware Update This section will describe backward compatibility when upgrading the Sensor PIR application from one SDK to a newer version SDK 7 11 is the first...

Page 36: ... on any device that is connected to power Examples include lights appliances etc The Switch On Off application is based on Role Type Always On Slave AOS Supporting Device Type Actuator Device Type Binary Switch Generic Type Switch Binary Specific Type Not Used Requested security keys S0 S2_UNAUTHENTICATED and S2_AUTHENTICATED The Switch On Off features do not depend on the security level Graphical...

Page 37: ...ation 2 Highest granted Security Class Association Group Info 3 Highest granted Security Class Basic 2 Highest granted Security Class Binary Switch 2 Highest granted Security Class Device Reset Locally 1 Highest granted Security Class Firmware Update Meta Data 5 Highest granted Security Class Indicator 3 Highest granted Security Class Manufacture Specific 2 Highest Granted Security Class Multi Cha...

Page 38: ...nd Basic Set Value Binary Switch Set Value Basic Report Current Value Duration Binary Switch Report Value Duration 5 5 3 Association Groups The following association groups shown in Table 22 are available Table 22 Association Groups Available in Switch On Off ID Name Node count Description 1 Lifeline 5 Supports the following command classes Device Reset Locally triggered upon reset Binary Switch R...

Page 39: ...ff Buttons Interface Button Action Description BTN0 Press Toggle LED0 Table 24 Switch On Off LED Status Interface LED Description LED0 Switch LED ON indicates SWITCH ON LED OFF indicates SWITCH OFF 5 5 5 Firmware Update This section will describe backward compatibility when upgrading the Switch On Off application from one SDK to a newer version SDK 7 11 is the first SDK running on Z Wave 700 5 5 6...

Page 40: ... include scene and zone controller wall mounted AV controllers The Wall controller application implements a wall mounted switch that has three individually configurable buttons Each button has support for on off and dimming The Wall Controller application is based on Role Type Always On Slave AOS Supporting Device Type Actuator Device Type Central Scene Generic Type Wall Controller Specific Type N...

Page 41: ...rity Class Association 2 Highest granted Security Class Association Group Info 3 Highest granted Security Class Central Scene 3 Highest granted Security Class Device Reset Locally 1 Highest granted Security Class Firmware Update Meta Data 5 Highest granted Security Class Indicator 3 Highest granted Security Class Manufacture Specific 2 Highest Granted Security Class Multi Channel Association 3 Hig...

Page 42: ... Wall controller s tree buttons are configurable to control nodes Each button action is sent over life line as scene actions Current figure shows an example of this Figure 8 Wall Controller node 5 example of Central Scene 5 6 2 Basic Command Class mapping Basic Command Class is not mapped to any of the supported command classes ...

Page 43: ... 5 Supports the following command classes Device Reset Locally triggered upon reset Central Scene triggered by button press Indicator Report Triggered when LED1 changes state 2 BTN0 5 Basic Set Command 3 BTN0 5 Switch Multilevel CC 4 BTN2 5 Basic Set Command 5 BTN2 5 Switch Multilevel CC 6 BTN3 5 Basic Set Command 7 BTN3 5 Switch Multilevel CC 5 6 4 Usage of buttons and LED Status Besides the gene...

Page 44: ...y Held Down Trigger association group 5 Multilevel Switch Start Level Change BTN2 Button on Wall Controller 2 Hold release Lifeline with Central Scene Key Attribute Key Held Down Trigger association group 5 Multilevel Switch Stop Level Change Press Lifeline with Central Scene Key Attribute Key Pressed 1 Time Trigger association group 6 Basic Set Hold start Lifeline with Central Scene Key Attribute...

Page 45: ...ecification 4 Silabs SDS13784 Software Design Specification Z Wave Network Protocol Command Class Specification 5 Silabs SDS13548 Software Design Specification List of defined Z Wave Command Classes 6 Silabs SDS11846 Software Design Specification Z Wave Plus Role Type Specification 7 Silabs SDS14223 Software Design Specification Z Wave Command Class Control Specification 8 Silabs SDS14224 Software...