home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR4 / X10DC150.ZIP / X10DC.DOC < prev    next >
Text File  |  1993-12-22  |  46KB  |  978 lines
  1. ────────────────────────────────────────────────────────────────────
  2. X10DC X10 Direct Control
  3. ────────────────────────────────────────────────────────────────────
  4. Version 1.50
  5. December 1993
  6.  
  7. Copyright 1993 ∙ D.Huras ∙ All Rights Reserved
  8.  
  9. ───────────────────────────────────────────────X10DC.DOC v1.50──────
  10. CONTENTS
  11. ────────────────────────────────────────────────────────────────────
  12.  1. DESCRIPTION                11. KEYBOARD USAGE
  13.  2. WARRANTY                   12. MENU BAR
  14.  3. FEATURE OVERVIEW           13. UNDOCUMENTED CP290 COMMANDS
  15.  4. REQUIREMENTS               14. CP290 SELF TEST
  16.  5. INSTALLATION INSTRUCTIONS  15. SIGNAL TEST GENERATOR
  17.  6. COMMAND LINE ARGUMENTS     16. CLOCK SYNCHRONIZATION
  18.  7. COMMUNICATION PORTS        17. BASE HOUSECODE
  19.  8. OPERATING MODES            18. PROBLEM RESOLUTION
  20.  9. DEBUG MODE                 19. REGISTRATION INFORMATION
  21. 10. PROGRAM OVERVIEW           20. OTHER HOME AUTOMATION SOFTWARE
  22.  
  23. 1. DESCRIPTION
  24. ────────────────────────────────────────────────────────────────────
  25. X10DC is a program which sends immediate commands to the X10 CP290
  26. (*1) Computer Interface.  The CP290 transmits these commands over the
  27. power line to control X10 devices.  X10DC does not currently modify
  28. the EVENT DATA stored in the CP290 Interface (*2).  X10DC is a DOS
  29. program that uses a simple point & click user interface.  (A Mouse
  30. though not required is highly recommended).  X10DC is designed to be
  31. robust software that is processor speed independent.  This program is
  32. shareware and you are invited to evaluate it for 30 days. If you
  33. continue to use the program after the 30 day evaluation period you are
  34. asked to register it.  The author retains all rights to the program.
  35.  
  36. (*1) The CP290 Computer Interface is a device manufactured by X-10
  37.      that can be connected to a micro-computer serial port.  The CP290
  38.      also plugs into an electrical outlet and it is through this
  39.      connection that the CP290 imposes X-10 commands onto the powerline.
  40.      X-10 commands use the power line as a carrier; other X-10 devices
  41.      connected to the power line will respond to these commands (ie.
  42.      switch ON/OFF lights, appliances).
  43.  
  44. 2. WARRANTY
  45. ────────────────────────────────────────────────────────────────────
  46. X10DC is supplied as is.  The author disclaims all warranties,
  47. expressed or implied, including, without limitation, the warranties
  48. of merchantability and of fitness for any purpose.  The author
  49. assumes no liability for damages, direct or consequential, which may
  50. result from the use of X10DC.
  51.  
  52. 3. FEATURE OVERVIEW
  53. ────────────────────────────────────────────────────────────────────
  54. ∙ User-Friendly point & click DOS character-based Interface
  55.  
  56. ∙ All program functions can be controlled using a mouse; no keyboard
  57.   intervention is required.
  58.  
  59. ∙ Supports Standard CommPorts 1 thru 4 and a User Defined CommPort
  60.   which can support any IRQ between 1 & 15 (inclusive) and any
  61.   Base I/O Address.
  62.  
  63. ∙ SUPPORTS * 5 * UNDOCUMENTED CP290 Commands
  64.  
  65. ∙ The Program supports 3 operating modes; each mode uses a different
  66.   combination of on-screen controls.  Mode 1 is suggested for users
  67.   not using a mouse.
  68.  
  69. ∙ When running in Mode 3, the program reads in an X10.DAT file
  70.   [this file format is used by the X10 Program supplied with
  71.   the CP290 Interface] and presents a list box of device
  72.   descriptions/locations which can be targetted for commands.
  73.   (The Unregistered version will only send commands to the 1st
  74.    8 Devices found; SEE REGISTRATION BENEFITS)
  75.  
  76. ∙ Commands can be sent to all 256 X10 device addresses.
  77.  
  78. ∙ Commands can be targetted for any number of units within an X10
  79.   House Code (effectively supporting for ALL ON and ALL OFF).
  80.  
  81. ∙ Supports 16 discrete dimming levels.
  82.  
  83. ∙ Acknowledgements sent from the CP290 (after receiving commands from
  84.   the program) are monitored and checksums are verifed.
  85.  
  86. ∙ A scrollable Command History is available for browsing while the
  87.   program is running.
  88.  
  89. ∙ A software-based Signal Test Generator is available to assist in
  90.   identifying and isolating X10 transmission/reception problems.
  91.  
  92. ∙ A Debug Mode is available which reports all data sent from the
  93.   CP290 as well as timing information.
  94.  
  95. ∙ A CP290 Self Test with event preservation is supported.
  96.   (*2) NOTE, the self test overwrites the EVENT/ICON DATA.  X10DC
  97.   will preserve the EVENT/ICON DATA by downloading it from the
  98.   CP290, saving it in memory, running the Self Test, and
  99.   finally uploading the saved EVENT/ICON DATA back to the CP290.
  100.  
  101. ∙ Clock Synchronization function for the CP290 and the PC
  102.  
  103. ∙ Change Base HouseCode stored in the CP290 function with
  104.   or without Event & Icon Data Preservation.
  105.  
  106. ∙ Detects and exploits EGA/VGA 43/50 line mode
  107.  
  108. ∙ A comprehensive on-line Help sub-system that can be disabled
  109.   at the user's option to decrease program load time.
  110.  
  111. ∙ The program WILL load without a CP290 Interface attached, however
  112.   all attempts at serial communications will result in errors; the
  113.   program will attempt to trap all such errors.
  114.  
  115. 4. REQUIREMENTS
  116. ────────────────────────────────────────────────────────────────────
  117. ∙ An IBM-Compatible PC with at least 1 serial port.
  118.  
  119. ∙ An X10 CP290 Computer Interface attached to a serial port.
  120.  
  121. ∙ A Microsoft-Compatible Mouse is highly recommended
  122.  
  123. ∙ A Colour adapter/display is recommended although the program
  124.   should run with a monochrome display/adapter.  If you
  125.   experience problems with the default colors, then try the /BW
  126.   command line argument which will set everything to Black &
  127.   White.
  128.  
  129. The program requires approximately 415K available conventional memory
  130. to run.  The Command History will consume up to an additional 32K
  131. of memory however this translates to approximately 1000 commands; its
  132. unlikely that this many commands will be sent during one invokation of
  133. the program.  However, if Debug Mode is on, the Command History will
  134. quickly fill up since all CP290 responses are reported in the
  135. Command History list box.
  136.  
  137. 6. INSTALLATION INSTRUCTIONS
  138. ────────────────────────────────────────────────────────────────────
  139. There are no special installation instructions; simply copy the
  140. program to a sub-directory of your choice and run it.  The program
  141. will look for 3 files in the directory it is run from.  However,
  142. the program will run with or without the following 3 files:
  143.  
  144.   1) X10.DAT
  145.      If you want to use Mode 3 then you may want to copy an
  146.      X10.DAT file to the sub-directory where you have installed
  147.      X10DC.EXE.  Alternatively, you can load an X10.DAT file from
  148.      any sub-directory by using the 'Load X10 File' menu option.
  149.      An X10.DAT file is a file format used by the X10 program
  150.      supplied by X10 with the CP290 interface.  The unit
  151.      addresses, locations and descriptions are read from this
  152.      file and presented in a list box by X10DC.  X10DC DOES NOT
  153.      MODIFY THE X10.DAT FILE.  A sample X10.DAT is provided
  154.      with X10DC.
  155.  
  156.   2) X10DC.HLP
  157.      X10DC retrieves the on-line help text from this file. If the
  158.      file is not found then X10DC will display a message during
  159.      startup and then continue.  The help feature will be
  160.      unavailable in this case.  If you decide that you no longer
  161.      need the help sub-system, then you should run the program
  162.      with the /NH command line argument; this will suppress the
  163.      'Help not found' message and decrease program load time.
  164.  
  165.   3) X10DC.INI
  166.      The registered version of the program will look for a
  167.      X10DC.INI file in the current directory.  The X10DC.INI file
  168.      is a text file containing all program parameters; there is no
  169.      need to create this file yourself since the program will
  170.      generate one whenever you select the 'Save Options' menu item.
  171.      A sample X10DC.INI file (generated by X10DC.EXE) is shown
  172.      below:
  173.  
  174. ;
  175. ;X10DC.INI File Created: 08-06-1993 01:40:00
  176. ;
  177. ;All Lines prefixed with ; are ignored
  178. ; Program Options
  179. ; ---------------
  180. ; CommPort=1,2,3 OR 4            DEFAULT=1
  181. ; Mode=1,2 OR 3                  DEFAULT=1
  182. ; Debug=ON/OFF                   DEFAULT=OFF
  183. ; X10File=[d:]\FILENAME.EXT      DEFAULT=X10.DAT
  184. ; LoadHelp=YES/NO                DEFAULT=YES
  185. ; Sounds=ON/OFF                  DEFAULT=ON
  186. ; PreserveICONData=YES/NO        DEFAULT=NO
  187. ;
  188. Mode=1
  189. X10File=X10.DAT
  190. ;
  191. ; User Defined CommPort
  192. ; ---------------------
  193. ; IRQ and Base_IO_Address apply to User Defined CommPort ONLY
  194. ;
  195. ; IRQ=1-15                 DEFAULT=4; IF Base_IO_Address is set
  196. ;                                     --
  197. ; Base_IO_Address=nnnn(n)  DEFAULT=1016; IF IRQ is set
  198. ;                                        --
  199. IRQ=5
  200. Base_IO_Address=1016
  201. ;
  202. ; Colour Values
  203. ; -------------
  204. ; 0=Black  4=Red       8=Gray          12=Bright Red
  205. ; 1=Blue   5=Magenta   9=Bright Blue   13=Pink
  206. ; 2=Green  6=Brown    10=Bright Green  14=Yellow
  207. ; 3=Cyan   7=White    11=Bright Cyan   15=Bright White
  208. ;
  209. BackColor=7
  210. ForeColor=0
  211. HiLiteKey=14
  212. DisabledItem=8
  213. MenuBackColor=1
  214. MenuForeColor=7
  215. MenuSelectedBackColor=0
  216. MenuSelectedForeColor=7
  217. LabelBackColor=9
  218. LabelForeColor=7
  219. Hilite1ForeColor=4
  220. Hilite2ForeColor=1
  221. Hilite3ForeColor=14
  222. HelpTitleBackColor=5
  223. HelpTitleForeColor=15
  224. StatusTitleBackColor=4
  225. StatusTitleForeColor=15
  226. WarningTitleBackColor=12
  227. WarningTitleForeColor=15
  228. ;
  229. ; Other Screen Settings
  230. ; ----------------------
  231. ; ThreeD=ON/OFF*                 DEFAULT=ON
  232. ; Shadow=ON/OFF*                 DEFAULT=ON
  233. ; Graphics=ON/OFF                DEFAULT=ON
  234. ;  * OFF Recommended for Monochrome Displays
  235. ;
  236. ThreeD=ON
  237. Shadow=ON
  238. Graphics=ON
  239. ;
  240. ; End of X10DC.INI (13:59:37)
  241.  
  242. This X10DC.FILE was created using the 'Save Options' menu item.
  243.  
  244. NOTE:the DEBUGFORECOLOR directive was replaced with HILITE1FORECOLOR
  245.      effective with Version 1.50.  However, X10DC will still
  246.      recognize DEBUGFORECOLOR and map it to HILITE1FORECOLOR.
  247.      When the INI file is rewritten, the old directive will be
  248.      replaced.
  249.  
  250.  
  251. 6. COMMAND LINE ARGUMENTS
  252. ────────────────────────────────────────────────────────────────────
  253. DEFAULTS:  If the program is run without any command line arguments
  254.            it will default to COMMPORT 1,OPERATING MODE 1,DEBUG OFF,
  255.            F:X10.DAT.
  256.  
  257. The following command line arguments can be entered in any order:
  258.  
  259. /Annnn(n) ∙ Base I/O Address applicable to User Defined CommPort
  260.             (Must be specified as a decimal number)
  261.             If /I agrument is present, but /A is not; then Base
  262.             I/O Address will default to 1016 (3F8 Hex).
  263.  
  264. /BW  ∙ Use Monochrome colours (Black & White)
  265.  
  266. /Cn  ∙ COMMPORT where n = 1,2,3 & 4
  267.        ALWAYS overrides User Defined CommPort during Program Startup
  268.  
  269. /D   ∙ TURNS ON DEBUG MODE
  270.        When DEBUG MODE is ON, the CP290 responses & checksums are
  271.        displayed in the Command History List Box.
  272.  
  273. /F:[d]\filename ∙ X10.DAT FILE SPECIFICATION for MODE 3
  274.       where [d] = drivespec eg. /F:C:\X10\X10.DAT
  275.  
  276. /In  ∙ IRQ applicable to User Defined CommPort where n = 1 - 15
  277.        If /A argument is present, but /I is not; then IRQ
  278.        will default to 4.
  279.  
  280. /Mn  ∙ MODE where n = 1,2 or 3
  281.        MODE 1 Provides a List Box of Unit Codes; only 1 Unit Code
  282.               can be selected.  However, this mode will be easier to
  283.               use if you don't have a mouse since you'd have to TAB
  284.               through all the unit code check boxes used in MODE 2.
  285.        MODE 2 Provides a Check Box for each Unit Code plus ALL and
  286.               NONE buttons to quickly Check/Uncheck all check boxes.
  287.               In this mode, multiple Unit Codes can be targetted for
  288.               the X10 Command.
  289.        MODE 3 Provides a List Box of Devices which are read from
  290.               an X10.DAT file; X10DC will look for "X10.DAT" in the
  291.               current directory UNLESS the /F: command line argument
  292.               is supplied.  If X10.DAT cannot be found, the program
  293.               will switch to Mode 1.  Select 'Load X10 File' under
  294.               the File menu to load an X10.DAT file from another
  295.               sub-directory. (Once the file is loaded, its location
  296.               can be saved [REGISTERED VERSION ONLY] by selecting
  297.               'Save Options' under the Options menu.
  298.  
  299. /NH  ∙ Do Not Load HELP Sub-System
  300.  
  301. /NH- ∙ Load HELP Sub-System (Override INI directive)
  302.  
  303. /NS  ∙ No Sounds during Signal Test
  304.  
  305. /NS- ∙ Sounds during Signal Test (Override INI directive)
  306.  
  307. /P   ∙ Toggles ON 'Preserve ICON Data'
  308.        Normally, X10DC will only preserve the Event Memory stored
  309.        in the CP290.  This is because the DOS-based CP290 software
  310.        only utilizes the Cp290 Event Memory and does not utilize the
  311.        CP290 Icon memory area.  However, X10EC does store information
  312.        in the Icon memory, and X10DC has been upgraded to preserve
  313.        the Icon memory area for compatibility reasons.
  314.  
  315.  
  316.              NOTE: ONLY THE 1st 8 DEVICES CAN BE TARGETTED FOR
  317.                    COMMANDS WITH THE UNREGISTERED VERSION.
  318.  
  319.        1) Most Command Line directives (with the exception
  320.           exception of /A,/I & /NH) can be modified once the
  321.           program loads by selecting the appropriate menu items
  322.           under the Options Menu.  Registered Users can save all
  323.           these settings to the X10DC.INI file by using the 'Save
  324.           Options' menu item.
  325.  
  326.        2) COMMAND LINE OPTIONS OVERRIDE ALL X10DC.INI SETTINGS
  327.  
  328. 7. COMMUNICATION PORTS
  329. ────────────────────────────────────────────────────────────────────
  330. X10DC supports "pseudo standard" CommPorts 1 thru 4 using the
  331. following settings:
  332.  
  333.             ┌──────────┬──────┬──────────────────┐
  334.             │          │      │ Base I/O Address │
  335.             │ CommPort │ IRQ  ├─────────┬────────┤
  336.             │          │      │ Decimal │  HEX.  │
  337.             ├──────────┼──────┼─────────┼────────┤
  338.             │    1     │   4  │  1016   │  3F8   │
  339.             ├──────────┼──────┼─────────┼────────┤
  340.             │    2     │   3  │   760   │  2F8   │
  341.             ├──────────┼──────┼─────────┼────────┤
  342.             │    3     │   4  │  1000   │  3E8   │
  343.             ├──────────┼──────┼─────────┼────────┤
  344.             │    4     │   3  │   744   │  2E8   │
  345.             └──────────┴──────┴─────────┴────────┘
  346.  
  347. If one of these CommPort settings matches your hardware configuration
  348. simply use the /C command line argument with the appropriate
  349. CommPort.  The CommPort= X10DC.INI directive can also be used.  Note
  350. that if X10DC is run without the  /I (IRQ) or /A (Base I/O Address)
  351. Command Line arguments then the 'User Defined CommPort' is
  352. "undefined" and not selectable from the menu bar.
  353.  
  354. If your hardware configuration differs from the table above, then
  355. you can define your own CommPort by using the /I and /A command
  356. line arguments (or IRQ= & Base_IO_Address= X10DC.INI file directives).
  357. IRQ can be set to any value between 1 and 15 (inclusive).  Base I/O
  358. Address can be set to any value greater than zero.  CAUTION: your
  359. hardware may "lock up" if incorrect settings are used.  You should
  360. supply both arguments (/A & /I), however, if you only supply one of
  361. the arguments then the defaults applicable to CommPort 1 will apply
  362. to the other argument.  (eg. if only the /I5 argument is supplied,
  363. then the /A argument defaults to 1016).  If either the /I or /A
  364. argument is supplied, then the 'User Defined Commport' under the
  365. 'Options' menu becomes enabled.
  366.  
  367. NOTES: 1) The /C command line argument AND the CommPort= X10DC.INI
  368.           directive ALWAYS override the the User Defined CommPort
  369.           when the program first loads.  However, the 'User Defined
  370.           CommPort' will remain enabled under the 'Options' menu.
  371.           To start the program with the User Defined CommPort active,
  372.           ensure that there is no /C command line argument AND no
  373.           CommPort= X10DC.INI directive.
  374.  
  375.           THE BASE I/O ADDRESS MUST BE SPECIFIED IN DECIMAL NOTATION.
  376.  
  377.           IBM PS/2 CommPort Parameters are shown below:
  378.             ┌──────────┬──────┬──────────────────┐
  379.             │   PS/2   │      │ Base I/O Address │
  380.             │ CommPort │ IRQ  ├─────────┬────────┤
  381.             │          │      │ Decimal │  HEX.  │
  382.             ├──────────┼──────┼─────────┼────────┤
  383.             │    1     │   4  │  1016   │  3F8   │
  384.             │    2     │   3  │   760   │  2F8   │
  385.             │    3     │   3  │ 12832   │ 3220   │
  386.             │    4     │   3  │ 12840   │ 3228   │
  387.             │    5     │   3  │ 16928   │ 4220   │
  388.             │    6     │   3  │ 16936   │ 4228   │
  389.             │    7     │   3  │ 21024   │ 5220   │
  390.             │    8     │   3  │ 21032   │ 5228   │
  391.             └──────────┴──────┴─────────┴────────┘
  392.           A User Defined CommPort must be used for
  393.           PS/2 CommPorts 3-8.
  394.  
  395. 8. OPERATING MODES
  396. ────────────────────────────────────────────────────────────────────
  397. Operating Mode can be set using the 'Options' menu, the MODE command
  398. button (cycles through the modes), or the /M command line argument.
  399. ────────────────────────────────────────────────────────────────────
  400. MODE 1                    Unit
  401.                           Code            NOTE: Mode can be toggled
  402. In this mode only        ┌─────┐                at runtime by clicking
  403. one Unit Code can be     │   1                 the MODE button.
  404. selected from the        │   2 █                (Keyboard users press
  405. Unit Code List Box.      │   3 ░                 ALT-m).
  406.                          │   4 ░
  407.                          │   5 ░                Can also be set from
  408.                          │   6                 the Options Menu.
  409.                          └─────┘
  410. RECOMMENDED IF YOU DON'T HAVE A MOUSE.
  411. ────────────────────────────────────────────────────────────────────
  412. MODE 2                             Unit Code(s)
  413.                          ┌────────────────────────────┐
  414. In this mode multiple    │[X] 1  [ ] 5  [ ] 9   [ ] 13│
  415. Unit Codes can be        │[ ] 2  [ ] 6  [ ] 10  [ ] 14│
  416. checked; in addition     │[ ] 3  [ ] 7  [ ] 11  [ ] 15│
  417. the ALL button can be    │[ ] 4  [ ] 8  [ ] 12  [ ] 16│
  418. clicked to check all     │┌───────────┐  ┌───────────┐│
  419. the Unit Codes. The      ││    ALL    │  │    NONE   ││
  420. NONE button unchecks     │└───────────┘  └───────────┘│
  421. all the unit codes.      └────────────────────────────┘
  422.  
  423.  
  424. ────────────────────────────────────────────────────────────────────
  425. MODE 3          ** Example 1 **
  426.                   Unit Location               Description
  427. An X10.DAT      ┌────────────────────────────────────────────────────┐
  428. is read and     │ A  1│DINING ROOM           │TABLE LAMP             
  429. a List Box      │ A  2│FAMILY ROOM           │TV                     █
  430. replaces the    │ A  3│GARAGE                │CEILING LIGHT          ░
  431. House/Unit      │ A  4│GUEST ROOM            │DE-HUMIDIFIER          ░
  432. Controls used   │ G  7│HALL                  │CEILING LIGHT          
  433. in Modes 1 & 2. └────────────────────────────────────────────────────┘
  434. Also note that   {11 Device(s) Found} Brightness «█░░░░░░░» 1≈00.0%
  435. the Brightness
  436. List Box has been replaced by a Horizontal Slider Control. (above)
  437. ────────────────────────────────────────────────────────────────────
  438. 9. DEBUG MODE
  439.  
  440. ┌────────────────────────────────────────────────────────────────────┐
  441. │ Using COMMPORT: 2   X10 ∙ X-10 Direct Control   CP290 Day: Tuesday │
  442. │Base House Code: P         Version 1.50         CP290 Time: 11:51 AM│
  443. │Mode: 1   Debug ON      (c)1993 ∙ D.Huras          PC Time: 11:52 AM│
  444. └──────────────┼─────────────────────────────────────────────────────┘
  445.                └────┐
  446.                   ──┴─────
  447. When enabled, the DEBUG ON message appears in the screen Header and all
  448. responses from the CP290 are displayed in the Command History List Box,
  449. as well as Checksums and Timing Information.
  450.  
  451. Debug Mode can be toggled ON/OFF from the Options Menu.
  452.  
  453. NOTE: Debug Mode increases program overhead; memory requirements will
  454. be greater and program performance will be somewhat degraded.  It is
  455. recommended that you only toggle Debug Mode ON when necessary.
  456.  
  457. 10. PROGRAM OVERVIEW
  458. ────────────────────────────────────────────────────────────────────
  459. When X10DC initially loads, it requests the base house code and time
  460. stored in the CP290 via serial I/O using the selected COMMPORT.
  461. This information will be reported in the Screen Header if found.
  462. Note:  the CP290 Time and PC Time reported in the Screen are static
  463. and are only updated when the Base House Code is changed, a
  464. Self-Test is run or the Time is set.  You can use the 'Refresh' menu
  465. item under the 'Clock' menu to force an update to the on-screen Time
  466. displays.  The House Code List Box defaults to the Base House Code
  467. if the CP290 is found.  Once the program is loaded the SEND command
  468. button is disabled until you have selected all required
  469. information.  In some cases you need only to select a House Code and
  470. an Action (eg. All Units Off).  If the selected action is DIM, then
  471. a Brightness Level must be be selected before the SEND button
  472. becomes enabled.
  473.  
  474. The program supports 3 operating modes; use whatever mode suits
  475. your requirements.  Mode 3, which reads in Device Descriptions
  476. from an X10.DAT file, is likely the most user-friendly since you
  477. do not have to remember specific House/Unit code addresses.  X10EC
  478. a companion program to X10DC can read, write, and create X10.DAT
  479. files.
  480.  
  481. The Command History list box is scrollable and will store up to 1000
  482. commands after which it becomes a circular FIFO buffer.  If you
  483. suspect problems with your CP290, then you may want to toggle
  484. Debug Mode ON; in this case the Command History list box will
  485. contain additional information including responses from the CP290.
  486. You may also want to perform a CP290 Self-Test to ensure that
  487. the CP290 Memory is not being corrupted.
  488.  
  489. Finally, if you are experiencing X-10 transmission problems in your
  490. application; you may want to take advantage of the Signal Test
  491. Generator features provided by X10DC.  This subject is covered in
  492. detail in a later section of this document.
  493.  
  494. 11. KEYBOARD USAGE
  495. ────────────────────────────────────────────────────────────────────
  496. Use the TAB/Shift-TAB keys to move among the various controls.(*3)
  497. The Up/Down arrows can be used to move up and down List Boxes, and
  498. the Spacebar and Enter key can be used to select the current List
  499. Box item, check/uncheck a check box, or invoke a command button.
  500. The ESCAPE key will exit the current function or the program if no
  501. other windows are visible.  All of the Command Buttons and controls
  502. have quick access keys:
  503.  
  504.      House Code ∙ Alt-o [Mode 1 & 2]
  505.    Unit Code(s) ∙ Alt-u [Mode 1 & 2]
  506.     Device List ∙ Alt-u [Mode 3]
  507.             ALL ∙ Alt-l [Mode 2]
  508.            NONE ∙ Alt-n [Mode 2]
  509.          Action ∙ Alt-a
  510.      Brightness ∙ Alt-b [when enabled]
  511.  
  512.            MODE ∙ Alt-m (*3)
  513.            SEND ∙ Alt-s
  514.            EXIT ∙ Alt-x
  515.            HELP ∙ Alt-h
  516.  
  517. Command History ∙ Alt-c
  518.  
  519. (*3) The MODE Command Button is NOT in the TAB STOP sequence;
  520.      Keyboard users must use ALT+character to access this
  521.      button. (This eliminates extraneous TAB keystrokes)
  522.  
  523. 12. MENU BAR
  524. ────────────────────────────────────────────────────────────────────
  525. Press & release the ALT key to activate the Menu Bar.  Menu items
  526. can be selected by pressing the highlighted key (when applicable),
  527. or by positioning the highlight bar using the up/down arrow keys and
  528. pressing ENTER.  Some screen button functions are replicated within
  529. the menus (eg. Exit, Help).  However, there are some functions which
  530. are only available from within menus.  CommPort, Operating Mode,
  531. Debug, & Sounds can all be set from the Options Menu; the current
  532. state of each of these parameters is indicated on the menu itself
  533. with a '∙' character to the left of the menu item.
  534.  
  535. The following short-cut keys can also be used at any time to
  536. select menu items:
  537.  
  538. *FILE* Menu
  539.         Load X10 File ∙ Ctrl-L
  540.             Exit      ∙ Ctrl-X (Same as Exit Button, Alt-X)
  541.  
  542. *CLOCK* Menu
  543.          Set PC Clock ∙ Ctrl-T (Enter Time)
  544.       Set CP290 Clock ∙ Ctrl-K (Synchronize w/PC) - Registered Version
  545.        Refresh Clocks ∙ Ctrl-R
  546.    Set Base HouseCode ∙ Ctrl-B (Preserve Events) - Registered Version
  547.  
  548. *TEST* Menu
  549.       CP290 Self Test ∙ Ctrl-E
  550. Signal Test Generator ∙ Ctrl-G
  551.  
  552. *OPTIONS* Menu
  553.            CommPort 1 ∙ Ctrl-F1
  554.            CommPort 2 ∙ Ctrl-F2
  555.            CommPort 3 ∙ Ctrl-F2
  556.            CommPort 4 ∙ Ctrl-F2
  557. User Defined CommPort ∙ Ctrl-F5 (when applicable)
  558.  
  559.                Mode 1 ∙ Shift-F1
  560.                Mode 2 ∙ Shift-F2
  561.                Mode 3 ∙ Shift-F3
  562.  
  563.         Sounds Toggle ∙ Ctrl-N
  564.     Debug Mode Toggle ∙ Ctrl-D
  565.    Preserve ICON Data ∙ Ctrl-I
  566.  
  567.        Screen Colours ∙ Ctrl-C
  568.  
  569.          Save Options ∙ Ctrl-S  [Not Available in Unregistered Version]
  570.  
  571. *HELP* Menu
  572.                  Help ∙ F1 (Same as Help Button, Alt-H)
  573.                 About ∙ Ctrl-A
  574.  
  575. 13. UNDOCUMENTED CP290 COMMANDS
  576. ────────────────────────────────────────────────────────────────────
  577. X10EC supports the following undocumented CP290 commands:
  578.  
  579.    Fade OFF   ■ DIMS Light(s) to 0 then turns Unit(s) OFF
  580.                 (Can target multiple units for this command)
  581.    X-Light ON ■ Exclusive Light ON - Issues an ALL LIGHTS OFF
  582.                 then Brightens selected Unit(s)
  583.                 (Can target multiple units for this command)
  584.    All Lights ON  ■ All Lights on selected House Code set ON
  585.    All Lights OFF ■ All Lights on selected House Code set OFF
  586.    All Units OFF  ■ All Units on selected House Code set OFF
  587.  
  588. 14. CP290 SELF TEST
  589. ────────────────────────────────────────────────────────────────────
  590. The CP290 can perform a Self-Test to determine if there are any
  591. detectable problems within the device.  The Self-Test will return
  592. either a pass or fail status when it is run.  X10DC will report the
  593. results of the test in the CP290 Status window.  Whenever a
  594. Self-Test is run the memory contents of the CP290 are overwritten.
  595. X10DC can preserve the CP290 Event and Icon Data by downloading it
  596. from the CP290 prior to the Self-Test and uploading it back to the
  597. CP290 after the Test.  (X10DC also allows a Self-Test to be invoked
  598. without event preservation, but this leaves the device in a state
  599. which may cause problems with other programs that communicate with
  600. the CP290. It is recommended that the Self-Test always be invoked
  601. with Event Preservation regardless of whether or not there is any
  602. stored Event Data.)
  603.  
  604. 15. SIGNAL TEST GENERATOR
  605. ────────────────────────────────────────────────────────────────────
  606. The Signal Test Generator is a powerful feature that enables the
  607. user to track down and isolate X-10 transmission/reception problems
  608. and faulty modules.  This feature will send X-10 ON/OFF commands
  609. repeatedly until the test is ended by the user.  (Similar to the
  610. Leviton 6385 device).  The address to be targetted for commands can
  611. be a fixed House Code and Unit Code; alternatively, either the House
  612. Code or Unit Code (or both) can be varied. This allows you to send
  613. commands repeatedly to:
  614.  
  615. ∙ A 'Fixed' House Code & 'Fixed' Unit Code (eg. A1)
  616. ∙ A 'Fixed' House Code & 'Variable' Unit Code (eg. A1 - A16)
  617. ∙ A 'Variable' House Code & 'Variable' Unit Code (ie. A1 - P16;
  618.   All 256 addresses would be tested in this case)
  619. ∙ A 'Variable' House Code & 'Fixed' Unit Code (eg. A1 - P1)
  620.  
  621. When the Signal Test Generator is selected, a window is
  622. displayed that allows you to set the House Code & Unit Code to
  623. either 'Fixed' or 'Variable' mode; if 'Fixed' is selected then
  624. a List Box is enabled so that the fixed code can be selected.
  625. The Delay between commands can be set from 0 to 60 seconds;
  626. this delay applies to the pause between each pair of ON/OFF
  627. commands.  Once all required settings have been made the OK
  628. button becomes enabled.  When the OK button is clicked the
  629. test will begin; the test can be terminated by pressing [Esc].
  630. Note, if the Delay is set to 0, then the [Esc] key may have to
  631. be hit several times to stop the Signal Test.  X10DC will emit
  632. a brief beep before each ON command is sent, and another lower
  633. pitched beep before each OFF command is sent.  These beeps can
  634. be disabled by toggling the Sounds item on the 'Options'
  635. Menu.
  636.  
  637. 'Fixed' Mode Testing
  638. ────────────────────
  639. Generally speaking, you would want to use the 'Fixed' option
  640. to test the range of X-10 signal reception by starting the
  641. Signal Test using address P1 for example (the "only" address
  642. that the Leviton 6385 will test) and then walking around to a
  643. variety of outlet locations within your home and plugging in a
  644. module set to P1 to see if the ON & OFF commands are being
  645. received at all locations.  The program attempts to let you
  646. know when the commands are sent by beeping although you may
  647. not be able to hear the beep from all outlet locations.
  648.  
  649. 'Variable' Mode Testing
  650. ───────────────────────
  651. The 'Variable'(*4) option can be used when you suspect that an
  652. X-10 module has trouble receiving commands targetted for
  653. specific House and/or Unit Codes.  In this case, instead of
  654. walking around to locations, you would adjust the House and/or
  655. Unit Code dials on the module as the Signal Test cycles
  656. through each combination.  You may want to toggle the Sounds
  657. off in this case.
  658.  
  659. ────
  660. (*4) Not available in UNREGISTERED Version
  661.  
  662. 16. CLOCK SYNCHRONIZATION
  663. ────────────────────────────────────────────────────────────────────
  664. Clocks tend to run either fast or slow and therefore should be
  665. synchronized periodically.  X10DC allows you to set the time in both
  666. the PC and CP290 manually by specifying hh:mm and also allows you to
  667. synchronize the PC and CP290 by using one of the clocks to set the
  668. other.  When the PC clock is used to synchronize the CP290 clock,
  669. X10DC will wait until the seconds are at zero since the resolution
  670. of the CP290 clock is limited to minutes.  (This wait can be
  671. cancelled by pressing the [Esc] key).  When the CP290 is used to
  672. synchronize the PC, the hours and minutes from the CP290 are used
  673. immediately to set the PC Clock; since the CP290 cannot provide
  674. 'seconds', it is recommended that a CP290->PC Clock Sync be followed
  675. by a PC->CP290 Clock Sync.  This will ensure that both Clocks are
  676. synchronized.
  677.  
  678. 17. BASE HOUSECODE
  679. ────────────────────────────────────────────────────────────────────
  680. The Base HouseCode stored in the CP290 is only applicable to the
  681. rocker keys on the top of the CP290.  These keys are labelled 1 to 8
  682. and correspond to whatever House Code is stored as the Base
  683. HouseCode in the CP290.  The CP290 re-initializes itself whenever
  684. the Base HouseCode is changed; as a result, all of the CP290 Event
  685. Data is erased.  X10DC gives you the option of either Preserving or
  686. Erasing the Event and Icon Data whenever the Base HouseCode is
  687. changed.  If the user elects to preserve the Event Data, it is
  688. downloaded from the CP290 before the Base HouseCode is changed and
  689. then uploaded back to the CP290 after the Base HouseCode has been
  690. changed.
  691.  
  692. 18. PROBLEM RESOLUTION
  693. ────────────────────────────────────────────────────────────────────
  694. Generally, if your CP290 works with the X-10 supplied software then
  695. you should have no problems running X10DC.  The program will load if
  696. you run it without any arguments (thereby defaulting to COMMPORT 1)
  697. and your CP290 is actually attached to COMMPORT 2.  If this is the
  698. case X10DC will report an error when it attempts to retrieve the
  699. Time and Base HouseCode.  You can toggle to the correct COMMPORT
  700. once the program is running by using the Options menu.  In future
  701. you should include the Command Line argument /C2 if your CP290 is
  702. connected to COMMPORT 2.  The Save Options menu option will save all
  703. settings to the X10DC.INI which obviates the need for command line
  704. arguments.
  705.  
  706. If you run X10DC with a modem attached to the COMMPORT, you may get
  707. unpredictable results since the modem will echo everything back to
  708. X10DC.
  709.  
  710. If you are sure that the X10DC is using the correct COMMPORT and
  711. problems persist, try using Debug mode and then scroll through the
  712. Command History List Box; see if the calculated checksums match;
  713. look at the TIMER and MaxTimer Values. If the MaxTimer Value exceeds
  714. the TIMER value then the program is timing out while waiting for
  715. X-10 responses. PLEASE REPORT ANY TIMING PROBLEMS TO ME; adjustments
  716. can be made to the program to improve its compatibility if this
  717. turns out to be a problem.  As a last resort, run the CP290 Self
  718. Test, but only do so if you have backed up your EVENT DATA using a
  719. program you are sure works within your operating environment.
  720. (X10DC will preserve the CP290 Event Data but if you are
  721. experiencing problems with X10DC then this function may fail).
  722.  
  723. In some cases X10DC may report that a command failed, or a checksum
  724. did not match, but in fact the command was accepted by the CP290 and
  725. transmitted on the powerline.  This could happen if spurious
  726. responses are received from the CP290, ie.  if you were to press the
  727. rocker buttons on the CP290 just after sending a command.  If this
  728. happens, exit the program and re-invoke it to resynchronize,
  729. alternatively, if you have 2 serial ports you could try toggling the
  730. CommPort. (ie. if your CP290 is on CommPort 1 then switch to
  731. CommPort 2, then switch back to CommPort 1).
  732.  
  733. The open architecture of the PC compatible operating environment and
  734. the near infinite combinations of hardware and software complicate
  735. the compatibility of applications software.  While every effort has
  736. been made to ensure that X10DC is compatible with all
  737. hardware/software combinations, there may be operating environments
  738. in which X10DC will not run properly.
  739.  
  740. Problems can be reported to:
  741.  
  742.    David Huras
  743.    37 Ruddell Crescent
  744.    Georgetown, Ont. L7G 5N4
  745.    CANADA
  746.  
  747.    FAX: 905-873-6429
  748.    CIS: 72767,472
  749.    Internet: david.huras@canrem.com
  750.  
  751. 19. REGISTRATION INFORMATION
  752. ────────────────────────────────────────────────────────────────────
  753. X10DC is currently supplied as fully functioning software without
  754. built-in delays or obtrusive "nag" screens prompting you to
  755. register.  The ABOUT screen contains registration information in
  756. case this documentation file gets misplaced.  A significant amount
  757. of time and effort went into this program; please register the
  758. program if you intend to use it beyond the 30 day evaluation period.
  759. Registered Users will be shipped a printed manual and a 3½" diskette
  760. (if you would prefer a 5¼" diskette please advise) containing the
  761. Registered Version of the program which includes the following
  762. features:
  763.  
  764. ∙ Full support for the Signal Test Generator which allows you to
  765.   cycle through all House & Unit Codes and send an ON/OFF command
  766.   to each address.
  767.  
  768. ∙ Full support for operating mode 3 which reads in an X10.DAT file
  769.   and builds a "list box" of device names which can be targetted
  770.   for X10 commands.  (Unregistered Version will only send commands
  771.   to the first 8 Devices).
  772.  
  773. ∙ Support for an INI file which provides complete program
  774.   customization capabilities including Screen Colours.
  775.  
  776. ∙ BONUS PROGRAM: Registered Users will also receive a bonus
  777.   program; X10DAT reads an X10.DAT file and prepares a report
  778.   listing all installed devices and scheduled events including
  779.   "frozen" events and multiple unit events. See X10DAT.RPT for
  780.   a report sample.
  781.  
  782. Charge the registration fee to your Visa, Master Card, American
  783. Express by ordering X10DC (Item #10924) from Public (software)
  784. Library, call 800-242-4PsL (713-524-6394 overseas) or FAX your
  785. order to 713-524-6398.  These numbers are for ordering only.
  786. ALL OTHER INQUIRIES (eg. technical support, volume discounts
  787. site licensing) should be directed to the author: see PROBLEM
  788. RESOLUTION section.
  789.  
  790.    -=OR=-
  791.  
  792. Register by sending $20 (cheque/money order) to:
  793.  
  794.    David Huras
  795.    37 Ruddell Crescent
  796.    Georgetown, Ont. L7G 5N4
  797.    CANADA
  798.  
  799. Alternatively, you may wish to register using CompuServe Shareware
  800. Registration; you can register X10DC, X10EC or BOTH using CompuServe
  801. Shareware Registration.  The Registration Fee will be charged to
  802. your CompuServe billing account and the latest version of the
  803. software will be shipped within one business day. GO SWREG while on
  804. CompuServe to use Shareware Registration.
  805.  
  806. Program Title         Program Name    Program ID#   Charge
  807. ═══════════════════   ════════════    ═══════════   ═══════
  808. X-10 Direct Control      X10DC             620       $20.00
  809. X-10 Event Control       X10EC            1774       $25.00
  810.  
  811. X-10 Control Bundle      X10CB            1775       $40.00
  812. (X10DC + X10EC)
  813.  
  814. Shareware Registration (SWREG) will prompt you through the
  815. registration process; you can register programs by referring to them
  816. by program name or ID #.  SWREG will display a description of the
  817. program and prompt you to confirm the registration order; you have
  818. the opportunity to abandon the registration process at any time.
  819.  
  820. ╔══════════════════════════════════════════════════════════════╗
  821. ║REGISTERED USERS of prior versions of X10DC can upgrade to the║
  822. ║current version at ANY TIME by simply sending a diskette      ║
  823. ║containing their registered version of the software and $2    ║
  824. ║for postage to the address above.                             ║
  825. ╚══════════════════════════════════════════════════════════════╝
  826.  
  827. 20. OTHER HOME AUTOMATION SOFTWARE by David Huras
  828. ────────────────────────────────────────────────────────────────────
  829. Program   Description                                     Status
  830. -------   ------------------------------------------   --------------
  831. X10DC     X10 Direct Control - CP290 Point & Click     Version 1.50
  832.           Initial Release: February '93                December '93
  833.  
  834. X10EC     X10 Event Control - CP290 Point & Click      Version 1.00
  835.           Interface Program to manage Event Data.      December '93
  836.           Includes Sunrise/Sunset Time Offsets.
  837.           Initial Release: December '93
  838.  
  839. IRDC/     INFRA-RED Direct Control/Command Line Ctrl   Version 1.01
  840. IRDQ      A program which sends instructions to a      October '93
  841.           ONE FOR ALL (6 or 12) remote control. The
  842.           remote then emits I/R signals.
  843.  
  844. IRDCW     INFRA-RED Direct Control for WINDOWS         Version 1.00
  845.                                                        Development
  846.  
  847. ────────────────────────────────────────────────────────────────────
  848. Please register this software if you use it regularly; by registering
  849. you reinforce my commitment to ongoing development.
  850. ────────────────────────────────────────────────────────────────────
  851.  
  852. 21. RELEASE HISTORY ∙ X10DC Shareware/Registered Version
  853. ────────────────────────────────────────────────────────────────────
  854.  Date      Version     Changes
  855. ------   ----------   ----------------------------------------------
  856. DEC'93    1.50        ■Added support for 5 UNDOCUMENTED CP290 Cmds
  857.                       ■Added support for ICON Data Preservation
  858.                       ■Optimized screen layout for all 3 Modes
  859.                       ■Added support for EGA/VGA 43/50 Line Mode
  860.                       ■Added graphic 'percentage complete' gauges
  861.                       ■Countdown Timer added to Status Window while
  862.                        waiting for CP290 responses.
  863. NOV'93    1.42        ■Corrected problem reporting Base House Code
  864.                        when CP290 returns bad data.
  865. AUG'93    1.41        ■Public (software) Library registration method
  866.                        added to documentation.
  867.                       ■X10DAT Bonus Program added as registration
  868.                        benefit.
  869.                       ■X10DC.INI File Comment re: X10File argument
  870.                        corrected in documentation.
  871. AUG'93    1.40        ■Corrected 'Load X10 File' problem when X10.DAT
  872.                        located in Root Directory.
  873.                       ■Corrected problem whereby X10DC.INI was not
  874.                        processed when X10DC was started from a Root
  875.                        Directory (impacted Registered Version only).
  876. AUG'93    1.40 ß      ■COMMPORT 3 & 4 Support Added.
  877.                       ■User Defined CommPort support Added.
  878.                       ■Minor changes to default colours (LABELS).
  879. JUL'93    1.32        ■Corrected problem with DEBUG MODE colour setting
  880.                        not 'sticking'; setting from INI is workaround.
  881.                        (Not released).
  882. JUL'93    1.31        ■Fixed mouse cursor reset problem if Signal Test
  883.                        is run without a CP290 device. (Not released).
  884. JUL'93    1.30        ■ENABLED SEND Command under MODE 3 in Unregistered
  885.                        version for 1st 8 Devices in X10.DAT File
  886.                       ■ENABLED ALL Clock Sychronization options in
  887.                        Unregistered version
  888.                       ■ENABLED Change Base HouseCode with Event
  889.                        Preservation in Unregistered version
  890.                       ■ENABLED Screen Colours dialogue in Unregistered
  891.                        version
  892.                       ■Test menu item added to Menu Bar;
  893.                        ∙ CP290 Self Test disassociated with Debug Mode
  894.                          and Self Test button removed from Screen
  895.                          Header; Self-Test feature now a sub-menu
  896.                          item under Test.
  897.                        ∙ Signal Test Generator feature added; send
  898.                          ON/OFF commands repeatedly to a fixed/variable
  899.                          House Code/Unit Code address.  Unregistered
  900.                          version supports the fixed option only.
  901.                       ■Help Sub-system added; contains additional
  902.                        X10 background information as well as extracts
  903.                        from the documentation file.
  904.                       ■/NH command line argument added to optionally
  905.                        not load the help system for faster program
  906.                        load times.
  907.                       ■/NS command line argument added to disable
  908.                        sounds generated during the Signal Test.
  909.                       ■Sounds Toggle added as a sub-menu item under
  910.                        Options.
  911.                       ■INI Overwrite warning now uses the WARNING
  912.                        screen title colour(*5)
  913.                       ■'Save Options' displays a message box whenever
  914.                        INI options are saved(*5)
  915.                       ■The access key for the 'Exit' option under the
  916.                        'File' menu changed from 'E' to 'x'.
  917.                       ■[Esc] key will now back out any screen
  918.                        colour changes while in the Screen Colours
  919.                        dialogue
  920.                       ■[Esc] key will now skip the wait while
  921.                        SYNC'ing the CP290 clock based on the PC
  922.                        Clock
  923. MAR'93    1.20        ■Merged Shareware & Registered Versions;
  924.                        Registered Version features are disabled in
  925.                        the Unregistered version, specifically:
  926.                          ∙ Complete Mode 3 Support (X10.DAT File)
  927.                          ∙ Complete Screen Color Customization
  928.                            Dialogue
  929.                          ∙ INI File Support to save/modify
  930.                            Program settings/colors
  931.                          ∙ Preserve/Restore Event Data when
  932.                            Base House Code changed
  933.                          ∙ PC » CP290 Clock Synchronization
  934.                          ∙ CP290 » PC Clock Synchronization
  935.                       ■ENABLED Self Test EVENT Preservation
  936.                        in Unregistered version
  937.                       ■ENABLED MODE 3 Switch & X10.DAT File Load
  938.                        in Unregistered version (SEND-Disabled)
  939.                       ■ENABLED some Clock Functions, & Base House
  940.                        Code Setting in Unregistered Version
  941.                       ■CP290 Self Test changed to reset interface
  942.                        upon completion (The self test overwrites
  943.                        the Event Data and this data may cause
  944.                        problems with some programs)
  945.                       ■Added /BW command line argument to startup
  946.                        with monochrome color settings
  947.                       ■Added 'Refresh' menu item to refresh on-screen
  948.                        Clock Displays
  949.                       ■Error handling improved
  950.                       ■Retry logic added for all CP290 communications
  951.                        with automatic wait time adjustment (if program
  952.                        times out waiting for a response, it will
  953.                        increase the wait time if the command is retryed)
  954.                       ■Command History caption now indicates which
  955.                        entry is highlighted (ie. entry x of n)
  956.  
  957. MAR'93    1.10        ■MENU BAR Added - CommPort,Mode, & Debug can
  958.                        now be changed using the Options Menu
  959.                       ■Mode Indicator added to Screen Header
  960.                       ■Minor Screen Colour modifications
  961.  
  962. FEB'93    1.00        ■Mode Switch Command Button Added (Alt-M)
  963.                       ■Debug Command Button TAB Stop disabled-keyboard
  964.                        users must use ALT-T
  965.                       ■CIS Software Registration # added to ABOUT
  966.  
  967. FEB'93    1.00 ß.02   ■Operating Mode 2 Added (FIRST PUBLIC RELEASE)
  968.                       ■Operating Mode 3 Added to Registered Version
  969.                       ■Clock/Base House Code manipulation added to
  970.                        Registered Version
  971.  
  972. JAN'93    1.00 ß.01   ■Debug Mode Added
  973.  
  974. JAN'93    1.00 ß.00   ■Initial Beta (not publicly released)
  975.  
  976. ──────
  977.  (*5) Applicable to REGISTERED VERSION Only.
  978.