home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR4 / X10EC101.ZIP / X10EC.HLP < prev   
Text File  |  1993-12-22  |  37KB  |  788 lines
  1. .TOPIC:
  2. Contents
  3. ────────────────────────────────────────────────────────────────
  4. ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄│▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄│▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  5. ▌GENERAL INFORMATION▐│▌   PROGRAM USAGE   ▐│▌ PROGRAM FEATURES ▐
  6. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀│▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀│▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  7. X-10 Background    │Command Line Args  │Undocumented CP290
  8. CP290 Description  │Communication Ports│Intelligent Edit
  9. CP290 Event Storage│Keyboard Usage     │Start Up Options
  10. CP290 Icon Storage │Menu Bar           │Sun Time Options
  11. X10.DATFile Format │RECYCLE Process    │Screen Colours
  12. X10.EXE Program   │Problem Resolution │Save Options
  13. X-10 BBS Sources   │Compatibility      │Help on Help!
  14. ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄  ╔═══════╗  ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  15. ▌REGISTRATION INFORMATION▐  ║X10DC║  ▌UPGRADE INFORMATION▐
  16. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀  ╚═══════╝  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  17. .TOPIC:
  18. X-10 Background
  19. ────────────────────────────────────────────────────────────────────
  20. The X-10 group manufactures and markets a wide variety of home
  21. automation products that are relatively inexpensive and easy to
  22. install.  The product line consists of 'controllers' that send
  23. signals over existing home wiring to receiver 'modules' that
  24. control lights & appliances.
  25.  
  26. X-10 technology was developed by a group of engineers in
  27. Glenrothes Scotland, who began designing microelectronic chips
  28. when Large Scale Integrated Circuits were first introduced
  29. commercially in 1969. From 1976 to the present, all X-10 product
  30. design and development has been performed by this same
  31. organization, Pico Electronics Ltd., a subsidiary of X-10 Ltd.
  32.  
  33. The first X-10 products were announced in the U.S. on September
  34. 22, 1978. Prior to this introduction, two private label
  35. agreements had already been concluded, one with Sears Roebuck
  36. and the other with Radio Shack. Significant shipments to Radio
  37. Shack and Sears began in 1979.  More recent private label
  38. customers include Stanley Home automation and Heath Zenith.
  39. X-10 Ltd ships to other major customers in addition to X-10
  40. (USA) Inc. including Leviton Manufacturing Co. Inc.
  41.  
  42. Prior to July 1, 1984, X-10 products were marketed by BSR, as a
  43. result of a joint venture between the X-10 developers and BSR
  44. International PLC, parent of BSR (USA) Ltd. and BSR Canada Ltd.
  45. On July 1st, 1984, X-10 (USA) Inc. was established to take over
  46. all North American business activities formerly conducted by the
  47. X-10 division of BSR (USA) Ltd. and BSR Canada. In November
  48. 1987, X-10 Ltd.  acquired BSR's interest in the company, and is
  49. also X-10 (USA)'s parent company.
  50. ───────────────────────<End of Topic>────────────────────────────────
  51. .TOPIC:
  52. CP290 Description
  53. ────────────────────────────────────────────────────────────────────
  54. The CP290 is encased in a white plastic box about 5" wide x 7"
  55. deep x 2" high.  There are 8 rocker buttons on the top of the
  56. unit which will send ON/OFF commands to Unit Codes 1-8 of the
  57. Base HouseCode. A red LED flashes when you press the rocker
  58. buttons.  The unit plugs into a 110 volt AC wall outlet and is
  59. also supplied with an interface cable which plugs into the back
  60. of the unit and into a 9 pin serial port.  A micro-computer
  61. communicates with the device via this serial connection.  The
  62. unit also has a 9-volt battery backup that will retain the
  63. information stored within the unit in case of a power
  64. failure.
  65.  
  66. The serial connection to a micro-computer is only active when
  67. the micro-computer and CP290 are communicating; it can be
  68. disconnected once the CP290 Event Data has been loaded. For
  69. this reason, the CP290 is a good candidate to share a serial
  70. port with another serial device using a switch box.
  71.  
  72. The primary purpose of the CP290 is to store a schedule of
  73. events and issue X-10 commands at the scheduled times.  Up to
  74. 128 events can be stored within the device.  The CP290 is
  75. supplied with the program X10.EXE that allows the user to
  76. define devices and create a schedule of events. X10.EXE saves
  77. this information each time it is updated to an X10.DAT file.
  78. X10EC is file compatible (see Compatibility Topic) with
  79. X10.EXE since it can read/write X10.DAT files.  This provides
  80. you with the opportunity to experiment with X10EC and fallback
  81. to X10.EXE at any time.
  82.  
  83. The CP290 also accepts 'immediate' commands; X10DC sends its
  84. X-10 command directives to the CP290 in this 'immediate' mode.
  85. ───────────────────────<End of Topic>────────────────────────────────
  86. .TOPIC:
  87. X10DC
  88. ────────────────────────────────────────────────────────────────────
  89.                       X10DC ∙ X10 Direct Control
  90.                             Version 1.5
  91.                          (c) 1993 D.Huras
  92. ────────────────────────────────────────────────────────────────────
  93. This program is a real time controller for the X-10 CP290
  94. Computer Interface and uses the same DOS character-based point &
  95. click interface as X10EC.  Immediate commands (including the 5
  96. undocumented commands supported by X10EC) can be sent to any
  97. House/Unit address.  X10DC also supports
  98.  - X10.DAT file (Device Descriptions)
  99.  - Synchronize CP290/PC Time
  100.  - Change Base House Code w/Event Preservation*
  101.  - CP290 Diagnostic Self-Test w/Event Preservation*
  102.  - Signal Test Generator
  103. ─────
  104. *IMPORTANT NOTE: Version 1.42 and all prior versions of X10DC
  105. will not preserve the Sunrise/Sunset data stored in the CP290 by
  106. X10EC; All later versions of X10DC can optionally preserve this
  107. data.
  108. ───────────────────────<End of Topic>────────────────────────────────
  109. .TOPIC:
  110. CP290 Event Storage
  111. ────────────────────────────────────────────────────────────────────
  112. The CP290 will store up to 128 Events.  The following data
  113. is stored for each Event:
  114.    DAY(S) OF WEEK ∙ Monday,Tuesday...
  115.              TIME ∙ Hour & Minute
  116.              MODE ∙ Repeat each week,
  117.                     Repeat each week but randomize time +/- 30
  118.                       minutes (as a security measure)
  119.                     Today ONLY
  120.                     Tomorrow ONLY
  121.         HOUSECODE ∙ eg. A -> P
  122.      UNIT CODE(S) ∙ 1-16
  123. Events scheduled for TODAY/TOMORROW are cleared from memory at 4
  124. minutes after midnight on the day they were scheduled.
  125.  
  126. In addition to Event Data the CP290 also stores Time of Day, Day
  127. of Week and Base HouseCode. X10EC extends the storage capability
  128. of the CP290 by using the CP290 Icon Storage area.
  129. ───────────────────────<End of Topic>────────────────────────────────
  130. .TOPIC:
  131. CP290 Icon Storage
  132. ────────────────────────────────────────────────────────────────────
  133. The CP290 also has memory set aside for Icon storage.  The DOS
  134. character-based software does not display any graphical Icons
  135. hence this storage area is unused when the CP290 is used with
  136. the X10.EXE program.  X10EC uses this memory area to store
  137. Sunrise/Sunset (see Sun Time Options) information applicable
  138. to the scheduled Events as well as the 'Last Upload' Date/Time
  139. and other information.  Hence, all Event Information including
  140. Sunrise/Sunset Offset information is stored within the device.
  141. This means whenever you download Event Information from the
  142. CP290 the Sunrise/Sunset offset information is also downloaded;
  143. you do not have to 'match' or 'associate' the downloaded events
  144. with a data file in order to translate the 'Absolute' Time of
  145. Day back to a 'Relative' (Sunrise/Sunset +/- Offset) Time.  This
  146. also provides a complete backup to the Event Information stored
  147. in an X10.DAT file.
  148.  
  149. You can elect not to use the CP290 Icon Storage area by
  150. unchecking the 'Support Sunrise/Sunset' box on the
  151. Start Up Options screen.
  152. ───────────────────────<End of Topic>────────────────────────────────
  153. .TOPIC:
  154. X10.DAT
  155. ────────────────────────────────────────────────────────────────────
  156. The X10.DAT File Format is used by the X10.EXE program that is
  157. supplied with the CP290 Computer Interface.  If you have used
  158. the X10.EXE program then you will have created an X10.DAT that
  159. contains all of the device definitions (ie.  House Code, Unit
  160. Code, Location, Description) that you 'INSTALL'ed using X10.EXE.
  161. (The X10.DAT file will store up to 256 device definitions.)
  162. X10EC will read in an X10.DAT file, locate all of your device
  163. definitions, sort them by House & Unit Code and present them in
  164. a scrollable list box in the DEVICES window.  You can also merge
  165. Device Descriptions from any number of X10.DAT files; X10EC will
  166. remove any duplicate addresses and allow you to save all of the
  167. Device Descriptions to one X10.DAT file.
  168.  
  169. The X10.DAT file also stores event information; up to 128 events
  170. can be stored in the file.  X10EC will read all of the Events
  171. stored within the X10.DAT file and present them in a scrollable
  172. list box in the EVENTS window.  These Events are displayed in
  173. the same order as they are found in the file, however you can
  174. re-sort the Events using one of 3 sort criteria's supported by
  175. X10EC.
  176.  
  177. X10EC 'extends' the X10.DAT file by also storing the
  178. Sunrise/Sunset Offset information within it.  This additional
  179. data is transparent to X10.EXE, however, X10.EXE will
  180. eliminate it from the file if you overwrite the file using
  181. X10.EXE.  (see Compatibility Topic).
  182. ───────────────────────<End of Topic>────────────────────────────────
  183. .TOPIC:
  184. X10.EXE
  185. ────────────────────────────────────────────────────────────────────
  186. X10.EXE is supplied with the X-10 CP290 Computer Interface and
  187. provides a means to define devices and schedule events. There
  188. are a significant number of limitations associated with X10.EXE
  189. that X10EC improves upon, eg:
  190.  
  191.   ∙ Clumsy FUNCTION key driven Interface - no mouse support
  192.   ∙ EVENTS once scheduled cannot be modified.
  193.   ∙ DEVICES once INSTALL'd cannot be renamed or modified.
  194.   ∙ No facility to view/scroll a complete listing of EVENTS.
  195.   ∙ No control over CP290 Uploads/Downloads
  196.   ∙ EVENTS are tightly coupled with the X10.DAT file; loading
  197.     the wrong X10.DAT file can have unpredictable results.
  198.   ∙ CP290 ICON Storage area is not utilized
  199.   ∙ No support for Sunrise/Sunset Relative Times
  200.   ∙ No support for Undocumented CP290 Commands
  201.   ∙ No support for Last Upload Date/Time
  202.   ∙ No support for EGA/VGA 43/50 line mode
  203.   ∙ Very limited Screen Colour Support
  204. ───────────────────────<End of Topic>────────────────────────────────
  205. .TOPIC:
  206. X-10 BBS Sources
  207. ────────────────────────────────────────────────────────────────────
  208. The following BBS's are primarily dedicated to Home Automation
  209. and are good sources of both X-10 software and documentation.
  210.  
  211.      AUTOMATIC MANSION........................604-872-8407
  212.  
  213.      BARAN-HARPER GROUP HOME AUTOMATION BBS...905-471-9574
  214.      (HC2000 Source)                          905-471-6776
  215.  
  216.      HOME AUTOMATION LABS.....................404-319-6227
  217.  
  218. There is also a Home Automation section within the Consumer
  219. Electronics Forum (CEFORUM) on CompuServe.
  220.  
  221. If you are aware of other BBS's that should be included in this
  222. list, please contact the author.
  223. ───────────────────────<End of Topic>────────────────────────────────
  224. .TOPIC:
  225. Help On Help!
  226. ────────────────────────────────────────────────────────────────────
  227. Help On Help!
  228. ────────────────────────────────────────────────────────────────────
  229. Selecting a Help link:
  230. ══════════════════════
  231. With a mouse - click on phrases outlined by two triangles.
  232. With the keyboard - Press TAB or Shift-TAB to select a link.
  233.    Press ENTER to jump to that topic.
  234.  
  235. Scrolling the Help window:
  236. ══════════════════════════
  237. With a mouse - click on the horizontal or vertical scroll
  238.    bars.
  239. With the keyboard - press the cursor navigation keys.
  240.  
  241. Command Buttons:
  242. ════════════════
  243. Use a mouse to click a button or press the letter
  244. mentioned below.
  245.  
  246. Contents - displays a table of contents for the application's
  247.    Help.  Press C to select Contents.
  248.  
  249. Search -  opens a dialog box that lists all available Help
  250.    topics.  Select a topic from the list box and press ENTER.
  251.    Press S to select Search.
  252.  
  253. Back - jumps to the last Help topic viewed. Press B to select
  254.     Back.
  255.  
  256. Exit - Closes the Help Window.  Press X to select Exit.
  257. ───────────────────────<End of Topic>────────────────────────────────
  258. .TOPIC:
  259. Command Line Args
  260. ────────────────────────────────────────────────────────────────────
  261. The following arguments can be entered in any order:
  262.  
  263.   /Annnnn ∙ Base I/O Address ..see User Defined CommPort
  264.   /BW ∙ Use Monochrome colours
  265.   /F:[d]\filename ∙ X10.DAT FILE SPECIFICATION
  266.         where [d] = drivespec eg. /F:C:\X10\X10.DAT
  267.         overrides Start Up X10 File
  268.   /Cn ∙ COMMPORT where n = 1,2,3 or 4
  269.   /In ∙ IRQ where n=1-15 ...see User Defined CommPort
  270.   /NH ∙ Do Not Load HELP Sub-System
  271.   /NH-∙ Load HELP Sub-System (Override INI directive)
  272.   /RECYCLE ∙ Run X10EC in batch mode (see RECYCLE Process)
  273.   /?  ∙ Display Command Line Arguments
  274.  
  275. DEFAULTS:  If the program is run without any command line
  276. arguments it will default to COMMPORT 1.
  277.  
  278. NOTES:
  279. 1) All Command Line directives can be modified once
  280.    the program loads by using the appropriate Options
  281.    screen.  The obvious exception being /RECYCLE which
  282.    runs X10EC in batch mode. (See RECYCLE Process)
  283.  
  284. 2) COMMAND LINE OPTIONS OVERRIDE X10EC.INI SETTINGS
  285. ───────────────────────<End of Topic>────────────────────────────────
  286. .TOPIC:
  287. Communication Ports
  288. ────────────────────────────────────────────────────────────────────
  289. X10EC supports "pseudo standard" CommPorts 1 thru 4 using the
  290. following settings:
  291.   ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  292.   █          │      ├─ Base I/O Addr.──█  FOR PS/2 Settings
  293.   █ CommPort │ IRQ  │ Decimal │  HEX.  █  see PS/2 CommPorts
  294.   █──────────┼──────┼─────────┼────────█
  295.   █    1     │   4  │  1016   │  3F8   █
  296.   █    2     │   3  │   760   │  2F8   █
  297.   █    3     │   4  │  1000   │  3E8   █
  298.   █    4     │   3  │   744   │  2E8   █
  299.   ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  300. If one of these CommPort settings matches your hardware
  301. configuration simply select the appropriate CommPort from the
  302. Communications Options screen.  (You could also start X10EC with
  303. the /C command line argument or use the COMMPORT= X10EC.INI
  304. parameter).
  305.  
  306. If your hardware configuration differs from the table above,
  307. then can define your own CommPort;see User Defined CommPort
  308. ───────────────────────<End of Topic>────────────────────────────────
  309. .TOPIC:
  310. User Defined CommPort
  311. ────────────────────────────────────────────────────────────────────
  312. You can define your own CommPort by selecting User Defined
  313. CommPort from the Communications Options screen and setting the
  314. IRQ interrupt and Base I/O Address.  (You could also use the /I
  315. and /A Command Line Args or IRQ= & Base_IO_Address= X10EC.INI
  316. file directives).  IRQ can be set to any value between 1 and 15
  317. (inclusive).  Base I/O Address can be set to any value greater
  318. than zero.  CAUTION: your hardware may "lock up" if incorrect
  319. settings are used.  Once you have enabled communications with
  320. the CP290, then use the 'Save Options' menu item to save the
  321. information to the X10EC.INI file.
  322.  
  323. THE BASE I/O ADDRESS MUST BE SPECIFIED IN DECIMAL NOTATION.
  324. ───────────────────────<End of Topic>────────────────────────────────
  325. .TOPIC:
  326. PS/2 CommPorts
  327. ────────────────────────────────────────────────────────────────────
  328.    ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
  329.    █   PS/2   │      ├─ Base I/O Addr.──█ NOTE: A User Defined
  330.    █ CommPort │ IRQ  │ Decimal │  HEX.  █       CommPort must be
  331.    █──────────┼──────┼─────────┼────────█       used for PS/2
  332.    █    1     │   4  │  1016   │  3F8   █       CommPorts 3-8
  333.    █    2     │   3  │   760   │  2F8   █
  334.    █    3     │   3  │ 12832   │ 3220   █
  335.    █    4     │   3  │ 12840   │ 3228   █
  336.    █    5     │   3  │ 16928   │ 4220   █
  337.    █    6     │   3  │ 16936   │ 4228   █
  338.    █    7     │   3  │ 21024   │ 5220   █
  339.    █    8     │   3  │ 21032   │ 5228   █
  340.    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  341. ───────────────────────<End of Topic>────────────────────────────────
  342. .TOPIC:
  343. Keyboard Usage
  344. ────────────────────────────────────────────────────────────────────
  345. Use the TAB/Shift-TAB keys to move among the various controls.
  346. The Up/Down arrows can be used to move up and down List Boxes;
  347. the Spacebar can be used to select the current List Box item.
  348. The Enter key can be used to check/uncheck a check box, or
  349. invoke a command button.  The ESCAPE key will exit the current
  350. function or the program if no other windows are visible.  Most
  351. Command Buttons and controls have quick access keys which you
  352. can identify by the highlighted character in the button/control
  353. name; press the ALT key + the quick access key to invoke the
  354. action.
  355. ───────────────────────<End of Topic>────────────────────────────────
  356. .TOPIC:
  357. Menu Bar
  358. ────────────────────────────────────────────────────────────────────
  359. Press & release the ALT key to activate the Menu Bar.  Menu
  360. items can be selected by pressing the highlighted key (when
  361. applicable), or by positioning the highlight bar using the
  362. up/down arrow keys and pressing ENTER.
  363.  
  364. Short-cut Keys have been defined for many menu items.
  365. ───────────────────────<End of Topic>────────────────────────────────
  366. .TOPIC:
  367. Short-cut Keys
  368.    *NOTE: This is not a complete list of menu items; only
  369.     menu items with Short-cut Keys are listed here.
  370. ─┤FILE Menu├────────────────────────────────────────────────────────
  371.  
  372.    Open X10 File
  373.      Retrieve Devices/Events ∙ Ctrl-R
  374.    Save X10 File             ∙ Ctrl-S
  375.    Save X10 File AS          ∙ Ctrl-A
  376.    Print Report
  377.      Print Event Listing     ∙ Ctrl-P
  378.    Exit                      ∙ Ctrl-X
  379.    Unconditional Exit        ∙ Ctrl-Q
  380.  
  381. ─┤WINDOW Menu├──────────────────────────────────────────────────────
  382.    Devices                   ∙ Ctrl-D
  383.    Events                    ∙ Ctrl-E
  384.    Split
  385.      Horizontal              ∙ Ctrl-H
  386.      Vertical                ∙ Ctrl-V
  387.      Swap                    ∙ Ctrl-W
  388.  
  389. ─┤ACTIONS Menu├─────────────────────────────────────────────────────
  390.    Refresh Updated
  391.      Devices Name            ∙ F2
  392.      Event Counts            ∙ F3
  393.    Sort Events By
  394.      Location,Description    ∙ Shift-F1
  395.      Housecode,UnitCode      ∙ Shift-F2
  396.      Day,Time                ∙ Shift-F3
  397.    ReCycle Sun Times         ∙ F4
  398.    Show Sun Times            ∙ Ctrl-T
  399.  
  400. ─┤TRANSFER Menu├────────────────────────────────────────────────────
  401.    Upload Events TO CP290
  402.      All Events              ∙ Ctrl-U
  403.  
  404. ─┤OPTIONS Menu├─────────────────────────────────────────────────────
  405.    Communications            ∙ Ctrl-C
  406.    Startup                   ∙ Ctrl-B
  407.    Save Options              ∙ Ctrl-O
  408.  
  409. ─┤HELP MENU├────────────────────────────────────────────────────────
  410.    Help Information          ∙ F1
  411.    About                     ∙ Ctrl-F1
  412. ───────────────────────<End of Topic>────────────────────────────────
  413. .TOPIC:
  414. RECYCLE Process
  415. ────────────────────────────────────────────────────────────────────
  416. The RECYCLE Process runs X10EC in Batch Mode and updates any
  417. Events that have been scheduled with Relative Times (ie.
  418. Sunset/Sunrise +/- Offsets).  This allows you to run X10EC from
  419. a Batch File on a weekly basis to ensure your Sunset/Sunrise
  420. times are current.  X10EC will perform the following steps
  421. when run with the /RECYCLE Command Line Argument:
  422.  
  423.   ∙ Calculate Sunset/Sunrise Times for the upcoming 7 Days
  424.   ∙ Download Event Information from the CP290
  425.   ∙ Download Sunset/Sunrise Offset Information from the CP290
  426.   ∙ Update Events with Sunset/Sunrise relative times
  427.   ∙ Upload any updated Events to the CP290
  428.   ∙ Backup the old X10EC.LOG to X10EC_B.LOG
  429.   ∙ Log all activity to X10EC.LOG
  430.  
  431. Note that the RECYCLE process DOES NOT read EVENT INFORMATION
  432. from the X10.DAT Startup File, this is to ensure that only
  433. currently scheduled Events as stored in the CP290 are updated.
  434. (There is no guarantee that the current X10 Startup File as
  435. defined in the X10EC.INI reflects the contents of the CP290
  436. Event Memory.)  Consequently you may wish to set up X10EC to
  437. always download Events from the CP290 upon startup rather than
  438. retrieving Events from the X10.DAT file.
  439. ───────────────────────<End of Topic>────────────────────────────────
  440. .TOPIC:
  441. Problem Resolution
  442. ────────────────────────────────────────────────────────────────────
  443. Generally, if your CP290 works with the X-10 supplied software
  444. then you should have no problems running X10EC.  The program
  445. will load if you run it without any arguments (thereby
  446. defaulting to COMMPORT 1) and your CP290 is actually attached to
  447. COMMPORT 2.  If this is the case X10EC will report 'Timed Out
  448. waiting for a response' when it attempts to retrieve the CP290
  449. Time, Day of Week and Base HouseCode.  You can toggle to the
  450. correct COMMPORT once the program is running by using the
  451. Options, Communications menu.  The Save Options menu option
  452. will save all settings to the X10EC.INI which obviates the need
  453. for command line arguments.
  454.  
  455. If you run X10EC with a modem attached to the COMMPORT, you
  456. may get unpredictable results since the modem will echo
  457. everything back to X10EC.
  458.  
  459. If you use a Serial Mouse, this may cause a conflict if X10EC
  460. attempts to communicate with a CP290 on the same CommPort.  You
  461. may want to start X10EC with the /C command line argument to
  462. ensure it does not default to CommPort 1 if your mouse is also
  463. on CommPort 1.
  464.  
  465. If you suspect that your CP290 is failing, you should try
  466. using the diagnostic/debug features provided by X10DC.
  467.  
  468. In some cases X10EC may report communication errors (ie.
  469. time-outs, unmatched checksums, etc).  This may occur when
  470. scheduled Events collide with CP290 Uploads/Downloads that are
  471. in progress.  (The CP290 transmits onto the serial port line
  472. whenever a scheduled event occurs and when you press the rocker
  473. buttons on the CP290).  X10EC attempts to minimize collisions by
  474. discarding unexpected serial input, however the possibility
  475. still exists.  You should just re-invoke the interrupted action
  476. to recover from this type of problem.
  477.  
  478. The open architecture of the PC compatible operating
  479. environment and the near infinite combinations of hardware and
  480. software complicate the compatibility of applications
  481. software.  While every effort has been made to ensure that
  482. X10EC is compatible with many hardware/software combinations,
  483. there may be operating environments in which X10EC will not
  484. run properly.
  485.  
  486. Problems can be reported to:
  487.  
  488.    David Huras
  489.    37 Ruddell Crescent
  490.    Georgetown, Ont. L7G 5N4
  491.    CANADA
  492.  
  493.    FAX: 905-873-6429
  494.    CIS: 72767,472
  495.    Internet: david.huras@canrem.com
  496. ───────────────────────<End of Topic>────────────────────────────────
  497. .TOPIC:
  498. Compatibility
  499. ────────────────────────────────────────────────────────────────────
  500. FREEZE
  501. ══════
  502. X10EC is file compatible with X10.EXE but there are some
  503. limitations associated with partially 'Frozen' Group Events.
  504. X10.EXE allows you to partially freeze Group Events, that is
  505. some units within the group can be frozen whereas other remain
  506. scheduled Events.  X10EC does not support this level of
  507. granularity for Frozen Events; it considers any Event either
  508. Frozen or Thawed (ie. Not Frozen) and this applies to single
  509. unit Events and multiple unit Events alike.  If a multiple unit
  510. Event is Frozen by X10EC then all units defined to the Event
  511. will be Frozen.
  512.  
  513. X10.EXE relies solely on the X10.DAT file to decipher
  514. Frozen Events that it 'Freezes'.  Conversely X10EC.EXE can
  515. decipher Frozen Events that it 'Freezes' from either an Event
  516. Download or an X10.DAT.
  517.  
  518. IMPACT
  519. ══════
  520. If Events have been FROZEN by X10.EXE, then X10EC.EXE will
  521. behave as follows:
  522.  
  523. Event Source Event Type   Freeze  X10EC Interpretation
  524. ──────────── ───────────  ──────  ──────────────────────────────
  525. X10.DAT File Single Unit  Frozen  No impact: will interpret
  526. X10.DAT File Multi-Unit   Partial X10EC will capture unFrozen
  527.                                   units only and treat as a
  528.                                   Frozen Event.
  529. X10.DAT File Multi-Unit   Frozen  No impact: will interpret
  530.  
  531. CP290 D/L    Single Unit  Frozen  X10EC will NOT capture unit;
  532.                                   will treat as Frozen Event
  533. CP290 D/L    Multi-Unit   Partial X10EC will capture unFrozen
  534.                                   units only and treat as an
  535.                                   unFrozen Event
  536. CP290 D/L    Multi-Unit   Frozen  X10EC will NOT capture units;
  537.                                   will treat as Frozen Event
  538.  
  539. RECOMMENDATION
  540. ══════════════
  541. If this all seems confusing, just be sure to unFreeze any Events
  542. you have Frozen with X10.EXE before using X10EC.EXE.  Any
  543. Events Frozen by X10EC will be translated correctly by X10.EXE
  544. if you decide to fallback to X10.EXE.
  545.  
  546. FILE COMPATIBILITY
  547. ══════════════════
  548. X10.EXE will read and interpret the X10.DAT files created by
  549. X10EC that include X10EC extensions.  Of course, the extensions
  550. added by X10EC will be transparent to X10.EXE, however, they
  551. will be lost if X10.EXE overwrites the file.  (Extensions
  552. include Sunrise/Sunset information and Last Upload Date/Time).
  553. For this reason, it is recommended that you create an X10.DAT
  554. file for the exclusive use of X10.EXE rather than sharing
  555. X10.DAT files among the two programs.
  556. ───────────────────────<End of Topic>────────────────────────────────
  557. .TOPIC:
  558. Undocumented CP290
  559. ────────────────────────────────────────────────────────────────────
  560. X10EC supports the following undocumented CP290 commands:
  561.  
  562.    Fade OFF   ■ DIMS Light(s) to 0 then turns Unit(s) OFF
  563.                 (Can target multiple units for this command)
  564.    X-Light ON ■ Exclusive Light ON - Issues an ALL LIGHTS OFF
  565.                 then Brightens selected Unit(s)
  566.                 (Can target multiple units for this command)
  567.    All Lights ON  ■ All Lights on selected House Code set ON
  568.    All Lights OFF ■ All Lights on selected House Code set OFF
  569.    All Units OFF  ■ All Units on selected House Code set OFF
  570.  
  571. NOTE:Storing Events with these undocumented commands MAY CAUSE
  572.      problems with some CP290 Event Schedulers.  These commands
  573.      will be transparent to X10.EXE; however, X10.EXE can only
  574.      display ON/OFF/DIM.  If X10.EXE encounters one of these
  575.      undocumented commands it will display it as blank.
  576. ───────────────────────<End of Topic>────────────────────────────────
  577. .TOPIC:
  578. Intelligent Edit
  579. ────────────────────────────────────────────────────────────────────
  580. X10EC offers some degree of referential integrity when you're
  581. editing Device Names:
  582. ∙ If you modify a Device Address (ie. House and/or Unit Code)
  583.   X10EC can optionally examine all of the scheduled Events and
  584.   update* any that target the Device to reflect the new
  585.   house/unit code.
  586. ∙ If you Delete a Device Description X10EC can optionally
  587.   examine all of the scheduled Events and purge* any that are
  588.   specifically targetted for the deleted Device.
  589. ∙ If you change a Device Name; any Events which target the
  590.   Device will be updated to reflect the new Device Name the
  591.   next time the Event list gets focus. (IF AUTOREFRESH Device
  592.   Names is checked - otherwise you can press F2 at any time to
  593.   refresh Device Names).
  594. ─────
  595. * Group and Global Events are left intact; only single unit
  596. Events will be purged/modified.
  597. ───────────────────────<End of Topic>────────────────────────────────
  598. .TOPIC:
  599. Start Up Options
  600. ────────────────────────────────────────────────────────────────────
  601. DEVICES & EVENTS
  602. ════════════════
  603. The DEVICES Window and EVENTS Window are always opened each time
  604. you start X10EC.  You can setup X10EC to automatically populate
  605. these Windows by clicking the appropriate option buttons.  The
  606. only source to populate the DEVICES Window is an X10.DAT file;
  607. the EVENTS Window can be populated from either an X10.DAT file
  608. or a CP290 download.  Only one X10.DAT startup file can be
  609. identified and it will source both the DEVICES Window and the
  610. EVENTS Window (if applicable).
  611.  
  612. GENERAL OPTIONS
  613. ═══════════════
  614. General options can be modified at any time while X10EC is
  615. executing and the effect will be immediate.
  616.  
  617. SUNRISE/SUNSET SUPPORT: Uncheck if you DO NOT want X10EC to use
  618. the ICON memory area of the CP290.
  619.  
  620. LOAD HELP SUBSYSTEM: Uncheck to save memory and speed up program
  621. load time.
  622.  
  623. CONFIRM DELETE REQUESTS: Uncheck to delete without confirmation.
  624.  
  625. AUTOREFRESH DEVICE NAMES: On slower machines it could become a
  626. nuisance to wait for the program to refresh the Device Names in
  627. the EVENT Window whenever a Device Name is modified. You may
  628. want to Refresh 'ON DEMAND' instead by using F2.
  629.  
  630. AUTOREFRESH EVENT COUNTS: Uncheck to Refresh 'ON DEMAND' (F3).
  631.  
  632. CP290 CLOCK REFRESH: The PC Time in the screen header is
  633. refreshed every minute; the CP290 Time in the screen header can
  634. also be refreshed periodically by setting the refresh rate
  635. greater than 0.
  636. NOTE:
  637. ════
  638. THE FIELD WIDTH IS ONLY 1 CHARACTER AND THE COMPILER DEFAULTS
  639. TO KEYBOARD 'INSERT MODE'; PRESS THE INSERT KEY TO TOGGLE THE
  640. THE KEYBOARD TO 'TYPEOVER MODE' TO CHANGE REFRESH VALUE.
  641.  
  642. LINES PER REPORT PAGE: Valid Range is 10-99.
  643.  
  644. PRINT IBM BOX CHARACTERS: If your printer is set up to print the
  645. IBM ASCII character set you can improve the appearance of the
  646. DEVICE & EVENT printed reports by checking this box
  647. ───────────────────────<End of Topic>────────────────────────────────
  648. .TOPIC:
  649. Sun Time Options
  650. ────────────────────────────────────────────────────────────────────
  651. This screen under the 'Options' menu allows you to set the
  652. Longitude, Latitude & GMT Offset parameters specific to your
  653. location.  These parameters are used to calculate your local
  654. Sunrise and Sunset times.  Sample Longitude & Latitude
  655. parameters for a limited selection of cities can be set by using
  656. the combo box (click on the down arrow or press F4 to expand the
  657. list box).  THE GMT OFFSET MUST BE EXPLICITLY SET; it can vary
  658. depending on whether Daylight Savings Time is in effect or not.
  659. eg. for the Eastern Time Zone the GMT Offset is +4 when Daylight
  660. Savings Time is in effect and +5 when it is not.  The calculated
  661. Sunrise/Sunset times will be accurate to within a minute or
  662. two.
  663. ───────────────────────<End of Topic>────────────────────────────────
  664. .TOPIC:
  665. Screen Colours
  666. ────────────────────────────────────────────────────────────────────
  667. This feature allows the user to choose their own screen
  668. colours.  A list of screen elements is presented on the left
  669. side of the screen and all of the available Foreground and
  670. Background (when applicable) colours are displayed next to the
  671. screen elements.  To change a colour, simply select the screen
  672. element you wish to change and click on the preferred
  673. Foreground/Background colours.  The Colour defaults can be
  674. restored by clicking on the Colour button, similarly Black &
  675. White colours can be selected by clicking on the Monochrome
  676. button.  Note: some colour combinations will render the screen
  677. unreadable, if this happens press the [Esc] key to exit the
  678. dialogue and restore the colours to their previous setting.
  679. Once you are satisfied with your colour selections the
  680. Save Options command can be used to store them so that X10EC
  681. always starts up with your selected colours.
  682.  
  683. The colours for message boxes cannot be changed (always black
  684. on white;compiler limitation).
  685.  
  686. The Graphic Gauges setting is also set from this screen.
  687. ───────────────────────<End of Topic>────────────────────────────────
  688. .TOPIC:
  689. Graphic Gauges
  690. ────────────────────────────────────────────────────────────────────
  691. The Graphic Gauges checkbox determines whether or not graphical
  692. EGA/VGA characters are used to construct the sliding percentage
  693. complete gauge.  If this causes problems with your screen
  694. display, then uncheck the box; the ASCII character '█' 219 will
  695. be used to paint the gauges instead.
  696. ───────────────────────<End of Topic>────────────────────────────────
  697. .TOPIC:
  698. Save Options
  699. ────────────────────────────────────────────────────────────────────
  700. This menu option saves all of the current program settings to
  701. the X10EC.INI file.  If an X10EC.INI file exists, the program
  702. will display a Warning Message and confirm that you wish to
  703. overwrite the existing X10EC.INI file before proceeding.  The
  704. X10EC.INI file that X10EC generates is a plain ASCII file that
  705. you can edit using your favourite editor.  X10EC will notify you
  706. of any errors within the X10EC.INI by displaying the offending
  707. line along with a  message indicating it will be ignored.  Note
  708. that the X10EC.INI file is parsed before command line arguments
  709. and therefore will be overridden by conflicting command line
  710. arguments.
  711. ───────────────────────<End of Topic>────────────────────────────────
  712. .TOPIC:
  713. REGISTRATION INFORMATION
  714. ────────────────────────────────────────────────────────────────────
  715. The registration fee for X10EC is $25. (US Dollars for US
  716. shipping addresses, CDN Dollars for Canadian shipping
  717. addresses).  X10EC is currently supplied as functioning software
  718. without built-in delays or obtrusive "nag" screens prompting you
  719. to register.  The Relative Time feature (ie. Sunrise/Sunset
  720. support) is the only feature not supported in the shareware
  721. version of X10EC.  A SIGNIFICANT amount of time and effort went
  722. into this program; please register the program if you intend to
  723. use it beyond the 30-day evaluation period.  Registered Users
  724. will be shipped a printed manual and a 3½" diskette (if you
  725. would prefer a 5¼" diskette please advise) containing the
  726. registered version of the program.  Registration Benefits:
  727.  
  728. ∙ Full support for the Relative Time feature which allows you
  729.   to schedule Events relative to your local Sunset/Sunrise time
  730.   offset by up to +/- 255 minutes.
  731.  
  732. ∙ BONUS PROGRAM: Registered Users will also receive a bonus
  733.   program; X10DAT reads an X10.DAT file and prepares a report
  734.   listing all installed devices and scheduled events including
  735.   "frozen" events and multiple unit events. See the X10DAT.RPT
  736.   file for a report sample.
  737.  
  738. ∙ DISCOUNTED REGISTRATION FEE for X10DC; X-10 Direct Control.
  739.   Registered Users can register X10DC for $15; the regular
  740.   registration fee is $20.
  741.  
  742. Complete the order form in the REGISTER.FRM file and send with
  743. your payment to:
  744.                                  You can also register via
  745.    David Huras               CompuServe Shareware Registration
  746.    37 Ruddell Crescent
  747.    Georgetown, Ont. L7G 5N4
  748.    CANADA
  749. ───────────────────────<End of Topic>────────────────────────────────
  750. .TOPIC:
  751. Compuserve Shareware Registration
  752. ────────────────────────────────────────────────────────────────────
  753. You can register X10EC, X10DC or BOTH using CompuServe
  754. Shareware Registration.  The Registration Fee will be charged to
  755. your CompuServe billing account and the latest version of the
  756. software will be shipped within one business day. GO SWREG while
  757. on CompuServe to use Shareware Registration.
  758.  
  759. Program Title         Program Name    Program ID#   Charge
  760. ═══════════════════   ════════════    ═══════════   ═══════
  761. X-10 Event Control       X10EC            1774       $25.00
  762. X-10 Direct Control      X10DC             620       $20.00
  763.  
  764. X-10 Control Bundle      X10CB            1775       $40.00
  765. (X10DC + X10EC)
  766.  
  767. Shareware Registration (SWREG) will prompt you through the
  768. registration process; you can register programs by referring to
  769. them by program name or ID #.  SWREG will display a description
  770. of the program and prompt you to confirm the registration order;
  771. you have the opportunity to abandon the registration process at
  772. any time.
  773. ───────────────────────<End of Topic>────────────────────────────────
  774. .TOPIC:
  775. UPGRADE INFORMATION
  776. ╔══════════════════════════════════════════════════════════════╗
  777. ║REGISTERED USERS of prior versions of X10EC can upgrade to the║
  778. ║current version at ANY TIME by simply sending a diskette      ║
  779. ║containing their registered version of the software and $2    ║
  780. ║for postage to the address above.                             ║
  781. ╚══════════════════════════════════════════════════════════════╝
  782. ───────────────────────<End of Topic>────────────────────────────────
  783. .TOPIC:
  784. Special Thanks
  785. ────────────────────────────────────────────────────────────────────
  786. SPECIAL THANKS to Gary Soles, Beta Tester.
  787. ───────────────────────<End of Topic>────────────────────────────────
  788.