home *** CD-ROM | disk | FTP | other *** search
/ back2roots/padua / padua.7z / padua / ISDN-Master / StateMon2_8.LHA / StateMon / StateMon.doc < prev    next >
Encoding:
Text File  |  1995-09-29  |  8.3 KB  |  209 lines
  1. $Id: StateMon.doc,v 2.8 1995/09/29 01:44:39 chris Exp $
  2.  
  3. StateMon                                                             StateMon
  4.  
  5.    NAME
  6.         StateMon - Show the status of bscisdn device units
  7.  
  8.  
  9.    SYSTEM REQUIREMENTS
  10.         - Amiga with ISDN-Master board and bscisdn.device >= 2.164
  11.         - Kickstart 2.0 or newer (3.1 recommended)
  12.         - Locale.library installed
  13.  
  14.  
  15.    INSTALLATION
  16.         To install StateMon permanently in your system, just copy
  17.         the StateMon program into your WBStartup drawer.
  18.  
  19.  
  20.    DESCRIPTION
  21.         StateMon lets you monitor the traffic one or more units of the
  22.         bscisdn.device in a small window.
  23.  
  24.         The status of every selected unit is displayed on a single line:
  25.  
  26.         +-+-------------------------------------------------------+-+-+
  27.         |╖| ISDN StateMon 2.8 by Christian A. Weber               | | |
  28.         +-+-------------------------------------------------------+-+-+
  29.         | UNIT TR HS AA CD   KB_IN  KB_OUT  COST        NUMBER        |
  30.         |  7   [] [] [] []     345       2  SFr. 0.30   014401397     |
  31.         |  8   [] [] [] []  16'353   2'363  SFr. 6.50   004596300300  |
  32.         +-------------------------------------------------------------+
  33.  
  34.         AA     - Auto Answer indicator.
  35.  
  36.         CD     - Carrier Detect. This indicates if a connection exists for
  37.                  this unit number.
  38.  
  39.         COST   - Connection cost. If this is an incoming call, or if your
  40.                  network does not provide cost information, this field may
  41.                  be empty.
  42.  
  43.         HS     - High Speed indicator. This is turned on if a protocol with
  44.                  a speed of more than 38400 bps (such as X.75) is selected.
  45.  
  46.         KB_IN  - Number of KBytes (blocks of 1024 bytes) read during the
  47.                  actual connection.
  48.  
  49.         KB_OUT - Number of KBytes written so far.
  50.  
  51.         MSN    - not yet
  52.  
  53.         NUMBER - Number of the other party. If the network does not provide
  54.                  caller identification services, this field may be empty.
  55.  
  56.         ONLINE - Actual online time (HH:MM:SS)
  57.  
  58.         RD     - Receive Data indicator
  59.  
  60.         SD     - Send Data indicator
  61.  
  62.         TR     - Terminal Ready indicator. This light is turned on if the
  63.                  unit is currently open.
  64.  
  65.         UNIT   - The device unit number (0 to 9)
  66.  
  67.  
  68.    TOOLTYPES
  69.         StateMon recognizes the following tooltypes, which can be
  70.         changed by clicking on the StateMon icon and selecting
  71.         "Information..." from Workbench's "Icon"-menu:
  72.  
  73.         Name         Example     Function
  74.         --------------------------------------------------------------------
  75.         LEFT         250         Selects the left edge of the StateMon
  76.                                  window (in pixels).
  77.  
  78.         TOP          120         Selects the top edge of the StateMon
  79.                                  window (in pixels).
  80.  
  81.         PUBSCREEN    MyScreen    Selects the name of the public screen where
  82.                                  StateMon will open its window. The default
  83.                                  is `Workbench'.
  84.  
  85.         NOTITLE                  If this tooltype is present, the header line
  86.                                  with the field names will not be displayed.
  87.  
  88.         AUTOPOPUP                In this mode, the window will pop up when a
  89.                                  connection is initiated, and close when all
  90.                                  connections are terminated. Furthermore, the
  91.                                  window close gadget will not terminate the
  92.                                  program, you must send it a Ctrl-C or use
  93.                                  the Quit menu item.
  94.  
  95.         UNITS        0,7,8       List of the units to show, separated by
  96.                                  commas. If this tooltype is not present,
  97.                                  info for all units is shown.
  98.  
  99.         FORMAT       UNIT,TR,AA,CD,COST,NUMBER,ONLINE
  100.                                  Specifies the fields to display, separated
  101.                                  by commas (NO spaces!). The fields are shown
  102.                                  in the order of appearing.
  103.  
  104.                                  These fields are currently available:
  105.  
  106.                                  Name      Function
  107.                                  --------------------------------------------
  108.                                  AA        Auto answer LED
  109.                                  CD        Carrier detect LED
  110.                                  COST      Connection cost
  111.                                  HS        High Speed LED
  112.                                  KB_IN     Number of KBytes received so far
  113.                                  KB_OUT    Number of KBytes sent so far
  114.                                  MSN       Last digits of MSN of this unit
  115.                                  NUMBER    Other party's phone number
  116.                                  ONLINE    Online time (HH:MM:SS)
  117.                                  RD        Read data LED (not very accurate)
  118.                                  SD        Send data LED (not very accurate)
  119.                                  TR        Terminal Ready LED
  120.                                  UNIT      Unit number
  121.  
  122.    MENUS
  123.         Disconnect unit <n>
  124.             These menuitems let you disconnect a data unit. Use with care!
  125.  
  126.         Snapshot window
  127.             This function will write the current window position into
  128.             StateMon's icon tooltypes, so StateMon will open its window
  129.             at this position in the future.
  130.  
  131.    TODO
  132.         If you have any suggestions, let me know! Currently, I'm
  133.         thinking of adding the following features:
  134.  
  135.         - Display of call direction (incoming or outgoing)
  136.         - Tooltypes for the window's zoom position
  137.  
  138.  
  139.    AUTHOR
  140.         Christian A. Weber
  141.  
  142.         For suggestions and bug reports write to:
  143.  
  144.         Internet:    weber@relog.ch
  145.         Limmat-NET:  chris@limmat.net.ch
  146.         Snail mail:  Bruggerweg 2, CH-8037 Zⁿrich, Switzerland.
  147.  
  148.  
  149.    LEGAL STUFF
  150.         PROGRAM AND DOCUMENTATION ARE COPYRIGHT (C) 1991-1995 BY
  151.         CHRISTIAN A. WEBER, BRUGGERWEG 2, 8037 Z▄RICH, SWITZERLAND.
  152.  
  153.         THIS PROGRAM AND ITS DOCUMENTATION MAY BE DISTRIBUTED AND
  154.         MODIFIED FOR NON-PROFIT PURPOSE ONLY. ALTERED VERSIONS MUST
  155.         BE CLEARLY MARKED WITH THE NAME OF THE PERSON APPLYING THE
  156.         CHANGES, AND WITH THE NATURE OF THE CHANGE. ALL COPYRIGHT
  157.         MESSAGES MUST REMAIN UNCHANGED. USE AT YOUR OWN RISK.
  158.         NO WARRANTY. NO REFUNDS. NO CARRIER.
  159.  
  160.  
  161.    RELEASE NOTES
  162.         29-Sep-95  V2.8  ╖ Added the AUTOPOPUP tooltype
  163.                          ╖ Negative online times are no longer shown as
  164.                            large numbers.
  165.  
  166.         14-Apr-95  V2.7  ╖ Workaround for bug in bscisdn.device: does not
  167.                            display exotic online time anymore.
  168.  
  169.                          ╖ Fixed bug that display of online time of the last
  170.                            call vanished if the window was zoomed.
  171.  
  172.         06-Dec-94  V2.6  ╖ Added DEVICE tooltype
  173.  
  174.         06-Aug-94  V2.4  ╖ Online time is no longer increased when the window
  175.                            is refreshed but the call was already disconnected.
  176.  
  177.         02-Aug-94  V2.3  ╖ Uses less CPU time.
  178.                          ╖ Online time refresh problem corrected.
  179.                          ╖ New tooltype NOTITLE to hide the header line
  180.  
  181.         16-Jul-94  V2.2  ╖ Window snapshot function implemented.
  182.  
  183.         05-Jun-94  V2.1  ╖ Added RD, TD LEDs
  184.                          ╖ Added menu with disconnect function.
  185.                            This requires device 2.164 or newer.
  186.  
  187.         03-Jun-94  V2.0  ╖ Fixed a MungWall problem with pubscreen names
  188.                          ╖ Addded display of online time
  189.                          ╖ Added FORMAT tooltype to allow full configuration
  190.                            of the displayed fields
  191.  
  192.         23-Feb-94  V1.6  ╖ Uses ISDN_GetBoard() instead of device fields
  193.  
  194.         26-Jan-94  V1.5  ╖ Added the PUBSCREEN tooltype
  195.                          ╖ Compiled with SAS/C 6.51
  196.  
  197.         15-Jan-94  V1.4  ╖ Recompiled (now with SAS/C 6.50) for the
  198.                            new bscisdn.device (>2.118)
  199.  
  200.         27-Nov-93  V1.3  ╖ Phone number refresh problem corrected
  201.  
  202.         27-Nov-93  V1.2  ╖ Added TR indicator
  203.                          ╖ Removed useless channel number display
  204.                          ╖ Fixed window titlebar and title texts
  205.  
  206.         26-Nov-93  V1.1  ╖ Initial release.
  207.  
  208.  
  209.