Digi XBee Zigbee Cloud Kit Getting Started Manual
  1. Manuals
  2. Brands
  3. Digi Manuals
  4. Microcontrollers
  5. XBee ZigBee Cloud Kit
  6. Getting started manual

Digi XBee Zigbee Cloud Kit Getting Started Manual

Hide thumbs Also See for XBee Zigbee Cloud Kit:
Table of Contents

Advertisement

Quick Links

Download this manual
XBee Zigbee Cloud Kit
Getting Started Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XBee Zigbee Cloud Kit and is the answer not in the manual?

Questions and answers

Related Manuals for Digi XBee Zigbee Cloud Kit

Summary of Contents for Digi XBee Zigbee Cloud Kit

  • Page 1 XBee Zigbee Cloud Kit Getting Started Guide...
  • Page 2 Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose.
  • Page 3 Digi Technical Support: Digi offers multiple technical support plans and service packages to help our customers get the most out of their Digi product. For information on Technical Support plans and pricing, contact us at +1 952.912.3444 or visit us at www.digi.com/support.

  • Page 4: Table Of Contents

    Connect to a Wi-Fi network Connect to an Ethernet network Create a Remote Manager account Add your XBee Gateway to Remote Manager Log onto the XBee Zigbee Cloud Kit web application Hardware Development board components XBee Zigbee/Wi-Fi DIP switches on the XBee development board...
  • Page 5 Configure Zigbee nodes with custom PAN ID Create custom applications with the XBee Zigbee Cloud Kit Create your own applications XBee Zigbee Cloud Kit Examples Connect your application to Remote Manager Collaborate and share your story Troubleshoot your XBee Zigbee Cloud Kit...

  • Page 6: Xbee Zigbee Cloud Kit Getting Started Guide

    The XBee Zigbee Cloud Kit provides the foundation you need to get started working with XBee devices using the Zigbee protocol, and build cloud-connected prototypes quickly. This guide describes how to get started with your XBee Zigbee Cloud Kit. This guide is intended for a developer or programmer.

  • Page 7: Get Started

    If you already have a Remote Manager account, you can skip this step. Add your XBee Gateway to Remote Manager The graphic below shows the flow of information between the XBee Zigbee Cloud Kit components. XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 8: Verify Xbee Zigbee Cloud Kit Components

    View and customize widgets and development board components Join your XBee node to the Gateway network Create custom applications with the XBee Zigbee Cloud Kit Need more help? Find additional product support at www.digi.com/support/ZigbeeCloudKit. Verify XBee Zigbee Cloud Kit components Verify that you have all included equipment.
  • Page 9 Get started Verify XBee Zigbee Cloud Kit components Part Description Loose components Development board Battery holder USB cable XBee module XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 10: Required Additional Equipment

    2. Optional: If you are using an Ethernet network connection in addition to Wi-Fi, connect one end of the Ethernet cable to your gateway and the other to a live Ethernet jack. 3. The start up sequence that occurs after power is applied is as follows: XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 11: Connect The Xbee Module And Development Board Hardware

    Connect to a Wi-Fi network Before you begin, check with your network administrator on the Wi-Fi security mode and associated parameters for your network, including any passphrase or key used to connect to your Wi-Fi access XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 12: Connect To An Ethernet Network

    If the Ethernet network does not come up, see Troubleshoot your XBee Zigbee Cloud Kit. Create a Remote Manager account To use the features of the XBee Zigbee Cloud Kit web application, you must have a Remote Manager account. XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 13: Add Your Xbee Gateway To Remote Manager

    4. Click Add New Device. The Add a New Gateway to your Account page appears. 5. Type the serial number and a name or description for your XBee Gateway. You can find the serial number on the label attached to XBee Gateway, as shown below. XBee Zigbee Cloud Kit Getting Started Guide...
  • Page 14 XBee? to locate the device and see Join your XBee node to the Gateway network for more detailed troubleshooting instructions. The application checks the XBee module's configuration to make sure it can communicate with XBee Gateway. XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 15: Log Onto The Xbee Zigbee Cloud Kit Web Application

    10. Click Create Dashboard. The dashboard appears. Log onto the XBee Zigbee Cloud Kit web application You use the XBee Zigbee Cloud Kit web application to mange the XBee Zigbee Cloud Kit data. Note The web application and Remote Manager use the same user name and password, so you must create a Remote Manager account before you can log in to the web application.
  • Page 16 1. From a web browser, go to the XBee Zigbee Cloud Kit login page. 2. Type the user name and password that you created in Create a Remote Manager account. 3. Click Log in. XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 17: Hardware

    Hardware Development board components XBee Zigbee/Wi-Fi DIP switches on the XBee development board XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 18: Development Board Components

    This section contains information about the components on the development board. The table below contains an alphabetized list of the components on the board. Item Description Accelerometer The accelerometer drives the Tilt widget. You can control the accelerometer through the XBee Zigbee dashboard. XBee Zigbee Cloud Kit Getting Started Guide...
  • Page 19 The device is properly synchronized with blinking the network. (250 ms blink time) The device is in a low power mode. On, solid The device has not synchronized or has lost synchronization with the network. XBee Zigbee Cloud Kit Getting Started Guide...
  • Page 20 Breadboard Buzzer You can use the buzzer as an alarm to indicate trouble. You can control the buzzer through the XBee Zigbee dashboard. Use the buzzer toggle widget to turn the buzzer on/off. XBee Zigbee Cloud Kit Getting Started Guide...
  • Page 21 All devices that receive this transmission blink their Associate LED rapidly for one second. All devices in API operating mode that receive this transmission send a Node Identification Indicator frame (0x95) out their UART. XBee Zigbee Cloud Kit Getting Started Guide...
  • Page 22 (NI command), and other relevant data. All devices in API operating mode that receive the Node Identification Indicator frame send it out their UART as a Node Identification Indicator frame. XBee Zigbee Cloud Kit Getting Started Guide...
  • Page 23 You can use the USB jack to power the development board. The USB jack also provides serial port access to the XBee Zigbee for configuration or sending and receiving data to and from Remote Manager. XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 24: Xbee Zigbee/Wi-Fi Dip Switches On The Xbee Development Board

    XBee Zigbee/Wi-Fi DIP switches on the XBee development board The XBee development board in the XBee Zigbee Cloud Kit has three DIP switches on the back of the board. These switches set the board for use with XBee Zigbee or XBee Wi-Fi modules. A table on the board shows the proper switch settings for XBee Zigbee and XBee Wi-Fi modules and is shown in the following figure.
  • Page 25 Hardware XBee Zigbee/Wi-Fi DIP switches on the XBee development board XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 26: View The Device Data

    View the device data The XBee Zigbee Cloud Kit allows you to view and customize widgets for built-in components on the development board. View device data and events in the log file for XBee Gateway The XBee Gateway Python application resides on XBee Zigbee. Its key functions include connecting your XBee modules to Remote Manager, enabling uploads of data to Remote Manager, and receiving remote text and commands.
  • Page 27 4 19:44:06 (none) local7.info pylog: 2014-08-04 19:44:06,934 INFO xbgw.xbee.ddo_manager: Initializing DDOEventManager 4 19:44:07 (none) local7.info pylog: 2014-08-04 19:44:07,030 INFO xbgw.reporting.device_cloud: Initializing DeviceCloudReporter 4 19:44:07 (none) local7.info pylog: 2014-08-04 19:44:07,072 INFO xbgw.command.rci: RCICommandProcessor initialized XBee Zigbee Cloud Kit Getting Started Guide...
  • Page 28 These lines show an analog I/O reading received by the XBee Gateway application: 4 19:47:38 (none) local7.info pylog: 2014-08-04 19:47:38,610 DEBUG xbgw.xbee.manager: Processing IO sample from pin AD3 4 19:47:38 (none) local7.info pylog: 2014-08-04 19:47:38,620 DEBUG xbgw.xbee.manager: Analog data: 780 XBee Zigbee Cloud Kit Getting Started Guide...
  • Page 29 4 19:47:44 (none) local7.info pylog: 2014-08-04 19:47:44,332 DEBUG xbgw.reporting.device_cloud: stream_id: xbee.analog/ [00:13:A2:00:40:9F:6F:CB]!/AD2 4 19:47:44 (none) local7.info pylog: 2014-08-04 19:47:44,337 DEBUG xbgw.reporting.device_cloud: data: ('xbee.analog/ [00:13:A2:00:40:9F:6F:CB]!/AD2', 780, {}) 4 19:47:44 (none) local7.info pylog: 2014-08-04 19:47:44,354 INFO xbgw.reporting.device_cloud: Upload contains 6 datapoints XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 30: View Device Data From Remote Manager

    Device data or third party dashboards The XBee Zigbee Cloud Kit web application is available for viewing device data on Remote Manager. If you want to create your own dashboard or use a third-party dashboard instead, refer to the...

  • Page 31: View And Customize Widgets And Development Board Components

    View and customize widgets and development board components The XBee Zigbee Cloud Kit allows you to view and customize widgets for built-in components on the development board. The widgets represent elements of the XBee module on your device hardware. The data for those elements is represented in graphical form as a dashboard in the XBee Zigbee Cloud Kit web application.
  • Page 32 XBee and potential throttling of data by Remote Manager. If you notice that changes made on the development board are not reflected on the dashboard, refresh the web page and try again. XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 33: Add And Customize A Progress Bar Widget

    The Serial Data widget displays the serial data: Add and customize a progress bar widget There are a variety of widgets that you can use to customize your dashboard. The following example shows how to add a progress bar widget. XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 34: Configure A Widget On The Dashboard

    Input Stream setting, renamed to clarify the use of the stream.) Specifies the digital I/O pin (DIO#) on the XBee module to which Output Stream the widget sends its output values. XBee Zigbee Cloud Kit Getting Started Guide...
  • Page 35 On position sends 1 and setting the switch to the Off position sends 0. Read Only Switch When you select this check box, the switch represents the data stream value last received from the server. XBee Zigbee Cloud Kit Getting Started Guide...
  • Page 36 D0 on the XBee module is set to act as a digital input.) Click this button to ensure that your XBee module is configured to work with your XBee Zigbee Cloud Kit. Provides available options for refreshing the list of XBee modules.

  • Page 37: Join Your Xbee Node To The Gateway Network

    Join your XBee node to the Gateway network If you do not see your XBee node in the list of devices in the XBee Zigbee Cloud Kit web application, your XBee node is not joined to the Gateway network started by XBee Zigbee. Use the following sections to join your node to your XBee Zigbee.

  • Page 38: Verify Your Radio Has Joined The Correct Network

    XCTU is in Configuration mode. 3. In the Radio Modules pane, click the entry for your radio. A dialog box displays the progress as the configuration is read from the radio. XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 39: Get The Pan Id And Other Network Parameters For The Zigbee Network

    Get the PAN ID and other network parameters for the Zigbee network Use the XBee Zigbee Cloud Kit web application to retrieve the PAN ID of the Zigbee network that you want to join. Zigbee networks are called personal area networks (PANs). Each network is defined with a unique PAN identifier (PAN ID), which is common among all devices of the same network.
  • Page 40 2. Open XCTU and add the XBee node that is connected to your computer to the list of radio modules. 3. Select the node and wait for the application to read all its settings. XBee Zigbee Cloud Kit Getting Started Guide...
  • Page 41 5. Click the Write radio settings button to save the new PAN ID in the XBee module As soon as you save the new PAN ID in the XBee RF module, the module tries to connect to the Zigbee network that has the PAN ID that you configured. XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 42: Create Custom Applications With The Xbee Zigbee Cloud Kit

    XBee Zigbee Cloud Kit Examples Digi provides a number of examples to help you make use of your kit and the XBee Zigbee Cloud Kit web application. See the following resources: Examples & Guides...

  • Page 43: Collaborate And Share Your Story

    Monitoring data streams with a TCP or HTTP monitor. You can find more information about monitoring data streams by reading documentation about monitors. You also have access to various client libraries for the TCP Remote Manager monitors made available from the Digi International github account. The links to these libraries are located below:...

  • Page 44: Troubleshoot Your Xbee Zigbee Cloud Kit

    Troubleshoot your XBee Zigbee Cloud Kit This section covers common issues and troubleshooting information for your XBee Zigbee Cloud Kit. XBee Gateway fails to connect XBee Gateway fails to connect to and communicate with Remote Manager. Kit component: XBee Gateway Potential cause XBee Gateway is not configured properly.

  • Page 45: Xbee Module Fails To Join The Network

    Remote Manager. 2. Type your user name and password and click Log in. 3. Under the Device Management tab, right-click the device you want to delete and select Remove Devices from the list. XBee Zigbee Cloud Kit Getting Started Guide...

  • Page 46: Development Board Changes Are Not Reflected On The Dashboard

    Potential cause Web browser incompatibility. Resolution Try using a different web browser. The recommended web browsers for the XBee Zigbee Cloud Kit web application include Firefox and Google Chrome. Potential cause The development board may not be properly set for operation with an XBee Zigbee module.

  • Page 47: Data Does Not Display The Dashboard Or Remote Manager

    Data does not display the dashboard or Remote Manager Data does not display the dashboard or Remote Manager Data is not appearing in the XBee Zigbee Cloud Kit dashboard or Remote Manager. Kit component: Data from the XBee nodes Potential cause The XBee Gateway application is not running, or is not loaded, on XBee Gateway.

This manual is also suitable for:

Xka2c-z7t-u

Table of Contents