Appendix: Serial API Files#

The Serial API embedded sample code is provided in the Z Wave Developer’s Kit until SDK 6.81.0x. Only binaries are distributed starting with the SDK 7.00.00+. Note that altering the function IDs and frame formats in the Serial API embedded sample code can result in interoperability problems with the Z Wave DLL supplied on the Developer’s Kit as well as commercially available GUI applications. To determine the current version of the Serial API protocol in the embedded sample code, see the API call ZW_Version.

The ProductPlus\SerialAPIPlus directory contains sample source code for controller/end device applications on a Z Wave module. The application also uses several utility functions described in 2, depending on the SDK used.

Makefiles#

MK.BAT#

Make bat file for building the sample application in question. To only build applications using EU frequency enter: MK “FREQUENCY=EU” in the command prompt.

Makefile#

This is the Makefile for the sample application in question defining the targets built. See [2] for additional details depending on SDK used.

Makefile.common_ZW0x0x_supported_functions#

This makefile makes a text file showing the supported serial API functions for the given target.

Application#

app_version.h#

This header file contains defines for the application version.

config_app.h#

This header file contains defines for Manufacturer-Specific Command Class and defines for Security settings.

conhandle.h / conhandle.c#

Routines for handling Serial API protocol between PC and Z Wave module.

eeprom.h / eeprom.c#

NVM layout.

make-supported-functions-include.bat#

Windows batch script for generating Serial API defines for supported functions based on what exists in the library.

Prodtest_vars.c#

Critical memory variables used for a production test.

serialapi-supported-func-list.txt#

Template file for generating SerialAPI defines for supported functions based on what exists in the library. Enable/disable support of a given Serial API function in serialappl.h header file.

serialappl.h / serialappl.c#

This module implements the handling of the Serial API protocol, which involves parsing the frames, calling the appropriate Z Wave API library functions, returning results, and so on to the PC. Enable/disable support of a given Serial API function in serialappl.h header file.

Supported.bat#

Batch file called by Makefile.common_ZW0x0x_supported_function to obtain delayed environment variable expansion when using SET in DOS prompt.