home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / lambda / soundpot / p / px8util.lbr / PXML.TZT / PXML.TXT
Encoding:
Text File  |  1993-10-25  |  8.5 KB  |  246 lines
  1.     PXML.COM                  Message Logger for the PX-8
  2.  
  3.  
  4.  
  5.  
  6.     Overview
  7.     PXML  is intended to be used as a data logger for textual,  ASCII
  8.     information  transmitted  over telephone lines to an  Epson  PX-8
  9.     computer with an internal modem.  Data received by PXML is placed
  10.     in  a file named -MESSAGE.LOG on drive A:.  The information  con-
  11.     tained    in A:-MESSAGE.LOG may be edited via WordStar, listed  via
  12.     TYPE or PIP, etc.
  13.  
  14.  
  15.     Using PXML
  16.     Typing    PXML at the CP/M prompt will cause the program    to  begin
  17.     execution.  Simultaneously pressing CTRL and STOP will    interrupt
  18.     the program, close -MESSAGE.LOG, and return to the CP/M prompt.
  19.  
  20.     After  verifying that the PX-8 has an internal modem  and  enough
  21.     program  memory  (about 20K) to operate, the program  begins  its
  22.     main  loop.  The main loop waits for the telephone to  ring,  an-
  23.     swers  and verifies that the carrier is present, writes the  date
  24.     and  time to the message file, and begins the sub-loop.   In  the
  25.     sub-loop, data is taken character-by-character from the transmit-
  26.     ting device and placed in a 1000 byte long receiving buffer until
  27.     a CARRIAGE RETURN (or CTRL-Z) is received.  The receiving  buffer
  28.     is then transferred to the message file.  The sub-loop    continues
  29.     until  the  transmitter's carrier is lost (ie. the  caller  hangs
  30.     up).  Operation then resumes in the main loop.
  31.  
  32.     When PXML is operating in the sub-loop, several control  commands
  33.     are  available to the transmitting device.  Many of the  commands
  34.     are similar to those used to edit the CP/M "command line."  Note:
  35.     in the following, the character "^" followed by a capital  letter
  36.     means "CTRL-letter," eg. ^Z equals CTRL-Z.
  37.  
  38.          ^E   Toggles  the echo mode.  Normally, PXML  echoes  (sends
  39.           back) all data it receives to the transmitter.  If this
  40.           is not desired, transmitting ^E to PXML causes data not
  41.           to  be  echoed.  Sending another ^E  will  restart  the
  42.           echo,  etc.  When PXML answers a new call, echo is  al-
  43.           ways enabled.
  44.  
  45.          DEL  ^H  or BS deletes the previous character.  If  echo  is
  46.           enabled and the transmitting device is displaying,  the
  47.           character will erased on the display too.
  48.  
  49.          ^X   Deletes  the line.  This is equivalent to a  series  of
  50.           single character deletes.
  51.  
  52.          ^U   Deletes the line.  This is similar to ^X, but (assuming
  53.           echo    is  on) the line is not physically  erased.   In-
  54.           stead, "#" is printed and a new line is started.
  55.  
  56.          ^R   Starts  a  new line and "re-prints" the data    thus  far
  57.           received  in the current line back to the  transmitting
  58.           device.
  59.  
  60.  
  61.     EPSON_SUPPORT_DISKS, (313) 538-3733              Page 1 of 4
  62.     PXML.COM                  Message Logger for the PX-8
  63.  
  64.  
  65.  
  66.          ^Z   Terminates  the current line (same as RETURN) and  then
  67.           closes and automatically re-opens the message file.    A
  68.           new  "time stamp" is also written to the message  file.
  69.           This    helps to assure the validity of message  data  in
  70.           the case of a system crash.
  71.  
  72.     Most  of  the preceding commands are intended for use  with  echo
  73.     enabled and the system operating in an interactive mode.
  74.  
  75.  
  76.     Message File
  77.     Incoming  data is stored in the disk file -MESSAGE.LOG    on  drive
  78.     A:.   If the message file already exists, the file is opened  and
  79.     data  is appended to the current information.  If the  file  does
  80.     not currently exist, one is created.
  81.  
  82.     Whenever  an incoming call is accepted, or ^Z is pressed  in  the
  83.     sub-loop, a date and time stamp is written to the file.  The time
  84.     stamp  format is "YY-MM/DD.hh:mm:ss" which corresponds    to  year,
  85.     month, day, and hours, minutes, seconds.
  86.  
  87.     With  some  exceptions, all incoming data is transferred  to  the
  88.     message file.  The exceptions are:
  89.  
  90.          1.   None    of the previously described command keys are  put
  91.           into the file.
  92.  
  93.          2.   NULs (^@) are skipped.
  94.  
  95.          3.   CARRIAGE  RETURNs are expanded to a RETURN,  LINE  FEED
  96.           sequence.  Transmitted LINE FEEDs are skipped.
  97.  
  98.          4.   Data    bytes in the range of 128 to 255 (080h    to  0FFh)
  99.           have    their most significant bit converted to  zero  to
  100.           place  them into the ASCII set of control and  printing
  101.           characters.
  102.  
  103.          5.   Other  control characters are placed into the  file  as
  104.           is.  However, they will be echoed preceded by the char-
  105.           acter "^".
  106.  
  107.     When  the message file information is written to the  disk,  PXML
  108.     will  send the transmitting device a CTRL-S.  Upon completion  of
  109.     the  disk  write, CTRL-Q will be sent to the  transmitter.   This
  110.     happens if echo is on or off.  The transmitting device should  be
  111.     configured to accept the XON/XOFF handshake.
  112.  
  113.  
  114.     Error and Status Messages
  115.     All  error and status messages are sent to the LCD screen of  the
  116.     PX-8 running PXML or, in one case, the message file.
  117.  
  118.     <<overflow>>         Sent  to the message file when  the  re-
  119.                  ceive    buffer    contains more  than  1000
  120.  
  121.  
  122.     EPSON_SUPPORT_DISKS, (313) 538-3733              Page 2 of 4
  123.     PXML.COM                  Message Logger for the PX-8
  124.  
  125.  
  126.                  characters.  The buffer is truncated and
  127.                  written  following the  message.   Under
  128.                  this condition, incoming characters  may
  129.                  be lost.  The error may be prevented  by
  130.                  limiting  characters transmitted  before
  131.                  RETURN  (or ^Z) to less than 1000.   The
  132.                  program returns to the sub-loop.
  133.  
  134.     Insufficient memory     Displayed when PXML finds that there  is
  135.                  not  enough  memory for itself  and  its
  136.                  various buffers.  The program returns to
  137.                  the CP/M prompt.
  138.  
  139.     No internal modem     Displayed when PXML finds that there  is
  140.                  not  an internal modem  connected.   The
  141.                  program returns to the CP/M prompt.
  142.  
  143.     No carrier detected     Displayed  when  PXML    cannot    find  the
  144.                  transmitting device's carrier tone after
  145.                  answering an incoming call.  The program
  146.                  disconnects from the telephone line  and
  147.                  returns to the main loop.
  148.  
  149.     Lost carrier         Displayed when the transmitting  carrier
  150.                  is lost in the sub-loop, typically when-
  151.                  ever  the caller hangs up.  The  program
  152.                  closes  the  message  file,  disconnects
  153.                  from the phone line, and returns to  the
  154.                  main loop.
  155.  
  156.     RSX open failed      Displayed when PXML cannot open the  RSX
  157.                  (RS-232)  channel  after  answering   an
  158.                  incoming  call.  The program returns  to
  159.                  the main loop.
  160.  
  161.     RSX failure         Displayed when PXML detects an error  on
  162.                  the  RSX channel in the  sub-loop.   The
  163.                  program closes the message file, discon-
  164.                  nects    from the phone line, and  returns
  165.                  to the main loop.
  166.  
  167.     Message error
  168.     disk or directory full     These messages are displayed for various
  169.                  disk  errors.    The action taken by  PXML
  170.                  depends on when the error occurs.   Gen-
  171.                  erally, errors occurring during start-up
  172.                  cause the program to return to the  CP/M
  173.                  prompt  while    errors    occurring  during
  174.                  transmission are ignored until the  next
  175.                  call.
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.     EPSON_SUPPORT_DISKS, (313) 538-3733              Page 3 of 4
  184.     PXML.COM                  Message Logger for the PX-8
  185.  
  186.  
  187.     Control-STOP cancel     Displayed  whenever  CTRL and    STOP  are
  188.                  simultaneously  pressed.   The   program
  189.                  closes  the  message  file,  disconnects
  190.                  from  the phone line, and exits  to  the
  191.                  CP/M prompt.
  192.  
  193.  
  194.     Custom Configuration
  195.     Some  of  the defaults used by PXML may be changed via DDT  or    a
  196.     similar  editor.  If you are not familiar with this type of  pro-
  197.     cedure,  exercise caution and make sure that you have  a  back-up
  198.     copy of PXML.COM before attempting to make modifications.
  199.  
  200.     After  loading    PXML.COM with DDT, etc.  Data  at  the    following
  201.     addresses may be changed:
  202.  
  203.          0121 This is the ECHO_FLAG.  For a default of echo on,  this
  204.           byte    is  set to FF.    Set to 00 for a default  of  echo
  205.           off.
  206.  
  207.          0122 This    is  the disk number used for  the  message  file.
  208.           Drive  A=01, B=02, etc.  Warning: Do Not set this  byte
  209.           to  08  (tape drive H).  The random reads done  in  the
  210.           message file will result in BDOS errors on drive H:.
  211.  
  212.          0123 This    location  is the start of an eleven  byte  string
  213.           which defines the name of the message file.  The  first
  214.           8  bytes  are the file name (-MESSAGE) and the  last    3
  215.           bytes  are  the  file type (LOG).  If  this  string  is
  216.           changed,  be sure that any unneeded bytes are set to    a
  217.           space (20).
  218.  
  219.     After  exiting    DDT (etc.), type  SAVE 17 PXML.COM  to    save  the
  220.     changes you have made.
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.     EPSON_SUPPORT_DISKS, (313) 538-3733              Page 4 of 4
  245.  
  246.