home *** CD-ROM | disk | FTP | other *** search
/ Boldly Go Collection / version40.iso / TS / 25D / SETCLOCK.ZIP / SETCLOCK.DOC < prev    next >
Encoding:
Text File  |  1992-04-06  |  11.4 KB  |  301 lines
  1.                       
  2.  
  3.  
  4.                                                               SETCLOCK V0.2
  5.                                         Preliminary Documentation Apr 19/90
  6.  
  7. SETCLOCK is a utility which uses the Heathkit GC-1000 "Most Accurate Clock"
  8. to set you  PC's date and time according to  a world standard cesium-atomic
  9. clock.  The GC-1000 must be equipped  with the optional Heathkit GCA-1000-1
  10. computer interface.
  11.  
  12. SETCLOCK allows several  features and options in addition  to those offered
  13. by the GC-1000:
  14.  
  15.     - Sets  your PC's  date and  time very  accurately with  or without  an
  16.       audible signal for confirmation.
  17.  
  18.     - More flexible time-zone and propagation delay settings.
  19.  
  20.     - Automatic or manual setting of PC's date and time.
  21.  
  22.     -  Display of  time  error incurred  by PC's  clock  compared to  world
  23.       standard time.
  24.  
  25.     - Continuous  display of local,  UTC (Universal Coordinated  Time), and
  26.       PC time to 1/10 second accuracy.
  27.  
  28.     - Automatic and/or manual adjustment of year without having to take the
  29.       GC-1000 appart to change hardware switches.
  30.  
  31.     - Display of  time in 12-hour or 24-hour format  independent of GC-1000
  32.       display mode.
  33.  
  34. ---------------------------------------------------------------------------
  35.  
  36. Operation
  37. ---------
  38.  
  39. SETCLOCK.EXE is a stand-alone program which can be invoked using any one of
  40. three methods:
  41.  
  42. 1)
  43.     From the DOS  prompt by typing "SETCLOCK".  This allows  the setting of
  44.     various parameters on a configuation screen.
  45.  
  46. 2)
  47.     By a  batch file.  By checking  "errorlevel", a batch  command sequence
  48.     can determine  whether the PC's date  and time have been  properly set.
  49.     Eight distinct conditions are available.
  50.  
  51. 3)
  52.     From within another program.  Executing SETCLOCK  from a "C", BASIC, or
  53.     other program, the date and time can always be set correctly.
  54.  
  55.  
  56.                              S.K. Consultants
  57.                                                                           1
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.                                                               SETCLOCK V0.2
  65.                                         Preliminary Documentation Apr 19/90
  66.  
  67. SETCLOCK will maintain a small configuration  file SETCLOCK.CFG to hold the
  68. user selected options.  
  69.  
  70. To get started just type "SETCLOCK" at the DOS prompt.
  71.  
  72. In  the  absense   of  a  configuration  file,  SETCLOCK   will  present  a
  73. configuration  screen.  Sixteen  (16)  seperate parameters  may  be set  to
  74. customize the operation of program.  These parameters are described below.
  75.  
  76.  
  77.  
  78. Item                        Possible values
  79. ----                        ---------------
  80.  
  81. Serial port                 COM1, COM2
  82. Baud rate                   110, 150, 300, 600, 1200, 2400, 4800, 9600
  83. Current year                1990 to 2037
  84. UTC override preset         YES or NO
  85. Time zone preset            -11:00 to +12:00 (1 hour incr.)
  86. Propagation preset          0 to 3750 (250 mile incr.)
  87. DST adherence preset        YES or NO
  88. Tome zone actual            -15:45 to +15:45 (15 minute incr.) or "same"
  89. Propagation actual          0 to 8188 miles (2 mile incr.) or "same"
  90. DST adherence actual        YES or NO
  91. PC set HI-SPEC only         YES or NO
  92. PC set DATE & TIME          YES or NO
  93. PC set signal               YES or NO
  94. Auto read                   YES or NO
  95. Hours display mode          12 or 24
  96. Configuration screen        YES or NO
  97.  
  98.  
  99. Select the  item you wish  to change by pressing  the "up" or  "down" arrow
  100. keys. Once the item is selected, press  the "left" or "right" arrow keys to
  101. change its value to one of the possible values listed above.
  102.  
  103. Esc - Pressing the ESCAPE key will exit the program.
  104.  
  105. F1  - Function key 1 will cause the GC-1000 to send data to the PC.
  106.  
  107. F2  - Function key 2 will set the PC's date and time.
  108.  
  109.  
  110.  
  111. Each of the configuration items are described in detail next.
  112.  
  113.  
  114.  
  115.  
  116.                              S.K. Consultants
  117.                                                                           2
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.                                                               SETCLOCK V0.2
  125.                                         Preliminary Documentation Apr 19/90
  126.  
  127. Serial port:        
  128.  
  129.                     Choose the appropriate serial port to which the GC-1000
  130.                     will be connected.   Normally this will be  COM1.  Some
  131.                     PCs  are equipped  with ports  COM3 and  COM4 as  well.
  132.                     These  ports are  not  standardized  and are  thus  not
  133.                     supported in this software version.
  134.  
  135. Baud rate:
  136.  
  137.                     Select  the  baud rate  to  match  the rate  chosen  by
  138.                     switches in  the GC-1000.  It  is usually  desirable to
  139.                     use  the highest  baud  rate  available.  The  selected
  140.                     rates must match  in order for the sofware  to read the
  141.                     GC-1000.  The  accuracy of time  in unaffected  by this
  142.                     data rate.
  143.  
  144. Current year:
  145.  
  146.                     The GC-1000 provides  switches for setting the  year in
  147.                     the range 1983  to 1998.  Unfortunately the  clock must
  148.                     be opened every year in order to update these settings.
  149.                     And what about after 1998?  By setting the current year
  150.                     parameter this software will  provide the correct date.
  151.                     The year  is also updated automatically.   The internal
  152.                     setting of the GC-1000 is effectively ignored.
  153.  
  154. UTC override preset:
  155.  
  156.                     A switch on the GC-1000  allows it to display Universal
  157.                     Coordinated Time.  If this is  set, it also affects the
  158.                     data  transmitted to  the PC.   Set  this parameter  to
  159.                     match the  switch setting (YES  or NO) so  that correct
  160.                     local time and UTC is calculated.
  161.  
  162. Time zone preset:
  163.  
  164.                     Five switches on the GC-1000  select one of twenty-four
  165.                     time zones  relative to  UTC: -11:00  to +12:00  hours.
  166.                     Set this  parameter to  match the  setting of  the time
  167.                     zone as represented by the switches.
  168.  
  169. Propagation preset:
  170.  
  171.                     The propagation  delay is set  by four switches  on the
  172.                     GC-1000.  Set  this parameter to  match the  setting of
  173.                     the switches.
  174.  
  175.  
  176.                              S.K. Consultants
  177.                                                                           3
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.                                                               SETCLOCK V0.2
  185.                                         Preliminary Documentation Apr 19/90
  186.  
  187. DST adherence preset:
  188.  
  189.                     The  GC-1000 can  be set  to  adjust automatically  for
  190.                     Daylight Saving  Time.  Select this parameter  to match
  191.                     the present setting of the switch (YES or NO).
  192.  
  193. Time zone actual:
  194.  
  195.                     Select this parameter  for the time zone  in your area.
  196.                     This setting provides a more accurate and wider ranging
  197.                     set of values that of the  GC-1000.  Believe it or not,
  198.                     some  localities differ  from UTC  by  14 hours!   Some
  199.                     places are  not on  the hour  - like  Newfoundland (1/2
  200.                     hour).  Other regions are out by 1/4 hour.
  201.  
  202. Propagation actual:
  203.  
  204.                     This  parameter  allows  a  more  accurate  setting  of
  205.                     distance to Ft.  Colins, Colorado.  Set this  option if
  206.                     you know the exact distance and wish even more accurate
  207.                     time.
  208.  
  209. DST adherence actual:
  210.  
  211.                     Set this  parameter according to whether  your locality
  212.                     conforms to Daylight Saving Time.  During summer months
  213.                     when  this  is in  effect,  you  can also  change  this
  214.                     parameter to  see what  time it  was before  the clocks
  215.                     were changed.
  216.  
  217. PC set HI-SPEC only:
  218.  
  219.                     Set this  parameter to YES if  you wish your  PC's date
  220.                     and time to be updated only when the GC-1000 has locked
  221.                     into the  world standard and  is accurate to  within 10
  222.                     milliseconds.  Selecting  NO causes ths software  to be
  223.                     less descriminating,  and sets  PC whether  or not  the
  224.                     GC-1000 has been synchronized lately.
  225.  
  226. PC set DATE & TIME:
  227.  
  228.                     Set this parameter to YES if you want your PC's time to
  229.                     be updated  once data is  read from the  GC-1000.  This
  230.                     setting is only  in effect during "Auto  read" or while
  231.                     the configuration screen is OFF.
  232.  
  233.  
  234.  
  235.  
  236.                              S.K. Consultants
  237.                                                                           4
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.                                                               SETCLOCK V0.2
  245.                                         Preliminary Documentation Apr 19/90
  246.  
  247. PC set signal:
  248.  
  249.                     Set this parameter  to YES if you wish  an audible tone
  250.                     to confirm setting of the PC's  date and time when that
  251.                     occurs.
  252.  
  253. Auto read:
  254.  
  255.                     Set this parameter  to YES if you want  the software to
  256.                     periodically read the GC-1000 date  and time and update
  257.                     the screen  accordingly.  The  PC's date  and time  are
  258.                     also periodically  synchronized if the  "PC set  DATE &
  259.                     TIME" parameter is YES.
  260.  
  261. Hours display mode:
  262.  
  263.                     Set this parameter  to 12 hour mode  (North American AM
  264.                     or PM is displayed instead of 1/10's of seconds), or 24
  265.                     hour mode wich is internationally recognized.
  266.  
  267. Configuration screen:
  268.  
  269.                     Set this parameter to YES if you want the configuration
  270.                     screen the next time SETCLOCK  is run.  Setting this to
  271.                     NO is  useful if SETCLOCK is  run from a batch  file or
  272.                     executed  from  another  program.   No  information  is
  273.                     displayed on  the screen, but the  PC date and  time is
  274.                     updated  according to  other  parameter settings.   The
  275.                     program  returns  a  status code  allowing  batch  file
  276.                     commands or other programs to know what happened.
  277.  
  278. Status codes:
  279.         0   - Program was executed in "interactive" mode where the
  280.               configuratuion screen was shown.
  281.         1   - Communications error prevented the program to successfully
  282.               read the GC-1000.  Check all cables, baud rate settings, etc.
  283.         2   - GC-1000 synchronized & HI-SPEC indication.
  284.  
  285.         3   - GC-1000 synchronized but not HI-SPEC.  The clock is not
  286.               guaranteed to be accurate.
  287.         4   - GC-1000 is not synchronized to time signal.  It has just been
  288.               plugged in and as yet does not know the correct time.
  289.         5   - Failure to read SETCLOCK.CFG file.
  290.  
  291.         6   - Like condition 2, and PC date & time have been updated.
  292.  
  293.         7   - Like condition 3, and PC date & time have been updated.
  294.  
  295.  
  296.                              S.K. Consultants
  297.                                                                           5
  298.  
  299.  
  300.  
  301.