home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 1 / HamRadio.cdr / misc / ares / guide.txt < prev    next >
Encoding:
Text File  |  1988-06-24  |  19.1 KB  |  377 lines
  1. ARESDA01.CRD:Packet Operator Quick Reference Card for ARES/Data V 0.1
  2.  
  3. This is a shortened version of the standard ARES/Data documentation.
  4. Please read the full documentation for complete information on the
  5. overall operation of ARES/Data.  Since ARES/Data is a derivative of the
  6. FINDER program, some (only some) aspects of the operation are similar to
  7. FINDER.  Documentation on FINDER is published in the Proceedings of the
  8. 6th ARRL Computer Networking Conference, pp. 134-141.
  9.  
  10. 1. TNC Settings for Packet Concentrators.  These are ABSOLUTELY essential!
  11.    Use the commands appropriate for your type of TNC:
  12.  
  13.             TAPR                                     WA8DED
  14.         DWAIT 25 (250 ms)                       * W 25 (250 ms)
  15.         MAXFRAME 1                              * O 1
  16.         FRACK 10 (10 sec)                       * F 10 (10 sec)
  17.         RETRY 10                                * N 10
  18.         AX25L2V2 ON                             * V 2
  19.         RESPTIME 10 (1.0 sec)                   * @T2 100
  20.         TXDELAY 40 (400 ms)                     * T 40 (400 ms)
  21.  
  22. 2. Summary of database operations:
  23.  
  24.    A. Current information input: (commas are REQUIRED separators,
  25.       imbedded blanks are significant, and <CR> means carriage return)
  26.  
  27.       field1,field2,field3,field4,message<CR>
  28.  
  29.       where
  30.  
  31.       a. FIELD1 through FIELD4 are 20-character fields
  32.       b. MESSAGE is any message up to 80 characters
  33.  
  34.       Each entry like this creates one record in the database, and
  35.       the current date and time are added to the record.
  36.       (To leave a field blank, let the commas run together " ,, ")
  37.  
  38.       For example:   johnson,joe,shelter1,ok,has 4wd avail<CR>
  39.  
  40.       To update a record, enter the new information, but use two
  41.       adjacent commas to save typing information that has not changed.
  42.  
  43.       For example:   johnson,joe,,ill,ate cafeteria food<CR>
  44.              (Joe Johnson's location is still Shelter1).
  45.  
  46.    B. Searches available:
  47.  
  48.       /1,value<CR>    lists all records with "value" for field1
  49.       /2,value<CR>    lists all records with "value" for field2
  50.       /3,value<CR>    lists all records with "value" for field3
  51.       /4,value<CR>    lists all records with "value" for field4
  52.  
  53.       For example:    /1,johnson<CR>   <-- lists all Johnsons
  54.           or:         /3,shelter2<CR>  <-- lists everyone at Shelter2
  55.  
  56.  
  57.    C. Summaries available:
  58.  
  59.       $1<CR>          For each distinct value for fieldN, state number
  60.       $2<CR>          of records with that value for fieldN, where
  61.       $3<CR>          "N" can be 1, 2, 3, or 4.
  62.       $4<CR>
  63.  
  64.       For example:    $3<CR>   might print a summary of the number
  65.       of people checked in at each shelter:
  66.           SHELTER1 : 30
  67.           SHELTER2 : 47
  68.           SHELTER3 : 11
  69.             ... etc.
  70.  
  71.    D. Listing of specific records:
  72.  
  73.       l nnnn<CR>      lists all information for record "nnnn"
  74.       l all<CR>       lists ALL information in database.
  75.                       Use with CAUTION--could result in a long printout!
  76.  
  77.    E. Deleting specific records:
  78.  
  79.       d nnnn<CR>      deletes record nnnn, only if enabled by sysop
  80.  
  81. 3. CONFERENCE BRIDGE: users and tell commands:
  82.  
  83.    users<CR>                     requests list of calls connected to ARES/Data
  84.    u<CR>
  85.  
  86.    tell callsign message<CR>     sends message to callsign (partial calls
  87.    t callsign message<CR>        work, such as callsign suffix:
  88.                                  "t kl Need operators here" would send the
  89.                                  message "Need operators here" to any logged-
  90.                                  on station with "KL" as part of their
  91.                                  callsign:  N6KL, N6KL-2, KL7ABC, etc).
  92.  
  93.    tell * message<CR>            sends QST message to all connected stations
  94.    tell all message<CR>
  95.  
  96.    tell sysop message<CR>        sends message to sysop
  97.  
  98.    message<CR>                   UNLIKE FINDER, this is NOT a message to
  99.                                  the sysop.  It will generate an
  100.                                  "Input ignored." error message.  Use
  101.                                  "t sysop message" to talk to sysop.
  102.  
  103. 5. OTHER COMMANDS:
  104.  
  105.    help<CR>                   requests a brief syntax reminder from system
  106.    h<CR>
  107.    ?<CR>
  108.  
  109.    <CR>                       tests to see if ARES/Data is running - response
  110.                               is a line feed plus the ">" prompt.
  111.  
  112.    b<CR>                      requests logoff from ARES/Data
  113.    bye<CR>
  114.  
  115.  
  116. end ARESDA01.CRD
  117. ARESDA01.REF      ARES/Data V. 0.1 Sysop Information and Reference
  118.  
  119. 1.  These instructions are aimed at those who will be actually running
  120. the ARES/Data program, or for those interested in some of the
  121. operational detail.  You need not read this file in order to
  122. effectively use the program as a Data Concentrator (e.g.  packet
  123. operator).  These instructions are abbreviated, so be sure to read the
  124. ARES/Data documentation files first for general background
  125. information.  You may also want to read about the ancestor of
  126. ARES/Data, the FINDER system, in the 6th ARRL Computer Networking
  127. Conference Proceedings.
  128.  
  129. 2.  You need an IBM PC or compatible to run the program with at least two
  130. drives, one of which should be a hard disk or hard card, if possible.
  131. ARES/Data has been tested on a PC, XT, AT and a PC Convertible using DOS
  132. 3.2.  (The program also appears to run fairly well on the PCjr.) In
  133. addition, if you want to allow remote packet radio access to the database,
  134. you need one serial port.
  135.  
  136. 3.  Assuming you want remote access to the database with packet, you
  137. also need a TNC with firmware (EPROM) written by Ron Raikes, WA8DED.
  138. ARES/Data has been tested on several TNC-1's with WA8DED firmware
  139. Version 1.3 modified for 8 simultaneous connects, on several TNC-2's
  140. with WA8DED firmware Version 2.0, and on several PK-87's with WA8DED
  141. firmware.  We noted that the channel polling loop runs about 3 times
  142. faster on the TNC-1 than on the TNC-2, with the PK-87 (4.9 MHz clock)
  143. somewhere between the two.  If your usage is totally non-commercial,
  144. you can get the WA8DED public domain firmware yourself from many
  145. sources; see your local packet hacker.  IF ALL ELSE FAILS, you can get
  146. it from us by sending two 27C64 EPROMS (for the TNC-1) or one 27C256
  147. EPROM (for the TNC-2 or PK-87) to Dave Palmer, N6KL, or W.  E.
  148. Moerner, WN6I.  Take a few minutes to learn the "DED" user mode
  149. command syntax - it is different from the TAPR syntax, but easy to
  150. learn.  The WA8DED documentation is included on the distribution
  151. diskette.
  152.  
  153. 4.  The ARES/Data program, a relative of the FINDER program, is in the
  154. public domain and is available for non-commercial, non-profit use from WN6I
  155. or N6KL by sending a blank, formatted 5 1/4" (360 kB) or 3 1/2" (720 kB)
  156. floppy with SASE for return to you.  The cost to you is the cost of the
  157. diskette and return postage.  We have included a configuration file
  158. facility so that you can tailor many parameters to your system.  If you
  159. want small changes in the code, we will try to accommodate you.
  160.  
  161. 5. ARES/Data file usage:
  162.  
  163.    ARESDATA.DAT                 the database itself - all records
  164.    FIELD1.NDX                   index file for field1
  165.    FIELD2.NDX                   index file for field2
  166.    FIELD3.NDX                   index file for field3
  167.    FIELD4.NDX                   index file for field4
  168.  
  169.    ARESDATA.JRN                 journal file - a normal ASCII file containing
  170.                                 a listing of all valid current information
  171.                                 packets.  May be edited or printed or used as
  172.                                 input to the ARES/Data program to recover a
  173.                                 damaged or erased database.
  174.  
  175.    ARESDATA.BAK                 backup of the database
  176.    FIELD1.BAK                   index file for field 1 backup
  177.    FIELD2.BAK                   index file for field 2 backup
  178.    FIELD3.BAK                   index file for field 3 backup
  179.    FIELD4.BAK                   index file for field 4 backup
  180.  
  181.  
  182. 6.  Before starting ARES/Data, be sure your hardware is set up correctly.
  183. Test the TNC and WA8DED firmware by using your own terminal emulator first.
  184.  
  185. 7.  Edit the configuration file ARESDATA.CFG to reflect your system
  186. configuration.  The configuration file is self-documenting for the most part.
  187. Multiple comment lines starting with a semicolon are allowed at the beginning
  188. of the file.  Thereafter, each line begins in column 1 with the desired value
  189. of the parameter.  Follow each parameter with at least one space and a
  190. semicolon.  Comments may follow the semicolon.  Here is a description of each
  191. parameter:
  192.  
  193.         a. Choose prompted or automatic mode.  This is described below in
  194.            number 9.
  195.         b. Choose TNC support (yes or no).  This controls whether remote
  196.            access via packet is desired.  If you choose NO, all parameters
  197.            relating to the TNC below will be ignored, but must be present
  198.            in this file.
  199.         c. Choose whether or not you want to allow remote deleting of
  200.            database records (yes or no) by connected packet stations.
  201.            Note this applies only for initial startup. You can always
  202.            change this setting in real-time from the sysop keyboard,
  203.            by entering the sysop DELETEON or DELETEOFF commands.
  204.         d. Maximum number of connections.  Specify 8, unless you want to
  205.            restrict the number of simultaneous connects to a smaller number.
  206.            The program will determine the maximum number your firmware will
  207.            support and will adjust accordingly.
  208.         e. Backup drive and path.  This is the drive:path for the automatic
  209.            backup of the database files.  Must end with a "\".
  210.         f. Journaling drive and path.  This is the drive:path for the
  211.            automatic journaling of valid database transactions. Must end
  212.            with a "\".
  213.         g. Backup interval.  Number of new entries before the entire
  214.            database is written to the backup file. 0 means no backup.
  215.         h. Journaling interval.  Number of new entries to the database
  216.            before the journal file is updated.  Max=25.
  217.         i. TNC serial port.  May be 1 (for COM1), 2 (for COM2), or 0 if you
  218.            are using a non-standard serial port.  If you specify 0, ARES/Data
  219.            will not initialize the serial port and you must have initialized
  220.            it separately to N, 8, 1, and whatever baud rate you like.
  221.         j. Serial port address.  ARES/Data allows you to use any serial port
  222.            you like.  Specify here the base address of the UART chip.  COM1 is
  223.            usually $3F8 and COM2 is usually $2F8.  Interrupts are not used,
  224.            thus the interrrupt level need not be specified.
  225.         k. Serial port baud rate.  We suggest 4800 or 9600 baud.
  226.         l. Serial port retry count. Try 10.  If you regularly get
  227.            TNC timeout messages, adjust this value higher.
  228.         m. Enable/disable interrupts during serial port I/O.  We strongly
  229.            suggest enable, unless your computer has difficulty keeping up with
  230.            the baud rate.
  231.         n. Printer number.  1 for lpt1: , etc.  Use 1, 2 or 3.
  232.         o. TNC commands to be issued during startup of ARES/Data.  The first
  233.            line begins with a single slash.  Change the callsign to your own.
  234.            All the other parameters have been determined to be reasonably
  235.            optimal for efficient ARES/Data database operation.  You may include
  236.            other commands or delete commands from this list if you wish.
  237.            End the TNC command list with a slash.
  238.  
  239. 8.  To start ARES/Data:  If you have selected automatic startup, be sure the
  240. drives have disks in them.  If you have included TNC support, be sure that the
  241. TNC is on.  Start the execution by typing "ARESDATA<CR>".
  242.  
  243. 9.  The startup sequence is self-explanatory.  If you have selected
  244. automatic startup and TNC support, no prompting will be done and after
  245. processing the .cfg file and opening the database files, the program will
  246. automatically enter host mode and begin polling the available channels for
  247. data.  If you have selected prompted startup, you will be prompted to put a
  248. diskette in the drive you have selected for the backup/journaling function.
  249. If previous database files are found, they are opened.  If none are found,
  250. new database files are created.  Note that after each disaster, you should
  251. rename the database files to start with a fresh (empty) database.  Then you
  252. are prompted to turn on the TNC.  When TNC-computer synchronization is
  253. established, the run-time status screen is displayed and several TNC
  254. parameters are set.  Don't be alarmed at the messages regarding "TNC
  255. Recover" at initial startup time.  The program does not know the state of
  256. the TNC, and if the TNC does not respond to host mode commands, the program
  257. will issue the appropriate "JHOST1" command.  (TCP/IP users:  If you have
  258. the TNC2 WA8DED+KISS Mode Combination EPROM, ARES/Data works fine with
  259. that, too.  You need not enter the initial "H" command following power up).
  260. If you have not selected TNC support, all TNC-related functions are
  261. disabled.  The sysop console is the only input/output port in the system.
  262.  
  263. 10.  The sysop keyboard can enter current information input and search
  264. requests like any connected channel, but don't try to type too fast if TNC
  265. polling is in progress.  If you have problems with this, press F5
  266. temporarily to stop polling so that you can enter your data.  Be sure to
  267. remember to press F5 to re-start polling or your users will think the database
  268. has crashed!  See the file ARESDA01.PKO for a summary of the standard
  269. packet operator commands.
  270.  
  271. 11.  The sysop can also send commands directly to the TNC by typing
  272. <ESC> and the one-letter command as is usual for the WA8DED user-mode
  273. firmware.  Some commands (such as "d" for disconnect) can reference a
  274. specific channel:  to set the channel for these commands, first type
  275. "<ESC>sn<CR>", where n is the channel number.  The currently selected
  276. channel is marked with a triangular arrow on the sysop screen.  For
  277. example, to force a disconnect on channel 3, type "<ESC>s3 <CR> <ESC>d
  278. <CR>".
  279.  
  280. 12.  The sysop can send messages to connected channels in several ways:
  281. (a) by typing "<ESC>nmessage<CR>" where n is the channel number, or (b) by
  282. using the "tell" command described in ARESDA01.PKO.  Note that the sysop
  283. can send a QST to all connected channels by typing "tell all msg"<CR> or
  284. "tell * msg"<CR>, where "msg" is the text to be sent.
  285.  
  286. 13.  Special SYSOP-only commands:
  287.  
  288.         deleteon                enables use of delete command by connected
  289.                                 stations
  290.  
  291.         deleteoff               disables use of delete command by remote
  292.                                 stations.  Note that delete command is
  293.                                 always enabled for the sysop.
  294.  
  295.  
  296. 14.  Special PF keys:
  297.  
  298.         F1              Immediate database backup: closes all files, copies
  299.                         current database files to the .BAK versions, and
  300.                         flushes the last few valid current information
  301.                         packets into the .JRN file.  Note: if communication
  302.                         is lost on the computer to TNC wire link, a backup
  303.                         is performed automatically, and the program
  304.                         attempts to resynchronize with the TNC.
  305.  
  306.         F2              Mode selector for the currently selected channel.
  307.                         Pressing the key cycles through three modes:  mode 0 -
  308.                         all packet operator functions enabled; mode 1 - "tell"
  309.                         and "users" only enabled; and mode 2 - chat mode only,
  310.                         which looks like normal terminal operation.  The
  311.                         current mode for each channel is indicated on the sysop
  312.                         screen.  Mode 0 has no character next to the channel
  313.                         number, mode 1 has a small square, and mode 2 has an
  314.                         "x" next to the channel number.  Upon startup, all
  315.                         channels are set to mode 0.  Mode 2 is useful to
  316.                         prevent a "jammer" from tampering with the database, or
  317.                         for normal terminal-mode connection to another station
  318.                         or BBS.  Mode 1 is useful for a round-table discussion
  319.                         only, without access to the database.
  320.  
  321.         <CTRL>F3        Shut down the program gracefully.  If the program is
  322.                         subsequently restarted from DOS, it will pick up where
  323.                         it left off.
  324.  
  325.         F5              Suspend polling of channels.  Use this if you
  326.                         experience missing characters during keyboard
  327.                         input, but be sure to re-start polling!
  328.  
  329.         F6              Redraw the sysop screen.
  330.  
  331.         F7              Send a full ASCII report of the database to file
  332.                         ARDAtime.RPT on a:.
  333.  
  334.         F8              Send a full ascii report of the database to file
  335.                         ARDAtime.RPT on b:.
  336.  
  337.         F10             Toggle printer.  All lines printed in the main part of
  338.                         the sysop screen will be echoed on the printer.  NOTE:
  339.                         this can slow down the polling loop dramatically.
  340.                         If your printer runs out of paper or has an I/O
  341.                         error, the program will retry for about 30 seconds,
  342.                         then give up on the printer.  Polling will continue,
  343.                         but no further output will be sent to the printer
  344.                         until you hit F10 again.
  345.  
  346. 15.  To terminate execution, use the sequence <CTRL><F3>.  <CTRL><BREAK> may be
  347. used to exit only during a tncrecover.   At other times, <CTRL><BREAK> has no
  348. effect.   <CTRL><F3> is best, because the program then properly closes all
  349. files.
  350.  
  351. 16.  If you have TNC errors, under certain conditions the program will execute
  352. a TNC reset and/or a TNC recovery procedure.  When this occurs, the first thing
  353. that happens is a backup.  The program should recover by itself.  Be patient.
  354. As a last resort, you can try turning off the TNC and then turn it on again.
  355. Note that you will then lose all packets in the receive and transmit queues,
  356. however.  If you are really paranoid and you are using an IBM PC, you can
  357. connect the cassette motor relay to the reset circuit on your TNC.  The TNC
  358. reset procedure will close the relay if it appears that the TNC fails to
  359. respond.  We haven't seemed to ever need this feature, though!
  360.  
  361. 17.  Remember that ARES/Data is designed to be general and flexible.  This
  362. means that little error checking is done on input packets.  Garbage in, garbage
  363. out!
  364.  
  365. 18. Good luck!
  366.  
  367. 19. If good luck is insufficient, or if you have comments or suggestions,
  368. please contact either of us at
  369.  
  370. W. E. Moerner, WN6I, 1003 Belder Drive, San Jose, CA 95120  408-997-3195
  371.      (WN6I @ NV6Z, MOERNER@IBM.COM (csnet))
  372.  
  373. Dave Palmer, N6KL, 248 Omira Drive, San Jose CA  95123  408-227-5236
  374.      (N6KL @ NV6Z, N6KL@IBM.COM (csnet) or 73357,3157 (Compuserve))
  375.  
  376. END ARESDA01.REF
  377.