home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 1 / HamRadio.cdr / cw / cw500 / cw.doc < prev    next >
Text File  |  1990-03-08  |  19KB  |  405 lines
  1. GENERAL INFORMATION
  2.  
  3.      CW is a Morse Code send/receive program designed to run on the IBM PC and
  4. it's clones.  A split screen format is used for the visual interface and on-line
  5. help is available to the operator.
  6.  
  7.      The program is user configurable and creates a file which supports the
  8. screen images for subsequent use.  The user has the option of changing the
  9. operating characteristics and input/output environment recognized by the pro-
  10. gram.  These may then be saved by CW in a file called INIT.CW, an ASCII file
  11. which can be viewed/modified using a word processor.  The default character-
  12. istics provide for Morse Input and Output on communications port COM1 using
  13. the RTS and CTS signal lines.   If INIT.CW is not on the default disk then
  14. the default values are assumed.
  15.  
  16.      CW.EXE is a user supported program which may be transferred and/or copied
  17. as often as you like.  No monetary fees (other than disk copying) may be
  18. charged as a part of this service.  The program is a product of
  19.  
  20.           Dave Freese, W1HKJ
  21.           c/o Clermont Computer Consultants
  22.           29 N Ravenwood Drive
  23.           Cape May Court House, NJ  08210
  24.  
  25.           (609) 624 0076
  26.  
  27.      The program is written in TURBO (tm) PASCAL and demonstrates how well
  28. that particular product allows full use of the PC's hardware.   Versions 4.0
  29. and later can be compiled using TP ver 5.  A recompilation also requires access
  30. to units distributed by 'The Research Group' called TOPAZ.  These units provide
  31. full screen handling and access to dBASE-III+ data files.  The logging provided
  32. by the program is maintained in a dBASE-III data file.
  33.  
  34.      THIS PROGRAM IS PUBLIC DOMAIN SOFTWARE.  YOU MAY FREELY DISTRIBUTE VIA ANY
  35. MEDIA, ELECTRONIC OR PHYSICAL.  THE AUTHOR ASKS ONLY THAT YOU DO NOT REMOVE
  36. THE CREDITS.
  37.  
  38.  
  39.      Have fun with CW.  If you enjoy using it as much as I enjoyed creating
  40. it, you will have a ball.  Happy DX and bcnu.
  41.                           73's   Dave   W 1 H K J
  42.  
  43.  
  44. INSTALLATION PROCEDURE
  45.  
  46.      Create a bootable disk with CW.EXE, IMAGE.CW and COUNTRY.LST installed in
  47. the desired directory.  CW.EXE is compatible with ancilliary programs such as
  48. SIDEKICK(tm).  When used with this and other keyboard enhancement programs
  49. special consideration must be given to program timing.  See the section on
  50. calibration for more details.
  51.  
  52.      Press <F1> to review the HELP screen.  Access to the configuration pro-
  53. cedures is provided by the <ALT> P combination.  CW is distributed preset for
  54. screen colors to suit the authors tastes.  Colors may be altered, reviewed and
  55. eventually stored in an initialization file called INIT.CW.
  56.  
  57.      The internal tone generator is configured to ON by the default configur-
  58. ation parameters.  Try typing a few lines of text and observe the operation of
  59. the type ahead keyboard buffer/display, the character transmit indication and
  60. the morse code generated on the internal speaker.
  61.  
  62. PROGRAM TERMINATION
  63.  
  64.      The program is exited by the <ALT> X combination.  The operator is
  65. given an opportunity to defeat the exit prior to actual program termination.
  66.  
  67. DIRECTORY ACCESS
  68.  
  69.      Whenever a file access is required by the program, the operator may be
  70. prompted to enter a file name.  The prompt may include a default response.  The
  71. operator will also have the choice of using the <Ctrl>F, ^F, key sequence to
  72. access the disk directory.  The directory access is provided by a window over-
  73. lay with an additional prompt for the directory mask.  This mask may use the
  74. usual wildcards and/or directory structure allowed under DOS.  A <Retrn> will
  75. produce the same result as the *.* wildcard specification.
  76.  
  77.  
  78. TEXT FILE TRANSMISSIONS
  79.  
  80.      Any valid ASCII file may be transmitted by pressing <F7> or <ALT> F.  The
  81. operator is prompted to enter the file name (directory modifiers are ok).  If
  82. the file is not found the operator is returned to the split screen display.
  83. If found, transmission begins immediately with character display in the transmit
  84. window.
  85.  
  86.       CR/LF and other non-Morse-characters are translated to a SPACE for the
  87. purposes of generating a correct timing duration.  Transmission may be altered
  88. with the ^P or ^X keys, causing a pause of termination respectively.  If this
  89. key is accidently pressed, respond to the file name prompt with a <RETN>.
  90.  
  91.      The file may contain control fields which alter several aspects of the
  92. code transmission.  A control field is generated by the backslash character as
  93. at the beginning of the first three lines.  A space followed by any ASCII char-
  94. acters is treated as a comment field which is skipped over during transmission.
  95.  
  96.      A backslash in column one followed by a control character and/or control
  97. values will cause the transmission characteristic to change as follows:
  98.  
  99.     Control sequence            Effect
  100.  
  101.     \*ascii text                ascii text dislayed on line 24 of display
  102.     \#nnn                       wpm rate changed to nnn (integer value)
  103.     \Dff.f                      dash-dot-ratio changed to ff.f (float value)
  104.     \dff.f                       "    "    "      "     "   "    "      "
  105.     \Lff.f                      letter-dot-ratio changed to ff.f
  106.     \lff.f                         "    "    "      "     "   "
  107.     \Tnnn                       insert delay of nnn seconds during transmission
  108.     \tnnn                          "     "   "   "     "      "         "
  109.     \Wff.f                      word-dot-ratio changed to ff.f
  110.     \wff.f                        "   "    "      "     "   "
  111.  
  112.      See the file CODETEST for examples of each of the above.
  113.  
  114. TRANSMIT/RECEIVE CHARACTER RATES
  115.  
  116.  
  117.      The transmitted code speed may be adjusted in 1 WPM increments.  The
  118. <ALT> W combination causes an operator prompt for the new value on the
  119. status line.  Entries must be digits 0 ... 9, improper entries will be
  120. rejected and the prompt reissued.
  121.  
  122. Set Transmit Code Speed = Receive Code Speed
  123.  
  124.      During contests and other rapid CW exchanges it is considered good oper-
  125. ating to transmit at the receive code speed.  Pressing <F8> will immediately
  126. force the transmit code speed to the received code speed.
  127.  
  128. MISCELLANEOUS FUNCTIONS
  129.  
  130. Tune the Transmitter
  131.  
  132.      Pressing the <ALT> T key causes the transmitter to be held in the
  133. key down condition.  The key down condition is released when any other key is
  134. pressed.  I suggest the <SPACE> to prevent on the air burbles - hi.
  135.  
  136.  
  137. Send V's
  138.  
  139.      The character V is used as a standard "test" signal by most CW operators.
  140.  
  141. The <ALT> V key causes a string of V's to be transmitted.  Pressing any key
  142. will terminate the sequence of V-s.  The <SPACE> is also appropriate here.
  143.  
  144. SOFTWARE/HARDWARE CONFIGURATION
  145.  
  146. Setting Program Parameters
  147.  
  148.      The operator may modify the characteristics of the program with respect
  149. to the transmit code weight, initialization values, internal tone, and screen
  150. colors.  Input/output port assignments and logical levels may be changed.  The
  151. designation of time zone for the purposes of timekeeping and logging is avail-
  152. able.   A previous configuration saved on disk may be loaded for quick changes
  153. in operating characterics.
  154.  
  155.  
  156.      TRANSMIT WEIGHTING - The operator may select transmit code weighting to
  157. fit his or her individual requirements.  A prompt for the following charac-
  158. teristics is presented:
  159.  
  160.                     Dash/Dot (3.00).....
  161.                     Letter/Dot (3.00)...
  162.                     Word/Dot (7.00).....
  163.  
  164. where the values in parenthesis are the present values.  Pressing return at
  165. any one of the three leaves the value unchanged.  Here are some suggestions
  166. for transmit weighting and its intended use.
  167.  
  168.           Dash/Dot    Letter/Dot    Word/Dot       Used for:
  169.  
  170. 3.00        3.00          7.00         Standard code weighting
  171.  
  172. 3.60        3.60          8.00         Moderately heavy code
  173.                                        good for QRN conditions
  174.  
  175. 3.00       10.00         30.00         Practice at 1/2 WPM rate
  176.  
  177. 3.00       17.00         51.00         Practice at 1/3 WPM rate
  178.  
  179. 3.00       24.00         73.00         Practice at 1/4 WPM rate
  180.  
  181.  
  182.  
  183.      SET INTERNAL TONE - The internal cw tones may be toggled ON/OFF and the
  184. frequency of the tone modified.  If the 'y' response is made to the prompt:
  185.  
  186.                PC tone on? <Y/N>');
  187.  
  188. then the operator is requested to enter the desired tone:
  189.  
  190.                Note frequency =  600  change to....
  191.  
  192.      Pressing <RETN> leaves the frequency unchanged.
  193.  
  194.      SPECIFYING DEFAULT MESSAGE FILE - The operator may specify the start-up
  195. messages which will be loaded on each execution of CW.  The response to the
  196. prompt:
  197.  
  198.                Enter message file name.ext...
  199.  
  200. should be an existing \directory\filename.ext string, where the directory is
  201. optional.
  202.  
  203.  
  204.  
  205.      SPECIFYING TIME ZONE - The program default for time zone is 0.  That is,
  206. you live in Greenwich, England.  Since most of us are not so fortunate, and
  207. good log keeping stipulates using UTC (GMT for us oldtimers), the operator can
  208. specify his or her own time zone as:
  209.  
  210.                Enter your time zone...
  211.  
  212.      If a non-zero time zone is entered, the program adjusts the date and time
  213. for the on screen display and the log to accomodate the time zone.  Proper
  214. attention is also made to month and year rollover with the exception of leap
  215. year.  This is a subject of a future change to the program.
  216.  
  217.  
  218.  
  219.      CONTROLLING HARDWARE INTERFACE - CW may be configured to access any port
  220. within the 8088 port address space.  The individual bit and its logical sense
  221. can also be specified.  The program default values are for the COM1 port and
  222. uses the RTS, CTS signals for Transmit and Receive respectively.  The operator
  223. will be prompted:
  224.  
  225.                     Enter transmit port.........
  226.                           transmit bit #........
  227.                           transmit logic........
  228.                           receive port..........
  229.                           receive bit #.........
  230.                           receive logic.........
  231.  
  232. A <RETN> leaves the value unchanged.  You must enter the port numbers in
  233. decimal, the bit number as 0.. 7, and the logic level as 1 => active high;
  234. 0 => active low.  This may take some experimenting for your particular hardware.
  235. The author has configured a VISUAL COMMUTER (IBM clone) and the MFJ 1224,
  236. RTTY/CW terminal unit to the LPT1 parallel port and a homebrew interface to
  237. the COM1 port.  The homebrew design is the subject of a forthcoming public
  238. domain release.
  239.  
  240.  
  241.  
  242. CHANGING RECEIVE FILTERING - The program is designed to track the charac-
  243. ter rate of the incoming (received) morse code.  Under ideal conditions, no
  244. filtering is required at all, however, in the real world of QRN and QRM it is
  245. an absolute necessity.  The filtering is accomplished using the digital equiv-
  246. alent of a low pass filter.  Just as the response of a low pass RC filter can
  247. be controlled by the resistor-capacitor product, the difference equation
  248. coefficients can be modified to adjust it's response.  The operator is prompt-
  249. ed as follows:
  250.  
  251.                     Receive filter coeff: 3
  252.                       slow... fast
  253.                         <0> .. <9>
  254.  
  255.                     Enter...
  256.  
  257.      Selecting the value <0> will disable the filter.  In this case the receive
  258. algorithm will rely on the transmit WPM selection.
  259.  
  260.      The default value is 3 which seems to work well with the author's Kenwood
  261. 440S transceiver with an 800 Hz CW filter.  A 200 Hz wide active audio filter
  262. is also used along with a limiter/detector of the author's own design.  This is
  263. definitely an area for experimentation and user feedback.  I simply cannot
  264. afford to buy one of everything to test the programs utility.
  265.  
  266.      LOADING CONFIGURATION - The operator is prompted to enter the name of a
  267. configuration file which is to be loaded.  If the file does not exist or the
  268. <RETN> is pressed without a file name then the default configuration is
  269. established.
  270.  
  271.  
  272.      SAVING CONFIGURATION - The operator has the option of saving the operating
  273. configuration of the program on a disk file.  The prompt for a file name may be
  274. given a <RETN> response in which case the default name of 'INIT.CW' is assumed.
  275.  
  276.      The operating characteristics of CW as determined by the configuration
  277. parameters can be saved on the default disk.  The program looks for this file
  278. on initial execution and uses the values contained therein for its presets.
  279. INIT.CW is an ASCII file which may be observed/changed with any wordprocessor.
  280. A sample of the INIT.CW file contents are:
  281.  
  282.                     Xmt_WPM............. 18
  283.                     Dash Dot Ratio..... 3.0
  284.                     Letter Dot Ratio... 3.0
  285.                     Word Dot Ratio..... 7.0
  286.                     PC monitor flag....   1
  287.                     Monitor note freq ..600
  288.                     Time Zone..........   0
  289.                     Initial msg file... NIL
  290.                     Timing Duration.... 920
  291.                     Rx Coefficient.....8250
  292.                     Xmt background.....   7
  293.                     Xmt foreground.....  14
  294.                     Rcv background.....   3
  295.                     Rcv foreground.....  15
  296.                     Status background ..  4
  297.                     Status foreground .. 11
  298.                     Prompt background ..  1
  299.                     Prompt foreground .. 14
  300.                     Aux background.....   6
  301.                     Aux foreground.....  14
  302.                     Help background....   2
  303.                     Help foreground....  14
  304.                     Transmit port......1020
  305.                     Transmit bit.......   2
  306.                     Transmit level.....   1
  307.                     Receive port.......1022
  308.                     Receive bit........  16
  309.                     Receive level......   1
  310.                     Filter coefficient..  3
  311.  
  312.      The above values are the equivalent to the internal program configuration
  313. defaults.
  314.  
  315.      SPECIAL NOTE FOR USE WITH SIDEKICK - I have always used the program with
  316. the utility SIDEKICK.  Some early feedback on program operation indicated that
  317. my machine was slower than I wanted to believe. It seems that SIDEKICK really
  318. makes a significant impact on program speed such as CW which uses a lot of key-
  319. board i/o.  All of the timing loops involved in generation and reception of the
  320. morse characters have i/o tests imbedded in them.  These i/o calls to DOS are
  321. trapped by SIDEKICK.  The number of tests SIDEKICK performs is apparently not
  322. trivial.  My computer is a VISUAL COMMUTER with a V20 operating at 4.77 MHz.
  323. The Norton Utility SYSINFO indicates a 1.8 performance index.  This computer
  324. requires the following constants in the INIT file:
  325.  
  326.       constant           w/o SK         w SK
  327.  
  328.        Timing Duration    920            850
  329.        Rx Coefficient    8250           5660
  330.  
  331. If you use SIDEKICK or other keyboard enhancement utility with CW, you may
  332. find it necessary to play around a little to find the right values for these
  333. two constants.
  334.  
  335. Calibrating the Code Speed
  336.  
  337.      The transmit and receive code speeds are dependent on timing loops used
  338. in TURBO (tm) PASCAL.  They are therefore sensitive to the clock rate of the
  339. computer.  CW can accomodate variations in clock frequencies.  Accurate timing
  340. does require a scope and an external 10 HZ signal generator.  The signal gen-
  341. erator may be a calibrated keyer.
  342.  
  343.      To begin the calibration press <ALT> C and select the transmit or re-
  344. ceive procedure.
  345.  
  346.  
  347.      RECEIVE CALIBRATION - Apply a 10 Hz square wave of the proper amplitude
  348. to the input port.  The 10 Hz square wave is the dot rate equivalent of 25
  349. WPM cw.  Pressing the <u> and <d> keys will alter the displayed code speed in
  350. 0.1 WPM increments.  Pressing <U> and <D> will alter displayed code speed in
  351. 1.0 WPM increments.  Press <Q> when the calibration is complete.
  352.  
  353.  
  354.      TRANSMIT CALIBRATION - The transmit calibration is fully automatic.  The
  355. calibration procedure takes 1 minute.
  356.  
  357. AUTOMATIC LOG MAINTENANCE
  358.  
  359.      CW maintains a logging file (default: HAMLOG.DBF), a dBase III+ compatible
  360. file which contains all relevant logging data.  The format of this file is
  361. compatible with the program KAM.EXE, the Kantronics All Mode TNC terminal
  362. program also written and distributed by W1HKJ.  Two index files are maintained
  363. for the database, HAMLOG.CLL (callsign) and HAMLOG.DTM (date time).  These
  364. files are created and maintained using 'TOPAZ units' purchased from
  365.  
  366.         The Research Group
  367.         100 Valley Drive
  368.         Brisbane, CA 94005 (800-HOTWARE)
  369.  
  370.      The index files are unique to TOPAZ and are cannot be used by either
  371. dBase or FoxBase.  The data file is totally compatible with both.  If you use
  372. dBase or FoxBase to add records, delete records or sort the file then you
  373. should delete both the xxx.CLL and xxx.DTM files.  The next time CW is exec-
  374. uted these files will be recreated in proper form.  Failure to do so will
  375. cause an error termination of the program.
  376.  
  377.      Data is entered into the database from CW using the following form.
  378.  
  379. ╔╣Index [ callsign ] ╠═════════════════════════════════════════════════════════╗'
  380. ║Record #        of            File                   Last Update :            ║'
  381. ╠════════════════════╤═════════════════════╤═════════════════╤═════════════════╣'
  382. ║Callsign            │Name                 │Date             │Time             ║'
  383. ╟────────────────────┼───────────┬─────────┼─────────────────┼─────────────────╢'
  384. ║Freq                │Power      │Mode     │RSTout           │RSTin            ║'
  385. ╠════════════════════╧═══════════╧═════════╪═════════════════╪═════════════════╣'
  386. ║Comment                                   │QSLsent          │QSLrcvd          ║'
  387. ╠══════════════════════════════════════════╧═════════════════╧═════════════════╣'
  388. ║ Next  Prev  Top bOttom  Go  Find  Edit  Add  Del  Browse  paCk  Index  Quit  ║'
  389. ╚╣<F1> = Help╠═════════════════════════════════════════════════════════════════╝'
  390.  
  391. A separate program HAMLOG.EXE should also be available on this BBS.  HAMLOG
  392. allows separate maintenance of several amateur radio logs.  It uses identical
  393. database structures and is compatible with CW and/or KAM.
  394.  
  395. COUNTRY LIST - PREFIXES and NAMES
  396.  
  397. The file COUNTRY.LST is a flat file (ASCII text) containing all of the countries
  398. listed in the 1987 Callbook (my last purchased copy).  This file is accessed by
  399. pressing <F10>.  A scrollable window is opened beginning with the 'A's.  You may
  400. browse through the list by using the arrow keys; the page-up, page-down keys;
  401. the home, end keys; or by pressing the first letter (or number) of the prefix in
  402. question.  New countries may be added to the list.  Keep them in alph-numeric
  403. order and do not exceed the line width of the present entries!
  404.  
  405.