CONFIDENTIAL - silabs.com · INS13501-3 Z-Wave ZDB5304, UZB & SD3503 serial API based applications...

Instruction

Z-Wave ZDB5304, UZB & SD3503 serial API based applications using SDK v6.71.0x

Document No.: INS13501

Version: 3

Description: -

Written By: JFR;BBR

Date: 2018-03-05

Reviewed By: COLSEN;BBR;CRASMUSSEN

Restrictions: Public

Approved by:

Date CET Initials Name Justification

2018-03-05 14:39:09 NTJ Niels Thybo Johansen

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.

INS13501-3 Z-Wave ZDB5304, UZB & SD3503 serial API based applications using SDK v6.71.0x 2018-03-05

silabs.com | Building a more connected world. Page ii of iii

REVISION RECORD

Doc. Rev

Date By Pages affected Brief description of changes

1 20160125 JFR ALL Initial draft based on INS13118

1 20160127 JFR ALL Added static controller single hex files

2 20170120 JFR Frontpage Updated to 6.71.0x

3 20180305 BBR All Added Silicon Labs template

https://www.silabs.com/


silabs.com | Building a more connected world. Page iii of iii

Table of Contents

1 ABBREVIATIONS ................................................................................................................................. 1

2 INTRODUCTION ................................................................................................................................... 2

2.1 Purpose .............................................................................................................................................. 2 2.2 Audience and prerequisites ................................................................................................................ 2

3 SOFTWARE COMPONENTS ............................................................................................................... 3

3.1 Directory Structure ............................................................................................................................. 3 3.2 Binaries ............................................................................................................................................... 4 3.3 ZM5304 .............................................................................................................................................. 5

3.3.1.1 SerialAPI_Controller_Bridge ............................................................................................ 5 3.3.1.2 SerialAPI_Controller_Static .............................................................................................. 5 3.3.1.3 SerialAPI_Controller_Static_Single .................................................................................. 5

3.4 UZB and SD3503 ............................................................................................................................... 6 3.4.1.1 SerialAPI_Controller_Bridge ............................................................................................ 6 3.4.1.2 SerialAPI_Controller_Static .............................................................................................. 7 3.4.1.3 SerialAPI_Controller_Static_Single .................................................................................. 7

4 Z-WAVE APPLICATIONS .................................................................................................................... 8

4.1 Serial API ............................................................................................................................................ 8 4.1.1 Production test mode ............................................................................................................... 8

REFERENCES ............................................................................................................................................. 9

INDEX .........................................................................................................................................................10

List of Tables

Table 1. 500 Series targets hex files naming .............................................................................................. 4



silabs.com | Building a more connected world. Page 1 of 10

1 ABBREVIATIONS

Abbreviation Explanation

ANZ Australia/New Zealand

API Application Programming Interface

ERTT Enhanced Reliability Test Tool (Part of Z-Wave PC Controller)

EU Europe

HK Hong Kong

IL Israel

IMA Installation and Maintenance Application that typical resides on the gateway

IN India

JP Japan

KR South Korea

MY Malaysia

NVM Non-volatile memory

OTA Over the air (e.g. making a firmware update wireless)

OTW Over the wire (e.g. making a firmware update via the serial API interface)

RF Radio Frequency

RU Russia

SDK Z-Wave Software Developers Kit includes software and related software documentation.

US United States

USB Universal Serial Bus

UZB USB v2.0 full speed low power CDC-ACM compliant Z-Wave adapter

VCP Virtual COM Port

XML eXtensible Markup Language




2 INTRODUCTION

2.1 Purpose

The purpose of this document is to describe the ZDB3504(ZM5304/SD3503), UZB(SD3503) and other SD3503 applications based on the Z-Wave Software Developer’s Kit (SDK). Document contains also a description of all applications including user guide or reference to relevant document.

2.2 Audience and prerequisites

The audience is Z-Wave Partners.




3 SOFTWARE COMPONENTS

The software packet consists of ZDB5304(ZM5304/SD3503), UZB(SD3503) and other SD3503 related applications.

3.1 Directory Structure

The software is organized in the following directory structures:

/ - ZM5304

- Product - Bin

- SerialAPI_Controller_Bridge - SerialAPI_Controller_Static - SerialAPI_Controller_Static_Single

- SD3503 - Product

- Bin - SerialAPI_Controller_Bridge - SerialAPI_Controller_Static - SerialAPI_Controller_Static_Single




3.2 Binaries

The table below show the hex files naming for the different y frequency targets.

Table 1. 500 Series targets hex files naming

Target Module/chip

used Hex file name

ZDB5304

ZM5304/SD3503 (modem)

*_ZM5304_y.hex *_ZM5304_USBVCP_y.hex

UZB

SD3503 *_OTW_SD3503_USBVCP_y_WITH_BOOTLOADER.hex

SD3503 *_OTW_SD3503_USBVCP_y_WITH_BOOTLOADER.hex

*_OTW_SD3503_y.ota

Notice that RF power settings (Normal Tx Power and Low Tx Power) apply only for the ZM5304 module. The RF Power settings for UZB must be adjusted in ZWaveProgrammer [4] to fulfill regulatory requirements for the given region.




3.3 ZM5304

The ZM5304 directory structure contains hex files for ZDB3504(ZM5304/SD3503) applications.

3.3.1.1 SerialAPI_Controller_Bridge

The Product\Bin\SerialAPI_Controller_Bridge directory contains all files needed for running a serial API based bridge controller application on a ZDB3504 board. The directory contains the following files:

serialapi_controller_bridge_ZM5304_y.hex RS232 1 port (ZDP03A) based serial API hex files for y frequency versions.

serialapi_controller_bridge_ZM5304_USBVCP _y.hex

USB 2 port (ZDP03A) based serial API hex files for y frequency versions.

SupportedFunc_serialapi_controller_bridge.txt Show enabled (1) and disabled (0) serial API calls of released sample application.

The ZDB5304 based Serial API applications implement in addition production test mode. Refer to 4.1.1 for details.

3.3.1.2 SerialAPI_Controller_Static

The Product\Bin\SerialAPI_Controller_Static directory contains all files needed for running a serial API based static controller application on a ZDB3504 board. The directory contains the following files:

serialapi_controller_static_ZM5304_y.hex RS232 1 port (ZDP03A) based serial API hex files for y frequency versions.

serialapi_controller_static_ZM5304_USBVCP _y.hex


SupportedFunc_serialapi_controller_static.txt Show enabled (1) and disabled (0) serial API calls of released sample application.

The ZDB3504 based Serial API applications implement in addition production test mode. Refer to 4.1.1 for details.

3.3.1.3 SerialAPI_Controller_Static_Single

The Product\Bin\SerialAPI_Controller_Static_Single directory contains all files needed for running a serial API based static controller application on a ZDB3504 board. Notice that this application is used in combination with ERTT [5]. The directory contains the following files:

serialapi_controller_static_single_ZM5304_y.hex RS232 1 port (ZDP03A) based serial API hex files for y frequency versions.

serialapi_controller_static_single_ZM5304_USBVCP _y.hex


SupportedFunc_serialapi_controller_static_single.txt Show enabled (1) and disabled (0) serial API calls of released sample application.




3.4 UZB and SD3503

The SD3503 directory structure contains hex files for UZB(SD3503) and other SD3503 related applications.

3.4.1.1 SerialAPI_Controller_Bridge

The Product\Bin\SerialAPI_Controller_Bridge directory contains all files needed for running a serial API based bridge controller application on a UZB dongle or SD3503 module. The directory contains the following files:

serialapi_controller_bridge_OTW_SD3503 _y_WITH_BOOTLOADER.hex serialapi_controller_bridge_OTW_SD3503 _USBVCP_y_WITH_BOOTLOADER.hex

RS232 1 / USB 2 port based serial API hex files supporting OTW firmware update for y frequency versions. UZB dongle [1] uses USBVCP variant. Hex file comprises of application and bootloader. This hex file MUST be used first time when programming the device.

serialapi_controller_bridge_OTW_SD3503 _y.ota serialapi_controller_bridge_OTW_SD3503 _USBVCP_y.ota

RS232 1 / USB 2 port based serial API hex files supporting OTW firmware update for y frequency versions. UZB dongle [1] uses USBVCP variant. Hex file comprises of only the application. This hex file MUST be used when doing OTW firmware update.

SupportedFunc_serialapi_controller_bridge.txt Show enabled (1) and disabled (0) serial API calls of released sample application.

The SD3503 based Serial API applications implement in addition production test mode. Refer to 4.1.1 for details.




3.4.1.2 SerialAPI_Controller_Static

The Product\Bin\SerialAPI_Controller_Static directory contains all files needed for running a serial API based static controller application on a UZB dongle or SD3503 module. The directory contains the following files:

serialapi_controller_static_OTW_SD3503 _y_WITH_BOOTLOADER.hex serialapi_controller_static_OTW_SD3503 _USBVCP_y_WITH_BOOTLOADER.hex

RS232 1 / USB 2 port based serial API hex files supporting OTW firmware update for y frequency versions. UZB dongle [1] uses USBVCP variant. Hex file comprises of application and bootloader. This hex file MUST be used first time when programming the device.

serialapi_controller_static_OTW_SD3503 _y.ota serialapi_controller_static_OTW_SD3503 _USBVCP_y.ota

RS232 1 / USB 2 port based serial API hex files supporting OTW firmware update for y frequency versions. UZB dongle [1] uses USBVCP variant. Hex file comprises of only the application. This hex file MUST be used when doing OTW firmware update.

SupportedFunc_serialapi_controller_static.txt Show enabled (1) and disabled (0) serial API calls of released sample application.

The SD3503 based Serial API applications implement in addition production test mode. Refer to 4.1.1 for details.

3.4.1.3 SerialAPI_Controller_Static_Single

The Product\Bin\SerialAPI_Controller_Static_Single directory contains all files needed for running a serial API based static controller single application on a UZB dongle or SD3503 module. Notice that this application is used in combination with ERTT [5]. The directory contains the following files:

serialapi_controller_static_single_SD3503_y.hex RS232 1 port (ZDP03A) based serial API hex files for y frequency versions.

serialapi_controller_static_single_SD3503_USBVCP _y.hex


SupportedFunc_serialapi_controller_static_single.txt Show enabled (1) and disabled (0) serial API calls of released sample application.




4 Z-WAVE APPLICATIONS

This chapter describes the functionality of the ZDB3504(ZM5304/SD3503), UZB(SD3503) and other SD3503 related applications.

4.1 Serial API

For a description of the functionality supported by the Serial API application refer to [3].

4.1.1 Production test mode

The Serial API based applications implement in addition production test mode. The ZM5304 modules use I/O P2.1 (UART0 TX pad on the ZM5304) to initiate production test mode and run the various tests. This can be achieved by short-circuiting J16-pin16 to J17-pin1 (ground) on ZDP03A.

After power recycling the ZDP03A module and the SerialAPI enters the production test mode, the following happens:

1. Radio start to send constant un-modulated signal on channel 0.2. Radio start to send constant modulated signal on channel 0 by pressing the reset button on the

ZDP03A once.3. Radio start to send constant un-modulated signal on channel 1 by pressing the reset button on

the ZDP03A once.4. Radio start to send constant modulated signal on channel 1 by pressing the reset button on the

ZDP03A once.5. Radio start to send constant un-modulated signal on channel 2 by pressing the reset button on

the ZDP03A once. (3 channels system only, for 2 channel systems it jumps to point 7).6. Radio start to send constant modulated signal on channel 2 by pressing the reset button on the

ZDP03A once. (3 channels system only, for 2 channel systems it jumps to point 7).7. Pressing the reset button on the ZDP03A once, will Initializes RF to receive NOP frames and

acknowledge them. Use node ID equal to 0x01 in NOP frame, the home ID value is ignored inproduction test mode. The Production test generator can now be used to test RF link becausedirectly default node ID used is equal to 0x01.

8. Jump to point 1 by pressing the reset button on the ZDP03A once

The production test mode application is located in the ApplicationTestPoll function.




REFERENCES

[1] SD, INS11850, Instruction, UZB User Manual. [2] SD, INS13478, Instruction, Z-Wave 500 Series Application Programming Guide v6.71.00. [3] SD, INS12350, Instruction, Serial API Host Appl. Prg. Guide. [4] SD, INS10679, Instruction, Z-Wave Programmer User Guide (ZDP03A, PC). [5] SD, INS13114, Instruction, Z-Wave PC based Controller v5 User Guide.




INDEX

ApplicationTestPoll ...................................................................................................................................... 8 Carrier signal ............................................................................................................................................... 8 Modulated signal .......................................................................................................................................... 8 Production test mode ................................................................................................................................... 8


http://www.silabs.com

Silicon Laboratories Inc.400 West Cesar ChavezAustin, TX 78701USA

Smart. Connected. Energy-Friendly.

Productswww.silabs.com/products

Qualitywww.silabs.com/quality

Support and Communitycommunity.silabs.com

DisclaimerSilicon 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 and limitation to product information, specifications, and descriptions herein, and does not give warranties as to the accuracy or completeness of the included information. Silicon Labs shall have no liability for the consequences of use of the information supplied herein. This document does not imply or express copyright licenses granted hereunder to design or fabricate any integrated circuits. The products are not designed or authorized to be used within any Life Support System 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.

Trademark InformationSilicon 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®, ISOmodem®, Micrium, Precision32®, ProSLIC®, Simplicity Studio®, SiPHY®, Telegesis, the Telegesis Logo®, USBXpress®, Zentri, 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. All other products or brand names mentioned herein are trademarks of their respective holders.

CONFIDENTIAL - silabs.com · INS13501-3 Z-Wave ZDB5304, UZB & SD3503 serial API based applications...

Documents

Transcript of CONFIDENTIAL - silabs.com · INS13501-3 Z-Wave ZDB5304, UZB & SD3503 serial API based applications...