Difference between revisions of "Firecracker Setup"

From X10Wiki
Jump to: navigation, search
(Perl Automatic Add)
Line 1: Line 1:
Questions
+
==Introduction==
Firecracker Setup
+
 
Answer
+
'''FIRECRACKER V2.0.0.33'''
+
<!--
+
/////////////////////////////////////////
+
// Descriptions, Troubleshooting, & Advisories: Start
+
-->
+
'''CONTENTS'''
+
*[a href="#Introduction"]Introduction[/a]
+
*[a href="#HardwareInstallation"]Hardware Installation[/a]
+
*[a href="#SoftwareInstallation"]Software Installation[/a]
+
*[a href="#GraphicalUserInterface"]Graphical User Interface[/a]
+
*[a href="#PopUpMenu"]Pop-Up Menu[/a]
+
*[a href="#ConfiguringSoftware"]Configuring The Software[/a]
+
*[a href="#UsingKeyboardCommands"]Using Keyboard Commands[/a]
+
*[a href="#Frequently_Asked_Questions"]Frequently Asked Questions[/a]
+
[a name="Introduction"][/a]
+
'''Introduction'''
+
 
The following document covers the features and configuration of the Firecracker software with the original CM17A Firecracker serial port interface.  Firecracker enables your PC to function as a remote control.  Once configured, you will be able to control lights, appliances, and cameras from your Windows desktop with a few clicks of the mouse.
 
The following document covers the features and configuration of the Firecracker software with the original CM17A Firecracker serial port interface.  Firecracker enables your PC to function as a remote control.  Once configured, you will be able to control lights, appliances, and cameras from your Windows desktop with a few clicks of the mouse.
[a name="HardwareInstallation"][/a]
+
 
'''Hardware Installation'''
+
==Hardware Installation==
 +
 
 
The Firecracker software was originally created as a part of the Firecracker kit (CK18A).  Since its inception, the Firecracker Computer Interface (CM17A) has been incorporated into other kits; i.e., MultiView and X-Ray Vision.  Due to the modular nature of X10 equipment, the Firecracker application may be utilized as long as specific equipment is available.  The following X10 hardware is the '''minimum equipment required''' to use the Firecracker application:
 
The Firecracker software was originally created as a part of the Firecracker kit (CK18A).  Since its inception, the Firecracker Computer Interface (CM17A) has been incorporated into other kits; i.e., MultiView and X-Ray Vision.  Due to the modular nature of X10 equipment, the Firecracker application may be utilized as long as specific equipment is available.  The following X10 hardware is the '''minimum equipment required''' to use the Firecracker application:
*(1) Firecracker Computer Interface (CM17A) [[a href="http://graphics.x10.com/images7/tech_cm17a.jpg"]photo[/a]]
+
 
*(1) Transceiver (TM751 or RR501) [[a href="http://graphics.x10.com/images7/tech_tm751.jpg"]photo[/a]]
+
<div align="center">
'''Configuring the Firecracker Computer Interface'''
+
{| width="85%"
 +
| ''(1) Firecracker Computer Interface (CM17A)''<br> http://graphics.x10.com/images7/tech_cm17a.jpg
 +
| ''(1) Transceiver (TM751 or RR501)''<br> http://graphics.x10.com/images7/tech_tm751.jpg
 +
|}
 +
</div>
 +
 
 +
===Configuring the Firecracker Computer Interface===
 
*Connect the female serial port connector on the Firecracker Interface directly to your PC's serial port.
 
*Connect the female serial port connector on the Firecracker Interface directly to your PC's serial port.
[center][img src="http://www.x10.com/instructions/images/cm17aconnection.jpg" border=0>[/center>
+
 
 +
<div align="center"> http://www.x10.com/instructions/images/cm17aconnection.jpg </div>
 +
 
 
*If you own an MR26A PC Receiver, it can be connected to the male DB9 connector (pass-through port) on the Firecracker Interface.
 
*If you own an MR26A PC Receiver, it can be connected to the male DB9 connector (pass-through port) on the Firecracker Interface.
*If the computer's case or other cables prevent the Firecracker Interface from connecting properly, you may have to purchase an extension serial cable from a local computer parts supplier.
+
*If the computer's case or other cables prevent the Firecracker Interface from connecting properly, you may have to purchase an extension serial cable from a local computer parts supplier. '''Note:''' You may connect other serial devices to the pass-through port of the Firecracker Interface; however, if the device operates all the time (mouse, modem, etc.), the Firecracker Interface will not operate properly.  A device operating at all times should be connected to its own serial port.
'''Note:''' You may connect other serial devices to the pass-through port of the Firecracker Interface; however, if the device operates all the time (mouse, modem, etc.), the Firecracker Interface will not operate properly.  A device operating at all times should be connected to its own serial port.
+
 
'''Configuring The Transceiver'''
+
===Configuring The Transceiver===
 
*Set the House dial on the face of the unit to "A."
 
*Set the House dial on the face of the unit to "A."
 
*Temporarily plug an incandescent lamp into the outlet on the bottom of the Transceiver (first make sure the lamp's power switch is ON).
 
*Temporarily plug an incandescent lamp into the outlet on the bottom of the Transceiver (first make sure the lamp's power switch is ON).
Line 37: Line 29:
 
*Press the ON/OFF button again until the relay (and the lamp) is off.
 
*Press the ON/OFF button again until the relay (and the lamp) is off.
 
*Extend the Transceiver's antenna.
 
*Extend the Transceiver's antenna.
 +
 
'''Note:''' The TM751 Transceiver does not have a Unit dial. It is preset to Unit code 1.
 
'''Note:''' The TM751 Transceiver does not have a Unit dial. It is preset to Unit code 1.
[a name="SoftwareInstallation"][/a]
+
 
'''Software Installation'''
+
 
Installation of the Firecracker software is easy.  Download the installation file from the X10 web site ([a href="http://www.x10.com/software"]www.x10.com/software[/a]).  Shut down all other programs currently running on your computer.  Double click on the Firecracker installation file.  Throughout the installation process, you will see the following windows:
+
==Software Installation==
[img src="http://graphics.x10.com/images7/tech_1button.gif" border=0 align=middle]
+
 
'''Welcome Window'''
+
Installation of the Firecracker software is easy.  Download the installation file from the X10 web site ([http://www.x10.com/software www.x10.com/software]).  Shut down all other programs currently running on your computer.  Double click on the Firecracker installation file.  Throughout the installation process, you will see the following windows:
Click Next to continue with the installation or Exit to abort.
+
 
[center][img src="http://graphics.x10.com/images7/tech_firecracker_install1.gif" border=0>[/center>
+
<div align="center">
[img src="http://graphics.x10.com/images7/tech_2button.gif" border=0 align=middle]
+
{| width="85%"
'''Destination Directory'''
+
| '''Welcome Window''' <br> Click Next to continue with the installation or Exit to abort.
If you wish to change the directory where the Firecracker application files will be saved, navigate to the new location.  When the new directory has been selected, or the default directory will be used, click Next to continue.
+
| http://graphics.x10.com/images7/tech_firecracker_install1.gif
[center][img src="http://graphics.x10.com/images7/tech_firecracker_install2.gif" border=0>[/center>
+
|-
[img src="http://graphics.x10.com/images7/tech_3button.gif" border=0 align=middle]
+
| '''Destination Directory''' <br> If you wish to change the directory where the Firecracker application files will be saved, navigate to the new location.  When the new directory has been selected, or the default directory will be used, click Next to continue.
'''File Transfer'''
+
| http://graphics.x10.com/images7/tech_firecracker_install2.gif
A few moments to transfer the files...
+
|-
[center][img src="http://graphics.x10.com/images7/tech_firecracker_install3.gif" border=0>[/center>
+
| '''File Transfer''' <br> A few moments to transfer the files...
[img src="http://graphics.x10.com/images7/tech_4button.gif" border=0 align=middle]
+
| http://graphics.x10.com/images7/tech_firecracker_install3.gif
'''Installation Complete'''
+
|-
...and you are finished!  Click OK to exit the installation.  Restart Windows.
+
| '''Installation Complete''' <br> ...and you are finished!  Click OK to exit the installation.  Restart Windows.
[center][img src="http://graphics.x10.com/images7/tech_firecracker_install4.gif" border=0>[/center>
+
|http://graphics.x10.com/images7/tech_firecracker_install4.gif
[a name="GraphicalUserInterface"][/a]
+
|}
'''Graphical User Interface'''
+
</div>
 +
 
 +
==Graphical User Interface==
 +
 
 
The main Firecracker Graphical User Interface is a representation of the PalmPad Remote (HR12A).  This section will explain the various parts and functions of the User Interface.
 
The main Firecracker Graphical User Interface is a representation of the PalmPad Remote (HR12A).  This section will explain the various parts and functions of the User Interface.
[AREA SHAPE="circle" COORDS="21,61,18" ALT="Go to Module Labels" HREF="#gui1"]
+
 
[AREA SHAPE="circle" COORDS="150,22,18" ALT="Go to Transmit LED" HREF="#gui2"]
+
===Firecracker Graphical User Interface===
[AREA SHAPE="circle" COORDS="218,53,18" ALT="Go to Control Buttons" HREF="#gui3"]
+
 
[AREA SHAPE="circle" COORDS="238,266,18" ALT="Go to Dim / Bright Control Buttons" HREF="#gui4"]
+
http://graphics.x10.com/images7/tech_firecracker_gui.jpg
[AREA SHAPE="circle" COORDS="195,333,18" ALT="Go to Unit Selection Switch" HREF="#gui5"]
+
 
[AREA SHAPE="circle" COORDS="30,333,18" ALT="Go to House Code Dial" HREF="#gui6"]
+
====1. Module Labels====
Firecracker Graphical User Interface
+
 
[img src="http://graphics.x10.com/images7/tech_firecracker_gui.jpg" border=0 USEMAP="#firecracker_gui"][p>
+
[a name="gui1"][/a]
+
[img src="http://graphics.x10.com/images7/tech_1button.gif" border=0 align=middle]
+
'''Module Labels'''
+
 
This section displays a short name representing the House/Unit code of a device controlled by an X10 module.  You can configure the labels including the size and type of font. In the upper left corner of each label is the Unit code.  The number displayed for each row will change if the Unit Selection Switch at the bottom of the User Interface is toggled.
 
This section displays a short name representing the House/Unit code of a device controlled by an X10 module.  You can configure the labels including the size and type of font. In the upper left corner of each label is the Unit code.  The number displayed for each row will change if the Unit Selection Switch at the bottom of the User Interface is toggled.
[a name="gui2"][/a]
+
 
[img src="http://graphics.x10.com/images7/tech_2button.gif" border=0 align=middle]
+
====2. Transmit LED====
'''Transmit LED'''
+
 
 
Any time the ON, OFF, DIM, or BRIGHTEN buttons are pressed, the red LED at the top of the User Interface will flash to indicate transmission of the command.
 
Any time the ON, OFF, DIM, or BRIGHTEN buttons are pressed, the red LED at the top of the User Interface will flash to indicate transmission of the command.
[a name="gui3"][/a]
+
 
[img src="http://graphics.x10.com/images7/tech_3button.gif" border=0 align=middle]
+
====3. Control Buttons====
'''Control Buttons'''
+
 
 
These buttons allow you to transmit ON and OFF commands for specific units assigned to the House code currently set on the House code dial.
 
These buttons allow you to transmit ON and OFF commands for specific units assigned to the House code currently set on the House code dial.
[a name="gui4"][/a]
+
 
[img src="http://graphics.x10.com/images7/tech_4button.gif" border=0 align=middle]
+
====4. Dim / Bright Control Buttons====
'''Dim / Bright Control Buttons'''
+
 
 
These light blue buttons control the dimming and brightening functions for Lamp Modules and Wall Switch Modules.  The left button (UP arrow) controls brightening and the right button (DOWN arrow) controls dimming.  When these buttons are used, the command is sent to the last House/Unit code used.  These buttons may be pressed once to change the light level by one step or they may be held down to send repeated commands and released when the desired level (of dim/brightness) is achieved.
 
These light blue buttons control the dimming and brightening functions for Lamp Modules and Wall Switch Modules.  The left button (UP arrow) controls brightening and the right button (DOWN arrow) controls dimming.  When these buttons are used, the command is sent to the last House/Unit code used.  These buttons may be pressed once to change the light level by one step or they may be held down to send repeated commands and released when the desired level (of dim/brightness) is achieved.
[a name="gui5"][/a]
+
 
[img src="http://graphics.x10.com/images7/tech_5button.gif" border=0 align=middle]
+
====5. Unit Selection Switch====
'''Unit Selection Switch'''
+
 
 
This switch controls the assignment of the ON and OFF Control Buttons and the displayed Module Labels above.  If the switch is set to the left (1-8), the Control Buttons are set to Units 1 through 8 and the Module Labels display 1 through 8.  If the switch is set to the right (9-16), the Control Buttons are set to Units 9 through 16 and the Module Labels display 9 through 16.
 
This switch controls the assignment of the ON and OFF Control Buttons and the displayed Module Labels above.  If the switch is set to the left (1-8), the Control Buttons are set to Units 1 through 8 and the Module Labels display 1 through 8.  If the switch is set to the right (9-16), the Control Buttons are set to Units 9 through 16 and the Module Labels display 9 through 16.
[a name="gui6"][/a]
+
 
[img src="http://graphics.x10.com/images7/tech_6button.gif" border=0 align=middle]
+
====6. House Code Dial====
'''House Code Dial'''
+
 
 
This dial represents the House code the Firecracker will transmit if any of the Control Buttons are clicked.  If Module Labels have been assigned over more than one House code, the labels displayed will change as each House code is selected.
 
This dial represents the House code the Firecracker will transmit if any of the Control Buttons are clicked.  If Module Labels have been assigned over more than one House code, the labels displayed will change as each House code is selected.
[a name="PopUpMenu"][/a]
+
 
'''Pop-Up Menu'''
+
===Pop-Up Menu===
 +
 
 
To access the pop-up menu, right mouse click anywhere on the User Interface. If you right mouse click over the Module Labels, the Unit Selection Switch, or the House Code Dial, the pop-up menu will have an additional option corresponding to the section the mouse pointer is over when the right mouse button is pressed.
 
To access the pop-up menu, right mouse click anywhere on the User Interface. If you right mouse click over the Module Labels, the Unit Selection Switch, or the House Code Dial, the pop-up menu will have an additional option corresponding to the section the mouse pointer is over when the right mouse button is pressed.
[AREA SHAPE="rect" COORDS="2,4,180,19" ALT="About Firecracker" HREF="#AboutFirecracker"]
+
 
[AREA SHAPE="rect" COORDS="2,25,180,42" ALT="Help" HREF="#Help"]
+
====About Firecracker====
[AREA SHAPE="rect" COORDS="2,54,180,69" ALT="Print Labels" HREF="#PrintLabels"]
+
[AREA SHAPE="rect" COORDS="2,74,180,88" ALT="Sounds" HREF="#Sounds"]
+
[AREA SHAPE="rect" COORDS="2,94,180,111" ALT="Setup Firecracker" HREF="#SetupFirecracker"]
+
[AREA SHAPE="rect" COORDS="2,114,180,131" ALT="View Command History" HREF="#ViewCommandHistory"]
+
[AREA SHAPE="rect" COORDS="2,143,180,160" ALT="Display" HREF="#Display"]
+
[AREA SHAPE="rect" COORDS="2,163,180,178" ALT="Task Bar Icon" HREF="#TaskBarIcon"]
+
[AREA SHAPE="rect" COORDS="2,184,180,200" ALT="Startup Menu" HREF="#StartupMenu"]
+
[AREA SHAPE="rect" COORDS="2,213,180,227" ALT="Move" HREF="#Move"]
+
[AREA SHAPE="rect" COORDS="2,233,180,247" ALT="Minimize" HREF="#Minimize"]
+
[AREA SHAPE="rect" COORDS="2,252,180,269" ALT="Original Size" HREF="#OriginalSize"]
+
[AREA SHAPE="rect" COORDS="2,282,180,296" ALT="www.x10.com" HREF="#X10DotCom"]
+
[AREA SHAPE="rect" COORDS="2,301,180,315" ALT="Close" HREF="#Close"]
+
Click on the menu commandbelow to view its description.
+
[img src="http://graphics.x10.com/images7/tech_firecracker_menu02.gif" border=0 usemap="#firecracker_menu"][p>
+
[a name="AboutFirecracker"][/a]
+
'''About Firecracker'''
+
 
Select this command to view the About dialog box, which lists the software version.  The dialog box also contains an Upgrade button, which launches your browser and takes you to the X10 website.
 
Select this command to view the About dialog box, which lists the software version.  The dialog box also contains an Upgrade button, which launches your browser and takes you to the X10 website.
[a name="Help"][/a]
+
 
'''Help'''
+
====Help====
 
Select this command to view the online help file.
 
Select this command to view the online help file.
[a name="PrintLabels"]
+
 
'''Print Labels'''
+
====Print Labels====
 
This menu command allows you to print your Module Labels.  The labels can be cut out and placed under the plastic label cover of any HR12A PalmPad remotes you own.
 
This menu command allows you to print your Module Labels.  The labels can be cut out and placed under the plastic label cover of any HR12A PalmPad remotes you own.
[a name="Sounds"][/a]
+
 
'''Sounds'''
+
====Sounds====
 
Select this menu command to enable or disable sounds corresponding to actions occurring in Firecracker.
 
Select this menu command to enable or disable sounds corresponding to actions occurring in Firecracker.
[a name="SetupFirecracker"][/a]
+
 
'''Setup Firecracker'''
+
====Setup Firecracker====
 
Setup Firecracker Dialog Box
 
Setup Firecracker Dialog Box
[img src="http://graphics.x10.com/images7/tech_dialog_setup_fc.gif" border=0]
+
 
 +
http://graphics.x10.com/images7/tech_dialog_setup_fc.gif
 +
 
 
Use this menu command to select the serial port to which the Firecracker Interface is connected.  The Firecracker Interface is used with other X10 programs (i.e. MultiView) and can be used in conjunction with our MR26A PC Receiver (also known as the Firecracker Receiver).
 
Use this menu command to select the serial port to which the Firecracker Interface is connected.  The Firecracker Interface is used with other X10 programs (i.e. MultiView) and can be used in conjunction with our MR26A PC Receiver (also known as the Firecracker Receiver).
 +
 
If you do not know to which comport the Firecracker Interface is connected, select the Automatic radio button in the Firecracker Transmitter section.  It is important that all other programs, which may be utilizing your comports, be shut down during setup of the Firecracker software.  If you know which comport to use, select the Manual, Use This Serial Port radio button and then the appropriate comport from the selection box.
 
If you do not know to which comport the Firecracker Interface is connected, select the Automatic radio button in the Firecracker Transmitter section.  It is important that all other programs, which may be utilizing your comports, be shut down during setup of the Firecracker software.  If you know which comport to use, select the Manual, Use This Serial Port radio button and then the appropriate comport from the selection box.
 +
 
To test the Firecracker Interface, click on the Send Test Command button (default command is A1 ON).  To change the test command, click on the Edit Test Command button.
 
To test the Firecracker Interface, click on the Send Test Command button (default command is A1 ON).  To change the test command, click on the Edit Test Command button.
 +
 
The Firecracker Receiver section of the dialog box pertains to the configuration of the MR26A PC Receiver.  If you do not have an MR26A connected to your computer, select the Disabled, No Receiver radio button.  The Received Commands box will display any commands sent by remote controls or motion detectors (PalmPads, HawkEyes, etc.).  The commands will be displayed as A1 ON, C7 OFF, etc.
 
The Firecracker Receiver section of the dialog box pertains to the configuration of the MR26A PC Receiver.  If you do not have an MR26A connected to your computer, select the Disabled, No Receiver radio button.  The Received Commands box will display any commands sent by remote controls or motion detectors (PalmPads, HawkEyes, etc.).  The commands will be displayed as A1 ON, C7 OFF, etc.
[a name="ViewCommandHistory"][/a]
+
 
'''View Command History'''
+
====View Command History====
 
Select this option to open a dialog box that displays the history of commands sent by the application.
 
Select this option to open a dialog box that displays the history of commands sent by the application.
[a name="Display"][/a]
+
 
'''Display'''
+
====Display====
 
Select this submenu to choose from three styles of User Interfaces: PalmPad, DigiPad, or SlimFire.
 
Select this submenu to choose from three styles of User Interfaces: PalmPad, DigiPad, or SlimFire.
[a name="TaskBarIcon"][/a]
+
 
'''Task Bar Icon'''
+
====Task Bar Icon====
 
Select this submenu to choose from four styles of System Tray icons: PalmPad, DigiPad, X10, or Firecracker.
 
Select this submenu to choose from four styles of System Tray icons: PalmPad, DigiPad, X10, or Firecracker.
[a name="StartupMenu"][/a]
+
 
'''Startup Menu'''
+
====Startup Menu====
 
Select this submenu to choose to add or remove Firecracker from your Startup menu.
 
Select this submenu to choose to add or remove Firecracker from your Startup menu.
[a name="Move"][/a]
+
 
'''Move'''
+
====Move====
 
Select this menu command to engage the move mode.  The mouse pointer will change to a hand.  Click and drag anywhere on the User Interface.  Drag the image to a new location on the screen.  Release the mouse button when the new location has been reached.
 
Select this menu command to engage the move mode.  The mouse pointer will change to a hand.  Click and drag anywhere on the User Interface.  Drag the image to a new location on the screen.  Release the mouse button when the new location has been reached.
 +
 
The User Interface can also be moved by clicking and dragging anywhere on the User Interface except for the Module Label area, the House Code dial, the Unit Selection Switch, and the Control Buttons.
 
The User Interface can also be moved by clicking and dragging anywhere on the User Interface except for the Module Label area, the House Code dial, the Unit Selection Switch, and the Control Buttons.
[a name="Minimize"][/a]
+
 
'''Minimize'''
+
====Minimize====
 
This menu option will minimize the User Interface.  A Taskbar button for Firecracker will not be displayed.  Firecracker places a System Tray icon on your Taskbar.  Click on the System Tray icon and then select Restore to return the User Interface to its original screen position.
 
This menu option will minimize the User Interface.  A Taskbar button for Firecracker will not be displayed.  Firecracker places a System Tray icon on your Taskbar.  Click on the System Tray icon and then select Restore to return the User Interface to its original screen position.
The User Interface may also be minimized by pressing the Escape key.
+
 
To restore the User Interface, double click on the Firecracker's icon in the System Tray on the taskbar.
+
The User Interface may also be minimized by pressing the Escape key. To restore the User Interface, double click on the Firecracker's icon in the System Tray on the taskbar.
[a name="OriginalSize"][/a]
+
 
'''Original Size'''
+
====Original Size====
 
This menu option will return the User Interface to its original size if it has been resized.  Use this option if the User Interface does not redraw properly after a window covering it is moved.
 
This menu option will return the User Interface to its original size if it has been resized.  Use this option if the User Interface does not redraw properly after a window covering it is moved.
[a name="X10DotCom"][/a]
+
 
'''www.x10.com'''
+
====www.x10.com====
 
This menu command will launch your browser and direct it to the X10 web site.
 
This menu command will launch your browser and direct it to the X10 web site.
[a name="Close"][/a]
+
 
'''Close'''
+
====Close====
 
This menu command will cause Firecracker to ask if you wish to close the application.  You may choose Yes, No, or Minimize.
 
This menu command will cause Firecracker to ask if you wish to close the application.  You may choose Yes, No, or Minimize.
[a name="ConfiguringSoftware"][/a]
+
 
'''Configuring The Software'''
+
==Configuring The Software==
 
This section covers establishing communication between the Firecracker Interface and the Transceiver, as well as configuring the User Interface to your liking.
 
This section covers establishing communication between the Firecracker Interface and the Transceiver, as well as configuring the User Interface to your liking.
'''Configuring And Testing The Firecracker Application'''
+
 
 +
===Configuring And Testing The Firecracker Application===
 
*Before loading Firecracker, shut down any programs that utilize a communications port (comport) to avoid any possible conflicts during the configuration process (i.e. PDA or digital camera software).
 
*Before loading Firecracker, shut down any programs that utilize a communications port (comport) to avoid any possible conflicts during the configuration process (i.e. PDA or digital camera software).
 
*Run the Firecracker application (Start button | Programs | Firecracker | Firecracker).
 
*Run the Firecracker application (Start button | Programs | Firecracker | Firecracker).
[a name="gui"][/a]
 
Firecracker Graphical User Interface
 
[img src="http://graphics.x10.com/images7/tech_firecracker_gui.jpg" border=0 USEMAP="#firecracker_gui"][p>
 
 
*A graphic of the PalmPad appears.  This is the User Interface.
 
*A graphic of the PalmPad appears.  This is the User Interface.
 
*Right mouse click on the User Interface to engage the pop-up menu.
 
*Right mouse click on the User Interface to engage the pop-up menu.
Line 175: Line 156:
 
*A warning dialog box appears.  Click OK to continue.
 
*A warning dialog box appears.  Click OK to continue.
 
*The Setup Firecracker dialog box appears.
 
*The Setup Firecracker dialog box appears.
Setup Firecracker Dialog Box
 
[img src="http://graphics.x10.com/images7/tech_dialog_setup_fc.gif" border=0]
 
 
*If you do not know to which comport the Firecracker Interface is connected select the Automatic radio button in the Firecracker Transmitter section.
 
*If you do not know to which comport the Firecracker Interface is connected select the Automatic radio button in the Firecracker Transmitter section.
 
*If you do know to which comport the Firecracker Interface is connected select the Manual radio button and then the comport from the selection box.
 
*If you do know to which comport the Firecracker Interface is connected select the Manual radio button and then the comport from the selection box.
Line 190: Line 169:
 
*You should hear the relay inside the Transceiver click on.  This confirms that the Firecracker Interface is transmitting properly and the Transceiver is receiving and responding to commands.  If you do not hear the click, press the OFF button on the User Interface instead.  The Transceiver's relay may already be in the ON position.  If you still have a lamp plugged into the Transceiver, it should turn on or off as you send the commands.
 
*You should hear the relay inside the Transceiver click on.  This confirms that the Firecracker Interface is transmitting properly and the Transceiver is receiving and responding to commands.  If you do not hear the click, press the OFF button on the User Interface instead.  The Transceiver's relay may already be in the ON position.  If you still have a lamp plugged into the Transceiver, it should turn on or off as you send the commands.
 
*If you have other Lamp, Appliance, or Wall Switch Modules configure them and then use the Firecracker application to test their control.
 
*If you have other Lamp, Appliance, or Wall Switch Modules configure them and then use the Firecracker application to test their control.
'''Configuring The Module Labels'''
+
 
 +
===Configuring The Module Labels===
 
Module Labels allow you to label the House/Unit codes with easy to remember names; i.e., Living Room for A1, Kitchen for A2, etc.
 
Module Labels allow you to label the House/Unit codes with easy to remember names; i.e., Living Room for A1, Kitchen for A2, etc.
 
*To change a module label's text, double click in the module label's text area.
 
*To change a module label's text, double click in the module label's text area.
Line 202: Line 182:
 
*A dialog box appears asking if you wish to close the application.  Select the Yes button.
 
*A dialog box appears asking if you wish to close the application.  Select the Yes button.
 
*The Firecracker application shuts down.  The changes have been saved.
 
*The Firecracker application shuts down.  The changes have been saved.
'''Printing The Module Labels'''
+
 
 +
===Printing The Module Labels===
 
The Print Labels command allows you to print a label insert that fits into any HR12A PalmPad remote.
 
The Print Labels command allows you to print a label insert that fits into any HR12A PalmPad remote.
 
*Right mouse click on the User Interface to engage the pop-up menu.
 
*Right mouse click on the User Interface to engage the pop-up menu.
Line 214: Line 195:
 
*The label inserts are printed.
 
*The label inserts are printed.
 
*The Print dialog disappears.  Click the Cancel button in the Print Labels dialog box to return to the User Interface.
 
*The Print dialog disappears.  Click the Cancel button in the Print Labels dialog box to return to the User Interface.
[a name="UsingKeyboardCommands"][/a]
+
 
'''Using Keyboard Commands'''
+
===Using Keyboard Commands===
 
To turn a module ON or OFF:
 
To turn a module ON or OFF:
 
*Type the House code (A through P).
 
*Type the House code (A through P).
Line 225: Line 206:
 
*Press the + (plus) key to brighten and the - (minus) key to dim.
 
*Press the + (plus) key to brighten and the - (minus) key to dim.
 
*For repeated dimming or brightening of the same module, you can press + (plus) or - (minus) without entering the House or Unit code again.
 
*For repeated dimming or brightening of the same module, you can press + (plus) or - (minus) without entering the House or Unit code again.
To delete the last entry press the Delet or Backspace key.
+
To delete the last entry press the Delete or Backspace key.
 
To cancel the last command, press the Escape key.
 
To cancel the last command, press the Escape key.
<!--
+
 
/////////////////////////////////////////
+
==Related Articles==
// Descriptions, Troubleshooting, & Advisories: End
+
[[Modules Work in Some Locations but not Others]]
-->
+
 
Related Articles
+
[a href="/kbase/articles/a00079.html"]a00079[/a] : Modules Work in Some Locations but not Others[BR]
+
 
Key Topics: module, outlet, wiring, phase, electrical, noise, line, interference, circuit
 
Key Topics: module, outlet, wiring, phase, electrical, noise, line, interference, circuit
Relates to:
+
 
LM465, LM15A, LM14A, AM15A, AM486, AM466, WS467, WS4777, WS12A, WS13A
+
Relates to: LM465, LM15A, LM14A, AM15A, AM486, AM466, WS467, WS4777, WS12A, WS13A
[a href="/kbase/articles/a00081.html"]a00081[/a] : Fluorescent Lights[BR]
+
 
 +
[[Fluorescent Lights]]
 +
 
 
Key Topics: neutral, ground, incandescent, wire, load, ballast
 
Key Topics: neutral, ground, incandescent, wire, load, ballast
Relates to:
+
 
WS467, WS4777, WS12A, WS13A
+
Relates to: WS467, WS4777, WS12A, WS13A
[img src="http://site.x10.com/?Z3gxT2tiYXNlYXJ0aWNsZTEuZGF0=RND|kbasearticle"]
+
 
 +
[[Category:hardware]]
 +
[[Category:software]]
 +
[[Category:frequently asked questions]]

Revision as of 19:58, 17 March 2006

Introduction

The following document covers the features and configuration of the Firecracker software with the original CM17A Firecracker serial port interface. Firecracker enables your PC to function as a remote control. Once configured, you will be able to control lights, appliances, and cameras from your Windows desktop with a few clicks of the mouse.

Hardware Installation

The Firecracker software was originally created as a part of the Firecracker kit (CK18A). Since its inception, the Firecracker Computer Interface (CM17A) has been incorporated into other kits; i.e., MultiView and X-Ray Vision. Due to the modular nature of X10 equipment, the Firecracker application may be utilized as long as specific equipment is available. The following X10 hardware is the minimum equipment required to use the Firecracker application:

(1) Firecracker Computer Interface (CM17A)
tech_cm17a.jpg
(1) Transceiver (TM751 or RR501)
tech_tm751.jpg

Configuring the Firecracker Computer Interface

  • Connect the female serial port connector on the Firecracker Interface directly to your PC's serial port.
cm17aconnection.jpg
  • If you own an MR26A PC Receiver, it can be connected to the male DB9 connector (pass-through port) on the Firecracker Interface.
  • If the computer's case or other cables prevent the Firecracker Interface from connecting properly, you may have to purchase an extension serial cable from a local computer parts supplier. Note: You may connect other serial devices to the pass-through port of the Firecracker Interface; however, if the device operates all the time (mouse, modem, etc.), the Firecracker Interface will not operate properly. A device operating at all times should be connected to its own serial port.

Configuring The Transceiver

  • Set the House dial on the face of the unit to "A."
  • Temporarily plug an incandescent lamp into the outlet on the bottom of the Transceiver (first make sure the lamp's power switch is ON).
  • Plug the Transceiver into an AC outlet.
  • Press the ON/OFF button on the face of the unit. You should hear the relay inside click, and the lamp will turn on or off. This verifies that the Transceiver is connected to power and is ready to send and receive commands.
  • Press the ON/OFF button again until the relay (and the lamp) is off.
  • Extend the Transceiver's antenna.

Note: The TM751 Transceiver does not have a Unit dial. It is preset to Unit code 1.


Software Installation

Installation of the Firecracker software is easy. Download the installation file from the X10 web site (www.x10.com/software). Shut down all other programs currently running on your computer. Double click on the Firecracker installation file. Throughout the installation process, you will see the following windows:

Welcome Window
Click Next to continue with the installation or Exit to abort.
tech_firecracker_install1.gif
Destination Directory
If you wish to change the directory where the Firecracker application files will be saved, navigate to the new location. When the new directory has been selected, or the default directory will be used, click Next to continue.
tech_firecracker_install2.gif
File Transfer
A few moments to transfer the files...
tech_firecracker_install3.gif
Installation Complete
...and you are finished! Click OK to exit the installation. Restart Windows.
tech_firecracker_install4.gif

Graphical User Interface

The main Firecracker Graphical User Interface is a representation of the PalmPad Remote (HR12A). This section will explain the various parts and functions of the User Interface.

Firecracker Graphical User Interface

tech_firecracker_gui.jpg

1. Module Labels

This section displays a short name representing the House/Unit code of a device controlled by an X10 module. You can configure the labels including the size and type of font. In the upper left corner of each label is the Unit code. The number displayed for each row will change if the Unit Selection Switch at the bottom of the User Interface is toggled.

2. Transmit LED

Any time the ON, OFF, DIM, or BRIGHTEN buttons are pressed, the red LED at the top of the User Interface will flash to indicate transmission of the command.

3. Control Buttons

These buttons allow you to transmit ON and OFF commands for specific units assigned to the House code currently set on the House code dial.

4. Dim / Bright Control Buttons

These light blue buttons control the dimming and brightening functions for Lamp Modules and Wall Switch Modules. The left button (UP arrow) controls brightening and the right button (DOWN arrow) controls dimming. When these buttons are used, the command is sent to the last House/Unit code used. These buttons may be pressed once to change the light level by one step or they may be held down to send repeated commands and released when the desired level (of dim/brightness) is achieved.

5. Unit Selection Switch

This switch controls the assignment of the ON and OFF Control Buttons and the displayed Module Labels above. If the switch is set to the left (1-8), the Control Buttons are set to Units 1 through 8 and the Module Labels display 1 through 8. If the switch is set to the right (9-16), the Control Buttons are set to Units 9 through 16 and the Module Labels display 9 through 16.

6. House Code Dial

This dial represents the House code the Firecracker will transmit if any of the Control Buttons are clicked. If Module Labels have been assigned over more than one House code, the labels displayed will change as each House code is selected.

Pop-Up Menu

To access the pop-up menu, right mouse click anywhere on the User Interface. If you right mouse click over the Module Labels, the Unit Selection Switch, or the House Code Dial, the pop-up menu will have an additional option corresponding to the section the mouse pointer is over when the right mouse button is pressed.

About Firecracker

Select this command to view the About dialog box, which lists the software version. The dialog box also contains an Upgrade button, which launches your browser and takes you to the X10 website.

Help

Select this command to view the online help file.

Print Labels

This menu command allows you to print your Module Labels. The labels can be cut out and placed under the plastic label cover of any HR12A PalmPad remotes you own.

Sounds

Select this menu command to enable or disable sounds corresponding to actions occurring in Firecracker.

Setup Firecracker

Setup Firecracker Dialog Box

tech_dialog_setup_fc.gif

Use this menu command to select the serial port to which the Firecracker Interface is connected. The Firecracker Interface is used with other X10 programs (i.e. MultiView) and can be used in conjunction with our MR26A PC Receiver (also known as the Firecracker Receiver).

If you do not know to which comport the Firecracker Interface is connected, select the Automatic radio button in the Firecracker Transmitter section. It is important that all other programs, which may be utilizing your comports, be shut down during setup of the Firecracker software. If you know which comport to use, select the Manual, Use This Serial Port radio button and then the appropriate comport from the selection box.

To test the Firecracker Interface, click on the Send Test Command button (default command is A1 ON). To change the test command, click on the Edit Test Command button.

The Firecracker Receiver section of the dialog box pertains to the configuration of the MR26A PC Receiver. If you do not have an MR26A connected to your computer, select the Disabled, No Receiver radio button. The Received Commands box will display any commands sent by remote controls or motion detectors (PalmPads, HawkEyes, etc.). The commands will be displayed as A1 ON, C7 OFF, etc.

View Command History

Select this option to open a dialog box that displays the history of commands sent by the application.

Display

Select this submenu to choose from three styles of User Interfaces: PalmPad, DigiPad, or SlimFire.

Task Bar Icon

Select this submenu to choose from four styles of System Tray icons: PalmPad, DigiPad, X10, or Firecracker.

Startup Menu

Select this submenu to choose to add or remove Firecracker from your Startup menu.

Move

Select this menu command to engage the move mode. The mouse pointer will change to a hand. Click and drag anywhere on the User Interface. Drag the image to a new location on the screen. Release the mouse button when the new location has been reached.

The User Interface can also be moved by clicking and dragging anywhere on the User Interface except for the Module Label area, the House Code dial, the Unit Selection Switch, and the Control Buttons.

Minimize

This menu option will minimize the User Interface. A Taskbar button for Firecracker will not be displayed. Firecracker places a System Tray icon on your Taskbar. Click on the System Tray icon and then select Restore to return the User Interface to its original screen position.

The User Interface may also be minimized by pressing the Escape key. To restore the User Interface, double click on the Firecracker's icon in the System Tray on the taskbar.

Original Size

This menu option will return the User Interface to its original size if it has been resized. Use this option if the User Interface does not redraw properly after a window covering it is moved.

www.x10.com

This menu command will launch your browser and direct it to the X10 web site.

Close

This menu command will cause Firecracker to ask if you wish to close the application. You may choose Yes, No, or Minimize.

Configuring The Software

This section covers establishing communication between the Firecracker Interface and the Transceiver, as well as configuring the User Interface to your liking.

Configuring And Testing The Firecracker Application

  • Before loading Firecracker, shut down any programs that utilize a communications port (comport) to avoid any possible conflicts during the configuration process (i.e. PDA or digital camera software).
  • Run the Firecracker application (Start button | Programs | Firecracker | Firecracker).
  • A graphic of the PalmPad appears. This is the User Interface.
  • Right mouse click on the User Interface to engage the pop-up menu.
  • Select Setup Firecracker.
  • A warning dialog box appears. Click OK to continue.
  • The Setup Firecracker dialog box appears.
  • If you do not know to which comport the Firecracker Interface is connected select the Automatic radio button in the Firecracker Transmitter section.
  • If you do know to which comport the Firecracker Interface is connected select the Manual radio button and then the comport from the selection box.
  • If you do not have an MR26A PC Receiver (also known as the Firecracker Receiver) connected to your computer select the Disabled radio button in the Firecracker Receiver section.
  • If you do own an MR26A, which has already been configured for use with other X10 software (i.e. MultiView), leave the Firecracker Receiver setting as it is. The Firecracker application does not utilize the MR26A.
  • Click on the OK button to save your settings and return to the User Interface.
  • The House Code dial in the lower left corner of the User Interface ([a href="#gui"]#6[/a]) is set to "A" by default. If it has been changed, set it back by clicking on the "A." Note: The dial displays the odd letters (A, C, E, etc.). The small ticks between these letters represent the even letters (B, D, F, etc.).
  • An alternate method to changing the House code is to right mouse click on the House Code dial to engage the pop-up menu. Select the House Code... menu option and then "A."
  • The Unit Selection Switch is located in the lower right corner of the User Interface ([a href="#gui"]#5[/a]). Clicking on the switch causes it to move from the 1-8 position to the 9-16 position or vice versa.
  • Verify the switch is in the 1-8 position. Change it if necessary.
  • The Transceiver has been configured to A1. To turn it on, click on the ON button in the row next to the Module Label "My Appliance" (top row) on the User Interface ([a href="#gui"]#3[/a]).
  • The red LED at the top of the User Interface will flash briefly ([a href="#gui"]#2[/a]). The Firecracker application has sent the A1 ON command to the Firecracker Interface, which has transmitted the command to the Transceiver.
  • You should hear the relay inside the Transceiver click on. This confirms that the Firecracker Interface is transmitting properly and the Transceiver is receiving and responding to commands. If you do not hear the click, press the OFF button on the User Interface instead. The Transceiver's relay may already be in the ON position. If you still have a lamp plugged into the Transceiver, it should turn on or off as you send the commands.
  • If you have other Lamp, Appliance, or Wall Switch Modules configure them and then use the Firecracker application to test their control.

Configuring The Module Labels

Module Labels allow you to label the House/Unit codes with easy to remember names; i.e., Living Room for A1, Kitchen for A2, etc.

  • To change a module label's text, double click in the module label's text area.
  • A dialog box will appear. Enter the new name for the label.
  • To change the font type or size, click on the Font button.
  • Another dialog box appears. Select the new attributes you wish to apply to the text.
  • Click the OK button to see the sample text in the previous dialog box. Experiment with the settings until the desired look is achieved.
  • When all changes to the Module Label are complete, click the OK button to return to the User Interface.
  • To save the changes, right mouse click to enable the pop-up menu.
  • Chose the Close menu command.
  • A dialog box appears asking if you wish to close the application. Select the Yes button.
  • The Firecracker application shuts down. The changes have been saved.

Printing The Module Labels

The Print Labels command allows you to print a label insert that fits into any HR12A PalmPad remote.

  • Right mouse click on the User Interface to engage the pop-up menu.
  • Select Print Labels.
  • To print all House codes, click the All radio button.
  • To print specific House codes, click the Selected radio button and then check the desired House codes in the selection box.
  • If the printer settings need to be changed, click the Setup button.
  • To see what the printout will look like, click the Print Preview button.
  • When all changes to the settings are complete, click the Print button.
  • The Print dialog appears. Click the OK button.
  • The label inserts are printed.
  • The Print dialog disappears. Click the Cancel button in the Print Labels dialog box to return to the User Interface.

Using Keyboard Commands

To turn a module ON or OFF:

  • Type the House code (A through P).
  • Type the unit code (1 through 16).
  • Type the letter N for ON and F for OFF.

To dim or brighten a lamp module:

  • Type the house code (A through P).
  • Type the unit code (1 through 16).
  • Press the + (plus) key to brighten and the - (minus) key to dim.
  • For repeated dimming or brightening of the same module, you can press + (plus) or - (minus) without entering the House or Unit code again.

To delete the last entry press the Delete or Backspace key. To cancel the last command, press the Escape key.

Related Articles

Modules Work in Some Locations but not Others

Key Topics: module, outlet, wiring, phase, electrical, noise, line, interference, circuit

Relates to: LM465, LM15A, LM14A, AM15A, AM486, AM466, WS467, WS4777, WS12A, WS13A

Fluorescent Lights

Key Topics: neutral, ground, incandescent, wire, load, ballast

Relates to: WS467, WS4777, WS12A, WS13A