home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS - Coast to Coast / simteldosarchivecoasttocoast.iso / x_10 / xe109.zip / XE109.DOC < prev   
Text File  |  1988-05-25  |  12KB  |  328 lines
  1. ╔══════════════════════════════════════╗
  2. ║ X-10 Events             Version 1.09 ║
  3. ║ Copyright 1988       F.C. Wilczynski ║
  4. ╚══════════════════════════════════════╝
  5.  
  6. Much of this file is duplicated in a HELP file within the program. To
  7. access the HELP, simply type HELP at the Xe> prompt, or enter
  8.  
  9.          XE HELP
  10.  
  11. at the DOS command prompt.
  12.  
  13.  
  14. X-10 Events allows you to access many of the features of the  X-10
  15. Computer Interface.  This program allows you to access the X-10
  16. Computer Interface from the command line, or from within the program.
  17. In addition, commands can be piped thru the program from a list of
  18. commands contained in an ASCII text file.
  19.  
  20. COM PORT
  21.  
  22. The default COM port of this program is COM1, but can be overridden to
  23. address COM 1 thru COM 4 by adding a /x as the final parameter on the
  24. command line at the DOS prompt; where x is a number 1, 2, 3 or 4.  You
  25. can permanently change the COM port by entering:
  26.  
  27.                XE PORT x
  28.  
  29. Where x is the COM port value, 1 thru 4, you wish to use.  The program
  30. must be in the current directory of the current drive, and there must
  31. be sufficient disk space remaining to allow the program to make a copy
  32. of itself.
  33.  
  34. This program allow the following:
  35.  
  36.          Clear any selected Timer Events
  37.          Change the Interface House Code
  38.          Read the Interface Time and House Code
  39.          Review Timer Events
  40.          Set the Interface Time
  41.          Send Direct Command thru the Interface
  42.          Set Interface Timer Event
  43.  
  44. The syntax of the program is not case sensitive, and commands can be
  45. entered in upper or lower case.
  46.  
  47. The program can operate from a command line, or within the program.
  48. To operate from the command line, enter the program name and the
  49. command you wish to execute:
  50.  
  51.     XE RV
  52.  
  53. would produce a list of the current X-10 Interface Timer Events, and
  54. return back to the DOS prompt.
  55.  
  56. If you wish to execute several commands, you may execute them from
  57. within the program, eliminating the need to enter the program name
  58. with each command.  The operation will also be faster since the
  59. program need not be loaded for each command.  Entering:
  60.  
  61.       XE
  62.  
  63. will cause a "Xe>" prompt to be displayed.  Enter your commands just
  64. as you would on the DOS command line, without the program name:
  65.  
  66.      RV
  67.  
  68. would produce the save list indicated above.  To exit from the program
  69. press the ESC key.  If the programs default COM port is not set to the
  70. port to which the X-10 Interface is attached, the port override (/x)
  71. would have to be entered for each command entered from the DOS command
  72. line.  Running from within the program, the override is only entered
  73. when the program is initially started.
  74.  
  75.  
  76.  
  77. Clear Timer Event
  78.  
  79.   Syntax:  cl  L
  80.  
  81.   Where 'L' is a valid event value in the range of 1 thru 128.  A
  82.   range of events can be specified by separating two values, the first
  83.   less then the second, by a dash.  A list of events can be specified
  84.   by separating the values by commas.
  85.  
  86.   Examples:
  87.  
  88.     cl 10        Clears timer event 10.
  89.  
  90.     cl 10-20     Clears timer events 10 thru 20.
  91.  
  92.     cl 10,11,12  Clears timer events 10 thru 12.
  93.  
  94.  
  95.  
  96.  
  97. Change House Code
  98.  
  99.   Syntax:  hc H
  100.  
  101.   Where 'H' is a valid house code in the range of 'A' thru 'P'.  All
  102.   timer events are maintained.
  103.  
  104.  
  105.  
  106.  
  107. Read Time
  108.  
  109.   Syntax:  rt
  110.  
  111.   Displays the current Day, Time, and House Code settings of the X-10
  112.   Computer Interface.
  113.  
  114.  
  115.  
  116.  
  117. Review Events
  118.  
  119.    Syntax: rv [p]
  120.  
  121.   Displays a list of the current timer events currently in the X-10
  122.   Computer Interface:
  123.  
  124.   ------------------ Event Number
  125.  |    -------------- Mode of Operation
  126.  |   |     --------- House Code
  127.  |   |    |   ------ Units
  128.  |   |    |  |       Time ---------------------------------------------
  129.  |   |    |  |       Days ------------------------------------         |
  130.  |   |    |  |       Command -----------------------          |        |
  131.  |   |    |  |                                      |         |        |
  132.  5 Secure A1,2,3,4,5,6,7,8,9,10 .................. DIM   8. Weekends  7:30 pm
  133.  6 Normal A15 .................................... SW/ON .. Everyday  6:00 pm
  134.  7 Normal A14  ....................................ON ..... Everyday  7:00 pm
  135.  8 Normal A16 .................................... OFF .... Everyday  7:30 pm
  136.  
  137. Using the optional 'P' command will cause the listing to be sent to the
  138. printer.
  139.  
  140.  
  141.  
  142.  
  143. Set Time
  144.  
  145.   Syntax  st T
  146.  
  147.   Sets the time of the X-10 Computer Interface to the specified day
  148.   and time, or to the current day and time established by the
  149.   computer.
  150.  
  151.   Examples:
  152.  
  153.      st mon,7:25 pm    Sets the day to Monday and the time to 7:25 pm
  154.  
  155.      st mon,19:25      Sets the day and time as in example one, using
  156.                        a 24 time format
  157.  
  158.      st C              Sets the day and time the current day and time
  159.                        of the computer.
  160.  
  161.  
  162.  
  163.  
  164. Direct Command
  165.  
  166.   Syntax  HU C
  167.  
  168.   Where 'H' is a valid house code in the range of 'A' thru 'P', 'U' is
  169.   a valid unit value, in the range of 1 thru 16, and 'C' is a valid
  170.   module command. Unit values may be specified as a range by
  171.   separating two values by a dash, or as a list, with values separated
  172.   by commas.  Valid commands are:
  173.  
  174.         ON  ....... Turns Specified Units ON
  175.         OFF ....... Turns Specified Units OFF
  176.         DIMxx ..... DIM Lights to a value of 1 thru 16 (16=bright)
  177.         LIGHTOFF .. Turns Specified Units off, but light are
  178.                     Dimmed off.
  179.         SWITCH .... Turns All Wall Switch Lights OFF.
  180.         SW/ON ..... Turns All Switch Lights OFF & Specified Units ON
  181.         ALLON ..... Turns All LIGHTS set to HOUSE CODE ON
  182.         ALLOFF .... TURNS ALL HOUSE CODE UNITS OFF
  183.  
  184.   Examples:
  185.  
  186.     A1 ON         Turns Unit 1 of House Code 'A' ON.
  187.  
  188.     A1-2 OFF      Turns Units 1 and 2 of House Code 'A' OFF.
  189.  
  190.     A1,2,5 DIM8   Dims light Units 1,2 and 5 of House Code 'A' to
  191.                      DIM LEVEL 8.
  192.  
  193.  
  194.  
  195.  
  196. Set Timer Event
  197.  
  198.   Syntax  HU D T C [S] [L]
  199.  
  200.   Where 'H' is a valid house code in the range of 'A' thru 'P', 'U' is
  201.   a valid unit value, in the range of 1 thru 16.  'D' represents the
  202.   days of the week, and 'T' the time of the day when the command will be
  203.   effected. 'C' is a valid module command as indicated in the Direct
  204.   Command above.  The optional 'S' will cause the timer event to be
  205.   entered in Security Mode.  The optional 'L' allows you to designate
  206.   the timer event position within the interface.
  207.  
  208.   HOUSE AND UNIT
  209.   The house code and unit values are entered just as they are for the
  210.   Direct Command described above.
  211.  
  212.   DAY(S) OF WEEK
  213.   The indication of the days of the week, when the timer event will be
  214.   executed, can be described as follows:
  215.  
  216.      TODAY  ........... An event will execute TODAY only.
  217.      TODAY+ ........... An event will execute TODAY and TOMORROW only.
  218.      TOMORROW ......... An event will execute TOMORROW only.
  219.      WEEKENDS ......... The event will execute on Saturday and Sunday.
  220.      WEEKDAYS ......... The event will execute only on weekdays.
  221.      EVERYDAY ......... The event will execute everyday of the week
  222.      TD ............... Same as TODAY
  223.      TD+ .............. Same as TODAY+
  224.      TM ............... Same as TOMORROW
  225.      WE ............... Same as WEEKENDS
  226.      WD ............... Same as WEEKDAYS
  227.      ED ............... Same as EVERYDAY
  228.  
  229.   Other sequences of days can be designated in one of the following
  230.   manners:
  231.  
  232.    Enter a list of numbers to indicate the days the event is to
  233.    occur, with 1 representing SUNDAY, and 7 representing SATURDAY.
  234.    For example if you want an event to occur on TUESDAY, THURSDAY,
  235.    and SATURDAY, enter a the 3 digits list 357.
  236.  
  237.    Enter a quoted string, 7 characters in length, filling in a
  238.    character for each day the event to be effective.  The string
  239.    "--t-t-s" would have the same effect as the 357 in the above
  240.    example.  You can use the - or a space, but the string must be
  241.    quoted.
  242.  
  243.    TIME
  244.    The time can be entered in 12 or 24 hour format. if the 12 hour
  245.    format is used the optional AM, PM is used.  The time can also be
  246.    set relative to either the computer clock, or the X-10 Computer
  247.    Interface clock.  Examples of valid times:
  248.  
  249.        10:40     = 10:40 am
  250.        22:40     = 10:40 pm
  251.        10:25 am  = 10:25 am
  252.         9:30 pm  =  9:30 pm
  253.        C         = Uses current time of computer clock.
  254.        X         = Uses current time of X-10 Computer Interface clock.
  255.        C+1:15    = Current computer clock time, plus one hour and 15
  256.                    minutes.
  257.        X-:10     = Current X-10 clock time, minus 10 minutes.
  258.  
  259.  
  260.    COMMANDS
  261.    The commands for a timer event are identical to those described in
  262.    the Direct command.
  263.  
  264.    SECURITY
  265.    The use of the optional 'S' marks the timer event as SECURITY Mode,
  266.    causing the events actual time of occurrence to vary within an hour of
  267.    the specified time.
  268.  
  269.    TIMER EVENT LIST ENTRY
  270.    The X-10 Computer Interface has room for 128 timer events.  When a
  271.    timer event is transmitted to the X-10 interface, the actual
  272.    position in the event list must be specified.  If the listing is
  273.    not specified, the program will download the current list of timer
  274.    events in order to locate an unused position for the new timer
  275.    event.  If you wish to change an exiting timer event it is faster
  276.    to specify the list entry value, because the program does not have
  277.    to download the existing events, and you will not have to remove
  278.    the previous entry, because it will be overwritten.
  279.  
  280.  
  281.    Timer event examples:
  282.  
  283.     A1,3 ED 23:30 OFF
  284.  
  285.     Turns units 1 and 3, on house code 'A', OFF at 11:30 pm everyday
  286.     of the week.
  287.  
  288.  
  289.     A6 TODAY C+:20 ON
  290.  
  291.     Turns unit A6 on 20 minutes from the current time.  Attached to a
  292.     signal device, this can be used as a timer.
  293.  
  294.     A9-12 TODAY+ 6:30 PM DIM10 L6
  295.  
  296.     Turns on units 9 thru 12 on house code 'A', and dims them to dim
  297.     level 10 at 6:30 pm.  The timer event in place in the 6th position
  298.     in the time list, overwriting any previous event existing in that
  299.     position.  This timer event will occur today and tomorrow, and
  300.     then the event will be cleared from the list by the X-10 Computer
  301.     Interface.
  302.  
  303.  
  304. Piping Files
  305.  
  306. This program allows an ASCII text file of commands to be piped
  307. thru as if the commands were typed at the keyboard.  This allows you to
  308. maintain a timer event list in a file which can be directly loaded into
  309. X-10 Interface.  Any changes can be made to the file with a text
  310. editor, and then reloaded.  To pipe a file enter:
  311.  
  312.     XE < filename
  313.  
  314. The file "TEST" is included to provide an example.  You may wish to
  315. take a good look at this file.  A couple of things you may wish to
  316. note:  1) The last line in the file is "ESC" which cause the program
  317. to terminate operation after sending all commands to the Interface.
  318. If the ESC is not entered, the program will hang up after executing the
  319. last command in the file, and will require you to reset your computer.
  320. 2) The first command sets the X-10 Computer Interface to Noon, and all
  321. the timer events are set relative to the X-10 clock. The final
  322. commands set the X-10 Interface clock to the same time as the computer
  323. clock.  This technique could be of value in setting dawn and dusk
  324. times by changing only the initial time setting of the X-10 clock in
  325. the first command.
  326.  
  327.  
  328.