SILICON LABS Z-Wave and Z-Wave Long Range 700 800 SDK User Manual

SILICON LABS Z-Wave and Z-Wave Long Range 700 800 SDK

Specifications

• Z-Wave and Z-Wave Long Range 700/800 SDK 7.21.4 GA
• Gecko SDK Suite 4.4 August 14, 2024
• Interoperability: 100% Interoperable
• Security: Best-In-Class Security with Z-Wave’s Security 2 (S2) framework
• Installation: SmartStart Easy Installation
• Backward-compatibility: Yes
• Compatible Compilers: GCC version 12.2.1

FAQ

Q: How can I check the certification status of Z-Wave and Z-Wave Long Range 700/800 SDK?

A: Refer to section 11 Product Life Cycle and Certification for information about the certification status of the product.

Q: What compilers are compatible with Z-Wave 7.21.4?

A: Z-Wave 7.21.4 is compatible with GCC version 12.2.1 provided with Simplicity Studio.

Z-Wave and Z-Wave Long Range 700/800

SDK 7.21.4 GA Gecko SDK Suite 4.4 August 14, 2024

• Z-Wave and Z-Wave Long Range 700/800 are designed to meet the demands of the fu-ture 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 evolu-tion 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 en-cryption 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 de-vices 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.21.4.0 Pre-Certified GA, see section 11 Product Life Cycle and Certification.
• These release notes cover SDK version(s):
  • 7.21.4 GA released August 14, 2024
  • 7.21.3 GA released May 2, 2024
  • 7.21.2 GA released April 10, 2024
  • 7.21.1 GA released February 14, 2024
  • 7.21.0 GA released December 13, 2023

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 section 10 Using This Release.

Compatible Compilers:
GCC (The GNU Compiler Collection) version 12.2.1, provided with Simplicity Studio.

Supported Radio Boards

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

Table 1-1. Supported Radio Boards

Se- ries| Radio Board| Description|  |  | Secure Vault
---|---|---|---|---|---
 | Z-Wave Long

Range

| Tx

Power

800| BRD2603A| ZGM230SB: SiP| yes| 14 dBm| High
800| BRD2705A| EFR32ZG28B: SoC| yes| 14 dBm| High
800| BRD4204A| EFR32ZG23A: SoC| yes| 14 dBm| Mid
800| BRD4204B| EFR32ZG23A: SoC| yes| 14 dBm| Mid
800| BRD4204C| EFR32ZG23B: SoC| yes| 14 dBm| High
800| BRD4204D| EFR32ZG23B: SoC| yes| 14 dBm| High
800| BRD4205A| ZGM230SA: SiP| yes| 14 dBm| Mid
800| BRD4205B| ZGM230SB: SiP| yes| 14 dBm| High
800| BRD4210A| EFR32ZG23B: SoC| yes| 20 dBm| High
800| BRD4400C| EFR32ZG28B: SoC| yes| 14 dBm| High
800| BRD4401B| EFR32ZG28B: SoC| yes| 20 dBm| High
800| BRD4401C| EFR32ZG28B: SoC| yes| 20 dBm| High
700| BRD4200A| ZGM130S: SiP| –| 14 dBm| –
700| BRD4201A| EFR32ZG14: SoC| –| 14 dBm| –
700| BRD4202A| ZGM130S: SiP & no SAW filters| –| 14 dBm| –
700| BRD4206A| EFR32ZG14: SoC| yes| 14 dBm| –
700| BRD4207A| ZGM130S: SiP| yes| 14 dBm| –
700| BRD4208A| EFR32ZG14: SoC| yes| 20 dBm| –
700| BRD4209A| ZGM130S: SoC| yes| 20 dBm| –

The applications in the above table need a radio board in combination with BRD4002A – Wireless Starter Kit Mainboard (WSTK) and BRD8029A – Buttons and LEDs Expansion Board. Notice that BRD4002A is compatible with the old BRD4001A mainboard that is going to be deprecated. The Serial APIs in the above table only need a radio board and a BRD4002A – 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.

Table 1-2. Radio Boards versus OPNs.

The table above shows the Radio Boards and OPN relation. This table can be used to clarify the compatibility of the prebuilt binaries offered in the GSDK. The prebuilt binaries are built targeting boards and not OPNs. More OPNs are available than the ones listed above. For those OPNs the prebuilt binaries will not work. The desired application must be built targeting the specific OPN instead.

Z-Wave Protocol

• Be aware that 800 products based on SDK v7.17.x do not support upgrade of Secure Element firmware over the air (OTA). However, a migration path exists to upgrade both main bootloader and Secure Element firmware to enable support of this feature. See INS14895: Instruction for How to Use Tiny App regarding the upgrade path. The 800-based SDK v7.18.x supports upgrade of Secure Element firmware over the air (OTA).
• The 8 kB reduction of the Z-Wave protocol NVM3 file system has an impact when making OTA firmware update on 800-based ap-plications deployed on version 7.17.2 and earlier. To make an OTA firmware update from 7.17.2 to 7.18.1/2 requires that 7.18.1/2 is modified to keep the same NVM3 protocol size as 7.17.2. This can be configured by the define NVM3_DEFAULT_NVM_SIZE when building 7.18.1/2.
• Note that due to the introduction of Secure Key Storage on the 800 series, having externally supplied key pairs is no longer sup-ported. To ensure that security is not compromised, keys are generated internally on first boot and the private key kept only in se-cure storage. The public key and the QR code can be read out in production.

New Items
Added in release 7.21.4 GA

• Adding additional information on the reset reason in the FUNC_ID_SERIAL_API_STARTED payload.
• Adding a new Serial API command to retrieve the supported region list.

Improvements
Improved in release 7.21.2 GA

Improved in release 7.21.1 GA

Reworked notifications (deep sleep, power down) related to EM4, EM3, EM2 states.

Improved in release 7.21.0 Pre-Certified GA

Fixed Issues

Fixed in release 7.21.4 GA

mode can enter a state where the CRCs associated with TX packets are erroneous. The issue is triggered in noisy environments, including FLiRS devices.
1298919| Under stress, the controller can experience a hard fault condition. With the watchdog disabled, it leads to the controller being unresponsive until the next softreset. The hard fault condition is addressed. It is still recommended to enable the controller watchdog.
1326988| The controller could fall in a state when it is constantly trying to send a beam to an always-listening device. This behavior was triggered by a wrong entry in the “Next to Last Working Route.”
1297362| TX queue refactoring addresses race conditions impacting the controller stability.

Fixed in release 7.21.1 GA

save data in the controller’s NVM. Increase largest NVM object size to match host’s limitation (from 204 to 512 bytes currently used by ZPC or ZGW).
1234133| Introduce memory optimizations to run the controller application in the EFR32ZG14.

Fixed in release 7.21.0 Pre-Certified GA

reach the EM4 energy mode.
1210023| FUNC_ID_ZW_SEND_TEST_FRAME caused the controller SerialAPI NCP to become unresponsive.
1209882| Improve NVM repack to avoid watchdog reset during this process.
1166462| Fix a race condition that can lead to a lock-up in the priority queue.
1165981| Added ZAF module for retention registers.
1142774| DoorLock did not respond with S2 message encapsulation with the SPAN extension to S2 Nonce Report.
1134377| NodeID Length configuration was not persistent in SerialAPI NPC memory.

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 Silicon Labs Release Notes page.

There is a known issue that can lead a device in such a configuration not to wake up.| Use the latest Simplicity SDK with the 800 Series platform.

Use the Z-Wave stack 7.21.3 with 700 Series platform.

1271456| The BRD4401x radio boards (EFR32ZG28 + 20 dBm output power) is misconfigured, resulting in a low TX output power.| Use the latest Simplicity SDK with the BRD4401x radio boards instead.
753756| Network Wide Inclusion (NWI) of 500-based apps doesn’t work through 700/800 repeaters.| NWI works at second attempt.
1227385| The 700/800 controller can lock itself up. The controller is not able to send acknowledgements and the data transmitted is corrupted| This low occurrence issue can be mitigated by the host. When the controller is locked replying with the status, TRANSMIT_COMPLETE_FAIL,

the host should reset the controller.

Deprecated Items
None

Removed Items
Removed in release 7.21.0 Pre-Certified GA

Z-Wave Plus V2 Application Framework

New Items
Supported applications on BRD2705 Explorer Kit: Serial API Controller, Zniffer NCP, LED Bulb, Multilevel Sensor, Power Strip, Sen-sor PIR, Switch On/Off, Wall Controller. Due to limited buttons, some features are limited on this board. Details can be found in the applications’ readme files.
The source code of the two Zniffer application variants are published and available as sample applications. The two variants are the ZnifferPTI and the Zniffer (non PTI).

Improvements
For a detailed description of application development using the Z-Wave Plus V2 Framework, refer to INS14259: Z-Wave Plus V2 Application Framework GSDK.
A porting guide is also available for customers who want to migrate to the 800 platform. The guide contains a detailed example of how to port a non- component/700-based Switch On/Off App (7.16.3) to a component/800-based Switch On/Off App (7.17.0). See APL14836: Application Note for Porting Z-Wave Appl. SW from 700 to 800 hardware.
More mandatory logic was moved from the application to ZAF. This contributed to bringing down the total number of lines in the application. This should decrease time to market for new products

resolves the OTW update compatibility issue for Serial API Controller introduced in 7.20.0 SDK version. More details can be found in the application readme file and in important_changes.md.

Fixed Issues
Fixed in release 7.21.1.0 GA

destination without Multi Channel Encapsulation when no Endpoint Association has been established. Fixes the CSR_MCSupportLifelineFromEPs_Rev01 manual test case.
1243767| Z-Wave ZG28 Margay demo OTA/OTW bootloaders are missing from Simplicity Studio

Fixed in release 7.21.0.0 GA

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 the Silicon Labs Release Notes page

source code depending on the frame sent.
1062482| OTA firmware update gets stuck when a Timer interrupt is triggered to toggle a GPIO frequently.| Currently not available.
1080416| The ASSERT macro does not print the file and line when it is used in the ApplicationTask function.| Prints after disabling all interrupts.
1172849| On series 800, sleep will no longer take advantage of EM1P current savings.| Currently not available.

Deprecated Items
None

Removed Items
Removed in release 7.21.0.0 GA
The Key Fob Controller has been removed.

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.
The LED Bulb application has been removed from the Certified Applications and moved to Pre-Certified Applications.

Door Lock Key Pad

1. New Items
   None

2. Improvements
   None

3. Fixed Issues
   None

4. Known Issues in the Current Release
   None

5. Deprecated Items
   None

6. Removed Items
   None

Power Strip

1. New Items
   None

2. Improvements
   None

3. Fixed Issues
   None

4. Known Issues in the Current Release
   None

5. Deprecated Items
   None

6. Removed Items
   None

Sensor PIR

New Items
None

Improvements
None

Fixed Issues
Fixed in release 7.21.4 GA

CCM_AssociationCmdClass_Rev01 CTT CTT Test case.
1274235| Sensor PIR enabling User Task ended up in Hard Fault.

This Enabled the User Task in Sensor PIR sample app (by setting the CREATE_USER_TASK macro from 0 to 1 in app.c), leading to Hard Fault.

Known Issues in the Current Release

expansion board using BRD4400C and BRD4401C radio boards due to these GPIOs not supporting wakeup from EM4.| Remap the buttons to GPIOs that support wakeup from EM4.

Deprecated Items
None

Removed Items
None

Switch On/Off

1. New Items
   None

2. Improvements
   None

3. Fixed Issues
   None

4. Known Issues in the Current Release
   None

5. Deprecated Items
   None

6. Removed Items
   None

Wall Controller

1. New Items
   None

2. Improvements
   None

3. Fixed Issues
   None

4. Known Issues in the Current Release
   None

5. Deprecated Items
   None

6. Removed Items
   None

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 or details.
The LED Bulb application has been removed from the Certified Applications and moved to Pre-Certified Applications.

Multilevel Sensor

1. New Items
   None

2. Improvements
   None

3. Fixed Issues
   None

4. Known Issues in the Current Release
   None

5. Deprecated Items
   None

6. Removed Items
   None

LED Bulb

1. New Items
   None

2. Improvements
   None

3. Fixed Issues
   None

4. Known Issues in the Current Release
   None

5. Deprecated Items
   None

6. Removed Items
   None

Serial API Applications

• Beginning with version 7.16, when backing up and restoring a SerialAPI end node via the FUNC_ID_NVM_BACKUP_RESTORE, the SerialAPI end node will automatically upgrade the protocol non-volatile memory (NVM) to the latest version. Any backup made of a 7.16 or later SerialAPI end node can be restored to its original version or to a later version of the SerialAPI end node without any manual upgrade of the protocol NVM being necessary.
• The serial interface is unchanged in version 8.
• As of SDK version 7.18.x, Serial API end node is available as source code as well as binary. This opens the possibility for building customized versions of Serial API end node with different pin configuration or additional hardware utilization. A use case might be to use SPI instead of UART for serial communication.
• No application using Serial API End Device is available in the GSDK.

Serial API Controller

1. New Items
   None

2. Improvements
   ** ID #| Description**
   ---|---
   1330199| The watchdog is enabled by default in the controller application.

3. Fixed Issues
   None

4. Known Issues in the Current Release
   None

5. Deprecated Items
   None

6. Removed Items
   None

800 SDK

BRD2603
800 SDK improvements:

• MultilevelSensor App improved by supporting ambient light sensor and motion sensor. The periodic timer for sensor data re-ports is configurable.
• Supported new apps on 800 DevKit: SensorPIR, WallController, PowerStrip, Zniffer
• Improved the usage of the 800 DevKit demo with the Unify Portable Environment by adding the ability to identify the application firmware on the boards. This makes preparation of the Dev Kit for the demo simpler and faster.

BRD2705
Support new applications for BRD2705A:

• SerialAPI Controller
• ZnifferPTI
• SwitchOnOff
• SensorPIR
• WallController
• PowerStrip
• MultilevelSensor
• LEDBulb

Important Changes

Starting in version 7.19, API-breaking changes have been documented in “Important_changes.md” available in the GSDK. Check it for a detailed description of changes introduced in the latest release.
HTML documentation has been added to the GSDK and can be found in Simplicity Studio, Documentation section, under “Z-Wave zipped doxygen documentation”. Location of this document is /protocol/z-wave/studio-docs/z-wave-html- docs.zip

Open Source Software

Z-Wave is using FreeRTOS as the underlying OS, and it is based on FreeRTOS Kernel V10.4.3.

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 compo-nents include EMLIB, EMDRV, RAIL Library, NVM3, PSA, and mbedTLS. Gecko Platform release notes are available through Sim-plicity Studio’s Launcher Perspective.

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/Sili-conLabs/gecko_sdk for more information.
Simplicity Studio installs the GSDK by default in:

• (Windows): C:\Users\\SimplicityStudio\SDKs\gecko_sdk
• (MacOS): /Users//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.

Security Information

Secure Vault Integration
This version of the stack is 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.

The following figure is an example:

Support

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

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. A change in the Z-Wave SDK utilized for a specific device does require recertification; however, the type of certification required, the amount of testing needed, and the associated fees depend on the scope of the change. Refer to Z-Wave Alliance home page https://z-wavealliance.org/ for details.

Table 11-1. Z-Wave SDK Release History

Simplicity Studio
One-click access to MCU and wireless tools, documentation, software, source code libraries & more. Available for Windows, Mac and Linux!

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.

Trademark Information
Silicon Laboratories Inc.®, Silicon Laboratories®, Silicon Labs®, SiLabs® and the Silicon Labs logo®, Bluegiga®, Bluegiga Logo®, EFM®, EFM32®, EFR, Ember®, Energy Micro, Energy Micro logo and combinations thereof, “the world’s most energy friendly microcontrollers”, Redpine Signals®, WiSeConnect , n-Link, EZLink®, EZRadio®, EZRadioPRO®, Gecko®, Gecko OS, Gecko OS Studio, Precision32®, Simplicity Studio®, 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.

Silicon Laboratories Inc. 400 West Cesar Chavez Austin, TX 78701 USA
www.silabs.com

References

• Silicon Labs
• Silicon Labs
• Silicon Labs Community
• IoT – Internet of Things - Silicon Labs
• Simplicity Studio - Silicon Labs
• Technical Support - Silicon Labs
• The Internet of Things is Powered by Z-Wave - Z-Wave Alliance

Read User Manual Online (PDF format)

Read User Manual Online (PDF format)  >>

Download This Manual (PDF format)

Download this manual  >>