X10 - Quick Start Guide - Downloads
Contents
1. Serial TTL Input RXDB 7 8 12V output 9 10 Auxiliary CMOS Output AUXO Auxiliary CMOS Output AUX2 f 13 14 Auxiliary CMOS Output AUX4 Ground 0V Serial RS232 Output TXD A Serial RS232 Output RTS A Serial TTL Output TXD B 12V output Auxiliary CMOS Output AUX1 Auxiliary CMOS Output AUX3 Auxiliary CMOS Output AUX5 12V and 12V outputs are only available if a 12V source has been connected to P5 However RS232 signal levels are generated on the Firefly X10 board and it is not necessary to connect a 12V power source to use RS232 signals The 12V and 12V outputs are intended for use by a BACTA port 5 5 P7 Audio In This is 3 5mm stereo jack Socket It duplicates the Audio Line In signals on Pins 33 amp 34 of Connector P2 to allow connection to Firefly 700 via a standard jack Jack lead The jack ground connections must be connected at both ends of the cable to obtain lowest background digital noise Table 6 P7 Audio In Connector Reference P7 Type 3 5mm stereo jack Socket Description Audio In Document No 80 17424 Issue 5 HEBER2. 1 Send and receive simple character When a single character is typed on the console it is displayed on HyperTerminal When single character is typed on HyperTerminal it is received on the console To exit this functionality c needs to be pressed on the console 2 It allows the user to send and receive multiple characters at once When on the console each time a key is pressed the program sends a string into HyperTerminal When on HyperTerminal user can press multiple keys The next time user will press a key all the characters transmitted by HyperTerminal will be displayed 3 2 2 8 SPldemo This sample demonstrates communication with a Starpoint Electronic Counter SEC device using the SPI protocol The sample sets the text HEBER on the SEC device in addition to a number that increments every time you press a key The sample displays the output from the SEC device using four hexadecimal bytes 3 2 2 5 Sramdemo Sramdemo accesses the 256 first bytes of the SRAM memory The memory can be erased read or filled with data 3 2 2 10 Timedemo This introduces basic communication with the PIC microcontroller When pressing any key the user will be able to access the real time clock provided by the PIC 3 2 2 11 InpMuxDemo This demonstrates input multiplexing on the X10 There are four channels corresponding to outputs 12 15 each containing 24 inputs corresponding to inputs 0 23 The X10 internally multiplexes the
3. su all Document No 80 17424 Issue 5 HEBER Page 11 The status of the reels is displayed in the top right corner of the window The position is set to a random position and will be used as a reference later in order to display the new position according to how far the reel spins It does not update from the optical index sensor on the reel When spinning all the reels a specific reel can be disabled or enabled by changing the Spin check box The box in the top left corner is used to physically spin the reels Moving the slider modified the number of steps the spin will accomplish before stopping The reels are activated by clicking one of the buttons below By clicking 1 the reels will all spin 1 number of steps forward By clicking 1 the reels will all spin 1 number of steps backward Different spin ramps can be set up by changing the ramp table of the reels All the reels can be set independently or share the same ramp table 3 2 Sample programs In the folder c heber firefly X10 Samples 10 folders contains demonstration programs each targeting a specific feature of the Firefly X10 Cj ectalkdemo eepromdema 9 fadedemo jiodemo i paralleldema reels Cj serialdemo C spidemo sramdemoa Cj timedemno Each folder contains an executable file as well as the sample code illustrating the use of some functions see software user manual for more details Each executable file runs in
4. amp ddress Clash Command 251 Address Change Command 250 amp ddress Random Command 249 Request polling priority Command 248 Request status Command 247 Request variable set Command 246 Request manufacturer id bi Ri RI RR H Ri v BET Wi EY EEE ME VANS EE RI Transactions 1 Host gt gt gt Device 2 Connection Port B k UART BAUDB 3k6 wl QuxOsFow FALSE i RtsControl DISABLE v When selecting a command from the output window and clicking Host gt gt gt Device button the corresponding line of the XML script is executed Document No 80 17424 Issue 5 HEBER Page 8 3 1 2 Input and Output Test Input Switches Dip Switches oo Do C 02 lm joo Clm 04 05 C 06 07 o2 103 los 109 10 11 Jos Clm 12 413 14 15 Jos 07 Linked Input Switches Output Lamps 16 O17 118 19 Ian Cla 122 123 Oo O01 Om O03 O04 O05 O0 O07 Lamp Brightness 10 on on Aux Outputs _ Oo On J Or O03 O04 O8 Output Lamps O08 Oo O10 On O12 O13 O14 O15 Q1e O1 O18 O19 O20 O21 Oz O23 O24 03 O26 O27 O28 O29 O30 O3 The first time the input output tab is clicked the program reinitializes all the output lamps to 0 no light and updates all the inputs to the status of the switches on the board Moving the cursor over any of the output lamps radio button will change the statu
5. 4 The software will now be removed from your system 2 2 Linux Installation 2 2 1 Extracting the Development Kit First find a suitable location to install the development kit usr src x10 is recommended Create the required directory and then unzip the supplied X10 tar archive e cd usr src e mkdir x10 e cd x10 e tar xzf fflyusb tar gz For the remainder of this guide it will be assumed that the development kit is placed in directory lusr src x10 2 2 2 Making the X10 Kernel Driver Due to the many variations of Linux kernel builds it is impossible to supply pre compiled versions of the X10 kernel driver It is therefore necessary for the end user to manually build the X10 kernel driver The process for building the X10 kernel driver differs slightly depending on the version of the Linux kernel you are using The X10 drivers have been tested on kernel versions 2 4 18 and above early versions of the Linux kernel are not supported although they should work 2 2 2 1 Building under Linux kernel version 2 4 To build the X10 driver under a 2 4 Linux kernel please follow these instructions e cd usr srce x10 driver e make The X10 kernel driver has now been created and is called X10 0 2 2 2 2 Building under Linux kernel version 2 6 Rather than providing a full makefile the makefile for the required target kernel is used instead This means that a full configured and built set of kernel sources is requir
6. DuC LEE PEE 15 Table 2 P2 VO 1 Connector mosaicos ene an eiaa aaa eaa aa aai 16 Table 3 P3 VO 2 Connector mosii onaran a ee Eaa aAa a eaaa laa 17 Table 4 P4 Hl cctalk Channels A Ap 18 Table 5 PG VO 3 Connector 00 0 eecc cece ce eseecceece eee eeceecsaeeeceeeeaueseceeeceueeceeecaaaeeeeeeeaueeseeeeeseaseeeeeenaaees 19 Table 6 P7 Audio JnConpnechor orae rrrt errr rrrtrennrrr r snnrrr rr rnrrre nennt 19 Document No 80 17424 Issue 5 HEBER Page iii This page intentionally left blank Document No 80 17424 Issue 5 HEBER Page 1 1 NEW IN THIS RELEASE This covers new features in Issue 24 of the Windows X10 drivers and Issue 11 of the Linux X10 drivers During initialisation the X10 now attempts to automatically detect the currently fitted EEPROM The X10 can differentiate between the following devices 24LC01 24LC02 24LC04 24LC08 24LC16 24LC32 24LC64 24LC128 24LC256 and 24LC512 A new function has been added to the X10 API called CheckEEPROM This detects the currently fitted EEPROM 2 INSTALLING THE SOFTWARE 2 1 Windows 2000 and Windows XP 2 1 1 Installation Once the development kit has been installed onto your computer using the set up program provided on the CD the actual USB device drivers must be installed This can happen in one of two ways 1 The Firefly X10 drivers have never been installed onto your PC before therefore the drivers will be installed for the first time 2 You
7. FR E F L Y iew Generation of Video Firefly X10 Quick Start Guide Document No 80 17424 Issue 5 HEBER LTD Current Issue Issue 5 8 March 2005 Previous Issues Issue 4 29 September 2004 Issue 3 10 August 2004 Issue 2 5 August 2004 Issue 1 15 December 2003 HEBER Ltd 2005 This document and the information contained therein is the intellectual property of HEBER Ltd and must not be disclosed to a third party without consent Copies may be made only if they are in full and unmodified Document No 80 17424 5 HEBEH HEBER LTD Belvedere Mill Chalford Stroud Gloucestershire GL6 8NT England Tel 44 0 1453 886000 Fax 44 0 1453 885013 Email support heber co uk http www heber co uk Document No 80 17424 5 HEBER Pagei CONTENTS 1 NEW IN THIS REEEASE entire cancasstec a Etro Resp ite so ne Resp REP RAS DR Ern engere 1 2 INSTALLING THE SOFTWARE reir beer erben erre iat 1 2 1 WINDOWS 2000 AND WINDOWS AP 1 PANEM Duel EET 1 2 1 2 File name lvusb int sese nenns sehen nnns enne nnne nennt 1 2 1 3 File name vide sws 1 2 1 4 File name vo gv 2 2 1 5 File name Olvusb dl senes enn 2 2 1 6 File name fflyusb lib sss esee nennen nennen nennt 2 2 1 7 File name lvusbbh eene nnne sena EA EEEE EAEE 3 2 1 8 File name unlockio lib sessi essen nnn nennen renes eren nennen nnn 3 2 1 9 File name omlockob en 3 2 1 10 Development Kit U
8. a console mode and can be run by double clicking on file exe In addition to these folders an extra lib directory contains a proper exit function which will identify if an error was return by the USB driver close the USB port properly as well as closing the console from Visual C 3 2 1 Compiling a sample program from its current directory As an example the reel project will be described but all samples will follow the same steps Explanations apply to Visual C version 6 but similar steps should be followed for other versions e Copy the reel folder into your working directory e Double click on reels cpp which should open Visual C application e Trying to build the file will lead to a message box from visual c asking you to create an active project workspace e Clicking on yes will create a project and return an error advising that file fflyusb h cannot be included e Access the setting of your project project setting Select C C tab and pre processor drop down menu from there In the additional include directory insert the path of X10 include files C neber FireFly X10 include as well as C neber FireFly X10 samples lib Document No 80 17424 Issue 5 HEBER Page 12 e Select the Link tab and the input drop down menu from there In the additional library path insert the path of the X10 library files C neber FireFly X10Mib and specify which library you need to identify in the project option fflyusb
9. have a previous version of the drivers installed in which case they must be upgraded Before attempting to install the drivers please ensure that the Firefly X10 board is unplugged Following are the instructions for both install methods FIRST TIME INSTALLATION e Plug in the Firefly X10 USB Board e A Found New Hardware dialog box should appear e When asked to specify the drivers location point it to the driver directory inside the development kit directory DRIVER UPGRADE INSTALLATION e Go to the Start Menu Programs gt Heber gt Firefly X10 e Click on Update X10 USB Driver e The drivers will now automatically upgrade For information only the files distributed with the device are in the order in which they are used 2 1 2 File name fflyusb inf This is a set up information file that tells Windows how to install files for drivers and register them Location systemroot inf 2 1 3 File name fflyldr sys This file is the Windows device driver that installs the firmware onto the Anchor device Location systemroot system32 drivers It is loaded briefly during the first enumeration phase after the USB device has been detected Document No 80 17424 Issue 5 HEBER Page 2 2 1 4 File name fflyio sys This file is the Windows device driver used when the device is running Location systemroot system32 drivers 2 1 5 File name fflyusb dll This DLL provides the API defined in fflyusb h This will be execu
10. lib unlockio lib e Press ok to change settings Rebuilding the project should now work properly 3 2 2 Description of the sample programs To have a better understanding of this explanation running the program at the same time is recommended 3 2 2 1 Cctalkdemo The communication with a cctalk device is using a buffer in SRAM Even if no CCtalk device is connected to the X10 board the sample program can erase the receive buffer However it will not be possible to e Read a buffer e Initialise the communication 3 2 2 2 Eepromdemo The program requires a start address as well as a number of bytes to read from this address When setting a start address and a correct number of bytes to read ensure that will not exceed the memory range EEPROM 512 bytes Can be accessed from 0x8 to Ox1FF gt last bit to be written is Ox1FE The program returns the contents of the memory A similar process happens in order to write to memory 3 2 2 3 Fadedemo The sample demonstrates lamp fading The programs executes a caterpillar by first switching on all the output lights one after the other then turning them off one after the other The animation speed is set up by using the input switches IP16 to IP23 3 2 2 4 lodemo For this program inputs and outputs are organised as follows Link Input Output Outputs OPO OP OP8 OP15 OP16 OP23 OP24 OP31 LSB MSB LSB MSB LSB MSB LSB MSB 0 1 2 3 Direction of reading for outputs Inputs Lin
11. regarding Enumeration for details and as a result BYTE 0 to 7 cannot be overwritten or read When first accessing the EEPROM from the tab menu the start address of the memory is set to 0x0000 and should display 256 bytes As a result the X10 board returns an error saying that the memory is out of range and displays random data into the memory view EEPROM Memory Range enter the start address in either decimal or hex Start Address 000000000 Number of Bytes 256 EEPROM Memory View 00000010 CC CC CC CC CC CC CC CC CC CC CC CC CC CC CC CC IIIIIIIIIIIIIIII Log Success EEPROM Sample initialised FireFlyUSB ReadEEPROM 0x00000000 256 error USB MESSAGE PARAMETER OUT 0 When setting a correct start address and a correct number of bytes to read which will not exceed the memory range EEPROM 512 bytes Can be accessed from 0x8 to Ox1FF gt last byte to be written is Ox1FE the memory view will be displayed as follow when clicking Update View button and no message will be displayed in the Log part Document No 80 17424 Issue 5 HEBER Page 10 EEPROM Memory Range enter the start address in either decimal or hex Start Address 0400000008 Number of Bytes 1256 EEPROM Memory View 00000008 54 48 41 54 20 49 53 20 54 48 45 20 43 4F 4E 54 THAT IS THE CONT 00000018 45 4E 54 20 4F 46 20 4D 59 20 4D 45 AD AF 52 59 ENT OF MY MEMORY 3 1 6 SRAM Memory The SRAM is as for the PIC microcontroller battery backed A
12. Open Drain Output OP14 Open Drain Output OP15 HEBER Page 17 5 2 P3 l O2 This is a 50w Header It may be fitted with a ribbon cable assembly to jump to a 50W D Type on an I O panel The high current outputs should use all three connections if the load will draw a high current Otherwise only one of the connections needs to be made Similarly sufficient ground connections should be used to meet the maximum load current expected Table 3 P3 I O 2 Connector Reference P3 Type 50W Header Description 02 Open Drain Output OP16 Open Drain Output OP18 Open Drain Output OP20 Open Drain Output OP22 Open Drain Output OP24 Open Drain Output OP26 High Current Output OP28 High Current Output OP29 High Current Output OP29 High Current Output OP30 High Current Output OP31 High Current Output OP31 Open Drain Output OP17 Open Drain Output OP19 Open Drain Output OP21 Open Drain Output OP23 Open Drain Output OP25 Open Drain Output OP27 High Current Output OP28 High Current Output OP28 High Current Output OP29 High Current Output OP30 High Current Output OP30 High Current Output OP31 Input IP6 Input IP7 Input IP8 Input IP9 Input IP10 Input IP11 Input IP12 Input IP13 Input IP14 Input IP15 12V 12V 12V 12V Ground 0V Ground 0V Ground 0V Security Switch SW1 4 common Security Switch SW 1 47 48 Security Switch SW 3f 49 50 Ground 0V Ground 0V Ground 0V Ground 0V Security Switch SW 2 Se
13. curity Switch SW 4 Document No 80 17424 Issue 5 HEBER Page 18 5 3 P4 Hl cctalk Channels A amp B This connector provides 2 Hll cctalk interface channels It may be fitted with a 20W IDC header and the 20W ribbon split to provide 2 Industry Standard 10W Connections Table 4 P4 HI cctalk Channels A amp B Hil cctalk CHANNEL A Reference P4 Type 20W Header Description HI cctalk Channels A amp B DATA Channel A Ground 0V BUSY Channel A Ground 0V Hil cctalk RESET Channel A CHANNEL A Output OP8 12V Power Ground 0V Ground 0V BE 12V Power DATA Channel B Ground 0V BUSY Channel B Ground 0V Hil cctalk RESET Channel B 15 CHANNEL B Output OPO Ground 0V 12V Power Ground 0V DE 12V Power 9 3 1 Boards from issue 6 onwards 56 16325 6 Note that the cctalk receiver is configured for 5V operation If the interface is operating at 12V levels then R32 should be removed and fitted in R33 position instead If this is not done the cctalk interface will work but with slightly reduced noise immunity and will be pulled up to 5V by the Firefly X10 This is unlikely to cause any problems Document No 80 17424 Issue 5 Hil cctalk CHANNEL B HEBER Page 19 5 4 P6 1 03 This is a 16w Header Table 5 P6 I O 3 Connector Reference P6 Type 16W Header Description 0 3 Ground OV B 1 2 Serial RS232 Input Rap Al 3 4 Serial RS232 Input CTS Al 5 6
14. e can run Note however that Windows requires the Vendor ID and Product ID to identify the device driver that is required e Fflyldr sys is the device driver that will be identified as being required and it will be loaded It downloads software to the 8051 code memory space Once it has downloaded the software to the 8051 its function is complete and it has no other use It then allows the 8051 to run this downloaded code e The first thing that the 8051 does when it runs the downloaded code is to disconnect itself electrically from the USB This is so that Windows thinks that it has been unplugged causing Windows to remove the device driver that it had loaded fflyldr sys e After a short delay the 8051 reconnects itself electrically to the USB bus and Windows carries out the Enumeration process again on this new USB device This time the interrogation process is controlled by the 8051 which identifies itself differently causing Windows to identify a different device driver to be identified as the one to be loaded The driver loaded this time is fflyio sys This provides the device driver that the API application interface functions in fflyusb dll require The API functions are described in detail in the document x10 soft user manual doc e When the device identifies itself to Windows this time the Vendor ID Product ID and Device ID are supplied by the 8051 code not the EEPROM Again it is only the Vendor ID and Product ID
15. ed to make the X10 driver For a good introduction to the changes required to port modules to the 2 6 kernel see http Iwn net Articles 21823 The 2 6 makefile is called Makefile the upper case M is important and is called via the kernel makefile To build the X10 driver under a 2 6 Linux kernel please follow these instructions e cd usr srce x10 driver e make C usr src linux SUBDIRS pwd modules Please note that under version 2 6 of the Linux kernel modules have the extension ko instead of o Therefore the X10 kernel driver is called X10 ko Please remember this when starting the driver using insmod 2 2 3 Starting the X10 driver Document No 80 17424 Issue 5 HEBER Page 5 Two batch files have been created and are located in the directory usr src x10 driver x10init which initialises the X10 driver and x10remove which closes the X10 driver In order to execute these batch files you must be logged in as root Please remember that before running x10remove to unplug all connected X10 boards The batch files have been written to work with version 2 4 of the Linux kernel If you want to use them under version 2 6 then you need to manually edit the batch files to change all references of X10 0 to X10 ko Once the X10 driver is loaded and the X10 is plugged in it takes a couple of seconds for the X10 to download the required code and initialise In order to check that the X10 is ready to go you can loo
16. er File Action View Help E GG m xi Sound video and game controllers System devices Universal Serial Bus controllers Firefly X10 Board Intel PCI to USB Enhanced Host Controller Intel R 82801DB DBM USB Universal Host Controller 24C2 Intel R 82801DB DBM USB Universal Host Controller 24C4 When first clicking on X10DIAG exe the About tab is displayed and shows the status of the connection as well as the version of the libraries provided Document No 80 17424 Issue 5 HEBER Page 7 FireFly X10 Diagnostic Suite cctalk Port Input Output Real Time Clock Serial Port EEPROM Memory SRAM Memory Reels About Device Status Initialised Device Unlocked yes DLL Version 24 8051 Version 27 PIC Version 11 Issue 81 16721 2 Copyright Heber Ltd 2002 At anytime while running the program if USB connection is lost clicking Re initialise should restore the USB connection between the firefly X10 board and Windows operating system At the top of the display a user will be able to navigate from one X10 function test to another by clicking on the specific tab 3 1 1 CcTalk This part of the diagnostic program allows the user to communicate with a coin acceptor or any other cctalk device connected to the X10 board Dutput e Transactions Al Command 255 Factory set up and test 3 Command 254 Simple Poll E Command 253 Address Poll Command 252
17. he other one are sharing their status with the reels This number depends on the number of reels configured Document No 80 17424 Issue 5 HEBER Page 9 3 1 3 Real Time clock This part of the diagnostic software presents basic communication between the PIC security microcontroller and windows Using this tab you will be able to access the real time clock provided by the PIC reset its internal clock and verify that if the X10 board is powered off the battery backed feature of the board will keep the clock up to date 3 1 4 Serial Ports Click on the Serial Port tab on the diagnostic suite The serial port window will be shown Connection 2 Port B UART_BAUDB_Sk6 v OutxCtsFlow FALSE RtsControl DISABLE v Output 0000 48 65 6C 6C 6F 2C 20 77 6F 72 6C 64 21 Hello world INSERT add byte DEL BACKSPACE delete byte TAB toggle hex char Transactions Clicking on send button will send Hello world on the serial channel If HyperTerminal has been set to the correct communication speed the same message will be displayed on the screen The user can send a string from the X10 s port A a 9 W D type connector or from port B which allows TTL communication The user can also modify the string to send by changing the ASCII value directly from the output window 3 1 5 EEPROM Memory The EEPROM on the X10 board can be used to store data at anytime The EEPROM is also used for security settings see part
18. k Input Output Dip switch Input IPO IP7 IP IP15 IP16 IP23 1 8 LSB MSB LSB MSB LSB MSB LSB MSB 0 1 2 SW Direction of reading for inputs The status reported by the program is e When an output is on light on gt the value is set to 1 by the program e When an input switch is on gt the value read by the program is 1 Three menus are available when launching the sample Document No 80 17424 Issue 5 HEBEH Page 13 e T will test the general X10 input reading and output writing When it is started each time a user presses one of the keys of the program the status of the inputs is updated on the screen and the next output is lit e P will send a 150 ms pulse to all outputs one after the other each time a key is pressed e U will read the inputs all together 3 2 2 5 PParalleldemo This demonstrates the X10 functionality to drive parallel devices e g coin hoppers There are two modes of operation e Press P to test input pulse reading e Press H to test parallel hopper coin release 3 2 2 6 Reels This sample demonstrates basic functionality of the reels When C is pressed the program spins the first reel forward the second backward and the third forward If C is pressed again it reverses it 3 2 2 7 Serialdemo Serialdemo first demonstrates how to set up the serial channel Then the program will execute two main tasks It is best to use a program such as HyperTerminal to monitor the results
19. k at the kernel log by using the command dmesg One of the last entries should read Firefly X10 Board ready Document No 80 17424 Issue 5 HEBER Page 6 A DEMONSTRATION PROGRAMS A number of demonstration programs are supplied with the development kit They give examples of how to use the API calls described in the software user manual Within the bin directory is an executable diagnostic program named X10Diag exe as well as a XML script entitled cctalk 4 1 This executable will allow you to test each area of the Firefly X10 s functionality Even though the code is not provided users can have an idea of the range of opportunity offered by the board Please note that this program is currently only available under Windows and has not yet been ported to Linux When ready to write software for the board the user should to refer to the sample directory where all functionality is independently described Source code demonstrating how to use some of the functions described in the software user manual is provided These samples can be executed directly or recompiled and modified as required by user The sample software is identical for both Windows and Linux versions 3 1 Diagnostic Software To start running this program it is advised to first check that the power is on then unplug the USB cable and plug it back in When the Firefly X10 appears in Device Manager the demonstration program can be run Device Manag
20. ll the data stored into this memory will be saved on power down of the board The SRAM is 32 kBytes battery backed and does not have any restricted areas This part of the program works identically to the EEPROM 3 1 7 Reels This part of the program is set up to work with STARPOINT 20RM reels As reel devices are working according to ramp table which varies from one reel to another connecting a reel other than STARPOINT 20RM will probably not spin the reel properly When clicking on the reel tab the following window will appear Spin Selected Reels Reel 1 Status Reel 2 Status Reel 3 Status Number of steps 48 Position 123 Position 127 Position 255 Error OOO Error 000 Error 000 E Busy 000 Busy 000 Busy 000 Sync DUU Sync DUU Sync 000 JMA mm mm v Spin v Spin v Spin Configure Ramp T ables Reel 1 Share ramp tables Apply Ramps 3 reels Clear Sync Up 7 lisa 23 13 OE 10 10 OB Half steps per gr full rotation 36 E E eg Dec A vll s 0E 23 ce Log FireFlyLISB ConfigureReels D 96 0 success FireFlpUSB SpinRampUp 0 success FireFlyUSB SpinRampD own 0 success FireFlyUSB SpinRampUp 1 success FireFlyUSB SpinRampD own 1 success FireFlyUSB SpinRampUp 2 success FireFlyUSB SpinRampD own 2 success FireFlyUSB ReelSynchroniseE nable 0 success FireFlyUSB ReelSynchroniseE nable 1 success gt FireFlpUSB ReelSynchroniseEnable 2
21. nd is not functional Before the X10 can be used it must first be unlocked The unlockio library provides two functions to achieve this BOOL UnlockX10 FireFlyUSB FireFly This function unlocks the X10 and is used in all provided demonstration programs It returns TRUE if no problems were encountered during the unlock process and FALSE otherwise If the X10 was previously unlocked then this function will simply return BOOL UnlockX10Recheck FireFlyUSB FireFly This function is provided as an alternative to UnlockX10 The UnlockX10Recheck function differs from UnlockX10 in that it always attempts to unlock the X10 If the X10 was previously unlocked and UnlockX10Recheck is called using the incorrect unlockio library then the unlock process will fail and the X10 will re lock itself A final function is provided in the unlockio library BOOL VerifyX10UnlockLibrary FireFlyUSB FireFly This function ensures that the unlockio library is correctly linked to the fitted X10 It does not attempt to unlock or re lock the X10 The function returns TRUE if the unlockio library matches and FALSE otherwise You must include unlockio h in your program file 2 1 10 Development Kit Uninstall In order to uninstall the software follow these steps Start Menu gt Control Panel gt Add Remove Programs Select Firefly X10 Development Kit Click Remove When asked to confirm click Yes Document No 80 17424 Issue 5 HEBER Page
22. nmstal enne nn nnns nnns 3 2 2 LINUX INSTALLATION 4444242442088 MR 4 2 2 1 Extracting the Development ku 4 2 22 Making the X10 Kernel Driver 4 2 2 3 Starting the A LEE 4 3 DEMONSTRATION PROGRAMS uuuuerzensnnsnsnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnsnnnnnnnnnnnnnnnnnn 6 3 1 DIAGNOS Nee 6 tle OCT AUK C 7 3 1 2 Input and Output Test 8 3 13 Real Time Nee Sm 9 EXE MEC PIU 9 3 1 5 EEPROM Memory ssssssssssssesss eene nennen nnne nint nnne nr ihren nh nis sinet ee eii EE ananin iein 9 3 1 6 SRAM Memory ssssssssssssees esent hnnh nihit tnis sinant renis sahen rn inris senten ir innen nnne ies 10 NXNGEE ncc 10 3 2 SAMPLE PROGRAMS d 11 3 2 1 Compiling a sample program from its current directory essen 11 3 2 2 Description of the sample programs eene nnn nnns 12 4 ENUMERATION EDIDI 14 5 CONNECTING DEVICES TO THE FIREFLY X10 BOARD ene 15 5 1 PZ ONT TT 16 5 2 uo M ts 17 5 3 PA HI7 CCTALK CHANNELS AAR 18 5 3 1 Boards from issue 6 onwards 56 16325 6 seen 18 5 4 POTO een 19 5 5 EP Uie ree 19 Document No 80 17424 Issue 5 HEBEH Page ii LIST OF TABLES Table 1 Table of Connectors IR
23. s of the output lamp on the board If the output lamp was off it will turn on The status of the radio button will be updated at the same time When switching an input on the board the status of the Input Switches check box will be updated on the screen When switching a dip on the board the status of the Dip Switches check box will be updated on the screen Switching a link I O on the board will lead to the change of the status of the linked input check box on the screen but not the output radio button which should be linked to it Moving the cursor over any of the output linked lamps radio button on the screen will change the status of the output lamp on the board as well as the check box related to the status of the input linked to it on the screen If changing the lamp brightness at this stage the lower the value the slower the flickering of the linked Input Switches check box on the screen and the lower the brightness of the lamps on the board the higher the value the faster the flickering of the linked Input Switches check box up to continuous light and the higher the brightness of the lamps on the board Auxiliary outputs working as regular outputs Each time this tab will be clicked it should reinitialize the status of the output to 0 on the board as well as on the screen If the reel tab was clicked in a previous test only some of the outputs will be reinitialized on the board as t
24. se inputs and outputs together to provide 96 inputs Document No 80 17424 Issue 5 HEBER Page 14 4 ENUMERATION This section is provided for interest It may help to understand how the Firefly X10 USB device interacts with Windows Note however that it is not necessary to understand it in order to use a Firefly X10 USB device When the Firefly X10 USB is detected on the USB port Windows carries out the following sequence of events e A process is started called Enumeration in which it interrogates the Firefly X10 USB device to find out what it is and what device driver must be loaded The Firefly X10 USB will identify itself using data stored in the EEPROM device U4 This data will enable Windows to find the driver which will be the file fflyldr sys At this stage the process is under control of the 8051 built in USB core and the 8051 U1 is not running any user program code As stated above the Firefly X10 USB device identifies itself to Windows It does this through built in descriptor data apart from 6 bytes that are supplied from the EEPROM U4 These bytes reside at the following addresses in EEPROM 0x01 Vendor ID LSB 0x02 Vendor ID MSB 0x03 Product ID LSB 0x04 Product ID MSB 0x05 Device ID LSB 0x06 Device ID MSB DU PONZ EEPROM address 0x00 must always contain OxBO This code tells the Anchor Cypress chip that it must obtain software from the PC and load it into the code memory before the 8051 cor
25. ted when any program using the Firefly X10 is running 2 1 6 File name fflyusb lib This file is the LIB that is used to provide an API application interface for the Firefly X10 USB IO Board This is the file that provides users with access to the Firefly X10 USB functions This file must be linked into your project in order to use the API Document No 80 17424 Issue 5 HEBER Page 3 2 1 7 File name fflyusb h This file is the C Header file which enables applications API calls to access the DLL functions correctly This header file includes 3 other header files 1 x10err h This defines Firefly X10 error codes 2 x10serl h This defines constants relating to Firefly X10 serial communications 3 x10io h This defines constants relating to Firefly X10 input output These files tell what functions are available to the developers and how they should be called You must include it in your program file 2 1 8 File name unlockio lib This module provides advanced security features that will prevent other people running your game code The complexities of this procedure are hidden to you This library file must be linked into your project in order to use it and to benefit from these security features 2 1 9 File name unlockio h This file is the C Header file that enables you to benefit from the security features described above in unlockio lib When the X10 is first plugged in and initialised it is in a locked state a
26. that control which driver is loaded Document No 80 17424 Issue 5 HEBER Page 15 5 CONNECTING DEVICES TO THE FIREFLY X10 BOARD The board is fitted with the following connectors Table 1 Table of Connectors Ident Type Function VO 2 HOS 7 ee 0 O 20W Header HI cctalk Channels A amp B 4W AMP 12V Power in Hard Disk style connector VO3 P6 16W Header O 3 3 5mm Stereo Jack Socket And organised as follow on the board 2 95 75mm 8 3 211 mm Document No 80 17424 Issue 5 HEBER Page 16 5 1 P2 1 01 This is a 34w Header Table 2 P2 I O 1 Connector Reference P2 Type 34W Header Description I O 1 Open Drain Output OPO Input IP16 Open Drain Output OP2 Input IP18 Open Drain Output OP4 Input IP20 Open Drain Output OP6 Input IP22 Open Drain Output OP8 Open Drain Output OP10 Open Drain Output OP12 13 14 LS 5 6 CARA 9 10 Input IPO Input IP1 Input IP2 19 20 f Input IP3 Input IP4 Input IP5 12V Current Sensed 12V Power Ground 0V Ground 0V Loudspeaker left Loudspeaker left Ground 0V Document No 80 17424 Issue 5 Loudspeaker right Loudspeaker right Ground 0V Left Audio Line In Right Audio Line In Open Drain Output OP1 Input IP17 Open Drain Output OP3 Input IP19 Open Drain Output OP5 Input IP21 Open Drain Output OP7 Input IP23 Open Drain Output OP9 Open Drain Output OP11 Open Drain Output OP13
Download Pdf Manuals
Related Search