home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / cidos210.zip / readme.cid < prev   
Text File  |  1997-04-27  |  10KB  |  249 lines
  1.  
  2.  CID 0.10 OS/2 PM     Copyright (C) 1997, Craig Morrison          Caller ID Box
  3.                              All Rights Reserved.
  4.  
  5.   What is CID?
  6.  
  7.     CID...Pronounced "syd".
  8.  
  9.       CID is a simple Caller ID box for OS/2 Warp's Desktop. It is designed to
  10.     work with Caller ID subscribers who have CallerID Name & Number turned on.
  11.     You'll never lose another number again! The number of callers stored is
  12.     only limited by the amount of virtual memory you have. :-)
  13.  
  14.       If you can operate a standard phone company caller ID box, you can
  15.     operate CID. CID is an almost exact replacement for the box, the best part
  16.     about it is....CID sits right on your desktop, a mouse click away.
  17.  
  18.   Kudos out to..
  19.  
  20.       Thomas Westdorp
  21.       Dave Schooler
  22.  
  23.       These two are the most vocal of all the people helping me by testing CID.
  24.     Without their constant input, I wouldn't have gotten this far.
  25.  
  26.   Notes About CID..
  27.  
  28.       This is a pre-release version, it may or may not work for you.
  29.  
  30.       The current modem types supported are:
  31.  
  32.             Any Rockwell based modem
  33.             Any Sierra based modem
  34.             Practical Peripherals Proclass PC2888MT V.34
  35.  
  36.       PLEASE NOTE:
  37.  
  38.             CID will only work with non-ISDN modem types and for North
  39.             American caller ID services.
  40.  
  41.       What you are seeing here with CID is the spawning of a retail software
  42.     package. When finished, that release will only be sold, not given away.
  43.     However, you may use any pre-release version for whatever you wish, as long
  44.     as you wish.. The purpose of the net exposure is to allow me as wide a test
  45.     audience as possible. Thank you for helping me.
  46.  
  47.       The most recent version of CID will always be available at:
  48.  
  49.           http://home1.gte.net/basher/cid.htm     CID Home Page
  50.  
  51.       Please be patient with this site. GTE.NET is going through a major
  52.     restructuring right now, so the site may be down at times. This is the
  53.     preferred download site. From time to time I will post CID to Hobbes, where
  54.     it will usually end up in /pub/os2/apps/comm.
  55.  
  56.   Installing CID..
  57.  
  58.       If you downloaded the archive CIDOS210.ZIP from Hobbes, run INSTALL.EXE.
  59.  
  60.       If you got CID from the CID home page...Run CIDOS210.EXE, it will start
  61.     the installation program automatically.
  62.  
  63.       I hope you like the install program, it should be almost transparent to
  64.     the end user. Comments, suggestions, etc.. are welcome.
  65.  
  66.   Operating CID..
  67.  
  68.       Simple:  (well...It used to be simple :-)
  69.  
  70.         CID [switches]
  71.  
  72.         Switches:   (may be preceded by - or /)
  73.                     (NOTE: the examples below are the defaults for CID.)
  74.  
  75.             S              Swap last word in name for first word(s).
  76.                            ie. DOE JOHN becomes JOHN DOE
  77.  
  78.                            NOSWAP.CID allows you to tell CID what names
  79.                            to ignore when swapping. NOSWAP.CID is a
  80.                            simple text file, one name or partial name
  81.                            per line. All you have to do is put enough
  82.                            of the name on each line so that CID can
  83.                            recognize the name when a call comes in.
  84.                            Case is not important.
  85.  
  86.             O              External database file(**), example:
  87.                                -Ocallers.dat
  88.  
  89.             I              Country code, = 1 for USA.
  90.                            Example:        -I1
  91.  
  92.             A              Local area code list. This switch is for
  93.                            those who live in areas that may have one
  94.                            or more local (non-toll call) area codes.
  95.                            Simply string them together with a
  96.                            character separating each one. It will be
  97.                            used for auto-dialing purposes.
  98.                            Example:        -A317;765;
  99.  
  100.             D              Dial prefix, example:
  101.                                -DATDT
  102.  
  103.             P              Specify the comm port to use, i.e.:
  104.                                -PCOM2
  105.  
  106.             X              Exit at specified time, use this if you
  107.                            need to have CID exit so that the com port
  108.                            is not being tied up. Specify the time in
  109.                            24 hour military format. Example:
  110.                                -X13:00
  111.  
  112.             K              Disables the Delete functions.
  113.  
  114.            (**)            The record layout for the database file is
  115.                            a packed stream of the following structure:
  116.  
  117.                            typedef struct _cidinfo {
  118.                                unsigned short  cbData;
  119.                                unsigned char   phone[13];
  120.                                unsigned char   name[16];
  121.                                unsigned char   date[6];
  122.                                unsigned char   time[6];
  123.                                unsigned long   number;
  124.                                struct _cidinfo *next;
  125.                                struct _cidinfo *prev;
  126.                            } CIDINFO, *PCIDINFO;
  127.  
  128.                            number is relative only to the session that
  129.                            the call was received in. *next and *prev
  130.                            should be ignored as they serve no useful
  131.                            purpose in the external file. See the sample
  132.                            code at the end of this file for an example
  133.                            of how to read the database file.
  134.  
  135.       Closing CID can take upto 5 seconds. CID has to follow a specific set of
  136.     procedures when shutting down to ensure that the port is in a stable state
  137.     when closing. Basically CID has to wait for the port read thread to
  138.     time-out, currently this is set to a liberal 5 second interval. This is
  139.     *NOT* a bug, it is vital that CID's shutdown operate in this fashion.
  140.  
  141.       Please feel free to e-mail (1) the caller ID strings for other chipsets
  142.     to me and I will write an installation program that will allow for easier
  143.     setup (desktop objects, etc..)
  144.  
  145.   BUGs and Reporting Them..
  146.  
  147.       If you are submitting a bug report, I need *more* than "It doesn't work."
  148.     This doesn't do either of us any good. I need the following information:
  149.  
  150.         (1) Modem type and manufacturer.
  151.  
  152.         (2) Description as best you can of what does/does not happen.
  153.  
  154.         (3) Caller ID Initialization strings, one for ON and one for OFF.
  155.  
  156.             The ON string should turn on **FORMATTED** ICLID packages
  157.             from your telephone service provider. Look in your modem
  158.             documentation or contact the manufacturer.
  159.  
  160.         (4) The debug logs created by CID. There are two created, COM?PORT.LOG
  161.             and COM?CID.LOG. Where ? is the com port number. Please use some
  162.             type of archiver to pack these two files up before sending them to
  163.             me so that no line ending translations occur. (I have just about
  164.             every archiver ever produced, so it is up to you which one you
  165.             use.)
  166.  
  167.         (5) The tags used in the formatted data, i.e:
  168.  
  169.             DATE = ...
  170.             TIME = ...
  171.             NMBR = ...
  172.             NAME = ...
  173.  
  174.             These can be found by loading up your favorite terminal
  175.             package, typing in the CID ON string and having someone call
  176.             you. Your terminal package should display them on your console.
  177.  
  178.       Of the above, only 1-4 are really necessary, but 5 will give me a better
  179.     idea of what is going on with your modem's caller ID capabilities.
  180.  
  181.       As with all CallerID software, the line MUST ring TWICE for the data to
  182.     be transferred from the modem. If it doesn't, CID will not work for you.
  183.     S0=0 in your modem's stored NVRAM settings will fix this problem. Let CID
  184.     worry about the ring count. The extent of CID's modem initialization is;
  185.     ATZ<cr> ATE1V1X4<cr> and either the CID ON or OFF string.
  186.  
  187.       Please! E-mail (1) me any suggestions, bugs, comments, feature requests,
  188.     etc... My mailbox is always open. Or you can stop by my website and leave a
  189.     note there in the guestbook. You may also wish to browse a bit when you
  190.     stop by, there are links to a large number of resources on the net there.
  191.  
  192.       *** If you or someone you know has any information about the Sierra
  193.     Semiconductor ADPCM AT command set, PLEASE get in touch with me. I want to
  194.     add voice mail too, but not until I get the specs for SSC chipsets. I have
  195.     the Rockwell specs already. ***
  196.  
  197.       Good luck!
  198.  
  199.         Basher
  200.  
  201.         basher@gte.net                              E-Mail          (1)
  202.         http://home1.gte.net/basher/index.htm       My Home Page
  203.         http://home1.gte.net/basher/cid.htm         CID Home Page
  204.  
  205. ------------------------------------------------------------------------------
  206.  
  207. /*****************************************************************************
  208.  
  209.     Sample C code to list callers from the output file created by CID.
  210.  
  211.  ****************************************************************************/
  212. #include <stdio.h>
  213. #include <string.h>
  214. #include <stdlib.h>
  215.  
  216. typedef struct _cidinfo {
  217.     unsigned short  cbData;
  218.     unsigned char   phone[13];
  219.     unsigned char   name[16];
  220.     unsigned char   date[6];
  221.     unsigned char   time[6];
  222.     unsigned long   number;
  223.     struct _cidinfo *next;
  224.     struct _cidinfo *prev;
  225. } CIDINFO, *PCIDINFO;
  226.  
  227. int main(int argc, char **argv)
  228. {
  229.     FILE *f;
  230.     CIDINFO cid;
  231.  
  232.     if (argc>1)
  233.     {
  234.         f = fopen(argv[1], "rb");
  235.         if (f)
  236.         {
  237.             while(fread(&cid, 1, sizeof(CIDINFO), f))
  238.             {
  239.                 printf("Name:   %s\n", cid.name);
  240.                 printf("Number: %s\n", cid.phone);
  241.                 printf("Date:   %s\n", cid.date);
  242.                 printf("Time:   %s\n\n", cid.time);
  243.             }
  244.             fclose(f);
  245.         }
  246.     }
  247.     return 0;
  248. }
  249.