Silicon Labs Z/IP Gateway SDK 7.15.04 User Manual
silabs.com | Building a more connected world. Z/IP Gateway 7.15.04
Z/IP Gateway SDK 7.15.04
NEW FEATURES
Mailbox Queueing of Network
Management Commands (ZGW-
2981)
Z-Wave Long Range support
Pre-certified for Z-Wave Long Range
March 26, 2021
The Z/IP Gateway emulates the behavior of IP enabled Z-Wave devices so that IP
applications may interact with Z-Wave devices via normal IP routing principles. The Z/IP
Gateway decodes Z/IP Packet headers and forwards extracted Z-Wave commands to
the node identified by the given IPv6 or Ipv4 address.
These release notes cover Z/IP Gateway SDK version(s):
7.15.04
This release is a pre-certification Z-Wave LR release, all specifications needed for LR
are available as 2020C contribution, through the Z-Wave Alliance AWG
Compatibility and Use Notices
If you are new to the Z-Wave Gateway SDK, see Using This Release.
The audience of this document is Z-Wave Partners and Silicon Labs customers
interested in evaluating the Z/IP Framework. The reader must be familiar with the
following:
Basic IP terminology, such as routing, ping, UDP, subnet, etc.
Basic Z-Wave network creation and maintenance
While not used consequently throughout the document, the guidelines outlined in IETF
RFC 2119 “Key words for use in RFCs to Indicate Requirement Levels” are followed in
many sections. Essentially, the key words “MUST”, “MUST NOT”, “REQUIRED”,
“SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and
“OPTIONAL” in this document are to be interpreted as described in RFC 2119.
Contents
silabs.com | Building a more connected world. Z/IP Gateway 7.15.04 | 2
Contents
1 Improvements ......................................................................................................................................................................................3
2 Fixed Issues.........................................................................................................................................................................................4
3 Known Issues in the Current Release..................................................................................................................................................5
4 Removed and Deprecated Items .........................................................................................................................................................6
4.1 Firmware Update targets..............................................................................................................................................................6
4.2 Back-off during polling..................................................................................................................................................................6
5 Using This Release..............................................................................................................................................................................7
5.1 Key Features of Z/IP Gateway SDK.............................................................................................................................................8
5.1.1 LAN-Side Features...............................................................................................................................................................9
5.1.2 PAN-Side Features ............................................................................................................................................................16
5.1.3 SmartStart..........................................................................................................................................................................19
5.1.4 Installation and Maintenance Framework ..........................................................................................................................20
5.1.5 Migration from non-Z/IP Gateways to Z/IP Gateway..........................................................................................................20
5.1.6 Back-up and Recover the Z-Wave Network on the Z/IP Gateway devices........................................................................20
5.1.7 Persisting the S2 SPAN Table ...........................................................................................................................................21
5.1.8 Long Range Support..........................................................................................................................................................21
5.1.9 Mailbox Queueing of Network Management Commands (ZGW-2981)..............................................................................21
5.2 Platform Requirements ..............................................................................................................................................................22
5.3 Important Notes..........................................................................................................................................................................22
5.3.1 UART Connection Security ................................................................................................................................................22
5.4 Technical Support ......................................................................................................................................................................22
6 Legal ..................................................................................................................................................................................................23
6.1 Disclaimer ..................................................................................................................................................................................23
6.2 Trademark Information...............................................................................................................................................................23
Improvements
silabs.com | Building a more connected world. Z/IP Gateway 7.15.04 | 3
1 Improvements
Certified for Z-Wave according to the 2020B Specification Release
Pre-certified for Z-Wave Long Range. Pre-certified means that the final version of the Long Range certification tests were not
available at the time of this release. The LR certification will be performed based on the 2020C specifications test suites and is
anticipated to begin April 1, 2021. This release is a pre-certification Z-Wave LR release, all specifications needed for LR are
available as 2020C contribution, through the Z-Wave Alliance AWG
Support Z-Wave Long Range.
The following limitations compared to non-Long Range Z-Wave apply:
o To upgrade an existing network to Long Range functionality, the Z/IP Gateway must be reset with a Set Default
command and the network must be rebuilt.
o Migration to Long Range networks is not supported (ZGW-3153).
Mailbox Queueing of Network Management Commands (ZGW-2981). See section 5.1.9 for details.
Fixed Issues
silabs.com | Building a more connected world. Z/IP Gateway 7.15.04 | 4
2 Fixed Issues
ID#
Description
ZGW-3110
Recovering (restoring) a backup to a ZGW 7.15.2 connected to a 7.12.x to 7.15.1 SerialAPI fails due to the
SerialAPI being misidentified as a 7.15.2 SerialAPI. Earlier ZGWs do not support 7.15.2 SerialAPIs.
The 7.15.2 ZGW will not function after recovering a backup made with any ZGW version connected to SerialAPIs
version 7.12.x to 7.15.1
ZGW-3113
Backup of Z/IP gateways with 500-series radios will fail and cannot be restored a.k.a. recovered.
Migration to Z/IP gateways with 500-series radios still works.
Extraction of NVM image from 500 series devices fails due to misidentification of the protocol version.
This affects all backups taken from a 7.15.02 ZGW with 500-series chip connected. Earlier ZGW releases are
unaffected.
Migration to Z/IP Gateways with a 500-series radio still works because the protocol version must be manually
supplied in this case.
ZGW-3143
Fix issue of Add Node Status missing the DSK
ZGW-2962
Make debian package installable on Ubuntu 20.04. Required Ubuntu build platform changed to 20.04 from 18.04.
ZGW-3139
Fix issue of security keys wiping when serial api is unresponsive
ZGW-3114
Allow CRC16 when the S2 bootstrapping failed but supports CRC16
ZGW-3119
Allow BASIC SET from S0 nodes to be forwarded to UD
ZGW-3107
Restore the S0 key on S0 bootstrap failure
ZGW-2909
Allow user defined serial number config option for Z/IP Device specific Report
ID#
Description
ZGW-3026
Granting only unauthenticated key to end nodes based on SDK 7.14 and newer fails
ZGW-3023
Make Default UD port 41230 and UD2 port 41231
ZGW-3034
Check if any virtual node id is 0 in eeprom before conversion
ZGW-3071
Fix the issue of enabled Mailbox in clean chip
ID#
Description
ZGW-2306
After adding several node, the Z/IP Gateway may delayed sending a new node add notification to the mDNS.
ZGW-2623
Set Name and location only in PVL if its passed
ZGW-2871
Second ECDH keypair for PSIRT-33 and cert req.
ZGW-2996
Fix no 4nswer on mDNS query
ZGW-2972:
Forward supervision reports to Unsolicited Destination
ZGW-2256 /
ZGW-2951
Persist S2 SPAN table. Avoid extra traffic for S2 resynchronization when power-cycling the Z/IP Gateway.
ZGW-2934:
Retry self destruct remove failed after 240s. More robust reclaiming of nodeIDs after failed SmartStart inclusion.
Fixed in release 7.15.04
Note: There is no 7.15.03 Z/IP Gateway release. That version number is used solely for an interim Z-Wave Embedded SDK release.
Fixed in release 7.15.02
Fixed in release 7.15.01
Known Issues in the Current Release
silabs.com | Building a more connected world. Z/IP Gateway 7.15.04 | 5
3 Known Issues in the Current Release
ID
Description
Workaround
ZGW-1035
Z/IP Gateway will queue and delay incoming DTLS Client
Hello requests while attempting to deliver a frame to a FliRS
device. Delay may be multiple seconds if the FliRS device is
not working.
ZGW-633
In some situations, NACK Waiting is sent late. This occurs if
the internal queues are locked or are long. The queues are
locked when exercising the mailbox or performing network
management operations. A Z/IP client might time out on a
frame delivery even though the frame is in fact going to be
delivered. ACK/NACK will be received on delivery.
Extend timers in the client or if possible be aware that
the queues are locked due to network management
operations.
ZGW-2707
The Z/IP Gateway does not reply multichannel encapsulated
S2 secure command supported Get command.
Z/IP Client should not advertise multichannel as a
supported command class.
ZGW-2948
LibZWaveIP transmits data over Ipv4 while connecting over
Ipv6
ZGW-3021
ZGW cannot include the PC Controller. The inclusion fails.
ZGW-3025
Network keys are sent over UART in plaintext (see 5.3.1)
Secure GW product against physical tampering
ZGW-3006
Dynamic TX Power is not forwarded via IMA. Z/IP Clients are
not informed of the dynamic TX power used to send a
particular frame.
ZGW-3104
The Z/IP Gateway cannot supports network sizes exceeding
750 nodes. The Long Range specification allows even larger
networks.
ZGW-3153
Migration to Long Range (LR) Z/IP Gateway from a LR
gateway not based on Z/IP Gatway does not work. The
migrated LR Z/IP Gateway will not be operational.
Issues in bold were added since the previous release.
Removed and Deprecated Items
silabs.com | Building a more connected world. Z/IP Gateway 7.15.04 | 6
4 Removed and Deprecated Items
4.1 Firmware Update targets
All firmware targets except target 0 are deprecated in Firmware Update Command Class. It is only possible to update a firmware target
0 (i.e. the Z-Wave chip Flash memory). The other firmware targets have been deprecated because it is unsafe to update them
individually. It is recommended to use the backup/restore functionality of the ZGW instead. It will safely update the information
previously exposed through the firmware targets.
4.2 Back-off during polling
The Z/IP Gateway no longer performs back off when Z/IP clients are polling Z-Wave devices. This must be handled by the clients. The
change improves scalability of large networks. As mandated by SDS11846: Z-Wave Plus Role Type Specification section 3.7, a ZWave controller must rate-limit polling of devices in the network. Previously, the Z/IP Gateway would automatically apply rate limiting to
requests from Z/IP clients. This functionality has now been removed in order to improve large network scalability. As a consequence,
Z/IP clients must now adhere to the requirements in SDS11846: Z-Wave Plus Role Type Specification.
Using This Release
silabs.com | Building a more connected world. Z/IP Gateway 7.15.04 | 7
5 Using This Release
The Z/IP Gateway Software Developers Kit contains the following components:
Debian packages:
o Z/IP Gateway 7.15.04, for Raspberry Pi 3B+
o Z/IP Gateway 7.15.04, for Linux i386
Source code:
o Z/IP Gateway 7.15.04
o libzwaveip 7.15.04
Documentation:
INS12503, Z/IP Gateway Porting Process
SDS12938, Z/IP LAN Security
SDS12089, Z/IP Gateway Bootstrapping
SDS11756, Z/IP DNS Discovery support (DNS-SD, mDNS)
SDS11633, Z/IP Resource Directory (RD, DNS-SD, mDNS)
SDS11445, IP Architecture Framework for Z-Wave (Z/IP)
SDS13944, Node Provisioning Information Type Registry (QR code, Z/IP Gateway, SmartStart)
Z/IP Security 2 in Z/IP Gateway
Z/IP Gateway Source Code Documentation
Z/IP Gateway User Guide (Z-Wave & IP Basics, Compilation, Installation, Troubleshooting, Sample Code)
libzwaveip documentation in the file libzwaveip-7.15.04.release-docs.zip
Additionally, the following documentation can be found in https://www.silabs.com/products/wireless/mesh-networking/z-
wave/specification:
Z-Wave Command Class specifications
Loading...