How it Works
CYAN
Loading...
Gateway Evaluation
User Manual
40 pgs4.95 Mb0
Table of contents
Loading...

CYAN Gateway Evaluation User Manual

Gateway Evaluation Kit
for ZigBee
Getting Started Guide
V1.1
11 March 2009
11 March 2009 Cyan Technology Ltd.
Confidential and Proprietary Information
©Cyan Technology Ltd., 2009
This document contains confidential and proprietary information of Cyan Technology Ltd and is protected by copyright laws. Its receipt or possession does not convey any rights to reproduce, manufacture, use or sell anything based on information contained within this document.
Cyan Technology Holdings Ltd. CyanIDE Technology Ltd recognises other brand and product names as trademarks or registered trademarks of their respective holders.
Any product described in this document is subject to continuous developments and improvements. All particulars of the product and its use contained in this document are given by Cyan Technology Ltd in good faith. However, all warranties implied or expressed, including but not limited to implied warranties of merchantability, or fitness for purpose, are excluded.
This document is intended only to assist the reader in the use of the product. Cyan Technology Ltd shall not be liable for any loss or damage arising from the use of any information in this guide, any error or omission in such information, or any incorrect use of the product.
TM
, the Cyan Technology logo and Max-eICETM are trademarks of Cyan
®
and eCOG® are registered trademarks of Cyan Holdings Ltd. Cyan
This product is not designed or intended to be used for on-line control of aircraft, aircraft navigation or communications systems or in air traffic control applications or in the design, construction, operation or maintenance of any nuclear facility, or for any medical use related to either life support equipment or any other life-critical application. Cyan Technology Ltd specifically disclaims any express or implied warranty of fitness for any or all of such uses. Ask your sales representative for details.
11 March 2009 Cyan Technology Ltd. Page 2
Revision History
Version Date Notes
V1.0 03/02/2009 First release.
V1.1 11/03/2009 Updated references to FAT file system and USB memory
11 March 2009 Cyan Technology Ltd. Page 3
Contents
1 Introduction.......................................................................................... 6
2 PC and Cable Requirements ............................................................... 7
3 Installation of CyanIDE 2 ..................................................................... 8
3.1 CyanIDE 2 Version Notes.......................................................................... 8
3.2 Installation Notes ....................................................................................... 8
4 Connecting-Up..................................................................................... 9
4.1 Target System Connections ...................................................................... 9
4.2 Target Power ............................................................................................. 9
4.3 Connection Overview Diagrams .............................................................. 10
5 Summary of Example Projects .......................................................... 11
6 ZigBee Example Projects .................................................................. 12
6.1 Overview.................................................................................................. 12
6.1.1 Radio Module ................................................................................... 12
6.1.2 Projects Summary ............................................................................ 12
6.1.3 Using Two Gateways - System Overview......................................... 12
6.1.4 Antenna Fitting Note......................................................................... 12
7 Meter and Concentrator Example Projects........................................ 13
7.1 Overview.................................................................................................. 13
7.2 Steps / Procedure.................................................................................... 13
7.3 eICE Adaptors – ID and Firmware Version check ................................... 14
7.4 Create and Build the Meter Example Project 1 ....................................... 17
7.4.1 Connect-up and Invoke CyanIDE ..................................................... 17
7.4.2 Create the Meter Project .................................................................. 17
7.4.3 Build the Project ............................................................................... 19
7.4.4 Determine the Serial Configuration .................................................. 20
7.4.5 Invoke the Terminal Emulator........................................................... 20
7.4.6 Download and Run the Meter Project to ‘main’ ................................ 21
7.4.7 Run to Output Project Title ............................................................... 22
7.5 Create and Build the Concentrator Example Project 2............................ 23
7.5.1 Connect-up, and Invoke CyanIDE 2 ................................................. 23
7.5.2 Create the Concentrator Project....................................................... 23
7.5.3 Build the Project ............................................................................... 24
7.5.4 Determine the Serial Configuration .................................................. 25
7.5.5 Invoke the Terminal Emulator........................................................... 25
11 March 2009 Cyan Technology Ltd. Page 4
7.5.6 Download and Run the Concentrator Project to ‘main’..................... 25
7.5.7 Run to Output Project Title ............................................................... 26
7.6 Resume the Projects ............................................................................... 27
7.7 Terminate and Close ............................................................................... 28
8 Gateway Embedded Web Server Example Project ........................... 30
8.1 Overview and Assumptions ..................................................................... 30
8.2 Create and Build the Gateway Project .................................................... 30
8.3 PC Network Configuration ....................................................................... 31
8.4 Terminal Emulator ................................................................................... 32
8.5 Download and Execute............................................................................ 32
8.6 Run the Meter Emulator Project .............................................................. 32
8.7 Display Web page ................................................................................... 33
8.8 Terminate and Close ............................................................................... 33
8.9 Changing the Web Page Data................................................................. 34
9 Sink Example Project ........................................................................ 35
9.1 System Overview and Assumptions ........................................................ 35
9.2 Create and Build the Sink Project............................................................ 36
9.3 Terminal Emulator ................................................................................... 36
9.4 Download and Execute............................................................................ 37
9.5 Connect the Ember EM260 SPI/UART Breakout board .......................... 37
9.6 Terminate and Close ............................................................................... 37
Appendix A eICE Adaptor (Dongle) Update / ID Setting........................ 38
Appendix B Ember EM260 Breakout Board .......................................... 40
11 March 2009 Cyan Technology Ltd. Page 5

1 Introduction

The Gateway Evaluation kit is a development environment for wired-to-wireless connectivity applications. The kit includes the following:
• Gateway board (motherboard) with USB & Ethernet connectors
• A radio module (daughter board) – which is radio-standard-specific
• Embedded software development suite, CyanIDE 2
• Debug adaptor (to provide the MCU debug connection for the CyanIDE 2 debugger)
The development kit provides a fast-start for OEMs wishing to implement and integrate USB, Ethernet, and other wired communication functionality, into their products.
Different or new radio standards can be accommodated by changing the radio daughter board and a firmware update.
CyanIDE 2 includes radio-specific software peripherals to enable rapid switching over to different radio standards (for example, from Wireless MBus to ZigBee).
Gateway Board
Radio Modules
Wireless
M-BUS
CyNet3
ZigBee
Module versions of the evaluation kit, which plug into the OEM’s proprietary motherboard, are available for requirements where further access to microcontroller device pins is needed.
High-volume OEMs wishing to integrate and modify the gateway board circuitry (for example, to support multiple/emerging/proprietary radio standards) should contact Cyan for a manufacturing package.
Cyan supplies microcontrollers, board-level gateway products (with RF according to the wireless standard), s/w protocol stacks, and low-cost development tools/boards.
11 March 2009 Cyan Technology Ltd. Page 6

2 PC and Cable Requirements

These notes guide first-time users through:
• Installation of CyanIDE 2.
• Connecting-up the gateway board, the eICE debug adaptor and the PC.
• Selecting an example project, building and downloading the application, and running
the demonstration.
CyanIDE 2 installs on a PC running Windows XP or Vista. The PC must have the following available:
• 1GB of free disk space.
• CD-ROM drive.
• One Ethernet port (for use in example projects).
• Two USB ports (one for connecting the eICE debug adaptor, one for use in example
projects).
• A serial port or an additional USB port with a USB-serial converter cable (to display “printf” status/debug messages from example projects) – ideally one per each gateway board being used.
The use of a powered USB hub is suggested.
The PC should also have installed:
• Internet Browser.
• Adobe Reader.
• Terminal Emulator program.
• WinZip (or similar, to unzip files).
In order to run the example projects, the following may also be required:
• 5V PSU. (Optional, if the supply from the eICE debug adaptor, itself USB-powered, is not sufficient. This may exhibit itself by a failure of the debugger at download time.)
• Ethernet cable (for gateway board to PC connection).
• USB flash drive (for the embedded web server projects).
• USB adaptor cable to allow the USB flash drive to be connected to the USB peripheral
connector on the gateway board.
11 March 2009 Cyan Technology Ltd. Page 7

3 Installation of CyanIDE 2

3.1 CyanIDE 2 Version Notes

The Gateway Evaluation kit requires CyanIDE 2.1.1 or a later version. CyanIDE is supplied on the CD included in the kit.
The CD contains the complete suite of software development tools for Cyan microcontrollers and full documentation on the development kit boards.
Cyan does not release patches but releases complete updated versions of CyanIDE. These are made available for download on the Cyan website. Developers should regularly check the Cyan web site for the latest version.

3.2 Installation Notes

Insert the CD in the drive and it should autoplay.
If it does not, then go to My Computer, right-click on Devices with Removable Storage and select Autoplay.
Follow the prompts to install CyanIDE.
(A previous installation of CyanIDE 1.4 can co-exist with CyanIDE 2.1.1. A previous installation of an earlier version of CyanIDE 2 can co-exist with CyanIDE 2.1.1.)
IMPORTANT: Close all other applications before starting set-up.
11 March 2009 Cyan Technology Ltd. Page 8

4 Connecting-Up

The target system is shown, in diagram form, for reference at the end of this section. The diagrams may be useful when following the instructions below.

4.1 Target System Connections

Connect-up as follows:
1. Fit the radio module to the gateway board.
a. The radio module plugs into the two 16-pin headers.
b. The antenna connector is adjacent to the 10-way debug connector.
2. Connect the eICE adaptor to the gateway board using the ribbon cable.
3. Connect the eICE adaptor to the USB cable (for connecting to the PC) – DO NOT CONNECT THE USB CABLE TO THE PC AT THIS TIME.
4. If an example project is to be run, the “printf” status/debug messages (displayed using a terminal emulator) are required. Connect a 3-way serial cable to J10 on the gateway board:
a. If using the 3-way cable from the Cyan Cable kit, pin 1 is indicated by the arrow
on the moulding of the connector. Pin 1 on the board header is nearest the debug connector – see diagram below.
b. This cable should be connected to the PC serial port, or to a USB-Serial
converter (if the PC has USB but no serial ports).
(The COM port number should be noted for setting-up the terminal emulator; to check the port number, at the control panel, select: System->Hardware->Device Manager->Ports (COM&LPT) )
5. Connect the antenna to the radio module.
6. Check all connections are made, then connect the USB cable from the eICE adaptor to the PC. This powers-up the target system.

4.2 Target Power

The gateway board is powered from the eICE debug adaptor, which in turn is powered from the PC USB port.
If the supply from the eICE adaptor is not sufficient to drive the gateway board, an external 5V power supply may be used. Simply connect the external supply to the d.c. jack on the gateway board. The on-board circuitry includes blocking diodes which eliminate the need for supply changeover links.
If the eICE adaptor is connected to the PC via a USB hub and does not connect reliably to the target gateway, then check the power supply voltage. A USB hub powered by a separate PSU is recommended.
Note: the module version of the gateway board, which plugs into the customer’s main board, requires a 3.3V supply connected through the module daughter board pin headers. A “gateway module” has pin headers on the underside to allow it to plug into a motherboard. A “gateway board” is for stand-alone use.
11 March 2009 Cyan Technology Ltd. Page 9
p

4.3 Connection Overview Diagrams

Radio
Module
Socket
USB
Ethernet
3-way Serial Lead
(for “printf” status
messages/ debugging)
System Connection Overview
eICE Adaptor
(also known
as “dongle”)
To PC
Pin3
Pin1
ZigBee
Radio
Module
Module / Antenna Connection
Shrink
wra
To PC
3-way Serial Cable (as in Cyan Cable kit) – Connector Close-up View
11 March 2009 Cyan Technology Ltd. Page 10

5 Summary of Example Projects

Built into CyanIDE 2 are example projects for the Gateway, including:
• Basic Ethernet and USB demo projects.
• USB peripheral, host and mass storage applications.
• TCP/IP examples using the open source uIP stack, including:
o Embedded webserver, FTP, FAT filing system.
• Cyan Cy-Net 3, a wireless mesh network protocol, using an ISM-band Micrel MICRF6x0 RF transceiver (requires an mCOG-RF-1X-M1 of the selected frequency).
• Wireless M-Bus, an industrial and utility metering radio protocol, using a Radiocrafts RC1180 module (requires an mCOG-RF-RCWMB).
• ZigBee utility metering example using an Ember EM260 device (requires an mCOG- RF-EMZ1-2).
Note: The Cyan mCOG-xxx radio modules are listed on www.cyantechnology.com
.
11 March 2009 Cyan Technology Ltd. Page 11

6 ZigBee Example Projects

6.1 Overview

6.1.1 Radio Module

It is assumed a ZigBee daughter board, an mCOG-RF-EMZ1-2 (using an Ember EM260), is fitted to the gateway board.

6.1.2 Projects Summary

CyanIDE 2 includes the following example projects:
• Concentrator – the gateway receives data over-the-air via the EM260
• Meter – the gateway sends data over-the-air via the EM260
• Gateway – data received via the EM260 is combined with an embedded web page and
served via Ethernet and TCP/IP to a PC browser
• Sink Demo – the gateway acts as a concentrator and receives over-the-air data from an Ember EM260 SPI/UART Breakout board fitted with an EM260 radio daughter board.
To demonstrate the Concentrator, Meter and Gateway projects requires two Cyan Gateway boards.
Further details on the Ember boards are in Appendix B.

6.1.3 Using Two Gateways - System Overview

The system comprises:
USB
EM260
Ethernet
eCOG
MCU
CyanIDE2
Meter
Project
serial
eICE
Adapto r 1
USB
EM260
Ethernet
eCOG
MCU
CyanIDE2
Concentrator
Project
serial
eICE
Adapto r 2
Gateway 1
ZigBee
Gateway 2
Gateway 1 linked via ZigBee to Gateway 2

6.1.4 Antenna Fitting Note

It is recommended appropriate antennas are fitted to both mCOG modules.
If no antennas are fitted, then the boards will have to be positioned very close together but a working system is not guaranteed.
11 March 2009 Cyan Technology Ltd. Page 12
Loading...
+ 28 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use