QB-Zigbee Zigbee Demo Kit Manual

Transcription

1 QB-Zigbee Zigbee Demo Kit Manual (Model : QB-ZI-DEMO100) Apr Copyright by Quantumbase Inc., All rights reserved.

2 Contents 1. ZIGBEE DEMO KIT ITEMS IN ZIGBEE DEMO KIT THE DEMO KIT INSTALLATION THE EXTERNAL PORT OF THE ZIGBEE INTERFACE BOARD HOW TO MAKE COMMUNICATION BETWEEN THE ZIGBEE DEMO KITS INSTALLATION OF VCP DRIVER FOR THE INTERFACE BOARD THE DEFINITION OF VCP INSTALLATION OF VCP DRIVER CONFIRMING THAT THE ZIGBEE INTERFACE BOARD IS READY TO WORK INSTALLATION OF ZIGBEE DEMONSTRATION PROGRAM RUNNING ZIGBEE DEMONSTRATION PROGRAM COM PORT CONNECTION TAB ZIGBEE CONFIGURATION TAB ZIGBEE DEMONSTRATION TAB (1) Sending a character string...22 (2) Remote selection of a list box item...23 (3) Audio Play control

3 1. Zigbee Demo Kit 1.1 Items in Zigbee Demo Kit Zigbee Modules (ZI-100AS) Antenna & antennal cable Zigbee Interface Board (QB-ZI-IB100) USB Cable Program CD ( Note : Two Zigbee demo kits are needed for a demonstration or development of a wireless communication system with ZI-100AS ) 1.2 The Demo Kit installation Fig. 1.1 shows the Zigbee Demo Kit after all items are installed. For your convenience, the antenna is connected to the zigbee module board with flexible 50ohm coaxial cable, so that it can be fixed on your own case or similar fastening. 2

4 Fig. 1.1 Zigbee Demo kit in ready for run Installation Procedure 1 Fig 1.2 shows the Zigbee Interface board, where the Zigbee module should be installed. Please mount your Zigbee module on the interface board by carefully inserting the 12pin header on the Zigbee module in to the 12pin header socket on the interface board as shown in Fig Pin header for the Zigbee module Fig 1.2 Zigbee Interface Board MMCX (Female) connector for the an antenna Fig. 1.3 Zigbee Module Installed Interface Board 3

5 2 Do you notice a MMCX female connector on your Zigbee module? Connect the MMCX male connector on the end of the antenna cable by pressing it vertically onto the female connector as shown in Fig ( Please note that you should firmly hold the Zigbee module when you install the antenna, otherwise the 12pin header might be broken ) Fig. 1.4 Antenna Installation 3 Set the STATUS(MODE) jumper to Operation to enable communication between ZI-100AS and Host as shown in Fig ( Please refer to 1.3 The External port of the Zigbee Interface board below for details ) 4

6 STATUS(MODE) TEST(3-2) OPERATION(2-1) RXD EXT(3-2) USB(2-1) TXD EXT(3-2) USB(2-1) PWR LED Fig. 1.5 STATUS(MODE) Jumper setting of Zigbee Interface Board 4 And then, connect mini-b type USB connector, at the top left of the Interface board, to your PC local host s USB port with the provided USB cable. 5 The power of the interface board is supplied from USB port. So, you can see the PWR LED light to indicate that the board is on, as soon as it is connected. 6 You have to install the VCP driver and Demo program (on the provided CD) on to your local host PC for controlling host. ( Please refer to chapter 2 for details ) 1.3 The External port of the Zigbee Interface board Fig. 1.6 The external port of Zigbee Interface Board When you want to control the demonstration kit by using an embedded board, such as an ARM or AVR based board, instead of a PC, you can use the external port (J102) on the Zigbee Interface board instead of the USB port. 5

7 A user should note that the J102 external port works with 3.3V CMOS logic level and the GND should be connected to the GND of your embedded board. In addition, you should supply +5V DC power via J107 power connector. Finally, proper jumper settings should be made as shown in Table 1.1 and Table 1.2. As you can see in Table 1.1 RXD and TXD jumpers should select EXT for an embedded system host, and select USB for an PC host, respectively. Table 1.1 Jumper settings regarding UART Communication Jumper Name Jumper No 3-2 short 2-1 short RXD J105 EXT(J102 RXD) USB TXD J106 EXT(J102 TXD) USB Table 1.2 shows the mapping information of the external port between ZI-100AS and the Interface board. Table 1.2 Port map between ZI-100AS and the interface board ZI-100AS (J103) The Interface Board (J102) Description I/O (based on ZI- 100AS) Signal level CTS ZB_BUSY ZI-100AS busy O Active= L DTR RF ON/OFF RF ON/OFF I H / L DSR HOST BUSY Host busy I Active= L RXD RXD H ZI I CMOS Logic (3.3V) TXD TXD H ZI O CMOS Logic (3.3V) ( Note: each ports works with 3.3V logic level signals. Thus H stands for +3.3V, and L means 0V ) 1.4 How to make communications between the Zigbee demo kits For our convenience, let us use Zigbee modem as the same meaning as Zigbee kit here. Fig. 1.7 shows an example of a wireless communication system feature with 2 Zigbee Modems. In this example, a local host sends its commands through the air to a remote 6

8 host. For the air transmission and reception, the Zigbee modems are used, and the modems follow the standard. Local HOST Local Zigbee Modem Remote Zigbee Modem Remote HOST Fig. 1.7 An example of a wireless communication system configuration with 2 Zigbee Modems Easy-to-use and powerful command sets and communication protocols are implemented in the Zigbee modem. Please refer to Zigbee module protocol document for more details. ( Please note that the Zigbee modem follows Physical Layer and MAC(Medium Access Control Layer) standard, but not Network Layer and above ) Let s move on to the next page to check how to install the VCP driver for the Zigbee Interface board. 7

9 2. Installation of VCP driver for the Interface board 2.1 The definition of VCP The VCP (Virtual Com Port) is the method to make a system consider a USB port as a COM. That is, one can use a USB interface to make a UART connection via VCP! Since the Zigbee interface board employs a USB to UART bridge chip, you should install the VCP driver on your PC to use it. 2.2 Installation of VCP driver & USB to UART Bridge On the provided CD, there is CP210x_VCP_Win2K_XP_S2K3.exe file in USB driver folder. Fig. 2.1 The initial window of installing VCP driver 1 Double click the CP210x_VCP_Win2K_XP_S2K3.exe. And then the a window will appear as shown in Fig 2.1. Just click Next button. 8

10 Fig. 2.2 The license agreement window of VCP driver 2 Please check I accept the terms of the license agreement and click Next button to invoke the folder setting window as shown below. Fig. 2.3 The folder setting window installation location 9

11 3 If you want to change the installation location, click Change button and select a folder you want to install the program in. If not, just click Next button to continue. Now, you can see a window showing the Installer is ready to install the VCP driver on your PC as shown in Fig Fig. 2.4 Ready to install the program window 4 Clicking Install button, the VCP driver installation will start and the folder setting for USB to UART bridge window will appear as shown in Fig. 2.5 Fig. 2.5 Folder selection window for the USB to UART bridge 5 If you change the installation location, click Change Install Location button in box as shown Fig And select the folder you want. If not, just click Install button. 10

12 Fig. 2.6 Zigbee Interface board scanning window 6 And then PC starts scanning Zigbee Interface Board as shown Fig 2.6. After completing searching the board, an installation completed successfully message box will appear as shown Fig 2.7. Cliking OK button will show another window showing that all the installation procedure completed as shown in Fig. 2.8 Fig. 2.7 The installation success window Fig. 2.8 The completion window 11

13 2.3 Confirming that the Zigbee Interface board is ready to work Fig. 2.9 The device manager window When the VCP driver successfully completed and the Zigbee interface board is properly connection on your PC, you can confirm that the Zigbee interface board is ready to work with your PC on Windows Device Manager. As shown in Fig.2.9, CP210x USB to UART Bridge Controller(COM3) shows the Zigbee interface board is ready to work! Although the virtual COM port is assigned to COM3 in this example, it may be different case by case. Therefore one should check what port number is assigned after the driver installation. Let s move on to the next page to see how our demonstration program works with the Zigbee modem. 12

14 3. Installation of Zigbee Demonstration Program In order to see how it works, you should have two Zigbee modems and two PCs and connect them together as shown in Fig On the included CD, there is setup.exe file in Programs\Zigbee Demo folder. 1 Double click setup.exe file and the.net framework 2.0 library installation dialogue box will appear as shown in Fig Click Accept button below. Fig. 3.1.NET Framework 2.0 Library Installation Dialogue Box 2 After the.net Framework 2.0 Library installation, the Zigbee Demo program installation dialog box will appear as shown in Fig Just click the Next button to continue. 13

15 Fig. 3.2 Zigbee Demonstration program installation dialogue box 3 Clicking the Next button invokes the dialogue box for selecting installation folder, as shown Fig If you are using Windows XP and want to let every user on your computer use the program, please select Everyone radio button down there, and click Next button. 4 Do you see a confirmation dialogue box as shown in Fig. 3.4? Click Next to make the installation start. 5 When the installation finishes, a dialogue box appears showing the message Installation Complete as shown in Fig Then, Click Close button to finalize the whole installation procedure. 14

16 Fig. 3.3 Installation folder selection dialogue box Fig. 3.4 Confirmation dialogue box 15

17 Fig. 3.5 Installation Complete indication page Please note that you should make an installation on both of the PCs, a Host and a Remote host, to see how we can control and monitor via Zigbee modem through the air. Let s go on to the next page to see how to use the demonstration program. 16

18 4. Running Zigbee Demonstration Program It s simple! Just Double Click on your Desktop, or Select Start Programs Zigbee Demo Zigbee Demo on your Windows XP desktop menu to run the Program. 4.1 COM Port Connection Tab. For the sake of convenience, we will call both the local and the remote host a Host. In addition we will also call the local and the remote Zigbee Modem a Zigbee Modem from now on. When you run the program, you can see a window as shown in Fig At first, COM Port Connection tab is selected. In this tab, you should select the proper parameters for RS-232 communication environment between the Host and the Zigbee modem. Select proper serial port in the Port combo box. In Fig. 4.1, COM1 was selected because the Zigbee Modem was connected to the COM1 port of the HOST. Then select bps for Baud Rate, 8 bits for Data Bit, None for Parity, 2 bits for Stop bit, and None for Handshake, respectively. At the moment, Zigbee modem has yet to be logically connected, and you can see a red square bullet with Zigbee OFF message on upper left of the window. Now, clicking Connect button make a logical connection between the Host and the Zigbee modem. When the connection is successfully connected, the bullet changes its color to blue, and the message turn into Zigbee ON as shown in Fig

19 Fig. 4.1 COM Port Connection Tab Before the logical connection Fig. 4.2 COM Port Connection Tab after the successful connection 18

20 4.2 Zigbee Configuration Tab As shown in Fig 4.3, Zigbee Configuration tab has some fields and check boxes for setting the Zigbee modem parameters. With these fields you can change the Zigbee modem parameters on your Host PC. (Please refer to Zigbee Module Protocol document for details regarding the parameters) Please note that the changes in this tab are only valid when the Host and the Zigbee modem are properly connected. Fig. 4.3 Zigbee Configuration Tab If you want to check the parameters of the Zigbee modem that are already set, just click Load button and you can see the preconfigured parameters, as shown in Fig On changing or selecting the field values, the parameters immediately change the Zigbee modem parameters to. However, the changed parameters would be valid only when the Zigbee modem is on, because the parameter would be kept in the RAM until you click Save button. Thus, turn off the Zigbee modem and the parameters you changed will disappear. 19

21 Therefore, if you want to keep the values permanently, you should click Save button to make the parameters be kept in Flash memory of the Zigbee Modem. ( Note: Saving the parameter into the flash memory will take around 5 seconds. Therefore you should NOT send any commands to the ZI-100AS module and wait for about 5 seconds while it is doing saving operation. Otherwise the firmware in ZI-100AS can be blown up!!! ) Fig. 4.4 Zigbee Configuration Tab with the preset values of the Zigbee Modem Table 4.1 Parameter values of Local and Remote Zigbee Modem for the demonstration Paramters Local Zigbee Modem Remote Zigbee Modem Tx Power RF Channel Group ID Target ID Device ID Tx Retry Rx Mode 1. Frame Mode 2. Ack Request 3. Group Broadcast Rx 4. Device Broadcast Rx Select Frame Mode and ACK Request Select Frame Mode and ACK Request 20

22 For the demonstration, please set the local and remote Zigbee modem parameters as shown in Table 4.1, respectively. Summary of the Zigbee Modem Parameters. Tx Power : Tx power selection filed. ( From 0x00 to 0x09 ) Rf Channel : Channel selection ( From 0x to 0F ) Group ID : Group ID of the Zigbee Modem ( From 0x0001 to 0xFFFF ) (Note: The Zigbee modems with a same group ID can communicate each other) Target ID : The ID number of a Zigbee modem, which the Zigbee modem want to communicate with. ( From 0x0001 to 0xFFFF ) Device ID : The ID number of the Zigbee modem itself. ( From 0x0001 to 0xFFFF ) Tx Retry : The number of retry when communication fails. ( From 000 to 256 ) When the Zigbee Modem send a data or command to a remote Modem but doesn t get ACK signal from the remote Modem, it will resend the data again Tx Retry times. Rx Mode : There are 4 Rx mode setting items such as Frame Mode, ACK Request, Group Broadcast Rx,and Device Broadcast Rx. Since the demonstration program uses Frame mode and ACK request, Frame Mode and ACK Request check boxes are selected here as shown in Fig

23 4.3 Zigbee Demonstration Tab. Using the interface on the Zigbee Configuration Tab, you can see how air communication can be made between two Zigbee modems. Therefore, you need to install each of the two Zigbee modems to two separate PCs as shown in Fig In addition, the Zigbee Demonstration program should be installed on both of the PCs and the Zigbee configuration parameters must be set as shown in Table 4.1. Fig. 4.5 Zigbee Demonstratio Tab. Let s overview the fields on Zigbee Demonstration tab. Target ID : The device ID of the counterpart Zigbee modem. Tx Data : The data you are to send ( you can type in any characters you want) Rx Data : The data you receive from the counterpart. Sound :.wav file to play In order to explain the demonstration clearly, let us define Local Host as the PC 22

24 controlling counterpart PC, and Remote Host as the PC working as the Local Host commands. Set the Device ID of the Local Zigbee modem connected to the Local Host as 0001 and that of the Remote Zigbee modem connected to the Remote Host as 0002 by using the Device ID field on the Zigbee Configuration Tab. (Please note that the group ID of the both modems should be the same) (1) Sending a character string Fig. 4.6 Captured window after the transmission of a character string(at Local Host) In order to send a character string to the Remote Host, follow the procedure below. Set Target ID as 0002 ( at the Local Host) Type any characters in the Tx Data field Click Send button And you can see the same character string on Rx Data field of the Local and the Remote Hosts as shown in Fig. 4.6 and 4.7. Please note that the echoed character string on the Rx data field in the Local Host is the received data which is resent by the 23

25 Remote Host. Fig. 4.7 Captured window after the transmission of a character string(at Remote Host) (2) Remote selection of a list box item In order to check the remote selection control demonstration, follow the procedure below. Set Target ID as 0002 ( at the Local Host) Click Up or Down button and see what happens to the Remote Host. You can see the concurrent selection change on the both Hosts, as shown in Fig. 4.8 and

26 Fig. 4.8 Zigbee Demonstration tab at the Local Host s side Fig. 4.9 Zigbee Demonstration tab at the Remote Host s side 25

27 (3) Audio Play control This section shows a simple example of the Local Host making the Remote host play a wave file or stop playing it. Local Host only sends two commands, Play and Stop. Thus, the wave file you are to play should be selected by the Remote Host ahead, as shown in Fig Fig shows a captured image on the Zigbee demonstration tab at the Remote Host s side. Please note that Play button is disabled and Stop button is enabled when it plays the file as shown in Fig Fig Zigbee Demonstration tab at the Remote Host s side These examples are only simple examples to show how the Zigbee modem works. As you can guess now, there will be so many applications our Zigbee modem can work with, such as Home automation and security, Automatic Meter Reading, Factory automation and motor control, Remote Keyless Entry with acknowledgement, Healthcare equipments, PC peripherals, Toys and so on. 26