home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / pkcos2.zip / pkc.doc < prev    next >
Text File  |  1993-12-25  |  7KB  |  193 lines
  1.  
  2.                 PK-232/PK-88 Control version 1.0
  3.  
  4.                           for OS/2 2.x
  5.  
  6.                                by
  7.  
  8.                   Peter van der Post - PE1NNH
  9.  
  10.  
  11. *Important*
  12.  
  13. This software has been written for IBM OS/2 2.x. It will NOT run
  14. under DOS or under OS/2 1.x releases. DOS users should refer to
  15. the PKC11.ARJ archive, which contains the (old) DOS release of
  16. the program. I have no intentions to bring the DOS version
  17. (written in Pascal) up to date. The OS/2 version has been
  18. written in C and is, due to the use of advanced OS/2 features,
  19. not portable to DOS.
  20.  
  21.  
  22. Files in the archive
  23.  
  24. The PKCOS2.ZIP archive should contain the following files
  25.  
  26.         File            Description
  27.  
  28.         PKC.EXE         The executable
  29.         PKC.DOC         This documentation file
  30.         PKC.DAT         An example parameter file
  31.         PMNOS.DAT       An example parameter file
  32.         PK-232.ICO      PK-232 icon
  33.         PK-88.ICO       PK-88 icon
  34.  
  35.  
  36. General description
  37.  
  38. PKC is a utility to control the PK-232(MBX) and PK-88
  39. datacontrollers from Advanced Electronic Applications, Inc.
  40. These datacontrollers are serial devices and feature digital
  41. communications for radio hams and short wave listeners. This
  42. program cannot be used without one of these datacontrollers.
  43.  
  44.  
  45. Introduction
  46.  
  47. This program, PKC, will help you to easily change the serial
  48. bitrate and mode of the PK-232 or PK-88. When you use different
  49. software packages, you'll know that you are constantly changing
  50. your datacontrollers mode and serial bitrate. Some programs can
  51. use 9600 bps on the serial link, others have to run slower. Some
  52. programs use the Hostmode, others the terminal (verbose) mode
  53. and again others use the KISS mode.
  54.  
  55. PKC is able to automatically detect the current bitrate of the
  56. datacontroller and can set it to a new bitrate and operating
  57. mode for you. You can do this by simply starting the program and
  58. answering the questions or you can enter your input on the
  59. command line.
  60.  
  61. PKC supports the following bitrates: 300, 1200, 2400, 4800,
  62. 9600, 19200 bps (latter for PK-88 only). PKC can only detect the
  63. datacontrollers bitrate out of this selection. This has been
  64. done to speed up the program.
  65.  
  66.  
  67. Using command line options
  68.  
  69. When you're sure the program runs okay on your system, you can
  70. start using the command line options. This means that you type
  71. the COM port number, bitrate and mode right after 'PKC' on the
  72. OS/2 command line. The order and case of the options is not
  73. important, but follow these rules:
  74.  
  75. Information type:       Enter as:               Example:
  76. -----------------       ---------               --------
  77. COM port number         a single digit          2
  78. new bitrate             a number                2400
  79. new mode                a single character      H
  80. parameter file          filename                pkc.dat
  81.  
  82. The parameter file can be used to let PKC send additional
  83. commands to the datacontroller, after the new bitrate has been
  84. set. An example parameter file is included (pkc.dat). So, to put
  85. a PK-232 or PK-88 on COM2 in 4800 bps KISS mode, you would
  86. type:
  87.  
  88. PKC 2 4800 k
  89.  
  90. The program has the following defaults: COM1, 9600 bps, Hostmode
  91. with no parameter file. Of course, you should at least type one
  92. parameter after PKC to let PKC run in automatic mode.
  93.  
  94. Command file users can use the ERRORLEVEL variable to determine
  95. if the actions of PKC were successful. PKC returns zero if
  96. everything went okay and a nonzero value if an error occurred.
  97.  
  98. A single question mark on the command line will show the above
  99. information, as well as the program version information.
  100.  
  101. Creating Program Objects
  102.  
  103. You can create different Program Objects in the Workplace Shell
  104. to quickly set the PK-232 or PK-88 to an often used mode. Simply
  105. enter the command line parameters in the Settings page.
  106.   When you create a Program Object, don't forget to copy the
  107. icon of your controller to PKC.ICO. If you like, you can also
  108. mark the 'Start minimized' setting on the 'Session' page of the
  109. Program Object Settings.
  110.  
  111.  
  112. New features and changes from the DOS version
  113.   
  114. -First of all, PKC no longer resets the datacontroller. This is
  115. an advantage to people, who use the internal mailbox of the
  116. PK-232 or PK-88. It does mean, that you are totally responsible
  117. for the parameters of your datacontroller. (They are never
  118. 'cleaned up'.)
  119.  
  120. -PKC now also supports the PK-88. I found out that many people
  121. where using the program already for the PK-88. The only
  122. shortcoming was, that the 19200 bps bitrate could not be set
  123. with PKC. That is solved in this version. Be sure, however, not
  124. to try to put a PK-232 in that bitrate, it won't work!
  125.  
  126. -Ability to have a file with parameters sent to the
  127. datacontroller. If you specify a filename on the command line,
  128. the contents of that file will be transmitted to the
  129. datacontroller, after the new operating speed has been set. This
  130. allows you, for example, to set the HBAUD parameter for your
  131. 4800 or 9600 bps modem.
  132.  
  133. -PKC automatically adjusts to the current screen size.
  134.  
  135.  
  136. Programmers information
  137.  
  138. PKC is a 32 bit, multithreaded OS/2 2.x application. When PKC is
  139. running, a maximum of four threads are running in parallel.
  140.  
  141. You'll notice the multitasking character of the program as soon
  142. as you enter the COM port number. At that time, the process of
  143. finding the datacontroller is started. This process consists of
  144. three threads. The first one opens the serial device and starts
  145. transmitting data. The second thread reads data from the serial
  146. device and the third scans the data for a command prompt. As
  147. these three threads are running, the main function (the main
  148. thread) continues by asking the user the information on the
  149. desired operating bitrate and mode.
  150.  
  151. Programming using threads is a true delight. Sub processes can
  152. easily be isolated in that way, making the development of a
  153. program a lot easier. I rewrote the whole program in a few days.
  154.  
  155. This OS/2 version of PKC has been written in C, using the
  156. Borland C++ compiler for OS/2 v1.0.
  157.  
  158.  
  159. Problems
  160.  
  161. I have encountered some problems, running PKC in a window on the
  162. desktop. Occassionally, the program will simply freeze. If you
  163. have the same problems, run PKC in full screen mode. I think
  164. this problem is related to the compiler, which has a few nasty
  165. bugs itself.
  166.  
  167.  
  168. PKC in the future
  169.  
  170. I have plans to write a Presentation Manager version of PKC.
  171. This character mode version was an easy step into OS/2 C
  172. programming, using threads and serial device API calls. The
  173. logical step now is to get some experience in PM programming.
  174.  
  175.  
  176. Revision history
  177.  
  178. 931224 - Version 1.0 release of PKC as a character mode version.
  179.  
  180.  
  181. Copyright notice
  182.  
  183. I release this program as freeware. Feel free to share this
  184. utility with other hams, but please keep the original files
  185. together.
  186.   Please send me a message if you use this program. Now that's
  187. not too much to ask for a free program! If you have problems
  188. with the program, please specify your configuration.
  189.  
  190.  
  191. 73, Peter PE1NNH @ PI8UTR.#UTR.NLD.EU
  192.  
  193.