Appendix: Serial API Files#

Current SDKs#

This appendix describes files from legacy Z-Wave SDK releases. The embedded Serial API sample source code was distributed through SDK 6.81.x. Starting with SDK 7.00, Silicon Labs distributed the Serial API firmware as binaries. Therefore, the following makefiles, batch scripts, and source-file descriptions do not reflect the current development workflow.

For new development with the Simplicity SDK and Z-Wave SDK 8.1.x, use the NCP Serial API Controller application included with the SDK and follow the current Z-Wave documentation. The Simplicity SDK 8.1.x release stream is intended for Series 800 devices. Do not use this appendix as a guide for Series 500 or 700 development.

The Serial API protocol information in this guide remains useful as general background, but the commands available to a host depend on the firmware running on the device. Query the controller's Serial API version and supported-function capabilities, and consult the Z-Wave Host API Specification pdf and release notes for version-specific details.

Legacy SDK files#

The following descriptions apply to the legacy ProductPlus\\SerialAPIPlus sample application. They are retained for readers maintaining older projects; these files and build steps are not instructions for SDK 8.1.x.

  • MK.BAT builds the sample application. The legacy script accepted FREQUENCY=EU to build for the EU frequency.

  • Makefile defines the sample application's build targets.

  • Makefile.common_ZW0x0x_supported_functions generates a text file listing the Serial API functions supported by a target.

  • app_version.h contains application version definitions.

  • config_app.h contains Manufacturer-Specific Command Class and security settings.

  • conhandle.h / conhandle.c implement Serial API frame handling between the PC and Z-Wave module.

  • eeprom.h / eeprom.c define the legacy NVM layout.

  • make-supported-functions-include.bat and Supported.bat are Windows batch scripts used by the legacy build to generate Serial API function definitions.

  • Prodtest_vars.c contains memory variables used by production testing.

  • serialapi-supported-func-list.txt is a template for generating supported-function definitions.

  • serialappl.h / serialappl.c implement Serial API frame parsing, dispatch to Z-Wave API functions, and response handling.

Changing function IDs or frame formats in legacy Serial API firmware can cause interoperability problems with host software and tools built for a different Serial API implementation. Determine the firmware's actual Serial API version and capabilities rather than assuming they match this guide.