ZigBee

ZigBee Home Automation (HA) is a global standard for the flexible control of appliances in the home, including lights, heaters, curtains, blinds and door-locks. Appliances can be controlled wirelessly from a wide range of devices, such as switches, sensors, remote control units, mobile phones and computers. ZigBee HA can be used to equip the home with innovative functionality, allowing fully integrated control through existing consumer technology such as smart phones, tablets and laptops. A ZigBee HA system is implemented in the home using the ZigBee PRO protocol with the ZigBee Home Automation application profile.

NXP® provide a complete ZigBee Home Automation software solution for the JN5169 and JN5168 microcontrollers, including the ZigBee PRO protocol, HA application profile, ZigBee Cluster Library (ZCL) and JenOS (Jennic Operating System). A ZigBee Home Automation solution may use HA-specific 'clusters' from the HA profile and general clusters from the ZCL.

Home Automation Software

ZigBee PRO with the Home Automation profile is available for the JN5169 and JN5168 microcontrollers. The protocol, profile and associated support software are supplied in the following Software Developer's Kit (SDK):

The above SDK must be installed on top of the BeyondStudio for NXP toolchain (JN-SW-4141). Installation instructions are provided in the BeyondStudio for NXP Installation and User Guide (JN-UG-3098).

ZigBee Home Automation demonstration applications are provided and described in Application Notes (see below). These demonstrations can be programmed into and run on the boards of the JN516x-EK001 or JN516x-EK004 Evaluation Kit.

Software, Documentation and Support Resources

A wide range of user resources are provided to aid in the development of custom HA solutions, including an SDK, User Guides and Application Notes. Those resources that are relevant to HA are listed below.

Hardware-related resources can be found on the Support Resources for JN516x MCUs page

Legacy software is listed at the bottom of the page.

Part Number Title Description Version
Software
JN-SW-4168 JN516x ZigBee Home Automation SDK Software for the development of ZigBee PRO wireless network applications based on the Home Automation (HA) profile for JN516x devices. Also supports the ZigBee Light Link (ZLL) profile. Must be installed on top of the BeyondStudio for NXP toolchain. For details, refer to the Release Notes. 1620
JN-SW-4141 BeyondStudio for NXP Toolchain for developing JN516x applications. For details, refer to the Release Notes and User Guide JN-UG-3098. 1308
JN-SW-4107 JN51xx Production Flash Programmer Utility for loading built applications into JN51xx in a production environment. For details, refer to the Release Notes and User Guide JN-UG-3099. 1365
User Guides
JN-UG-3075 JenOS User Guide Details the JenOS APIs used in ZigBee PRO application code to manage OS resources. 1.8
JN-UG-3076 ZigBee Home Automation User Guide Introduces ZigBee Home Automation (HA) and details the HA API for developing applications. 1.4
JN-UG-3081 JET User Guide Describes the JN51xx Encryption Tool (JET) used to produce encrypted and/or merged application binary files. 1.7
JN-UG-3095 ZigBee Green Power User Guide Describes the use of ZigBee Green Power (GP) for Home Automation applications on the JN516x microcontrollers. 1.4
JN-UG-3098 BeyondStudio for NXP Installation and User Guide Describes the installation and operation of BeyondStudio for NXP (JN-SW-4141). Also covers JN516x SDK installation. 1.2
JN-UG-3101 ZigBee PRO Stack User Guide (for HA/ZLL) Introduces essential ZigBee PRO concepts and details the ZigBee PRO APIs for developing HA and ZLL applications. 1.5
JN-UG-3103 ZigBee Cluster Library User Guide (for HA/ZLL) Describes the NXP implementation of the ZigBee Cluster Library (ZCL) for the HA and ZLL profiles. 1.4
Application Notes
JN-AN-1172 JN516x Customer Module Evaluation Tool Provides and describes a tool which can be used to place the JN516x microcontroller into a number of test modes that enable measurement of module performance. 1.6
JN-AN-1175 Packet Error Rate Testing for JN516x Provides and describes Packet Error Rate (PER) testing software that can be used on boards from a JN516x evaluation kit. 1.2
JN-AN-1184 ZigBee PRO Application Template for JN516x Provides a set of ZigBee PRO application code templates that are profile-independent and can be used as a basis for ZigBee PRO application development for the JN516x devices. 1620
JN-AN-1189 ZigBee Home Automation Demonstration Application Note Provides and describes an example Home Automation application that can be run on the JN516x-EK001 Evaluation Kit. 1.15
JN-AN-1193 JN516x Lauterbach JTAG Debugger Details the configuration of a debug environment for code running on a JN516x device using a Lauterbach JTAG Debugger. 1.4
JN-AN-1194 ZigBee IoT Gateway Application Note Provides information and software for developing a custom IoT Gateway which interfaces the WPAN of a ZigBee system to a LAN/WAN. This Application Note is now frozen and has been replaced with JN-AN-1222 and JN-AN-1223. 2.1
JN-AN-1201 ZigBee HA Intruder Alarm System Application Note Demonstrates a ZigBee network which employs Intruder Alarm System (IAS) devices from the Home Automation profile. 2.1
JN-AN-1202 BeyondStudio Migration Guidelines Provides guidance on migrating existing JN516x projects to BeyondStudio for NXP. 1.1
JN-AN-1203 JN516x JTAG Debugging in BeyondStudio Describes use of the JTAG debugging features of the JN516x devices via the BeyondStudio for NXP software tool. 1.2
JN-AN-1221 ZigBee HA Lighting with NFC Provides and describes an example Home Automation application that can be run on the JN516x-EK004 Evaluation Kit. This example employs NFC commissioning and IoT connectivity. 1.2
JN-AN-1222 ZigBee IoT Gateway Host with NFC Details the hardware and software required to implement the Host part of a ZigBee IoT Gateway with NFC functionality, using the components of the JN516x-EK004 Evaluation Kit. 2006
JN-AN-1223 ZigBee IoT Gateway Control Bridge Illustrates control of the ZigBee Control Bridge part of an IoT Gateway from a graphical interface application running on a PC. 1014
Related Documentation
JN5169 JN5169 Datasheet Details the JN5169 microcontroller 1
JN5169M0x JN5169-001-M0x-2 Datasheet Details the JN5169-001-M0x series of modules 3.0
JN-DS-JN516x JN516x Datasheet Details the JN516x series of microcontrollers. 1.3
JN-DS-JN5168-001-MO JN5168-001-Myy Datasheet Details the JN5168-001-Myy series of modules. 1.4
JN-RM-2003 LPRF Board API Reference Manual Details the Board API, used in application code to interact with components on the boards supplied in an evaluation kit. 2.4
JN-UG-3087 JN516x Integrated Peripherals API User Guide Details the JN516x Integrated Peripherals API, used in application code to interact with JN516x on-chip peripherals. 1.5
JN-UG-3093 JN516x-EK001 Evaluation Kit User Guide Describes the contents of this JN516x evaluation kit, and how to set up and run the pre-loaded demonstration. 1.5
JN-UG-3099 JN51xx Production Flash Programmer User Guide Describes use of the JN51xx Production Flash Programmer (JN-SW-4107). 1.1
JN-UG-3108 JN516x-EK004 Evaluation Kit User Guide Describes the contents of the JN516x-EK004 Evaluation Kit, and how to set up and run the pre-loaded demonstration. 2.0

Legacy Software

The software required to develop JN516x ZigBee Home Automation applications using the former Eclipse-based toolchain (JN-SW-4041) is listed and described below. This is not recommended for new designs.

Part Number Title Description Version
JN-SW-4041 SDK Toolchain Toolchain for developing JN516x applications. 1.1
JN-SW-4067 JN516x ZigBee Home Automation SDK Software for the development of ZigBee PRO wireless network applications based on the Home Automation (HA) profile for JN516x devices. Must be installed on top of the JN51xx SDK Toolchain. 1108
JN-SW-4007 JN51xx Flash Programmer Utility for loading built applications into JN51xx Flash memory. 1.8.9