SILICON LABS 800 SDK Z Wave And Long Range Instructions

SILICON LABS 800 SDK Z Wave And Long Range

Z-Wave and Z-Wave Long Range 800
SDK 7.22.0 GA
Simplicity SDK Suite 2024.6.0
June 5, 2024

Z-Wave and Z-Wave Long Range 800 is 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 800 SDK v7.22.0.0 GA, see section 11 Product Life Cycle and Certification.
These release notes cover SDK version(s):
7.22.0 GA released June 5, 2024

Compatibility and Use Notices
For more information about security updates and notices, see the Security chapter of the 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 800 SDK, see section 10 Using This Release.
Compatible Compilers:
GCC (The GNU Compiler Collection) version 12.2.1, provided with Simplicity Studio.

KEY FEATURES

• 7.22.0 and future updates support the 800 Series platform
• 700 Series platform will continue to be supported through the upcoming 7.21.x releases
• Introducing ZWLR Europe support in experimental quality
• Z-Wave NCP controller stability improvements
• Introducing User Credential Command Class beta
• Introducing CLI support in sample apps
• Removed support for Series 0/1

Supported Radio Boards

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

Table 1-1. Supported Radio Boards

Series

| Radio Board| ****

Description

| Z-Wave Long Range| Tx Power| Secure Vault
---|---|---|---|---|---
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| BRD4400B| EFR32ZG28B: SoC| yes| 14 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

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 Simplicity SDK. 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.

SDK Changes
Simplicity SDK is an embedded software development platform for building IoT products based on our Series 2 and Series 3 wireless and MCU devices. It integrates wireless protocol stacks, middleware, peripheral drivers, a bootloader, and application examples – a solid framework for building power- optimized and secure IoT devices.
The Simplicity SDK offers powerful features such as ultra-low power consumption, strong network reliability, support for a large number of nodes, and abstraction of complex requirements like multiprotocol and pre- certification. Additionally, Silicon Labs provides over-the-air (OTA) software and security updates to remotely update devices, minimize maintenance costs, and enhance the end-user product experience.
Simplicity SDK is a follow-on from our popular Gecko SDK, which will continue to be available providing long-term support for our Series 0 and Series 1 devices. For additional information on the Series 0 and Series 1 devices please reference: Series 0 and Series 1 EFM32/EZR32/EFR32 device (silabs.com).

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

• The Z-Wave stack supports the Z-Wave Long-Range Europe region in Alpha quality.
• A new Serial API command is available to backup and restore the information in NVM (Non-Volatile Memory).
• Simplicity SDK requires that all sections are placed in the linkerscript. If using software components, they are contributed by the

Z- Wave software components. For developers not using the software component mechanism, they should contribute the follow-ing sections to their linker file.

• Contributed by the zw_core.slcc software component:
  • zw_protocol_cmd_handlers_lr
  • zw_protocol_cmd_handlers
• Contributed by the zw_apputilities.slcc software component:
  • zw_cc_handlers_v3
  • zw_zaf_cc_config
• Contributed by the zaf_event_distributor_soc.slcc software component:
  • zw_zaf_event_distributor_cc_event_handler
• Contributed by the zwave_ncp_serial_api_controller.slcp software component:
  • zw_cmd_handlers

Improvements
Improved in release 7.22.0 GA

ZAFVERSION[MAJOR|MINOR|PATCH] are no longer available in Applications. They have been re- placed by several accessor functions defined in “ZAF_version.h”.

|
1196450| zpal_reset_reason_t replaces EResetReason_t enum.

Fixed Issues
Fixed in release 7.22.0 GA

when a Timer interrupt was triggered.
1266899| Fixed a controller migration issue impacting the migration process from 7.17 to newer NCP Serial API Controller.
1271456| The BRD4401C radio board (EFR32ZG28 + 20 dBm output power) was misconfigured resulting in a low TX output power. This issue has been addressed.
1273430| Fixed high priority packet management impacting Network Wide Inclusion and Exclusion.
---|---
1289422| Fixed an issue causing a reset when polling the end device with a high frequency.
1238611| TX queue refactoring addressing race conditions impacting the controller stability.
1285197| Rarely, the controller hit a state that led to an unmanaged state (RAIL_EVENT_RX_FIFO_OVERFLOW). The con- troller now triggers a soft-reset.

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.

This low occurrence issue can be mitigated by the host. When the control- ler is locked replying with the status, TRANSMIT_COMPLETE_FAIL, the host should reset the controller.
1302749| The controller configured in Z-Wave Long-Range mode can enter a state where the CRCs associated with TX packets are erroneous. The issue is triggered in noisy environments, including FLiRS devices.| No workaround.
1247775| The RTOS tick can stop when the application requires frequent interruptions. The RTOS tick is then not incremented and stops the Z- Wave stack and other tasks.| In the sli_schedule_wakeup_timer_expire_handler() function, replace

/ Increment the RTOS tick. /

while ((current_tick_count – last_update_lftick) > lfticks_per_os_ticks) {

sched |= xTaskIncrementTick(); last_update_lftick+= lfticks_per_os_ticks;

}

By

/ Increment the RTOS tick. /

while ((current_tick_count – last_update_lftick)

= lfticks_per_os_ticks) {

sched |= xTaskIncrementTick(); last_update_lftick+= lfticks_per_os_ticks;

}

1300414| End-Device acknowledges packet after exclusion.| No workaround.
1295158| The emulated end-device inclusion fails when used with the CTT agent.| It is recommended testers use another version of the emulated end-de- vice.
753756| Network Wide Inclusion (NWI) of 500-based apps doesn’t work through 700/800 repeaters.| NWI works at second attempt.

Deprecated Items
As of the 7.22.0 stack release, the 700 platform is not supported by the Simplicity SDK. The 700 platform will be maintained through the 7.21.x release stream.

Removed Items
Removed in release 7.22.0 GA
None.

Z-Wave Plus V2 Application Framework

New Items
Added User Credential Command Class beta implementation. Please note that more updates are expected in this command class specification in the upcoming 2024A Z-Wave specification, and this early implementation does not implement all of these changes. The command class will be adjusted to the 2024A specs in the future patch releases.
New variant of the Door Lock Key Pad sample application is added: “Door Lock Key Pad with U3C Beta”, which supports the User Credential Command Class.
CLI support is added for the sample apps. In case of FL and NL applications, the CLI is disabled by default because it prevents the apps from entering sleep mode. The instructions to enable the CLI for these sleeping apps can be found in the apps’ readme files.

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.

Fixed Issues
Fixed in release 7.22.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.
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.
1301405| Z-Wave Version Config SLC component’s input fields are set to 1.0.0 by default, but 0 is outside of the allowed range. The version is not set properly in zw_version_config.h in case of 0 input fields.| Inside the project, open config/zw_version_config.h and change the values of the defines starting with USERAPP to 0 manually.
1257690| sl_storage_config.h does not handle custom OTA slot size.| Currently not available.

Deprecated Items
None.

Removed Items
Removed in release 7.22.0. GA None.

Sample Applications

The Door Lock Key Pad, Power Strip, Sensor PIR and Wall Controller applications based on v7.22.0 will be formally certified by a certification house. However, at the time of the release, these applications are self- certified on certification tests using CTT v3.

Door Lock Key Pad

New Items
None.

Improvements
None.

Fixed Issues
None.

Known Issues in the Current Release

available.
1245554| DoorLock app does not work with UserID over 163.| Currently not available.

Deprecated Items
None.

Removed Items
None.

Door Lock Key Pad with U3C Beta
This is a new variant of the Door Lock Key Pad sample application which supports the User Credential Command Class, and is a Beta version. Because it has not been self-certified yet, the application contains known issues and will be adjusted according to changes expected in the 2024A Z-Wave specification.

New Items
None.

Improvements
None.

Fixed Issues
None.

Known Issues in the Current Release

available.
1297611| Next Credential value doesn’t keep ascending order.| Currently not available.
1297370| Multiple Credential delete not working.| Currently not available.
1297352| Pin code should only store numbers instead of any character.| Currently not available.
1297175| Credential max length is wrong in Credential Capabilities Report.| Currently not available.
1296879| User deletion does not guarantee deletion of all associated Credentials.| Currently not available.
1296863| Unsupported User Types can be added.| Currently not available.
1296859| USER_NOTIFICATION_REPORT commands are missing.| Currently not available.
1296854| USER_SET_ERROR_REPORT commands are missing.| Currently not available.

Deprecated Items
None.

Removed Items
None.

Power Strip

1. New Items
   None.

2. Improvements
   None.

3. Fixed Issues
   None.

Known Issues in the Current Release

Deprecated Items
None.

Removed Items
None.

Sensor PIR

1. New Items
   None.

2. Improvements
   None.

3. Fixed Issues
   None.

Known Issues in the Current Release

Enabling the User Task in Sensor PIR sample app (by setting the CREATE_USER_TASK macro from 0 to 1 in app.c) leads to Hard Fault.

| Add 500 ms delay to the beginning of the SensorPIR_DataAcquisitionTask function.
1256505| Sensor PIR does not wake up on BTN0 and BTN1 button pressing on an 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.
1231755| Sensor PIR On to Off movement alarm notification is missing.| Currently not available.

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.

7. Multilevel Sensor
   This application is not certifiable due to missing features for passing the certification tests.

8. New Items
   None.

9. Improvements
   None.

10. Fixed Issues
    None.

11. Known Issues in the Current Release
    None.

12. Deprecated Items
    None.

13. 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 Serial API end node via the FUNC_ID_NVM_BACKUP_RESTORE, the Serial API end node will automatically upgrade the protocol non-volatile memory (NVM) to the latest version. Any backup made of a 7.16 or later Serial API end node can be restored to its original version or to a later version of the Serial API 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 Simplicity SDK.

Serial API 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.

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 Simplicity SDK. Check it for a detailed description of changes introduced in the latest release.
HTML documentation has been added to the Simplicity SDK and can be found on https://docs.silabs.com/z-wave/7.22.0/zwave-api/ and in Simplicity Studio, Documentation section, under “Z-Wave zipped doxygen documentation”. Location of this document is  /protocol/z-wave/docs_public/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 Simplicity SDK Platform. The Simplicity SDK 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.

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 800 SDK is provided as part of the Simplicity SDK, the suite of Silicon Labs SDKs. To quickly get started with the Simplicity SDK, install Simplicity Studio 5, which will set up your development environment and walk you through Simplicity SDK 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, Simplicity SDK may be installed manually by downloading or cloning the latest from GitHub. See https://github.com/Sil- iconLabs/simplicity_sdk for more information.
Simplicity Studio installs the SDK by default in:

• (Windows): C:\Users\\SimplicityStudio\SDKs\simplicity_sdk
• (MacOS): /Users//SimplicityStudio/SDKs/simplicity_sdk

To implement a specific application, Silicon Labs recommends starting with one of the existing self-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.

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!

IoT Portfolio
www.silabs.com/IoT
SW/HW
www.silabs.com/simplicity
Quality
www.silabs.com/quality
Quality
www.silabs.com/quality

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 infor-mation 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

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

Read User Manual Online (PDF format)

Read User Manual Online (PDF format)  >>

Download This Manual (PDF format)

Download this manual  >>