Z-Wave and Z-Wave Long Range 700/800 SDK 7.17.2.0 GA

The Z-Wave and Z-Wave Long Range 700/800 are designed to meet the demands of the future smart home, where increasing needs for more sensors and battery-operated devices require both long range and low power. Context-aware environments are the next evolution in the smart home market, and they require technologies that have been optimized specifically for these applications.

100% Interoperable: Every product in the Z-Wave ecosystem works with every other product, regardless of type, brand, manufacturer or version. No other smart home/IoT protocol can make this claim.

Best-In-Class Security: Z-Wave's Security 2 (S2) framework provides end-to-end encryption and the most advanced security for smart home devices and controllers. Homes with S2 Z-Wave devices are virtually un-hackable.

SmartStart Easy Installation: SmartStart radically simplifies the installation of smart devices by using QR code scans for uniform, trouble-free setup. Devices and systems can be pre-configured, dramatically easing deployments.

Backwards-Compatible: Z-Wave certification mandates backward-compatibility. The first Z-Wave devices on the market, more than ten years old, still perform as intended in networks with the latest Z-Wave technologies.

For more information about the certification status of Z-Wave and Z-Wave Long Range 700/800 SDK v7.17.2 GA, see section 9 Product Life Cycle and Certification.

These release notes cover SDK version(s):

• 7.17.2.0 GA released March 9, 2022
• 7.17.1.0 Pre-Certified GA released January 28, 2022
• 7.17.0.0 Pre-Certified GA released December 15, 2021

Compatibility and Use Notices

For more information about security updates and notices, see the Security chapter of the Gecko Platform Release notes installed with this SDK or on the Silicon Labs Release Notes page. Silicon Labs also strongly recommends that you subscribe to Security Advisories for up-to-date information. For instructions, or if you are new to the Z-Wave 700/800 SDK, see 8 Using This Release.

1 Supported Radio Boards

This section describes the radio boards supported by the certified and pre-certified applications for 700 and 800 Series, respectively.

The applications in the above table need a radio board in combination with BRD4001A – Wireless Starter Kit Mainboard (WSTK) and BRD8029A – Buttons and LEDs Expansion Board. The Serial APIs in the above table only need a radio board and a BRD4001A – Wireless Starter Kit Mainboard (WSTK). Refer to INS14278: How to Use Certified Apps and INS14816: How to Use Pre-Certified Apps, for details.

ZW-LR indicates that the radio board supports both Z-Wave and Z-Wave Long Range. 14/20 dBm indicates the transmit power of the radio board. Secure Vault is an industry-leading suite of state-of-the-art security features that address escalating Internet of Things (IoT) threats.

2 Z-Wave Protocol

2.1 New Items

The Gecko Software Development Kit version 4.00 introduces a new underlying platform architecture based on components. The Z-Wave SDK 7.17.x now uses this component structure and the structure and build method of Z-Wave applications has therefore changed compared to previous releases of Z-Wave SDK. The new component structure offers several new features in the GSDK:

• Search and filter to find and discover software components that work with the target device
• Automatically pull in all component dependencies and initialization code
• Configurable software components including peripheral units and drivers
• All configuration settings in C header files for usage outside of Simplicity Studio
• Configuration validation to alert developers to errors or issues
• GNU makefiles as a build option

Other changes specific to the Z-Wave Gecko SDK:

• main() is now part of the application
• The FreeRTOS configuration is available for application developers
• The region can be configured in Simplicity Studio GUI

2.2 Improvements

None

2.3 Fixed Issues

Fixed in release 7.17.2 GA

Fixed in release 7.17.1 Pre-Certified GA

Fixed in release 7.17.0 Pre-Certified GA

2.4 Known Issues in the Current Release

Issues in bold were added since the previous release. If you have missed a release, recent release notes are available on https://www.silabs.com/products/software.

2.5 Deprecated Items

None

2.6 Removed Items

None

3 Z-Wave Plus V2 Application Framework

3.1 New Items

None

3.2 Improvements

For a detailed description of application development using the Z-Wave Plus V2 Framework, refer to INS14259: Z-Wave Plus V2 Application Framework SDK7.

A porting guide are also available for customers that want to migrate 800 hardware. The guideline contains a detailed example on how to port a non-UC 700 based Switch On/Off App (7.16.3) to a UC 800 based Switch On/Off App (7.17.0), refer to APL14836: Application Note for Porting Z-Wave Appl. SW from 700 to 800 hardware.

3.3 Fixed Issues

Fixed in release 10.17.2 GA

Fixed in release 10.17.1 Pre-Certified GA

3.4 Known Issues in the Current Release

Issues in bold were added since the previous release. If you have missed a release, recent release notes are available on https://www.silabs.com/products/software.

3.5 Deprecated Items

None

3.6 Removed Items

None

4 Certified Applications

The certified applications based on v7.x.1+ will be formally certified by a certification house. However, the first release (v7.x.0) will only contain pre-certified applications based on a certification test using CTT v3. Refer to INS14278: How to Use Certified Apps for details.

4.1 Door Lock Key Pad

4.1.1 New Items

None

4.1.2 Improvements

None

4.1.3 Fixed Issues

Fixed in release 10.17.0 Pre-Certified GA

4.1.4 Known Issues in the Current Release

None

4.1.5 Deprecated Items

None

4.1.6 Removed Items

None

4.2 LED Bulb

4.2.1 New Items

None

4.2.2 Improvements

None

4.2.3 Fixed Issues

None

4.2.4 Known Issues in the Current Release

None

4.2.5 Deprecated Items

None

4.2.6 Removed Items

None

4.3 Power Strip

4.3.1 New Items

None

4.3.2 Improvements

None

4.3.3 Fixed Issues

None

4.3.4 Known Issues in the Current Release

None

4.3.5 Deprecated Items

None

4.3.6 Removed Items

None

4.4 Sensor PIR

4.4.1 New Items

None

4.4.2 Improvements

None

4.4.3 Fixed Issues

Fixed in release 10.17.2 GA

Fixed in release 10.17.1 Pre-Certified GA

4.4.4 Known Issues in the Current Release

Issues in bold were added since the previous release. If you have missed a release, recent release notes are available on https://www.silabs.com/products/software.

4.4.5 Deprecated Items

None

4.4.6 Removed Items

None

4.5 Switch On/Off

4.5.1 New Items

None

4.5.2 Improvements

None

4.5.3 Fixed Issues

None

4.5.4 Known Issues in the Current Release

None

4.5.5 Deprecated Items

None

4.5.6 Removed Items

None

4.6 Wall Controller

4.6.1 New Items

None

4.6.2 Improvements

None

4.6.3 Fixed Issues

None

4.6.4 Known Issues in the Current Release

None

4.6.5 Deprecated Items

None

4.6.6 Removed Items

None

5 Pre-Certified Applications

The pre-certified applications will not be formally certified but certification tests have been performed based on CTT v3. Refer to INS14816: How to Use Pre-Certified Apps for details.

5.1 Multilevel Sensor

5.1.1 New Items

None

5.1.2 Improvements

None

5.1.3 Fixed Issues

Fixed in release 10.17.1 Pre-Certified GA

5.1.4 Known Issues in the Current Release

None

5.1.5 Deprecated Items

None

5.1.6 Removed Items

None

6 Serial API Bridge Controller

Beginning with version 7.16, when backing up and restoring a SerialAPI via the FUNC_ID_NVM_BACKUP_RESTORE, the SerialAPI will automatically upgrade the protocol non-volatile memory (NVM) to the latest version. Any backup made of a 7.16 or later SerialAPI can be restored to its original version or to a later version of the SerialAPI without any manual upgrade of the protocol NVM being necessary.

The serial interface is unchanged in version 8.

6.1 New Items

None

6.2 Improvements

None

6.3 Fixed Issues

Fixed in release 10.17.2 GA

6.4 Known Issues in the Current Release

Issues in bold were added since the previous release. If you have missed a release, recent release notes are available on https://www.silabs.com/products/software.

6.5 Deprecated Items

None.

6.6 Removed Items

None

7 Important Changes

7.1 Command Classes

Invoking command class handlers, delivered in the SDK, will cause the build to fail. To resolve such build errors, remove the call to the command class handler that causes the error from Transport_ApplicationCommandHandlerEx() in the application source file.

Z-Wave Application Framework (ZAF) automatically invokes the correct command class handler based on the received frame. Transport_ApplicationCommandHandlerEx() is defined as a weak function in ZW_TransportEndpoint.c and therefore leaving the function defined in the application will not break the build.

All command classes delivered in the SDK use one of multiple REGISTER_CC macros. Non-Silicon Labs command class implementations must use one of those macros as well.

Given that all command classes use REGISTER_CC() or later, Transport_ApplicationCommandHandlerEx() can be removed from an existing application main source file.

7.2 Association Group Information for Lifeline

CC_AGI_LifeLineGroupSetup() no longer has any effect. Its previous functionality was to configure the list of command class / command pairs that would be reported in the Association Group Command List Report. The content of the Association Group Command List Report is now automatically populated by ZAF.

ZAF only reports command class / command pairs that are implemented by ZAF and required according to https://sdomembers.z-wavealliance.org/wg/AWG/document/120.

Non-Silicon Labs command class implementations must use REGISTER_CC_V3() to be listed in the Association Group Command List Report. See existing Silicon Labs implementations for an example.

If optional command class / command pairs are desired in the Association Group Command List Report, use REGISTER_CC_V3().

7.3 Network Learn Mode

The function used in ZAF to set network learn mode has been modified so it will no longer have wakeUpReason as input. Parameters related to the wake up reason are now handled directly in the ZWave protocol.

The new format for ZAF setNetworkLearnMode() is:

void ZAF_setNetworkLearnMode(E_NETWORK_LEARN_MODE_ACTION bMode)

7.4 Queue Notifying

The function used to add an item to the back of the queue and notify the receiver task from an ISR has been modified. The parameter related to check if a higher priority task needed to be woken was removed. This functionality is now handled inside the component.

The new format for QueueNotifyingSendToBackFromISR() is:

EQueueNotifyingStatus QueueNotifyingSendToBackFromISR (SQueueNotifying* pThis, const uint8_t* pItem);

8 Using This Release

This release contains the following:

• Z-Wave Plus V2 Application Framework
• Z-Wave Certified Applications for a broad range of smart home applications
• Z-Wave Protocol and Serial API Applications

If you are a first-time user, Z-Wave documentation is installed with the SDK. See INS14280: Z-Wave Getting Started for End Devices, INS14278: How to Use Certified Apps in Z-Wave, and INS14281: Z-Wave Getting Started for Controller Devices for instructions.

This SDK depends on a Gecko Platform. The Gecko Platform code provides functionality that supports protocol plugins and APIs in the form of drivers and other lower layer features that interact directly with Silicon Labs chips and modules. Gecko Platform components include EMLIB, EMDRV, RAIL Library, NVM3, PSA, and mbedTLS. Gecko Platform release notes are available through Simplicity Studio's Launcher Perspective.

8.1 Installation and Use

Order a Z-Wave Wireless Starter kit. The kit offers the easiest and fastest way to start evaluation and development of your own Z-Wave mesh application. It provides a single world-wide development kit for both end devices and gateways with multiple radio boards, with which developers can create a mesh network and evaluate the Z-Wave module.

The Z-Wave and Z-Wave Long Range 700/800 SDK is provided as part of the Gecko SDK (GSDK), the suite of Silicon Labs SDKs. To quickly get started with the GSDK, install Simplicity Studio 5, which will set up your development environment and walk you through GSDK installation. Simplicity Studio 5 includes everything needed for IoT product development with Silicon Labs devices, including a resource and project launcher, software configuration tools, full IDE with GNU toolchain, and analysis tools. Installation instructions are provided in the online Simplicity Studio 5 User's Guide.

Alternatively, Gecko SDK may be installed manually by downloading or cloning the latest from GitHub. See https://github.com/SiliconLabs/gecko_sdk for more information.

Simplicity Studio installs the GSDK by default in:

• (Windows): C:\Users\<NAME>\SimplicityStudio\SDKs\gecko_sdk
• (MacOS): /Users/<NAME>/SimplicityStudio/SDKs/gecko_sdk

To implement a specific application, Silicon Labs recommends starting with one of the existing pre-certified apps with the desired Role Type.

8.2 Security Information

Secure Vault Integration

This version of the stack are using secure vault interface for key management of asymmetric keys (ECC Curve 25519) and Symmetric keys (AES).

Security Advisories

To subscribe to Security Advisories, log in to the Silicon Labs customer portal, then select Account Home. Click HOME to go to the portal home page and then click the Manage Notifications tile. Make sure that 'Software/Security Advisory Notices & Product Change Notices (PCNs)' is checked, and that you are subscribed at minimum for your platform and protocol. Click Save to save any changes.

8.3 Support

Development Kit customers are eligible for training and technical support. See support resources and contact Silicon Laboratories support at http://www.silabs.com/support.

9 Product Life Cycle and Certification

Silicon Labs will add new features based on market requirements and continuously improve the Z-Wave Protocol to position the Z-Wave Ecosystem. The Z-Wave Protocol Life Cycle is a process to provide rapid innovation, new features, and robust matured protocol release to Z-Wave Partners. The Z-Wave Protocol Life Cycle defines the maturation process of Z-Wave Protocol generations and consist of three phases divided in five Life Cycle stages.

Ascent Phase (BETA)

Silicon Labs releases new Z-Wave protocol generations (branches), i.e., initial BETA release of a Z-Wave Protocol generation that will introduce major new features/functions or support for a new Z-Wave Single Chip generation. This release is not certified and not eligible for certification.

Maturity Phase (ACTIVE/MAINTAINED)

Each new generation will generate follow-on matured releases to resolve protocol issues prioritized by Silicon Labs and based on input from Z-Wave Alliance Partners.

Decline Phase (MONITORED/OBSOLETE)

After a period of 17-24 months in the maturity phase a branch/release is discontinued and for an additional period (up to 24 months) a discontinued branch/release will be monitored since products based on this branch may still be shipping or under warranty in the field.

Table 9-2. Z-Wave Certification in case of a SDK upgrade.

10 Legal

10.1 Disclaimer

Silicon Labs intends to provide customers with the latest, accurate, and in-depth documentation of all peripherals and modules available for system and software implementers using or intending to use the Silicon Labs products. Characterization data, available modules and peripherals, memory sizes and memory addresses refer to each specific device, and "Typical" parameters provided can and do vary in different applications. Application examples described herein are for illustrative purposes only. Silicon Labs reserves the right to make changes without further notice to the product information, specifications, and descriptions herein, and does not give warranties as to the accuracy or completeness of the included information. Without prior notification, Silicon Labs may update product firmware during the manufacturing process for security or reliability reasons. Such changes will not alter the specifications or the performance of the product. Silicon Labs shall have no liability for the consequences of use of the information supplied in this document. This document does not imply or expressly grant any license to design or fabricate any integrated circuits. The products are not designed or authorized to be used within any FDA Class III devices, applications for which FDA premarket approval is required or Life Support Systems without the specific written consent of Silicon Labs. A "Life Support System" is any product or system intended to support or sustain life and/or health, which, if it fails, can be reasonably expected to result in significant personal injury or death. Silicon Labs products are not designed or authorized for military applications. Silicon Labs products shall under no circumstances be used in weapons of mass destruction including (but not limited to) nuclear, biological or chemical weapons, or missiles capable of delivering such weapons. Silicon Labs disclaims all express and implied warranties and shall not be responsible or liable for any injuries or damages related to use of a Silicon Labs product in such unauthorized applications. Note: This content may contain offensive terminology that is now obsolete. Silicon Labs is replacing these terms with inclusive language wherever possible. For more information, visit www.silabs.com/about-us/inclusive-lexicon-project

10.2 Trademark Information

Silicon Laboratories Inc.®, Silicon Laboratories®, Silicon Labs®, SiLabs® and the Silicon Labs logo®, Bluegiga®, Bluegiga Logo®, Clockbuilder®, CMEMS®, DSPLL®, EFM®, EFM32®, EFR, Ember®, Energy Micro, Energy Micro logo and combinations thereof, "the world's most energy friendly microcontrollers", Ember®, EZLink®, EZRadio®, EZRadioPRO®, Gecko®, Gecko OS, Gecko OS Studio, ISOmodem®, Precision32®, ProSLIC®, Simplicity Studio®, SiPHY®, Telegesis, the Telegesis Logo®, USBXpress®, Zentri, the Zentri logo and Zentri DMS, Z-Wave®, and others are trademarks or registered trademarks of Silicon Labs. ARM, CORTEX, Cortex-M3 and THUMB are trademarks or registered trademarks of ARM Holdings. Keil is a registered trademark of ARM Limited. Wi-Fi is a registered trademark of the Wi-Fi Alliance. All other products or brand names mentioned herein are trademarks of their respective holders.