home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 31 / CDASC_31_1996_juillet_aout.iso / vrac / x10ec130.zip / X10ECDOS.EXE / X10EC.DOC < prev    next >
Text File  |  1996-05-31  |  62KB  |  1,324 lines

  1. --------------------------------------------------------------------
  2. X10EC - X10 Event Control
  3. --------------------------------------------------------------------
  4. Version 1.30
  5. May 1996
  6.  
  7. Copyright 1993-1996 - D.Huras - All Rights Reserved
  8.  
  9. -----------------------------------------------X10EC.DOC v1.30------
  10. CONTENTS
  11. --------------------------------------------------------------------
  12.  1. DESCRIPTION               14. SAVE OPTIONS
  13.  2. REQUIREMENTS              15. INTELLIGENT EDIT
  14.  3. WARRANTY                  16. UNDOCUMENTED CP290 COMMANDS
  15.  4. FEATURE OVERVIEW          17. INCREMENTAL BRIGHTENING
  16.  5. QUICK START INSTRUCTIONS  18. DIRECT COMMAND PAD
  17.  6. INSTALLATION INSTRUCTIONS 19. LAST UPLOAD DATE/TIME
  18.  7. COMMAND LINE ARGUMENTS    20. CP290 ICON STORAGE
  19.  8. PROGRAM OVERVIEW          21. BATCH MODE PROCESSING
  20.  9. KEYBOARD USAGE            22. COMPATIBILITY ISSUES
  21. 10. START UP OPTIONS          23. PROBLEM RESOLUTION
  22. 11. COMMUNICATION PORTS       24. REGISTRATION INFORMATION
  23. 12. SCREEN DISPLAY OPTIONS    25. UPGRADE INFORMATION
  24. 13. SUN TIME PARAMETERS       26. RELEASE HISTORY
  25.                               27. ACKNOWLEDGEMENTS
  26. 1. DESCRIPTION
  27. --------------------------------------------------------------------
  28. X10EC is an Event Scheduler for the X10 CP290 Computer Interface(*1)
  29. with many distinguishing features.  X10EC is a full-screen DOS
  30. program that uses a simple point & click user interface.  (A Mouse
  31. though not required is highly recommended).  X10EC is designed to be
  32. robust software that is processor speed independent; however, the
  33. overhead required for the user interface is significant and a 286 or
  34. above processor is recommended.  This program is shareware and you
  35. are invited to evaluate it for 30 days.  If you continue to use the
  36. program after the 30-day evaluation period you are asked to register
  37. it.  The author retains all rights to the program.
  38.  
  39. (*1) The CP290 Computer Interface is a device manufactured by X-10
  40.      that can be connected to a microcomputer serial port.  The CP290
  41.      also plugs into an electrical outlet and it is through this
  42.      connection that the CP290 imposes X-10 commands onto the powerline.
  43.      X-10 commands use the power line as a carrier; other X-10 devices
  44.      connected to the power line will respond to these commands (ie.
  45.      switch ON/OFF lights, appliances).
  46.  
  47. 2. REQUIREMENTS
  48. --------------------------------------------------------------------
  49. - An IBM-Compatible PC with at least 1 serial port.
  50.  
  51. - An X10 CP290 Computer Interface attached to a serial port.
  52.  
  53. - A Microsoft-Compatible Mouse is highly recommended
  54.  
  55. - A Colour adapter/display is recommended although the program
  56.   should run with a monochrome display/adapter.  If you
  57.   experience problems with the default colors, then try the /BW
  58.   command line argument which will set everything to Black &
  59.   White.
  60.  
  61. The program requires approximately 525K available conventional memory
  62. to run.  The program will attempt to run if less than 525K is
  63. available; however, depending on the number of Events/Devices
  64. loaded and the number of modeless Windows opened, an 'Out of Memory'
  65. error may occur.  X10EC will forewarn you of a low memory situation
  66. during program startup.  You can reduce the memory requirements
  67. somewhat by foregoing the online Help Sub-system (See STARTUP
  68. OPTIONS).
  69.  
  70. 3. WARRANTY
  71. --------------------------------------------------------------------
  72. X10EC is supplied as is.  The author disclaims all warranties,
  73. expressed or implied, including, without limitation, the warranties
  74. of merchantability and of fitness for any purpose.  The author
  75. assumes no liability for damages, direct or consequential, which may
  76. result from the use of X10EC.
  77.  
  78. 4. FEATURE OVERVIEW
  79. --------------------------------------------------------------------
  80. - User-Friendly point & click DOS character-based Interface.
  81.  
  82. - Most program functions can be controlled using a mouse; minimal
  83.   keyboard intervention is required.
  84.  
  85. - Supports Standard CommPorts 1 thru 4 and a User Defined CommPort
  86.   that can support any IRQ between 1 & 15 (inclusive) and any
  87.   Base I/O Address.
  88.  
  89. - SUPPORTS * 5 * UNDOCUMENTED CP290 Commands.
  90.  
  91. - Pop-up X-10 Direct Command Pad w/UNDOCUMENTED CP290 Command Support.
  92.  
  93. - Compatible with the X10.DAT file format used by X10.EXE
  94.   (X10.DAT files can be read, created, updated and written).
  95.  
  96. - Supports X10.EXE 'Frozen' Events
  97.  
  98. - Supports Relative Times (Sunrise/Sunset +/- Offsets) and can be
  99.   setup to observe Daylight Savings Time.
  100.  
  101. - Stores ALL EVENT information (including Sunrise/Sunset Offsets
  102.   and Last Upload Date/Time) within the CP290
  103.  
  104. - Optionally synchronizes CP290 or PC Clock upon Event Upload.
  105.  
  106. - CP290 & PC Clock Setting/Synchronizing Function
  107.  
  108. - EVENTS can be programmed without touching the keyboard
  109.   (using a mouse)
  110.  
  111. - EVENTS can be sorted using one of 3 sort criteria's
  112.  
  113. - Flexible EVENT Scheduling; Program EVENTS from a DEVICE List
  114.   Window -OR- an EVENT List Window
  115.  
  116. - 'Intelligent' Edit (referential integrity) automatically
  117.   updates EVENTS when you change a DEVICE House/Unit address
  118.  
  119. - Merge Events from any number of X10.DAT files into one X10.DAT
  120.   file (up to the CP290 maximum of 128 Events).
  121.  
  122. - Merge Device Descriptions from any number of X10.DAT
  123.   files into one X10.DAT file
  124.  
  125. - Runs in batch mode to recycle Sunrise/Sunset times after
  126.   a user specified number of days have passed since the last upload
  127.  
  128. - Runs in batch mode to replace the CP290 Event Schedule with
  129.   the Events contained within an X10.DAT file.
  130.  
  131. - Detects and exploits EGA/VGA 43/50 line mode
  132.  
  133. - A comprehensive on-line Help sub-system that can be disabled
  134.   at the user's option to decrease program load time.
  135.  
  136. - The program WILL load without a CP290 Interface attached, however
  137.   all attempts at serial communications will result in errors; the
  138.   program will attempt to trap all such errors.
  139.  
  140. 5. QUICK START INSTRUCTIONS
  141. --------------------------------------------------------------------
  142. These instructions are targetted for experienced users who wish
  143. to get up & running quickly without reading this entire document:
  144.  
  145. 1) Install X-10 Event Control to a sub-directory of your choice;
  146.    preferably NOT the same sub-directory where X10.EXE resides.
  147. 2) If you have a relevant X10.DAT file, then copy it to the
  148.    sub-directory where you have installed X10EC.EXE; if you don't
  149.    have an X10.DAT file X10EC can build one for you.
  150. 3) If your CP290 is on CommPort 1, then run X10EC without any
  151.    command line arguments; otherwise use the /Cn argument where
  152.    n = CommPort (for non-standard IRQ/Base_IO_Address set up see
  153.    COMMUNICATION PORTS section).
  154. 4) a) X10.DAT File AVAILABLE
  155.       X10EC will load the Devices and Events from your X10.DAT
  156.       file and display them in the DEVICES and EVENTS Windows
  157.       respectively.  If the EVENTS in your X10.DAT file are not
  158.       up to date, then 'Download Events' using the 'Transfer'
  159.       menu item.  When the Events have been downloaded they
  160.       will be matched against your DEVICES; any Events for
  161.       house/unit codes that are not defined as a DEVICE will
  162.       show up as 'Unnamed Device' - click on 'Name Device' to
  163.       name these Devices.
  164.    b) X10.DAT File NOT AVAILABLE
  165.       X10EC will load and attempt to load Devices & Events from
  166.       an X10.DAT file (that doesn't exist); each load attempt
  167.       will abort, click on OK to continue.  You will see an
  168.       empty EVENTS window, use the 'Download Events' menu item
  169.       under 'Transfer' to populate your EVENTS Window. Now
  170.       scroll through the EVENT List and click on 'Name Device'
  171.       for each 'Unnamed Device'; type a Description and/or
  172.       Location for each.
  173. 5. SAVE your X10.DAT file; press CTRL-S.
  174. 6. EDIT existing DEVICES and/or EVENTS by double-clicking
  175.    the list item your wish to change. (or click on Modify once
  176.    you've highlighted the list item).  You can apply as many edits
  177.    as you wish and experiment with the program. NO CHANGES WILL
  178.    BE UPLOADED TO YOUR CP290 UNTIL YOU EXPLICITLY UPLOAD THEM
  179.    USING THE TRANSFER MENU.  Similarly, no changes will be
  180.    written to your X10.DAT File until you explicitly use the
  181.    SAVE Menu.  X10EC will prompt you to save your X10.DAT File
  182.    if any changes were made to the Devices or Events when you
  183.    Exit the program UNLESS you use the Unconditional Exit which
  184.    quickly Exits the Program without prompting you to save
  185.    anything.
  186.  
  187. 6. INSTALLATION INSTRUCTIONS
  188. --------------------------------------------------------------------
  189. There are no special installation instructions; simply run the
  190. SETUPDOS program will will extract files from the X10ECDOS.EXE file.
  191. X10EC will look for 3 files in the directory it is run from.  However,
  192. the program will run with or without the following 3 files:
  193.  
  194.   1) X10EC.INI
  195.      The X10EC.INI file is a text file containing all program
  196.      parameters; there is no need to create this file yourself
  197.      since the program will generate one whenever you select the
  198.      'Save Options' menu item. If an X10EC.INI file is not found
  199.      (which will be the case the first time X10EC run), X10EC
  200.      will revert to program defaults.  A sample X10EC.INI file
  201.      (generated by X10EC.EXE) is shown below.
  202.  
  203.   2) X10EC.HLP
  204.      X10EC retrieves the on-line help text from this file. If the
  205.      file is not found then X10EC will continue loading however
  206.      the help feature will be disabled. If you wish to reduce
  207.      X10EC's memory requirements, you can uncheck 'Load Help'
  208.      from the Startup Options screen, or use the /NH command
  209.      line argument.
  210.  
  211.   3) X10.DAT
  212.      The default X10 Startup File is X10.DAT; X10EC will attempt
  213.      to retrieve Device Descriptions and Events from this file
  214.      in order to populate the DEVICES and EVENTS Windows respectively.
  215.      An X10.DAT file is a file format used by the X10 program
  216.      supplied by X10 with the CP290 interface.  From the Startup
  217.      Options screen you can instruct X10EC to look for the Startup
  218.      X10 File on any drive/sub-directory.  Conversely, you can
  219.      instruct X10EC to NOT retrieve Devices and/or Events from
  220.      an X10.DAT file upon Program Startup; in this case X10EC
  221.      will open empty DEVICES and EVENTS Windows.
  222.  
  223. ;
  224. ; X10EC.INI File Created: 08-28-1994 11:37:30
  225. ; All Lines prefixed with ; are ignored
  226. ; ---------------------------------------------------------
  227. ;
  228. ; CommPort=1,2,3 OR 4  DEFAULT=1
  229. ;
  230. [Communications]
  231. CommPort=2
  232. ;
  233. [Startup]
  234. LoadDevices=YES
  235. LoadEvents=FILE
  236. X10File=X10.DAT
  237. SyncClockOnUpload=CP290
  238. UseCP290IconStorage=YES
  239. LoadHelp=YES
  240. ConfirmDeletes=YES
  241. AutoRefreshDeviceNames=YES
  242. AutoRefreshEventCounts=YES
  243. SaveX10FileUponRecycle=YES
  244. RefreshClocks=5
  245. LinesPerPage=60
  246. UseBoxChars=YES
  247. ;
  248. [Display]
  249. ThreeD=YES
  250. Shadows=YES
  251. Graphics=YES
  252. ;
  253. ; Colour Values
  254. ; -------------
  255. ; 0=Black  4=Red       8=Gray          12=Bright Red
  256. ; 1=Blue   5=Magenta   9=Bright Blue   13=Pink
  257. ; 2=Green  6=Brown    10=Bright Green  14=Yellow
  258. ; 3=Cyan   7=White    11=Bright Cyan   15=Bright White
  259. ;
  260. BackColor=7
  261. ForeColor=0
  262. HiLiteKey=14
  263. DisabledItem=8
  264. MenuBackColor=1
  265. MenuForeColor=7
  266. MenuSelectedBackColor=0
  267. MenuSelectedForeColor=7
  268. LabelBackColor=9
  269. LabelForeColor=11
  270. HiliteText1ForeColor=4
  271. HiliteText2ForeColor=1
  272. HiliteText3ForeColor=14
  273. HelpTitleBackColor=5
  274. HelpTitleForeColor=15
  275. StatusTitleBackColor=4
  276. StatusTitleForeColor=15
  277. WarningTitleBackColor=12
  278. WarningTitleForeColor=15
  279. ;
  280. [SunParms]
  281. LatitudeDegrees=43
  282. LatitudeMinutes=39
  283. LatitudeNS=N
  284. LongitudeDegrees=79
  285. LongitudeMinutes=49
  286. LongitudeEW=W
  287. GMTOffSetHours=5
  288. GMTOffSetMinutes=0
  289. GMTOffSetPlusMinus=-
  290. ObserveDST=YES
  291. ;
  292. ; End of X10EC.INI (11:37:30)
  293.  
  294. This X10EC.FILE was created using the 'Save Options' menu item.
  295.  
  296. 7. COMMAND LINE ARGUMENTS
  297. --------------------------------------------------------------------
  298. DEFAULTS:  If the program is run without any command line arguments
  299.            it will default to COMMPORT 1.
  300.  
  301. The following command line arguments can be entered in any order:
  302.  
  303. /Annnn(n) - Base I/O Address applicable to User Defined CommPort
  304.             (Must be specified as a decimal number)
  305.             If /I agrument is present, but /A is not; then Base
  306.             I/O Address will default to 1016 (3F8 Hex).
  307.  
  308. /BYD - Bypass DEVICES (ie. Do not load; ignore LoadDevices INI directive)
  309.  
  310. /BYE - Bypass EVENTS (ie. Do not load; ignore LoadEvents INI directive)
  311.  
  312. /BW  - Use Monochrome colours (Black & White)
  313.  
  314. /Cn  - COMMPORT where n = 1,2,3 & 4
  315.  
  316. /F:[d]\filename - X10.DAT Startup File Specification
  317.       where [d] = drivespec eg. /F:C:\X10\X10.DAT
  318.  
  319. /In  - IRQ applicable to User Defined CommPort where n = 1 - 15
  320.        If /A argument is present, but /I is not; then IRQ
  321.        will default to 4.
  322.  
  323. /NH  - Do Not Load HELP Sub-System
  324.  
  325. /NH- - Load HELP Sub-System (Override INI directive)
  326.  
  327. * The following 2 arguments run X10EC in Batch Mode *
  328.  
  329. /RECYCLEnn - Perform Recycle Process (Can be abbreviated as /Rnn)
  330.       where nn = number of elapsed days since last upload (0-99);
  331.       X10EC will examine the X10EC.LOG file and only continue the
  332.       Recycle Process if nn days have elapsed. If nn is not
  333.       present 0 is assumed and Reycle will run unconditionally.
  334.       Optionally save EVENTS to RECYCLE.DAT file if 'Save X-10 File
  335.       upon RECYCLE' is checked on the Startup Options screen.
  336.  
  337. /UF:[d]\filename - Clear CP290 Event memory and upload X10.DAT file
  338.       where [d] = drivespec eg. /F:C:\X10\X10.DAT
  339.  
  340. COMMAND LINE OPTIONS OVERRIDE CONTRADICTING X10EC.INI SETTINGS.
  341.  
  342. 8. PROGRAM OVERVIEW
  343. --------------------------------------------------------------------
  344. X10EC has been designed to be flexible so that the user controls the
  345. program rather than the program controlling the user.  There are a
  346. variety of options that let the user determine how the program will
  347. respond in certain instances including Program Startup.  The DEVICES
  348. and EVENTS Windows are the 'cornerstones' of the program but they do
  349. not limit the user to performing Device related activities in the
  350. DEVICES Window or Event related activities in the EVENTS Window.
  351.  
  352. For example, if you spot an EVENT in the Events Window and notice
  353. that there is no Device Description for it, you can simply highlight
  354. the Event and click on the 'Name Device' button; an 'Insert Device'
  355. window will pop up with the House and Unit code preset from the
  356. highlighted Event.  Once you have entered the Device Location and/or
  357. Description it will be propagated to all Events in the EVENTS Window
  358. that have targetted that particular house/unit code.  Similarly,
  359. while in the DEVICES Window (which provides you a Count of how many
  360. Events have been scheduled for each Device), you may notice that a
  361. particular Device has no Events scheduled.  In this case, you can
  362. simply highlight the Device and click the 'Schedule Event' button
  363. and an 'Insert Event' window will pop up with the Device Description
  364. already filled in.
  365.  
  366. When X10EC loads, it looks at the Startup Options to determine if
  367. Devices and/or Events are to be loaded.  Devices can only be loaded
  368. from an 'X10.DAT' file whereas Events can be loaded from either the
  369. same X10.DAT file or downloaded from the CP290.  Loading Events from
  370. the file is faster than downloading them, but you may want to ensure
  371. you're always working with current information by waiting for the
  372. download.  (Also, if you've RECYCLE'd your Events you may want to
  373. see what the Relative Times were for the last RECYCLE iteration; in
  374. this case you should download the Events).  If you have defined
  375. devices across multiple X10.DAT files, you can merge them all
  376. without disturbing the currently loaded Events.  Use the 'Retrieve
  377. Devices ONLY' menu item; X10EC will ask you if you want to replace
  378. the loaded Devices with the Devices from the File OR if you want to
  379. append the Devices from the File; select Append to merge the
  380. Devices.  Note that any time X10EC loads Devices it will discard
  381. duplicate descriptions; it will also sort Devices by House/Unit code
  382. in support of the referential integrity features offered by X10EC.
  383. The Event Counts displayed in the DEVICES Window refer to
  384. single-unit Events, Group and Global Events are not included in
  385. these counts.  You can also merge Events from multiple X10.DAT files
  386. up to the CP290 maximum of 128 Events; use the 'Retrieve Events Only'
  387. menu item.  If there are vacant event slots available then X10EC will
  388. ask you if you want to merge or replace Events.
  389.  
  390. Once you've loaded Devices/Events, you can update them freely.  The
  391. Insert, Modify, & Delete buttons will behave as expected. To use the
  392. Modify or Delete button you must have highlighted an entry from the
  393. List box.  Instead of clicking the Modify button you can double
  394. click the list item (or press the spacebar).  The Clone button is
  395. similar to the Modify button since it will present a change form
  396. just as if you've clicked the Modify button.  The difference is a
  397. new entry will be created.  This is handy if you're programming
  398. ON/OFF times; Insert the ON Event, then clone the ON Event, change
  399. the action to OFF and set the Time.
  400.  
  401. In the Events Window you can Freeze or Secure Events from the list
  402. box.  If you Freeze an Event, an asterisk will be displayed beside
  403. the Event Number.  If you Secure an Event, a '≈' will precede the
  404. time.  (Secured Events will occur at +/- 30 minutes from the set
  405. time).  You can easily swap between Windows by clicking the '' key.
  406. The 'Window' menu item allows you to manage the location and size of
  407. the EVENTS and DEVICES windows.  If your display is set for
  408. 43/50 line mode, you may find that the Split,Horizontal provides you
  409. with the optimal display.  The Unsplit command reverts both Windows
  410. back to their startup state.
  411.  
  412. You can print an Event or Device listing at anytime using 'Print
  413. Report' under the 'File' menu.  Each time you print a report you
  414. have the option of printing directly to your printer or to a file.
  415. The lines per report page can be set from the 'Start Up' options
  416. screen.
  417.  
  418. Once you're finished updating Event/Devices you can save them to
  419. your designated X10 Startup File (which will appear on the File
  420. Menu), or to any other filename (use 'Save AS').  You can also
  421. upload your Events to the CP290.  X10EC gives you 2 choices, you can
  422. upload the modified Events ONLY, or ALL Events. CAUTION:  ONLY USE
  423. THE 'UPDATES ONLY' option if you are sure that the currently loaded
  424. Events are based on the Events loaded in the CP290 before you
  425. applied your Updates.  If you do not explicitly Save and/or Upload
  426. the program will prompt you to before exiting; UNLESS YOU EXIT USING
  427. THE 'UNCONDITIONAL EXIT' which quickly exits the program without
  428. prompting you to save/upload anything.
  429.  
  430. 9. KEYBOARD USAGE
  431. --------------------------------------------------------------------
  432. Use the TAB/Shift-TAB keys to move among the various controls. The
  433. Up/Down arrows can be used to move up and down List Boxes; the
  434. Spacebar can be used to select the current List Box item.  The Enter
  435. key can be used to check/uncheck a check box, or invoke a command
  436. button.  The ESCAPE key will exit the current function or the
  437. program if no other windows are visible.  Most Command Buttons
  438. and controls have quick access keys which you can identify by
  439. the highlighted character in the button/control name; press the
  440. ALT key + the quick access key to invoke the action.
  441.  
  442. The menu-bar can be activated by pressing the ALT key, you can use
  443. the cursors keys to navigate the menus, or press the highlighted
  444. character to immediately invoke the desired menu item.  Many of the
  445. menu items have short-cut keys.  The following list shows ALL menu
  446. items along with the associated short-cut key if one is defined.
  447.  
  448. -<FILE Menu>-
  449.  
  450.    New
  451.      Devices                 -
  452.      Events                  -
  453.    Open X10 File
  454.      Retrieve Devices/Events - Ctrl-R
  455.      Retrieve Devices ONLY   -
  456.      Retrieve Events ONLY    -
  457.    Save X10 File             - Ctrl-S
  458.    Save X10 File AS          - Ctrl-A
  459.    Print Report
  460.      Print Device Listing    -
  461.      Print Event Listing     - Ctrl-P
  462.    Unconditional Exit        - Ctrl-Q
  463.    Exit                      - Ctrl-X
  464.  
  465.  
  466. -<ACTIONS Menu>-
  467.    Refresh Updated
  468.      Devices Name            - F2
  469.      Event Counts            - F3
  470.    Sort Events By
  471.      Location,Description    - Shift-F1
  472.      Housecode,UnitCode      - Shift-F2
  473.      Day,Time                - Shift-F3
  474.    ReCycle Sun Times         - F4
  475.    Show Sun Times            - Ctrl-T
  476.    Set CP290 Clock
  477.      Enter Time              - Ctrl-K
  478.      Synchronize w/PC        -
  479.    Set PC Clock
  480.      Enter Time              -
  481.      Synchronize w/CP290     -
  482.  
  483. -<TRANSFER Menu>-
  484.    Upload Events TO CP290
  485.      All Events              - Ctrl-U
  486.      Updated Events          -
  487.    Download Events FROM CP290-
  488.    Clear Events              -
  489.  
  490. -<OPTIONS Menu>-
  491.    Communications            - Ctrl-C
  492.    Display                   - Ctrl-G
  493.    Startup                   - Ctrl-B
  494.    Sunrise/Sunset Parms      -
  495.    Save Options              - Ctrl-O
  496.  
  497. -<WINDOW Menu>-
  498.    Devices                   - Ctrl-D
  499.    Events                    - Ctrl-E
  500.    Split
  501.      Horizontal              - Ctrl-H
  502.      Vertical                - Ctrl-V
  503.      Swap                    - Ctrl-W
  504.    UnSplit                   -
  505.  
  506. -<HELP MENU>-
  507.    Help Information          - F1
  508.    About                     - Ctrl-F1
  509.  
  510. 10. STARTUP OPTIONS
  511. --------------------------------------------------------------------
  512. DEVICES & EVENTS
  513. ================
  514. The DEVICES Window and EVENTS Window are always opened each time you
  515. start X10EC.  You can setup X10EC to automatically populate these
  516. Windows by clicking the appropriate option buttons.  The only source
  517. to populate the DEVICES Window is an X10.DAT file; the EVENTS Window
  518. can be populated from either an X10.DAT file or a CP290 download.
  519. Only one X10.DAT startup file can be identified and it will source
  520. both the DEVICES Window and the EVENTS Window (if applicable).
  521.  
  522. CLOCK
  523. =====
  524. The CP290 or PC Clocks can be synchronized to each other every time
  525. you upload Events.  To synchronize the CP290 Clock to your PC Clock,
  526. select 'Sync CP290 on Upload'; this option will examine the PC clock
  527. and then wait until the seconds are at zero before setting the CP290
  528. Clock (the CP290 Clock resolution is limited to minutes). If you
  529. elect to 'Sync PC on Upload' then the PC Clock will be set
  530. immediately just prior to uploading Events.  You can also bypass all
  531. Clock Sync'ing by choosing 'Do Not Sychronize'.
  532.  
  533. GENERAL OPTIONS
  534. ===============
  535. General options can be modified at any time while X10EC is executing
  536. and the effect will be immediate.
  537.  
  538. SUNRISE/SUNSET SUPPORT:
  539.   Uncheck if you DO NOT want X10EC to use the ICON memory area of
  540.   the CP290; in this case the Relative Time & Last Upload Date/Time
  541.   features will be disabled.
  542.  
  543. LOAD HELP SUBSYSTEM:
  544.   Uncheck to save memory and speed up program load time.
  545.  
  546. CONFIRM DELETE REQUESTS:
  547.   Uncheck to delete without confirmation, You may want to turn
  548.   off the confirmation if you're doing many deletes,
  549.   it's a good idea to leave it checked just in case.
  550.  
  551. AUTOREFRESH DEVICE NAMES
  552.   On slower machines it could become a nuisance to wait for the
  553.   program to refresh the Device Names in the EVENT Window
  554.   whenever a Device Name is modified. You may want to Refresh 'ON
  555.   DEMAND' instead by using F2.
  556.  
  557. AUTOREFRESH EVENT COUNTS:
  558.   See comments re: AUTOREFRESH DEVICE NAMES;Uncheck to Refresh
  559.   'ON DEMAND' (F3).
  560.  
  561. SAVE X-10 FILE UPON RECYCLE:
  562.   The RECYCLE process works exclusively with the CP290 (ie. Events
  563.   are downloaded from the CP290, Suntimes are refreshed, and the
  564.   Events are re-uploaded).  Checking this box will instruct X10EC
  565.   to save the recycled Events to the RECYCLE.DAT file.
  566.  
  567. CLOCK REFRESH RATE:
  568.   The PC Time & CP290 Time are displayed in the screen header and
  569.   can be refreshed periodically by setting a refresh rate greater
  570.   than 0.
  571.   NOTE:
  572.   ====
  573.   THE FIELD WIDTH IS ONLY 1 CHARACTER AND THE COMPILER DEFAULTS
  574.   TO KEYBOARD 'INSERT MODE'; PRESS THE INSERT KEY TO TOGGLE THE
  575.   KEYBOARD TO 'TYPEOVER MODE' TO CHANGE REFRESH VALUE.
  576.  
  577. LINES PER REPORT PAGE
  578.   Valid Range is 10-99. (see previous comments re: keyboard
  579.   INSERT MODE).
  580.  
  581. PRINT IBM BOX CHARACTERS:
  582.   If your printer is set up to print the IBM ASCII character set
  583.   you can improve the appearance of the DEVICE & EVENT printed
  584.   reports by checking this box.
  585.  
  586. 11. COMMUNICATION PORTS
  587. --------------------------------------------------------------------
  588. X10EC supports "pseudo standard" CommPorts 1 thru 4 using the
  589. following settings:
  590.  
  591.             +----------+------+------------------+
  592.             |          |      | Base I/O Address |
  593.             | CommPort | IRQ  +---------+--------+
  594.             |          |      | Decimal |  HEX.  |
  595.             +----------+------+---------+--------+
  596.             |    1     |   4  |  1016   |  3F8   |
  597.             +----------+------+---------+--------+
  598.             |    2     |   3  |   760   |  2F8   |
  599.             +----------+------+---------+--------+
  600.             |    3     |   4  |  1000   |  3E8   |
  601.             +----------+------+---------+--------+
  602.             |    4     |   3  |   744   |  2E8   |
  603.             +----------+------+---------+--------+
  604.  
  605. If one of these CommPort settings matches your hardware
  606. configuration simply select the appropriate CommPort from the
  607. Communications Options screen.  (You could also start X10EC with the
  608. /C command line argument or use the COMMPORT= X10EC.INI directive).
  609.  
  610. You can define your own CommPort by selecting User Defined CommPort
  611. from the Communications Options screen and setting the IRQ interrupt
  612. and Base I/O Address.  (You could also use the /I and /A Command
  613. Line Args or IRQ= & Base_IO_Address= X10EC.INI file directives).
  614. IRQ can be set to any value between 1 and 15 (inclusive).  Base I/O
  615. Address can be set to any value greater than zero.  CAUTION: your
  616. hardware may "lock up" if incorrect settings are used.  Once you
  617. have enabled communications with the CP290, then use the 'Save
  618. Options' menu item to save the information to the X10EC.INI file.
  619.  
  620. THE BASE I/O ADDRESS MUST BE SPECIFIED IN DECIMAL NOTATION.
  621.  
  622.           IBM PS/2 CommPort Parameters are shown below:
  623.             +----------+------+------------------+
  624.             |   PS/2   |      | Base I/O Address |
  625.             | CommPort | IRQ  +---------+--------+
  626.             |          |      | Decimal |  HEX.  |
  627.             +----------+------+---------+--------+
  628.             |    1     |   4  |  1016   |  3F8   |
  629.             |    2     |   3  |   760   |  2F8   |
  630.             |    3     |   3  | 12832   | 3220   |
  631.             |    4     |   3  | 12840   | 3228   |
  632.             |    5     |   3  | 16928   | 4220   |
  633.             |    6     |   3  | 16936   | 4228   |
  634.             |    7     |   3  | 21024   | 5220   |
  635.             |    8     |   3  | 21032   | 5228   |
  636.             +----------+------+---------+--------+
  637.           A User Defined CommPort must be used for
  638.           PS/2 CommPorts 3-8.
  639.  
  640. 12. SCREEN DISPLAY OPTIONS
  641. --------------------------------------------------------------------
  642. This feature allows the user to choose their own screen colours.  A
  643. list of screen elements is presented on the left side of the screen
  644. and all of the available Foreground and Background (when applicable)
  645. colours are displayed next to the screen elements.  To change a
  646. colour, simply select the screen element you wish to change and
  647. click on the preferred Foreground/Background colours.  The Colour
  648. defaults can be restored by clicking on the Colour button, similarly
  649. Black & White colours can be selected by clicking on the Monochrome
  650. button.  Note: some colour combinations will render the screen
  651. unreadable, if this happens press the [Esc] key to exit the dialogue
  652. and restore the colours to their previous setting.  Once you are
  653. satisfied with your colour selections the 'Save Options' command can
  654. be used to store them so that X10EC always starts up with your
  655. selected colours.
  656.  
  657. The colours for message boxes cannot be changed (always black
  658. on white;compiler limitation).
  659.  
  660. There are 3 additional program options that can be set:
  661.  
  662. THREE-D
  663.   The program will attempt to render the screen controls in 3D.
  664.   If you choose a bright screen background, the 3D effect will
  665.   not be evident and you may wish to turn off THREE-D.  It is
  666.   also recommended that you turn off THREE-D for Monochrome
  667.   Monitors.
  668.  
  669. WINDOW SHADOW
  670.   The program will paint shadows underneath and to the right of
  671.   loaded screen windows; this helps to define the boundaries of
  672.   pop-up windows.  It is recommended that you turn the WINDOW
  673.   SHADOW off for Monochrome Monitors.
  674.  
  675. GRAPHIC GAUGES
  676.   The Graphic Gauges checkbox determines whether or not graphical
  677.   EGA/VGA characters are used to construct the sliding percentage
  678.   complete gauge.  If this causes problems with your screen
  679.   display, then uncheck the box; the ASCII character '█' 219 will
  680.   be used to paint the gauges instead.
  681.  
  682. 13. SUN TIME PARAMETERS
  683. --------------------------------------------------------------------
  684. This screen under the 'Options' menu allows you to set the
  685. Longitude, Latitude & GMT Offset parameters specific to your
  686. location.  These parameters are used to calculate your local Sunrise
  687. and Sunset times.  The calculated Sunrise/Sunset times will be
  688. accurate to within a minute or two.  Sample Longitude & Latitude
  689. parameters for a limited selection of cities can be set by using the
  690. combo box (click on the down arrow or press F4 to expand the list
  691. box).  THE GMT OFFSET MUST BE EXPLICITLY SET; it can vary depending
  692. on whether Daylight Savings Time is in effect or not.  eg. for the
  693. Eastern Time Zone the GMT Offset is -4 when Daylight Savings Time is
  694. in effect and -5 when it is not.  Check 'Observe DST' to have X10EC
  695. automatically vary the GMT Offset while Daylight Savings Time is in
  696. effect [the first Sunday in April through the last Sunday in
  697. October].  When this option is checked the 'effective' GMT Offset
  698. will be displayed below the checkbox.  When 'Observe DST' is checked
  699. the GMT Offset you set should be for Standard Time since X10EC will
  700. adjust it for Daylight Savings Time.  Note that when X10EC
  701. calculates Sunrise/Sunset times for the next 7 days it will not
  702. adjust the GMT OffSet if Daylight Savings Time begins or ends in the
  703. middle of this period.  It is recommended that you RECYCLE each
  704. Sunday so that your Sunrise/Sunset times are always accurate.
  705.  
  706. You can view the Sun Times for the upcoming 7 days by using the
  707. 'Show Sun Times' option under the 'Actions' menu.
  708.  
  709. Note: when you set a Relative Time and want to see what Absolute
  710. time the Program will upload to the CP290, then use the 'ReCycle
  711. Sun Times' option under 'Actions' and then double-click the Event.
  712. The time is shown in the Absolute Time frame.  Note: X10EC will
  713. always 'ReCycle' the Sun Times prior to an upload.
  714.  
  715. When X10EC encounters a Relative Time it determines the Absolute
  716. Time to upload as follows:
  717.  
  718. 1) It looks at the 'Day(s) of Week' the Event is scheduled,
  719.    finds the next Date the Event will run and uses the Sunrise/
  720.    Sunset Times for that Day.
  721. 2) If the Event is to run today, it will compare the current time
  722.    to the Sunrise/Sunset +/- Offset Time.  If the time has already
  723.    past, then it will use the Sunrise/Sunset time for one week
  724.    from today.
  725. 3) X10EC will not allow the +/- Offset Time to cause the Event to
  726.    span to the previous day or the next day; X10EC will only
  727.    negatively Offset a time to 12:00 AM on the scheduled day, it
  728.    will only positively Offset a time to 11:59 PM.
  729.  
  730. 14. SAVE OPTIONS
  731. --------------------------------------------------------------------
  732. This menu option saves all of the current program settings to the
  733. X10EC.INI file.  If an X10EC.INI file exists, the program will
  734. display a Warning Message and confirm that you wish to overwrite the
  735. existing X10EC.INI file before proceeding.  The X10EC.INI file that
  736. X10EC generates is a plain ASCII file that you can edit using your
  737. favourite editor.  X10EC will notify you of any errors within the
  738. X10EC.INI by displaying the offending line along with a message
  739. indicating it will be ignored.  Note that the X10EC.INI file is
  740. parsed before command line arguments and therefore will be
  741. overridden by contradicting command line arguments.
  742.  
  743. 15. INTELLIGENT EDIT
  744. --------------------------------------------------------------------
  745. X10EC offers some degree of referential integrity when you're
  746. editing Device Names:
  747.  
  748. - If you modify a Device Address (ie. House and/or Unit Code)
  749.   X10EC can optionally examine all of the scheduled Events and
  750.   update* any that target the Device to reflect the new
  751.   house/unit code.
  752.  
  753. - If you Delete a Device Description X10EC can optionally
  754.   examine all of the scheduled Events and purge* any that are
  755.   specifically targetted for the deleted Device.
  756.  
  757. - If you change a Device Name; any Events which target the
  758.   Device will be updated to reflect the new Device Name the
  759.   next time the Event list gets focus. (IF AUTOREFRESH Device
  760.   Names is checked - otherwise you can press F2 at any time to
  761.   refresh Device Names).
  762.  
  763. -----
  764. * Group and Global Events are left intact; only single unit
  765. Events will be purged/modified.
  766.  
  767. 16. UNDOCUMENTED CP290 COMMANDS
  768. --------------------------------------------------------------------
  769. X10EC supports the following undocumented CP290 commands:
  770.  
  771.    Fade OFF   - DIMS Light(s) to 0 then turns Unit(s) OFF
  772.                 (Can target multiple units for this command)
  773.    X-Light ON - Exclusive Light ON - Issues an ALL LIGHTS OFF
  774.                 then Brightens selected Unit(s)
  775.                 (Can target multiple units for this command)
  776.    ALL Lights ON  - All Lights on selected House Code set ON
  777.    ALL Lights OFF - All Lights on selected House Code set OFF
  778.    ALL Units OFF  - All Units on selected House Code set OFF
  779.  
  780. NOTES: Storing Events with these undocumented commands MAY CAUSE
  781.        problems with some CP290 Event Schedulers.  These commands
  782.        will be transparent to X10.EXE; however, X10.EXE can
  783.        only display ON/OFF/DIM.  If X10.EXE encounters one of
  784.        these undocumented commands it will display it as blank.
  785.  
  786.        X-10 Light Switches usually respond to the ALL LIGHTS ON
  787.        command; however some Lamp Modules appear to ignore it;
  788.        increasing the DIM level when using this command occasionally
  789.        resolves this apparent hardware problem.
  790.  
  791. 17. INCREMENTAL BRIGHTENING
  792. --------------------------------------------------------------------
  793. X-10 Light Switches and Lamp Modules can be incrementally brightened by
  794. sending X-10 BRIGHT commands to them.  However, the CP290 controller has
  795. a built-in macro that forces these modules to 100% brightness and then
  796. sends X-10 DIM commands to them to dim them down to the desired
  797. brightness level.  This prevents you from gradually brightening a module
  798. over a period of time by sending several DIM commands with increasing
  799. brightness levels (the end result will be the desired brightness level,
  800. but after each command the module will be ramped up to 100% only to be
  801. dimmed back down to the desired brightness level).
  802.  
  803. The undocumented X-LIGHT command can be used to gradually brighten an
  804. X-10 Lamp Module but not an X-10  Wall Switch due to an inherent anomaly
  805. with the X-10 Lamp Modules.  The CP290 acts on an X-LIGHT command by
  806. sending several ALL LIGHTS OFF commands followed by a number of BRIGHT
  807. commands corresponding to the DIM level set.  If an X-10 Lamp Module or
  808. Wall Switch is currently off and a BRIGHT or DIM command is sent, that
  809. module will turn ON at 100% and then dim/brighten accordingly. However,
  810. most X-10 Lamp Modules do not respond to the ALL LIGHTS OFF command.
  811. So, when an X-LIGHT command is sent to the CP290 and it generates an ALL
  812. LIGHTS OFF command it will have no impact on the Lamp Module, however,
  813. the Lamp Module will respond to the subsequent BRIGHT commands by
  814. brightening from the current brightness level (without going to 100%
  815. brightness) providing it was NOT OFF  to begin with.  This means you can
  816. incrementally brighten one or more Lamp Modules by following these
  817. steps:
  818.  
  819. (1) Dedicate a House Code for those Lamp Modules that you wish to
  820.     incrementally brighten.  (Otherwise, any Wall Switch Modules on the
  821.     same house code will end up at 100% brightness).
  822.  
  823. (2) Send a DIM Command (0% Brightness) to the targetted Lamp Modules.
  824.  
  825. (3) Send a variable number of X-LIGHT Commands to the targetted Lamp
  826.     Modules.
  827.  
  828. NOTE, THE BRIGHTNESS LEVELS ASSOCIATED WITH X-LIGHT COMMANDS ARE BOTH
  829. INVERTED AND CUMULATIVE. For example, if you send an X-LIGHT Command
  830. with a brightness level of 80%, the targetted Lamp Module will
  831. incrementally brighten to 20% (assuming it was on at a brightness level
  832. of 0% to begin with). If you send the same command a second time, the
  833. Lamp Module will brighten to 40%.  NOTE: The Pop-up X-10 DIRECT COMMAND
  834. PAD uses absolute steps rather than a brightness setting; hence no
  835. inversion is required.
  836.  
  837. 17. DIRECT COMMAND PAD
  838. --------------------------------------------------------------------
  839. X-10 Direct Commands can sent to Devices in the Devices Window; simply
  840. highlight a Device and click the right mouse button (or click the DC
  841. command button).  This action will pop-up the X-10 Direct Command Pad
  842. which supports all CP290 X-10 Commands including the Undocumented
  843. Commands.  Click on the button corresponding to the X-10 Command you
  844. wish to send and then click on the Send button to send the command.
  845. NOTE: The Brightness/Steps slider control is only enabled when the
  846. selected command is DIM or X-LIGHT.  See the INCREMENTAL BRIGHTENING
  847. section for further information on using Absolute Steps with the
  848. X-LIGHT Command.
  849.  
  850. 18. LAST UPLOAD DATE/TIME
  851. --------------------------------------------------------------------
  852. If 'Sunrise/Sunset' support is enabled, X10EC will store the Last
  853. Upload Date/Time in the CP290 Interface.  When Events are uploaded
  854. to the CP290, the Last Upload Date/Time is updated.  Each time
  855. Events are downloaded from the CP290, the Last Upload Date/Time will
  856. be displayed in the Screen Header (left margin, 3rd line).  X10EC
  857. will also extract the Last Upload Date/Time from X10.DAT files when
  858. they are retrieved.
  859.  
  860. 19. CP290 ICON STORAGE
  861. --------------------------------------------------------------------
  862. The CP290 also has memory set aside for Icon storage.  The DOS
  863. character-based software does not display any graphical Icons hence
  864. this storage area is unused when the CP290 is used with the X10.EXE
  865. program.  X10EC uses this memory area to store Sunrise/Sunset (see
  866. Sun Time Parameters) information applicable to the scheduled Events
  867. as well as the 'Last Upload' Date/Time and other information.
  868. Hence, all Event Information including Sunrise/Sunset Offset
  869. information is stored within the device.  This means whenever you
  870. download Event Information from the CP290 the Sunrise/Sunset offset
  871. information is also downloaded; you do not have to 'match' or
  872. 'associate' the downloaded events with a data file in order to
  873. translate the 'Absolute' Time of Day back to a 'Relative'
  874. (Sunrise/Sunset +/- Offset) Time.  This also provides a complete
  875. backup to the Event Information stored in an X10.DAT file.
  876.  
  877. You can elect not to use the CP290 Icon Storage area by unchecking
  878. the 'Support Sunrise/Sunset' box on the 'Start Up' options screen.
  879. (This will also disable support for the 'Last Upload Date/Time'
  880. information in the screen header).
  881.  
  882. 20. BATCH MODE PROCESSING
  883. --------------------------------------------------------------------
  884. RECYCLE PROCESS
  885. ===============
  886. The RECYCLE Process runs X10EC in Batch Mode and updates any Events
  887. that have been scheduled with Relative Times (ie.  Sunset/Sunrise
  888. +/- Offsets).  You can specify how many days must elapse between
  889. each RECYCLE Process by using the nn parameter with the /RECYCLE
  890. command line argument.  When X10EC encounters the /RECYCLEnn
  891. argument it checks the last run date contained within the X10EC.LOG
  892. file and compares it with today's date; if the number of days that
  893. have elapsed does not exceed nn then the program will immediately
  894. terminate.  This allows you to add the following line to your
  895. AUTOEXEC.BAT file:
  896.  
  897.   X10EC /RECYCLE7
  898.  
  899. X10EC will run every time you boot but will only invoke the RECYCLE
  900. Process if 7 days have elapsed.  When a RECYCLE is indicated, the
  901. program will pause 5 seconds before proceeding with the RECYCLE Process.
  902. During this pause you can press the ESC key to bypass RECYCLE Processing
  903. or press ENTER to proceed with RECYCLE processing immediately.  To run
  904. the RECYCLE Process unconditionally use the the /RECYCLE0 or /RECYCLE
  905. command line argument.  When the RECYCLE Process is invoked, X10EC will
  906. perform the following steps.
  907.  
  908.   - Calculate Sunset/Sunrise Times for the upcoming 7 Days
  909.   - Download Event Information from the CP290
  910.   - Download Sunset/Sunrise Offset Information from the CP290
  911.   - Update Events with Sunset/Sunrise relative times
  912.   - Optionally synchronize the CP290 or PC Clock
  913.   - Upload any updated Events to the CP290
  914.   - Optionally save Events to the RECYCLE.DAT file
  915.   - Backup the old X10EC.LOG to X10EC_B.LOG
  916.   - Log all activity to X10EC.LOG
  917.  
  918. Note that the RECYCLE process DOES NOT read EVENT INFORMATION from
  919. the X10 Startup File, this is to ensure that only currently
  920. scheduled Events as stored in the CP290 are updated.  (There is no
  921. guarantee that the current X10 Startup File as defined in the
  922. X10EC.INI reflects the contents of the CP290 Event Memory.)
  923. Consequently you may wish to set up X10EC to always download Events
  924. from the CP290 upon startup rather than retrieving Events from the
  925. X10.DAT file.
  926.  
  927. UPLOAD FILE PROCESS
  928. ===================
  929. If you simply want to replace the Events Stored within the CP290
  930. (ie. you may have an X10.DAT file that you use to randomly turn
  931. lights ON & OFF as a security measure while you're on vacation)
  932. then you can use the /UF:[d]\filename command line argument. X10EC
  933. will perform the following steps:
  934.  
  935.   - Calculate Sunset/Sunrise Times for the upcoming 7 Days
  936.   - Read Events from the X10.DAT filename passed on the command line
  937.   - Update Events with Sunset/Sunrise relative times
  938.   - Optionally synchronize the CP290 or PC Clock
  939.   - Clear the CP290 Event Memory
  940.   - Upload all Events to the CP290
  941.   - Backup the old X10EC.LOG to X10EC_B.LOG
  942.   - Log all activity to X10EC.LOG
  943.  
  944. 21. COMPATIBILITY ISSUES
  945. --------------------------------------------------------------------
  946. FREEZE
  947. ======
  948. X10EC is file compatible with X10.EXE but there are some limitations
  949. associated with partially 'Frozen' Group Events.  X10.EXE allows you
  950. to partially freeze Group Events, that is some units within the
  951. group can be frozen whereas other remain scheduled Events.  X10EC
  952. does not support this level of granularity for Frozen Events; it
  953. considers any Event either Frozen or Thawed (ie. Not Frozen) and
  954. this applies to single unit Events and multiple unit Events alike.
  955. If a multiple unit Event is Frozen by X10EC then all units defined
  956. to the Event will be Frozen.
  957.  
  958. X10.EXE relies solely on the X10.DAT file to decipher Frozen Events
  959. that it 'Freezes'.  Conversely X10EC can decipher Frozen Events
  960. that it 'Freezes' from either an Event Download or an X10.DAT file.
  961.  
  962. IMPACT
  963. ======
  964. If Events have been FROZEN by X10.EXE, then X10EC.EXE will behave as
  965. follows:
  966.  
  967. Event Source Event Type   Freeze  X10EC Interpretation
  968. ------------ -----------  ------  ------------------------------
  969. X10.DAT File Single Unit  Frozen  No impact: will interpret
  970. X10.DAT File Multi-Unit   Partial X10EC will capture unFrozen
  971.                                   units only and treat as a
  972.                                   Frozen Event.
  973. X10.DAT File Multi-Unit   Frozen  No impact: will interpret
  974.  
  975. CP290 D/L    Single Unit  Frozen  X10EC will NOT capture unit;
  976.                                   will treat as a Frozen Event
  977. CP290 D/L    Multi-Unit   Partial X10EC will capture unFrozen
  978.                                   units only and treat as an
  979.                                   unFrozen Event
  980. CP290 D/L    Multi-Unit   Frozen  X10EC will NOT capture units;
  981.                                   will treat as a Frozen Event
  982.  
  983. RECOMMENDATION
  984. ==============
  985. If this all seems confusing, just be sure to unFreeze any Events you
  986. have Frozen with X10.EXE before using X10EC.EXE.  Any Events Frozen
  987. by X10EC will be translated correctly by X10.EXE if you decide to
  988. fallback to X10.EXE.
  989.  
  990. FILE COMPATIBILITY
  991. ==================
  992. X10.EXE will read and interpret the X10.DAT files created by X10EC
  993. that include X10EC extensions.  Of course, the extensions added by
  994. X10EC will be transparent to X10.EXE, however, THEY WILL BE LOST IF
  995. X10.EXE OVERWRITES the file.    (Extensions include Sunrise/Sunset
  996. information and Last Upload Date/Time).  For this reason, it is
  997. recommended that you create an X10.DAT file for the exclusive use of
  998. X10.EXE rather than sharing a single X10.DAT file between the two
  999. programs.
  1000.  
  1001. 22. PROBLEM RESOLUTION
  1002. --------------------------------------------------------------------
  1003. Generally, if your CP290 works with the X-10 supplied software then
  1004. you should have no problems running X10EC.  X10EC has been
  1005. successfully tested under Microsoft Windows v3.1 and OS/2 v2.1.  The
  1006. program will load if you run it without any arguments (thereby
  1007. defaulting to COMMPORT 1) and your CP290 is actually attached to
  1008. COMMPORT 2.  If this is the case X10EC will report 'Timed Out
  1009. waiting for a response' when it attempts to retrieve the CP290 Time,
  1010. Day of Week and Base HouseCode.  You can toggle to the correct
  1011. COMMPORT once the program is running by using the Options,
  1012. Communications menu.  The Save Options menu option will save all
  1013. settings to the X10EC.INI which obviates the need for command line
  1014. arguments.
  1015.  
  1016. If you run X10EC with a modem attached to the COMMPORT, you may get
  1017. unpredictable results since the modem will echo everything back to
  1018. X10EC.  If you're using a COMMPORT that shares an interrupt with
  1019. another COMMPORT (eg. 1 & 3, 2 & 4), then you must ensure that no
  1020. memory resident software (eg. a FAX TSR) that uses the other COMMPORT
  1021. is loaded as it will not release the interrupt.
  1022.  
  1023. If you use a Serial Mouse, this may cause a conflict if X10EC
  1024. attempts to communicate with a CP290 on the same CommPort.  You may
  1025. want to start X10EC with the /C command line argument to ensure it
  1026. does not default to CommPort 1 if your mouse is also on CommPort 1.
  1027. X10EC will not run properly if it attempts to communicate with a
  1028. COMMPORT that has been initialized with a Mouse Driver (ie. you
  1029. cannot use a switchbox between the CP290 and a Mouse unless you
  1030. reboot without loading the Mouse Driver).
  1031.  
  1032. The X10EC executable file is encrypted and there is a remote
  1033. possibility that the decryption process may fail with certain
  1034. processors; a blank screen immediately after attempting to run the
  1035. program typifies this problem.  Please contact the author if you
  1036. encounter this problem.
  1037.  
  1038. The clocks are refreshed in the background and the refresh process
  1039. requires serial I/O; if your CP290 is not connected or you are using
  1040. a slow processor the refresh process can interrupt the foreground
  1041. process to the point where the program seems to be unresponsive;
  1042. if you experience this problem then try a Clock Refresh Rate of 0.
  1043.  
  1044. If you suspect that your CP290 is failing, you should try using the
  1045. diagnostic/debug features provided by X10DC.
  1046.  
  1047. In some cases X10EC may report communication errors (ie.  time-outs,
  1048. unmatched checksums, etc).  This may occur when scheduled Events
  1049. collide with CP290 Uploads/Downloads that are in progress.  (The
  1050. CP290 transmits onto the serial port line whenever a scheduled event
  1051. occurs and when you press the rocker buttons on the CP290).  X10EC
  1052. attempts to minimize collisions by discarding unexpected serial
  1053. input, however the possibility still exists.  You should just
  1054. re-invoke the interrupted action to recover from this type of
  1055. problem.
  1056.  
  1057. The open architecture of the PC compatible operating environment and
  1058. the near infinite combinations of hardware and software complicate
  1059. the compatibility of applications software.  While every effort has
  1060. been made to ensure that X10EC is compatible with as many
  1061. hardware/software combinations as possible, there may be operating
  1062. environments in which X10EC will not run properly.
  1063.  
  1064. Problems can be reported to:
  1065.  
  1066.    David Huras
  1067.    37 Ruddell Crescent
  1068.    Georgetown, Ont. L7G 5N4
  1069.    CANADA
  1070.  
  1071.    FAX: 905-873-6429
  1072.    CIS: 72767,472
  1073.    Internet: davidhuras@inforamp.net
  1074.  
  1075. 23. REGISTRATION INFORMATION
  1076. --------------------------------------------------------------------
  1077. The registration fee for X10EC is $25. (US Dollars for US shipping
  1078. addresses, CDN Dollars for Canadian shipping addresses).  X10EC is
  1079. currently supplied as functioning software without built-in delays
  1080. or obtrusive "nag" screens prompting you to register.  The Relative
  1081. Time feature (ie. Sunrise/Sunset support) is the only feature not
  1082. supported in the shareware version of X10EC.  A SIGNIFICANT amount
  1083. of time and effort went into this program; please register the
  1084. program if you intend to use it beyond the 30-day evaluation period.
  1085. Registered Users will be shipped a printed manual and a 3.5" diskette
  1086. (if you would prefer a 5.25" diskette please advise) containing the
  1087. registered version of the program.  Registration Benefits:
  1088.  
  1089. - Full support for the Relative Time feature which allows you
  1090.   to schedule Events relative to your local Sunset/Sunrise time
  1091.   offset by up to +/- 255 minutes.
  1092.  
  1093. - BONUS PROGRAMS: Registered Users will also receive 2 bonus
  1094.   programs:
  1095.  
  1096.   1)  X10DAT reads an X10.DAT file and prepares a report
  1097.       listing all installed devices and scheduled events including
  1098.       "frozen" events and multiple unit events. See the X10DAT.RPT
  1099.       file for a report sample.
  1100.  
  1101.   2)  XDC issues immediate X-10 command directives to the CP290
  1102.       directly from the DOS prompt.  Alternatively, you can pass
  1103.       a filename to XDC containing 'batched' X-10 command directives.
  1104.       XDC supports the 5 undocumented CP290 commands that are
  1105.       supported by X10EC & X10DC. See the XDC.DOC file for additonal
  1106.       information.
  1107.  
  1108. - DISCOUNTED REGISTRATION FEE for X10DC; X-10 Direct Control.
  1109.   Registered Users can register X10DC for $15; the regular
  1110.   registration fee is $20.
  1111.  
  1112. - DISCOUNTED REGISTRATION FEE for X10WC; X-10 Windows Control.
  1113.   Registered Users can register X10WC for $22; the regular
  1114.   registration fee is $32.
  1115.  
  1116. To expedite your registration, you may wish to register using
  1117. CompuServe Shareware Registration; you will receive a Registration
  1118. Key via CompuServe E-Mail within 1 business day that will enable the
  1119. registered program features. (See CompuServe Shareware Registration
  1120. below).  Alternatively, you can charge the Registration Fee to your
  1121. VISA, Master Card, or American Express.  (See PsL Shareware
  1122. Registration Program below).  If you elect to use either of these
  1123. methods your software will ship within 1 business day.
  1124.  
  1125. If you do not wish to register via CompuServe Shareware Registration
  1126. or the PsL Shareware Registration Program then complete the order
  1127. form in the REGISTER.FRM file and send with your payment to:
  1128.  
  1129.    David Huras
  1130.    37 Ruddell Crescent
  1131.    Georgetown, Ont. L7G 5N4
  1132.    CANADA
  1133.  
  1134. CompuServe Shareware Registration
  1135. =================================
  1136. You can register X10EC, X10DC or BOTH using CompuServe Shareware
  1137. Registration.  The Registration Fee will be charged to your
  1138. CompuServe billing account and the latest version of the software
  1139. along with a printed User Guide will be shipped within one business
  1140. day.  In addition, you will receive a Registration Key via
  1141. CompuServe E-Mail (within one business day) that will immediately
  1142. allow you to run X10EC with the registered version features enabled
  1143. while you wait for your diskette to arrive.  GO SWREG while on
  1144. CompuServe to use Shareware Registration.
  1145.  
  1146. Program Title         Program Name    Program ID#   Charge
  1147. ===================   ============    ===========   =======
  1148. X-10 Event Control       X10EC            1774       $25.00
  1149. X-10 Direct Control      X10DC             620       $20.00
  1150.  
  1151. X-10 Control Bundle      X10CB            1775       $40.00
  1152. (X10DC + X10EC)
  1153.  
  1154. X10WC CompuServe Registration
  1155. =============================
  1156. You can also register X10WC using CompuServe Shareware
  1157. Registration.  The Registration Fee will be charged to your
  1158. CompuServe billing account and a Registration Key File will be
  1159. forwarded to you via Compuserve E-Mail within 1 business day.  This
  1160. Registration Key File will immediately allow you to run the current
  1161. and future versions of X10WC with all of the registered features
  1162. enabled.  A diskette will NOT be shipped to you if you elect to
  1163. register using Compuserve Shareware Registration, however, once you
  1164. are a registered user you can order a diskette upgrade at any time
  1165. for $2.00; see DISKETTE.FRM.  GO SWREG to access CompuServe
  1166. Shareware Registration.
  1167.  
  1168. Program Title          Program Name    Program ID#   Charge
  1169. ===================   ============    ===========   =======
  1170. X-10 Windows Control      X10WC           5226       $32.00
  1171. X10EC -> X10WC Upgrade*   X10EW           5227       $22.00
  1172. -----
  1173. * To use the X10EC-> X10WC upgrade you must have registered
  1174.   X10EC (or X10CB) using CompuServe Shareware Registration.
  1175.  
  1176. PsL Shareware Registration Program
  1177. ==================================
  1178. Charge the Registration Fee to your Visa, Master Card, or American
  1179. Express by ordering X10EC or X10DC (specify Program # below) from
  1180. Public (software) Library, call 800-242-4PsL (713-524-6394 overseas)
  1181. or FAX your order to 713-524-6398.  PsL will forward your order to me
  1182. via Compuserve E-Mail and your order will be shipped within one
  1183. business day.  Note, these phone numbers are for ordering only.  ALL
  1184. OTHER INQUIRIES (eg. technical support, volume discounts site
  1185. licensing) should be directed to the author: see program
  1186. documentation.
  1187.  
  1188. Program Title         Name  Program #  Charge   Handling  Total
  1189. ===================  ====== =========  ======   ======== ======
  1190. X-10 Event Control   X10EC   11595     $25.00    $1.00   $26.00
  1191. X-10 Direct Control  X10DC   10924     $20.00    $0.00   $20.00
  1192. X-10 Windows Control X10WC   14258     $32.00    $1.00   $33.00
  1193.  
  1194. You can also register via PsL on the Internet by accessing URL:
  1195.     WWW: http://206.109.101.6/cgi-win/psl_ord.exe/item11595
  1196.  
  1197. 24. UPGRADE INFORMATION
  1198. --------------------------------------------------------------------
  1199.  
  1200. Quick Upgrade
  1201. =============
  1202. REGISTERED USERS of prior versions of X10EC can immediately run the
  1203. shareware version of X10EC v1.10 and all future shareware versions
  1204. of X10EC with the registered features enabled.  X10EC will look in
  1205. the current sub-directory for the X10EC.KEY file; if a valid file is
  1206. found then X10EC will enable all registered program features.  This
  1207. means you can upgrade by downloading the latest shareware version of
  1208. X10EC and ensuring that your X10EC.KEY file resides in the same
  1209. sub-directory.
  1210.  
  1211.  
  1212. Existing Registered Users
  1213. =========================
  1214. If you registered a version of X10EC prior to 1.10; then you are
  1215. entitled to an X10EC.KEY file that will enable you to immediately
  1216. use the shareware version of X10EC v1.10 with the registered
  1217. features enabled.  Your X10EC.KEY file can be forwarded via
  1218. CompuServe E-Mail, Internet E-Mail, or you can download it directly
  1219. from the author.  Please contact the author via E-Mail or FAX to
  1220. arrange for the delivery of your X10EC.KEY file.
  1221.  
  1222. Diskette Upgrade
  1223. ================
  1224. REGISTERED USERS of X10EC can request a diskette containing the
  1225. current version of the software at ANY TIME by completing the order
  1226. form in the DISKETTE.FRM file and sending it along with $2 for
  1227. postage to the author.
  1228.  
  1229. 25. RELEASE HISTORY - X10EC Shareware/Registered Version
  1230. --------------------------------------------------------------------
  1231.  Date      Version     Changes
  1232. ------   ----------   ----------------------------------------------
  1233. MAY'96    1.30        - Added pop-up X-10 Direct Command Pad
  1234.                       - Added RECYCLE Process Bypass feature
  1235.                       - Added support for Right Click Event Edit
  1236.                       - Updated Author E-Mail Address
  1237. MAR'95    1.20        - Upgraded encryption scheme to improve program
  1238.                         compatibility
  1239.                       - Clock Synchronization Function added for
  1240.                         CP290 and PC
  1241.                       - Clock Setting Function changed from 24 Hour
  1242.                         clock to 12 Hour AM/PM clock
  1243.                       - Save X-10 File Upon RECYCLE option added to
  1244.                         Startup Options
  1245.                       - /UF:filespec argument validation improved
  1246.                       - Typo in 'Save Events' dialogue corrected
  1247. JAN'95    1.12        - Refresh of Last Upload Date added after a
  1248.                         'New Events' Window requested
  1249. NOV'94    1.11        - Corrected text misalignment of Event Counts
  1250.                         after an Event Count Refresh
  1251.                       - Optimized Event Refresh process for improved
  1252.                         performance
  1253. SEP'94    1.10        - Daylight Savings Time Support Added
  1254.                       - Synchronize CP290/PC Clock on Upload Feature
  1255.                         Added
  1256.                       - Set CP290/PC Clock Feature Added
  1257.                       - X10.DAT File Event Merge Support Added
  1258.                       - RECYCLE Process enhanced to accept frequency
  1259.                         parameter
  1260.                       - UPLOAD FILE Batch Mode Process Added
  1261.                       - Bypass Devices (/BYD) command line argument
  1262.                         added
  1263.                       - Bypass Events (/BYE) command line argument
  1264.                         added
  1265.                       - QUICK Registration/Upgrade Feature Added
  1266.                       - 'CP290 Clock Refresh' Startup Option renamed
  1267.                         to 'Clock Refresh Rate'; now applies to both
  1268.                         the CP290 Time and PC Time displayed in the
  1269.                         Screen Header.
  1270.                       - Display Options Short-Cut Key (Ctrl-G) Added
  1271.                       - INI Parse enhanced to report Line Number
  1272.                         when an invalid INI directive is detected
  1273.                       - Clock Refresh Rate defaulted to 0.
  1274.                       - Persistent Window Split Support Added.
  1275. JUL'94    1.04        - Corrected problem with Startup Option
  1276.                         AUTOREFRESH EVENT COUNTS checkbox always
  1277.                         displaying as 'checked' regardless of actual
  1278.                         setting (thanks Doug J.)
  1279.                       - Corrected problem with menu-driven Refresh
  1280.                         of Updated Event Counts following an Event
  1281.                         Sort (thanks Doug J.)
  1282. JUL'94    1.03        - Corrected problem with non-persistent Display
  1283.                         Options: THREE-D & SHADOWS (thanks Doug J.)
  1284. JAN'94    1.02        - Corrected problem with 12:00 PM scheduled
  1285.                         event time (thanks Paul S.)
  1286. DEC'93    1.01        - Fixed problem whereby Hilite3 assumed Hilite2
  1287.                         colour when Screen Colours dialogue cancelled
  1288.                       - Fixed CP290 Day field width problem
  1289.                         (occurs on Wednesday only)
  1290. DEC'93    1.00        First Public Release
  1291. DEC'93    1.00 ß.02   - Added Upload prompt when EVENTS window
  1292.                         unloaded (and Events updated)
  1293.                       - Fixed IRQ/Base_IO_Address default when
  1294.                         only 1 present
  1295.                       - Clear CP290 on Upload ALL Events (faster
  1296.                         than clearing individually)
  1297.                       - Added WARNING TITLE color to Save Options
  1298.                         prompt
  1299.                       - Fixed TITLE when Retrieving Devices ONLY
  1300. DEC'93    1.00 ß.01   - Added CLS to Program Exit (To Clear
  1301.                         Screen)
  1302.                       - Added UnSplit Menu Item:  EVENTS/DEVICES
  1303.                         Windows revert to Startup Size
  1304.                       - CP290 Clock Refresh defaulted to 1 Minute
  1305.                         (match PC Clock Refresh)
  1306.                       - /F Switch corrected to bypass colon (":")
  1307.                       - Short-Cut Key pass thru: added work-around
  1308.                         code to block short-cut keys when modal
  1309.                         form displayed (compiler bug).
  1310.                       - Changed 'X10.DAT File' reference to 'X10
  1311.                         File' on Startup Options
  1312.                       - Corrected 'Screen Colors' problem whereby
  1313.                         Text Hilights 1,2,3 would revert to black
  1314.                         when dialogue was Cancel'd
  1315.                       - Added SPACEBAR as keyboard equivalent to
  1316.                         DoubleClick in EVENTS/DEVICES list boxes
  1317. NOV'93    1.00 ß.00   Initial Beta Version
  1318.  
  1319. 26. ACKNOWLEDGMENTS
  1320. --------------------------------------------------------------------
  1321. Special Thanks to Gary Soles & Douglas Johnson, Beta Testers.
  1322.  
  1323. ---------------------END OF X10EC.DOC-------------------------------
  1324.