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