APPLICATION NOTE AVR2052: BitCloud SDK Quick Start Guide Atmel MCU Wireless Introduction This document is intended as a starting point for software engineers prototyping, implementing, testing, and deploying ZigBee Home Automation (ZHA), ZigBee Light Link (ZLL), and OEM ZigBee PRO devices based on the Atmel BitCloud software platform 1 . The BitCloud Software Development Kit (SDK) provides a complete set of tools including BitCloud ZigBee PRO libraries, reference applications, API documentation, required to build ZigBee-compliant end products running customized ZHA and ZLL applications. This document describes how to quickly start with the BitCloud SDK by installing development environment, assembling hardware and programming devices with reference applications. Chapter 1 provides an overview of the SDK, required development tools, and lists supported platforms. Chapter 2 describes the documentation set available for BitCloud SDK. Chapter 3 gives instructions on SDK and tools development tools setup. Chapter 4 describes how to build BitCloud application using supported IDEs. Chapters 5, 6, and 7 provide description of ZLL, ZHA, and WSNDemo reference applications supplied with the SDK. Starting from Appendix A the hardware specific part of the document begins. Each next appendix chapter describes the usage of a particular platform. Features Introduction to BitCloud Software Development Kit (BitCloud SDK) 1 Description of SDK contents Development tools installation procedure Application build process Description of reference applications ZHADevices ZigBee Home Automation devices ZLLDemo ZigBee Light Link devices WSNDemo OEM ZigBee devices 8200Q MCU 02/2015 Table of Contents Table of Contents .................................................................................... 2 1. Overview ............................................................................................ 4 1.1 BitCloud SDK .................................................................................................... 4 1.2 Development Tools ........................................................................................... 4 1.3 Supported Hardware Platforms and IDEs ......................................................... 5 2. BitCloud Documentation .................................................................... 6 2.1 Learning BitCloud .............................................................................................. 7 3. Development Environment Setup ....................................................... 8 3.1 Installing the BitCloud SDK ............................................................................... 8 3.1.2 Serial and OTAU Bootloader Setup .................................................... 9 3.2 IDE Installation .................................................................................................. 9 3.2.1 Atmel Studio ....................................................................................... 9 3.2.2 IAR Embedded Workbench .............................................................. 10 3.3 Hardware Configuration .................................................................................. 10 4. Building BitCloud Applications .......................................................... 11 4.1 Building Applications in Atmel Studio .............................................................. 11 4.2 Building Applications in IAR Embedded Workbench ....................................... 12 4.3 Makefiles Organization .................................................................................... 13 4.3.2 Low-level Makefile Name Structure .................................................. 14 5. ZigBee Light Link Reference Application .......................................... 15 5.2 Launching the Demo ....................................................................................... 15 5.3 Supported Clusters ......................................................................................... 16 5.4 Source Code Organization .............................................................................. 17 5.4.1 Application Configuration .................................................................. 17 5.5 Serial Console Commands ............................................................................. 18 5.6 Lights Functions ............................................................................................. 20 5.6.1 Reset Light to the Factory New State ............................................... 21 5.6.2 Use of On-board Peripherals ............................................................ 21 5.7 Bridges Functions ........................................................................................... 22 5.7.1 Network Joining ................................................................................ 23 5.7.2 Light Discovery and Control .............................................................. 23 5.7.3 SLRemote GUI ................................................................................. 23 5.8 Color Scene Controllers Functions ................................................................. 24 5.8.1 Touchlink / Network Joining .............................................................. 24 5.8.2 Use of On-board Peripherals ............................................................ 25 5.8.2.2 LCD Screen Output on Key Remote Control................... 25 5.8.2.3 Button Functionality on Key Remote Board .................... 26 5.9 Over-the-Air Firmware Update ........................................................................ 29 5.9.1 OTAU Configuration for ZLL Bridge .................................................. 29 5.9.2 OTAU Configuration for ZLL Light and Controller ............................. 29 5.9.3 OTAU Procedure .............................................................................. 29 5.10 Interoperability with ZHA Networks ................................................................. 31 5.11 Running Certification Test Scripts ................................................................... 31 5.11.1 Prerequisites ..................................................................................... 31 5.11.2 WSNRunner Setup ........................................................................... 31 5.11.3 Run a Script from the Command Line ............................................... 32 6. ZigBee Home Automation Reference Application ............................. 33 6.1 Launching the Demo ....................................................................................... 33 6.2 Supported Clusters ......................................................................................... 34 6.3 Source Code Organization .............................................................................. 35 2 AVR2052: BitCloud SDK Quick Start Guide APPLICATION NOTE 8200Q MCU02/2015