home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / CLIPPER / MISC / MKLAPI10.ZIP / K83LOOP.DOC next >
Encoding:
Text File  |  1993-05-04  |  3.5 KB  |  101 lines
  1.  
  2.  
  3.         K83LOOP - test your Marklin K83 decoders and switchpoints
  4.         ═════════════════════════════════════════════════════════
  5.                    Copyright 1993   Rob Hamerling
  6.  
  7.   K83LOOP is a simple program to test if your switchpoint decoders
  8.   (and the switchpoints themselves) are working properly. All switches
  9.   in a specified range are switched forward ('branch-off') and backward
  10.   ('straight') and switched off with a certain wait-time between these
  11.   commands. This wait-time can be specified.
  12.   The COM-ports to which the Marklin Interface is supposed to be connected
  13.   can be specified as well.
  14.  
  15.  
  16.   Deliverables:
  17.   ════════════
  18.   There are 3 versions of K83LOOP, all with the same functionality:
  19.  
  20.      K83LOOP.EXE   - DOS
  21.      K83LOOP2.EXE  - 16-bits version for OS/2 1.3, 2.0 or higher
  22.      K83LOOP3.EXE  - 32-bits version for OS/2 2.0 or higher
  23.  
  24.  
  25.   Command parameters
  26.   ══════════════════
  27.   The following parameters can be specified with execution of K83LOOP (all
  28.   variants the same) in the following sequence:
  29.  
  30.     K83LOOP  'first'  'last'  'port'  'pause'
  31.  
  32.               first  -  first switch address to be tested
  33.               last   -  last address to be tested (default 256)
  34.               port   -  COM-port number (default 1)
  35.               pause  -  Wait-time in milliseconds between commands
  36.                         (default 250)
  37.  
  38.   Note that the 'wait-time' is actually the time a switchpoint gets its
  39.   current, until the 'switch-off' command is executed.
  40.  
  41.   Only the first parameter is required. If you start K83LOOP without
  42.   parameters, you will be reminded of the parameters!
  43.  
  44.   K83LOOP can be terminated while running with Ctrl-Break.
  45.  
  46.  
  47.   Sample report:
  48.   ═════════════
  49.   K83LOOP reports its activity on your display. If you call K83LOOP for
  50.   example with:
  51.  
  52.      K83LOOP  253 4 2 250
  53.  
  54.   you may see the following report:
  55.  
  56.   switch     branch   straight  switchoff
  57.   number      time      time      time
  58.   ------     -------   -------   -------
  59.     253        0.000     0.281     0.531
  60.     254        0.781     1.093     1.343
  61.     255        1.593     1.843     2.093
  62.     000        2.343     2.593     2.843    (note: 000 equivalent of 256)
  63.     001        3.093     3.343     3.593
  64.     002        3.843     4.093     4.343
  65.     003        4.593     4.843     5.093
  66.     004        5.343     5.593     5.843
  67.  
  68.   Notes: - times may be rounded to the next timer-tick value!
  69.          - 'wrapping' of switchpoint addresses takes place when 'first'
  70.            address is higher than 'last'.
  71.  
  72.  
  73.   Internals
  74.   ═════════
  75.   K83 is a simple application which makes use of the MKLAPI, one of my
  76.   other products for programming the Marklin Digital system. MKLAPI is a
  77.   'driver' and high level Application Programming Interface (API).
  78.   See the MKLAPI package on the international FIDO Bulletin Board
  79.   network (in particular the Fernwood OS/2 program collection) for the
  80.   latest version.
  81.  
  82.   K83LOOP is written in standard C-language. The source code of K83LOOP
  83.   will be available from me, when you register your MKLAPI package!
  84.  
  85.  
  86.   Feedback
  87.   ════════
  88.   Comments, suggestions and problem reports are welcome. Send written
  89.   notes to:
  90.                R. Hamerling
  91.                Hogelandseweg 67
  92.                4132 CV  Vianen
  93.                The Netherlands
  94.                phone: 31.3473.72136  (voice)
  95.  
  96.   Or send a message via the FIDO Bulletin Board network to:
  97.  
  98.                Rob Hamerling  at  2:512/4.1098
  99.  
  100.  
  101.