@DATABASE GS CallerID @NODE Main GS CallerID V1.0 By: Glenn J. Schworak @{" Introduction " link Introduction} @{" Installation " link Installation} @{" Configuration " link Configuration} @{" Operation " link Operation} @{" Expectation " link Expectation} @{" Registration " link Registration} @{" The Icons " alink Icons.iff/main} @{" Contact Me! " link Contact} @ENDNODE @NODE Introduction @{U}Introduction@{UU} GS CallerID was written for one simple reason... There wasn't anything that would do the job I wanted done. I found and tried a few Caller ID programs. One had a lot of features, but didn't actually work with the modem in the unregistered version so I wasn't about to pay for it blindly. One worked, but didn't do anything other that what my little box on the will could do. The others simply didn't work properly. So decided to write a program myself. This little program has a lot of nice features and will have more in the next version. I just wanted to get the program out to the people in this simple working form and add the rest later. In short, GS CallerID makes use of a CallerID modem and monitors incoming calls. Each call is recorded to a history buffer and if a valid phone number comes in (not out of area or private or error) the number can be logged in to a @{" Black Book " link BlackBook} where you can keep track of friends and family and any one else you want. You can even use the @{" Black Book " link BlackBook} to configure special handling of incoming calls. For example, pickup and hang up on people who are really annoying, answer with a modem tone then hang up if they are really really annoying, or call external programs to answer (such as a FAX program). For details on the current and future features, take a look at the @{" Operation " link Operation} and @{" Expectation " link Expectation} sections of this manual. If you like this program and want to unlock all of the power it has, simply fill in the @{" Registration " link Registration} form and send it to me with the proper fee. Enjoy this software and happy computing! @ENDNODE @NODE Installation @{U}Installation@{UU} Installing GS CallerID is quite simple. Place the Icon in the drawer where you want it and double click! I would recommend the WBStartup drawer so the program is launched each time you reboot your computer. This will ensure you get full use of this program and catch as many calls as possible. @{" Install it then start it! " RXS "shell command 'Copy CallerID to sys:WBStartup';shell command 'Copy CallerID.info to sys:WBStartup'; shell command 'RUN CallerID'"} I run a BBS so my computer is running 24 hours a day. I keep an extra modem on the voice line just for use with this program and my FAX program so it works out well for me. @ENDNODE @NODE Configuration @{U}Configuration@{UU} Configuring GS CallerID is requires a text editor at this point. A GUI editor will be added at a later time. Sorry, but that is just the way I like to do things. Makes it much easier to have all the configuration files in one location. The name of the configuration file is CallerID.cfg (SUPRIZE!) and is created the first time you run the CallerID program. Here is a list of the options you can set and descriptions of what each one does and proper values.... @{" DEVICE " link DEVICE} @{" UNIT " link UNIT} @{" BAUD " link BAUD} @{" SHARED " link SHARED} @{" RESET " link RESET} @{" CID " link CID} @{" OFFHOOK " link OFFHOOK} @{" ONHOOK " link ONHOOK} @{" TONEANSWER " link TONEANSWER} @{" SLOWMODEM " link SLOWMODEM} @{" ACTION " link ACTION} @{" PATH " link PATH} @{" DEBUG " link DEBUG} @{" X " link X} @{" Y " link Y} @{" SMALLX " link SMALLX} @{" SMALLY " link SMALLY} @{" BBX " link BBX} @{" BBY " link BBY} @{" BACKGROUND " link BACKGROUND} @{" BBBACKGROUND " link BBBACKGROUND} @{" WARNBACKGROUND " link WARNBACKGROUND} @{" TEXTCOLOR " link TEXTCOLOR} @{" SHADOWCOLOR " link SHADOWCOLOR} @{" SECONDS " link SECONDS} @{" HISTORY " link HISTORY} @{" BBMAX " link BBMAX} @{" SHOWTIME " link SHOWTIME} NOTICE: If you are an unregistered user, all of this information is of no value. Although you can edit and save your settings, the GS CallerID program won't read them off of the disk. This is the only way I could think of to make the program functional enough for everyone while encouraging software @{" registration " link Registration}. Sorry, but I have gotten stiffed on too many programs in the past. @ENDNODE @NODE Operation @{U}Operation@{UU} The operation of the GS CallerID program is rather "hands off" for the most part. You simply let the program run and it will monitor the modem for incoming calls and pop open a window then one comes in. Now that seems rather easy. Launch it and forget it. But, this program is able to offer so much more! With the history review buffer you can look back and see who has called. Every call is logged to the history review buffer file (up to the maximum number specified in the config file). If the same person calls three times, each of the calls will show up in the review list. This offers you the chance to see the calls in the order they came in. Not just when one person last called like most of the normal caller ID boxes you can buy. To access the review buffer, you simply click on the CallerID window (or title bar if in stand by mode) and the window will become activated. you use the arrow keys (up/down & left/right) to move through the list. The number in the title bar within parentheses will indicate how far back in history you are looking. Entry (1) is the most recent call. Pressing the UP arrow will move up the list (increasing the entry number) and move you further back in history. If you reach the end of the list you wrap around to the beginning of the list. And pressing the DOWN arrow will do just the reverse. The left and right keys are simply added ways of doing the same thing. Left is back in history and Right is closer to the present. There is a special entry (0) which is simply the title of the program. This is so you won't forget me. As call come in, one of three things will happen. 1) This will be a new call with no phone number attaches. Such as an "Out Of Area" call or "Private Number" call where the CallerID information from the phone company doesn't provice a phone number. These calls are displayed as best as the computer can Simply posting the information provided and going on it's way. 2) This will be a new call with a phone number attached. This is the normal result of an incoming call from a CallerID supported area. Since this is a new number to the program, the name of the caller (if available) along with the time, date, and phone number will be added to the @{" Black Book " link BlackBook} file (if there is room as specified in the config file). Steps 1 and 2 are much like what a standard CallerID unit would provide with the exception for the @{" Black Book " link BlackBook} and the tracking of ALL calls. The exciting part comes in step 3.... 3) This will be a repeat call. A number that is known to the system calls again. The program will take a quick look into the @{" Black Book " link BlackBook} file and grab out some valuable information. Such as a replacement name! The caller's address, the action to be performed for this caller, and possibly some other notes you have added to the file. All of this information (accept for the action) will be displayed in the incoming call window. This will give you a great deal of information about the caller that you can't get in any other CallerID device that I have seen. Heck, you can even mark some numbers as CLICK action where once the phone rings (usually twice) it is answered and then hung up. This is rather rude so reserve it for people you really don't want to talk to! Now that I have given you a quick run down of the incoming call window with it's history, lets take a closer look at that wonderful @{" Black Book " link BlackBook}. @ENDNODE @NODE BlackBook @{U}BlackBook@{UU} First! There are a couple ways to get into the Black Book. All of them start by activating the incoming call window. Simply click on the window and it will pop open if it isn't already open. Then you have three ways you can open the Black Book.... 1) Select the menu item Black Book. 2) Press the Right Amiga button and the B key at the same time. 3) Just press the B key all by itself (or with any other key for that matter) I wanted it to be really easy to get into the Black Book so I have you a couple quick options. Use the one you like the most. I like the B key myself. Once the Black Book opens, the incoming call/history window will jump back to stand by mode. This gets it out of your way. Don't worry, any incoming calls will be identified while you are using the Black Book. I wouldn't want you to miss a call! The Black Book is NOT SORTED and can't be sorted in this version. That will be available in the next version I think. Just too many projects at this point. Bummer! The Black Book window is divided into three parts... 1) The top of the Black Book window looks much like the incoming call/history window. The date, number of calls, and time are posted there. You can't edit these fields. There is no real reason to do so. If something really bad happens and the data is damaged, you probably need to delete the entire file any way. 2) The bottom of the window is used for moving around in the Black Book. This is much like the way it is done in the incoming call/history window. You can use the arrow keys to jump from entry to entry. But I wanted you to have more control here. So, you may also key in any entry number in the numeric box located at the bottom left of the window. OR you can drag (or click) the slider gadget to get to where you want to be. I wanted you to have several options. 3) The middle of the window is the really important part. At least it is to me. This is where you are allowed to edit the caller's information. Thins like their name, address, a note, their action. Although I have allowed you to edit the caller's phone number, it is not a good idea unless that caller has really changed their phone number. Because if they call, and the number you have entered is not identical to the one that comes in through the aller ID message from the modem, a new entry will be created in the Black Book with their real number. I only added ability because I wouldn't want to retype all the information just because someone changed their phone number. Right under the phone number is the name field. You are allowed up to 40 characters in this field. That is more than enough for almost any name (or company name) you might come across. if not, too bad, abbreviate. Then phone number and name field are special fields and are used as such so it is only possible to put what are deemed valid phone numbers in the phone number slot. And it is to you advantage to only put names in the name slot. But that one is up to you I guess. The next two lines are intended for the address. You can of course put any text you like in here because these fields are not used for anything other than display purposes at this time. That may change in the future so it is a good idea if you can to follow the designations. The street address (or mailing address) goes on the 1st of the two lines and the City, State, Zip on the next. But again, this is really up to you. I am only suggesting at this point. You are again limited to 40 characters on each of these lines. The next line down is the NOTE line. This is really where your note should go. You have up to 40 characters to work with. It isn't a lot of room for a note to some people, but this is to keep the data base small. If you need lots of room, that may be vailable through external programs at a later time. The last field you can type in is the ACTION line. Here you have 127 characters of space. I offer so much room because often programs require parameters. Full paths may also be required. 127 characters should be enough. If not, you may need to make an assignment to shorten up the path or call a script file. If you leave this blank, the default action listed in the config file will be executed. There is a click gadget at the bottom. by default, this will read "Do Nothing". This is what the modem should do when a call comes in for this person. You have 5 options for this gadget at this time. 1) Do Nothing This is the default. The modem doesn't to anything. It just sits there and listens to the modem for the next call. 2) CLICK This is where the modem answers with no tone and then hangs up. This is rude but for those people who call over and over even when you tell them not to, this is a great way to deal with them. 3) BUZZ This is even more rude than CLICK. The modem will answer, buzz in the caller's ear, then hang up. This will really stop people from calling you. 4) Go to Shared mode, Do Action, Reset Modem This is great for answering the modem with another program such as a BBS or FAX program. You have GS CallerID set the serial port into shared mode then after the action returns control, it resets the modem. Even if you have GS CallerID in shared mode is the default in the config file, this is the most common way to access other programs and give out control for the duration of a call. NOTE: The incoming call window WILL NOT close while the external program has control of the modem. 5) Close the port, Do Action, Open port This is for those extreme programs that won't accept shared mode. It works just like mode 4 but completely closes the serial port then re-opens it once control is returned. You will want to keep in mind that when you give control to another program, there is about a 1 or 2 second delay after GS CallerID gets control back before the modem is reset. Then another 1 or 2 seconds while the modem is being reset. This shouldn't effect your incoming calls but it could if the timing of the next incoming call is just right. Through the use of the menu, you have the ability to add and delete records. You can of course use the menu short cut keys. I think the idea of adding and deleting is simple enough I don't need to go in to any detail about it. @ENDNODE @NODE Expectation @{U}Expectation@{UU} Here are a few things that you can look forward to in the up coming versions of this program. I simply wanted to get this working version out to the public in a timely manner so I have decided to save these things for the next time around. 1) A GUI for the configuration file 2) The ability to PRINT both the History file and the Black Book file. 3) Sorting of the Black Book file. 4) An auto dialer accessable from both the Black Book and incoming call/hisotry window. 5) Possibly an AREXX port! To allow programs to be integrated to the telephone system. For example you could set the action to call an arexx script that accesses your customer order data base (if you run a business or such) and when that person calls, the script will go dig up all their information and have it on screen for you. I am of course open to suggestions on other things that could be done with this program. Although once the AREXX port is added, there may be a tone of 3rd party scripts available to integrate this program with other programs such as word processors for mail merging or call reminders, or what ever. @ENDNODE @NODE Registration @{U}Registration@{UU} This program is SHAREWARE... This means you can test it out before paying for it. It is not free. Supporting the shareware programmer can only help you get the software you want at a reasonable price. I don't like to make programs unusable. So all the features are turned on accept for the ability to load a configuration file. This in turn limits the number of calls that are stored in the history file and @{" Black Book " link BlackBook} file. It also makes it impossible to save the locations or look of the windows. You are stuck with the defaults. BUT you do get a good feel for all the program can do. Once you register, you will receive a key file that unlocks all the configuration file and you can play with all the little settings you want. You will receive FREE upgrades forever! I generally don't require paid upgrading to any of my software. Something incredible would have to happen for me to change this policy. I don't send out upgrades unless you are on one of my InterNet mailing lists for them. But the new shareware versions that come out will use the same key file as V1.0 and if for some reason I need to change the key file, I usually offer free key upgrades to registered users. GS CallerID is what I would class as a valuable program. In this version its applications are some what limited but once the few additions that I already have on the drawing board are added, the value explodes. The current and future value of this program along with the increasing number of cities that are making CallerID available to their residents brings me to my requested price of $20.00 for this program. I hope you see enough value in what I have delivered at this point and trust me enough to continue developing (which I will because even if you don't want the features, I do) to see that this is a fair and reasonable price to ask. All you need to do is fill in the registration form bellow, throw in your money, and I will get you your key file and the most current version of the program as quickly as possible. In most cases, I ship the next day after receiving the registration fee and form. @{" View Registratoin Form " SYSTEM "more Registration"} @{" Print Registratoin Form " SYSTEM "Type >PRT: Registration"} @ENDNODE @NODE DEVICE @{U}DEVICE@{UU} This is the name of the serial device you use. By default, this will be set to "serial.device" but it can be any valid serial device driver. The GVP I/O card uses gvpser.device and the MultiFace II card uses duart.device. @ENDNODE @NODE UNIT @{U}UNIT@{UU} This is the serial port unit device. By default this is set to 0 (zero) but again can be any valid unit number on your system. Just make sure you specify the correct device and unit or the program won't be able to find your modem. @ENDNODE @NODE BAUD @{U}BAUD@{UU} The speed at which the computer will talk to the modem. You can make this any valid baud rate from 9600 baud to 115200 baud as long as the serial device you specified and the modem both support that speed. By default, this set to 9600. I have found that although I can get Caller ID to work at speeds lower than 9600, it is not reliable. The information coming from the modem often takes too long and is destroyed by the next in coming ring. So 9600 baud is the minimum value. @ENDNODE @NODE SHARED @{U}SHARED@{UU} This tells the GS CallerID to open the serial port in shared mode all the time. You can only enter 0 (zero) or 1 (one) for this field. Any non-zero value will be taken as a one. Shared mode = 1, non-shared mode = 0. By default the serial port is not opened in shared mode. This is really the best way to run the program unless you have some special need. @ENDNODE @NODE RESET @{U}RESET@{UU} This is the modem command that is used to cause a full modem reset. By default, this is ATZ and should stay that way unless you have special needs. @ENDNODE @NODE CID @{U}CID@{UU} This is the modem command that turn the caller ID on for your modem. By default the command is AT#CID=1 and if you are running a Supra modem or compatible (most are) this will do just fine. If this doesn't work for you, you will need to check your modem manual for help. @ENDNODE @NODE OFFHOOK @{U}OFFHOOK@{UU} This is the command that will cause the modem to answer the phone but make no noise. Simply take the phone off the hook. It is used when you want GS CallerID to block phone calls for you. The phone is answered then hung up again. By default this is ATH1 and works for most modems. @ENDNODE @NODE ONHOOK @{U}ONHOOK@{UU} This is the command that hangs up the phone. Used after the OFFHOOK or TONEANSWER commands are used. By default this is ATH0 and works for most modems. @ENDNODE @NODE TONEANSWER @{U}TONEANSWER@{UU} This is the command that will cause the modem to answer the phone and buzz in the caller's ear. This is a really rude thing to do so I recommend you only use it on people who are really really annoying and won't stop bothering you. By default the command is ATA and works on most modems. @ENDNODE @NODE SLOWMODEM @{U}SLOWMODEM@{UU} This will cause a delay when sending commands to the modem. By default this value is 0 (zero) but you can use any number from 0 (zero) to 3 (three). I would recommend starting with the lowest value and if you have problems increase the value one at a time until the errors go away. @ENDNODE @NODE ACTION @{U}ACTION@{UU} AAAhhhhh... Here is where the fun starts! This is the CLI command that is executed when any incoming call comes in. By default, SAY "Incoming Call From %s" is used. The %s is replaced by GS CallerID with the name of the caller. If you want, you can specify alternative actions in the @{" Black Book " link BlackBook} for each caller. But if no alternative action exists in the @{" Black Book " link BlackBook}, this default action will be used. @ENDNODE @NODE PATH @{U}PATH@{UU} This is the path to the CallerID.BlackBook and CallerID.History files. By default, this is the S: directory. You can place these files in any valid directory you want and then set this entry to point to that directory. If you change the path, it is best to do so while GS CallerID is not running. You won't be able to move the files while it is. @ENDNODE @NODE DEBUG @{U}DEBUG@{UU} Being this is version 1.0 I have decided to leave in the debug code for now. If you are experiencing problems, simply set this entry to a value of 1 (one) and run the program again or reload the configuration file. If you want help from me, you will need to use a CLI session to start the CallerID program and redirect the output to a file and then send me the file so I can figure out where the problem is. This can be done with the command CallerID >t:CID.log and after you are done running the program or have encountered your problem, you simple exit the program and Email or send me the CID.log file with a description of your problem. The valid settings for this entry are 0 (zero for no debug) or 1 (one for debug). By default, the debug mode is set to 0 (zero). @ENDNODE @NODE X @{U}X@{UU} The X location on the screen of the upper left hand corner of the caller ID window when a call comes in. (This is the left to right position) This is easy to set graphically! Simply move the window to where you want it to be then save the configuration to disk. The window defaults to the upper left corner of the screen. @ENDNODE @NODE Y @{U}Y@{UU} The Y location on the screen of the upper left hand corner of the caller ID window when a call comes in. (This is the top to bottom position) This is easy to set graphically! Simply move the window to where you want it to be then save the configuration to disk. The window defaults to the upper left corner of the screen. @ENDNODE @NODE SMALLX @{U}SMALLX@{UU} The X location on the screen of the upper left hand corner of the caller ID window when the program is in stand by mode. (This is the left to right position) This is easy to set graphically! Simply move the window to where you want it to be then save the configuration to disk. The window defaults to the upper left corner of the screen. @ENDNODE @NODE SMALLY @{U}SMALLY@{UU} The Y location on the screen of the upper left hand corner of the caller ID window when the program is in stand by mode. (This is the top to bottom position) This is easy to set graphically! Simply move the window to where you want it to be then save the configuration to disk. The window defaults to the upper left corner of the screen. @ENDNODE @NODE BBX @{U}BBX@{UU} The X location on the screen of the upper left hand corner of the caller @{" Black Book " link BlackBook} window when open. (This is the left to right position) This is easy to set graphically! Simply move the window to where you want it to be then save the configuration to disk. The window defaults to the upper left corner of the screen. @ENDNODE @NODE BBY @{U}BBY@{UU} The Y location on the screen of the upper left hand corner of the caller @{" Black Book " link BlackBook} window when open. (This is the top to bottom position) This is easy to set graphically! Simply move the window to where you want it to be then save the configuration to disk. The window defaults to the upper left corner of the screen. @ENDNODE @NODE BACKGROUND @{U}BACKGROUND@{UU} This is the pen number that you want used for the background on the incoming call window. By default, this is set to 3 under the assumption you are only running a 4 color WorkBench. But who really does that any more? You can really set this to any value you want but only valid pen numbers will actually function properly. @ENDNODE @NODE BBBACKGROUND @{U}BBBACKGROUND@{UU} This is the pen number that you want used for the background on the @{" Black Book " link BlackBook} window. By default, this is set to 3 under the assumption you are only running a 4 color WorkBench. But who really does that any more? You can really set this to any value you want but only valid pen numbers will actually function properly. @ENDNODE @NODE WARNBACKGROUND @{U}WARNBACKGROUND@{UU} This is the pen number that you want used for the background on the WARNING window. By default, this is set to 0 under the assumption you are only running a 4 color WorkBench. But who really does that any more? You can really set this to any value you want but only valid pen numbers will actually function properly. I like to use RED for this one!!! @ENDNODE @NODE TEXTCOLOR @{U}TEXTCOLOR@{UU} You get to choose the main color of the text displayed in the various windows. (sorry, all text must be the same color at this time). By default, this uses the #2 pen (usually white) but like with the other colors, you can set it to any value you like as long as the screen supports it. @ENDNODE @NODE SHADOWCOLOR @{U}SHADOWCOLOR@{UU} Much of the text displayed in the various windows is given the look of depth by drawing it twice! Once in the shadow color (usually black or dark gray) and once in the text color slightly off set to make it look like it is lifted off the screen. This is set to 1 (usually black) by default. @ENDNODE @NODE SECONDS @{U}SECONDS@{UU} This is the number of seconds you want the incoming call window to stay open before automatically shrinking back to the stand by mode. By default this is 15 seconds but I find that 8 to 10 actually works well for me. Notice, if you have selected the incoming call window this value is not used. As soon as you unselect the window it jumps right to stand by mode. @ENDNODE @NODE HISTORY @{U}HISTORY@{UU} This is the number of calls you want to keep track of in your review history file. By default this is set to 4 calls. It can't be set any lower than 3 calls either. Why? Because I said so. There is no upper limit, but I find that 100 calls is more that enough. I generally don't go back that far. Usually only 20-30 calls. But what the heck. If you want to scroll back 10,000 calls in history, one at a time, go for it! The history file is of FIXED size so once it is set, it won't grow/shrink unless you reset it later. @ENDNODE @NODE BBMAX @{U}BBMAX@{UU} This is the maximum number of names/numbers you want to keep track of in your @{" Black Book " link BlackBook}. By default, this is set to 12 entries. But I am sure you will want to change that. If you set this entry to 0 (zero) there is no limit on the size of the @{" Black Book " link BlackBook}. This file will grow (never shrink unless you delete it) as entries are added. @ENDNODE @NODE SHOWTIME @{U}SHOWTIME@{UU} You can opt to have the GS CallerID program display the time of day in the window title bar. This is a great way to conserve desk space. No need to run a clock and the CallerID program just to see the time. GS CallerID is running so why not have it show the time. By default, this is set to 0 (zero no time) but you can set it to 1 (one) if you want to see the time. @ENDNODE @NODE Contact @{U}Contact Me!@{UU} If you would like to get in contact with me for any reason, here is how... @{fg highlight}InterNet:@{fg text} glenn@g-world.com @{fg highlight} FidoNet:@{fg text} Glenn J. Schworak>1:3406/32 @{fg highlight} US Mail:@{fg text} Glenn J. Schworak 1710 Lee St SE Salem, OR 97302 @{fg highlight} Phone:@{fg text} (503) 399-7518 <--- Only 4pm - 8pm Pacific Time (8am - 12 noon Greenwich time) @ENDNODE