TO ALL USERS: This documentation is nowhere near what I had hoped to make it. I know there are lots of gaps that I have to fill in. Rather than hold the release of the software up until I feel that the documentation is ready I am electing to get this out in the form it is in in order to release the software as promised. Keep an eye on the web pages mentioned at the end of this file for updated information on both the software and documentation for it. Bob Arnold N2JEU 29 July 2001 ============================================================================= N2JEU's Internet Remote Base software for the Ten-Tec Pegasus/Jupiter transceiver Documentation version 1.0 - 29 July 2001 Software version 1.02 - 29 July 2001 About the Software and Documentation - This documentation is not meant as a complete manual for operating a web server or writing HTML code or any of the other things that are required to set up a successful Internet Remote Base using this software. If you are unfamiliar with setting up and running a web server, keeping your Internet connection up full time or writing HTML pages then please seek some local help in setting up this software on your system. This software is released as FREEWARE. It is however a fully copyrighted work and may not be sold or re-distributed as part of a CD software collection or web site or other means without the permission of the Author (Robert Arnold N2JEU). Links to the Author's web site (http://www.ralabs.com/remote/) are encouraged. Please link to the URL given since the software and the pages that support it are likely to change from time to time. The URL given should always be available however. Because this is released as freeware the Author is NOT responsible for ANY damages to the users computer or operating system from the use of this software. The Author is only responsible for answering support questions VIA EMAIL ONLY specifically relating to THIS SOFTWARE. I can not help with web server setup, HTML page creation or other support issues on a free basis. Help may be available on a PAID BASIS from the Author for things not related directly to this software. Please contact the Author via email for additional information at the address given later in this documentation. System Requirements - This software is a program that controls a Ten-Tec Pegasus or Jupiter transceiver from a web based form on the Internet or other TCP/IP based network. It REQUIRES: 1) Widows 98, 98SE, or ME (Note that the software will not work with NT4 or Win2000 due to routines used to access the system hardware. Later versions may run with NT or 2000 but NOT THIS VERSION!) 2) A copy of N4PY's Pegasus control software. It acts as the interface to the transceiver and permits local control of the transceiver at the same time as web control. Email Carl N4PY at n4py@earthlink.net for information. His software is NOT FREEWARE. Carl has sent many hours on his software and asks only a small fee from users to register it. Make sure Carls software is version 1.49 or newer for use with this software. You'll need to ENABLE the REMOTE INTERFACE ability in his software. See the file REMOTE.DOC that Carl includes with his software for information. 3) A PC using an Intel or compatible CPU running at 200 Mhz or better with 64 MB of RAM and at least 2 GB of hard drive space. 4) An Internet connection. Full time recommended of at least ISDN speed (128KB/sec) or better for the server. 5) Web server software supporting standard CGI applications. (see tested software later in the docs) 6) A Ten-Tec Pegasus or Jupiter transceiver 7) A Kachina rotor controller OR an Idiom Press ROTOR-EZ controller board installed in a HAM-X or Tailtwister rotor OR a HY-GAIN DCU-1 rotor controller 8) A parallel port Relay interface card. A kit made by kitsrus.com (kit number 74) was used in the development of this software. This provides remote antenna selection using a 1 of 6 type antenna relay box. 9) a remote antenna switch unit (a 1 of 6 type relay switch) Units from WX0B Array Solutions and Top Ten Devices work well. 10) A program capable of supporting two way Internet audio. Microsoft's NetMeeting software is recommended and may be downloaded free from the Microsoft web site at http://www.microsoft.com/. I will state one more time for the record - This document does NOT cover how to set up and run your own web services over a full time Internet connection from your home/remote base location. It only covers the setup and operation of this specific CGI-based application. If you do NOT know how to set up a web server or maintain a full time Internet connection then please seek LOCAL HELP for those tasks. I can NOT support you in those tasks since this is being released as a freeware product. Unpacking the software: The software is distributed as a ZIP file. You will need a program to UNZIP the installation files. I suggest WINZIP. A trial version is available from http://www.winzip.com/. Here's how to unpack the software and install it: 1) UNZIP the IRBPEGASUS.ZIP file into a TEMPORARY folder. 2) Go to the temporary folder and run the SETUP.EXE program. 3) The setup program will create a folder in your PROGRAM FILES folder on your C drive called IRBPEGASUS. 4) You will need to copy all of the files in the IRBPEGASUS folder to the CGI-BIN (or equivalent) folder in the structure if your web server software. 5) Edit the files to match the configuration and look of your system. Obtain a copy of the N4PY control software. Install it and configure it per N4PY's instructions. BE SURE TO ACTIVATE THE REMOTE INTERFACE AS OUTLINED IN HIS REMOTE.DOC FILE. You will not be able to control the radio from my software until the N4PY software is installed and operational. N4PY's software MUST be running for my software to access the transceiver. This software WILL NOT RUN from the installation directory. If your web server has a CGI-WIN folder DO NOT PLACE THE FILES THERE as they will not run in that folder. Put the files in the CGI-BIN or equivalent folder of your web server. Please keep a copy of the files in the installation directory should you need to replace any of the files in your web server's CGI-BIN folder. Configuring the software: The main configuration file is the pegasus.cfg file. It MUST be in the CGI- BIN folder (the same folder where the .EXE file resides) to be read whenever the program is started by the web server software. It looks like this: --------------------------------------------------------------------- ; this is the configuration file for the control software. ; lines starting with a semi-colon (;) are comment lines and are ignored ; blank lines are also ignored ; the format of each line is a key word followed by an equals sign then the ; appropriate value. NO SPACES BETWEEN THE KEY WORD AND THE EQUALS SIGN! ; this line makes the software display a "maint. mode" file to ; the user when set to 1 (0 is for normal operation) ; maintfile is the name of the file to send to the user maintmode= 0 maintfile= pmaint.txt ; this line forces the TX OFF in ALL instances when set to 1 ; 0 is for normal operation of the remote txlock= 0 ; set file path for most system files. can be set to RAM drive to increase ; system response speed - SEE DOCUMENTATION FIRST! ; leave commented out for all files in your web server's CGI-BIN folder ;filepath= c:\xitami\cgi-bin ; path and file name of N4PY interface file ; can use a RAM drive to reduce hard drive access peginfile= e:\remote.in ; path and file name for the n4py output file - leave blank to disable ; the auto-delete function ; comment out to turn off auto delete function. ; pegoutfile= e:\remote.out ; set serial port for the rotor here ; ports 1 to 16 are supported - serial port hardware MUST be present! ; set to 0 if no hardware present rotorport= 0 ; set the rotor type here (505AR for Kachina / HYGAIN for DCU1 or Rotor-EZ) rotortype= 505AR ; this sets the value of the IO port to use for external ; antenna and control relays ; lpt1(378H)=888, lpt2(278H)=632, lpt3(3BCH)=956 ; set to 0 if no hardware present ioaddress= 0 ; name or IP address of the web server this is ; running on It's used in the other files in ; several places. Entering it here makes it ; easier to get up and running ;server-192.168.1.1 server= your.server.here ; server operator's email address email= your.email@yourserver.com ; user time limit in seconds ; this is how long each user has to control the radio ; NOTE _ DOES NOT EFFECT THE AUDIO STREAM! ; this applies for ALL USERS! ; set value to 0 (ZERO) to disable this feature userlimit= 600 ; waittime is the number of seconds to give some else a chance ; to use the system after the time limit expires ; set value to 0 (ZERO) to disable thie feature waittime= 120 ; minimum transmit priv level (number from 1 to 9) ; this is the number after the password in the passwds.cdl file in ; each users's account setup txpriv= 2 ; txloop set to 1 will enable the Pegasus external amp control loop for ; amplifier keying an external relay is needed to key both the amp and the TX ; section of the Pegasus using this option - ; set to 0(ZERO) to disable using the external loop connections ; NOTE: The "normal" amplifier keying loop is NOT controlled from the Pegasus CPU Commands txloop= 0 ; minimum TX power level for external amplifier operation ; (number in WATTS) txampmin= 25 ; maximum TX power level for external amplifier operation ; (number in WATTS) txampmax= 75 ; force the external amp ON values are ; 0 (no amp) or 1 through 6 for the proper antenna port ; note - external amp forced ON if this antenna port is selected by user ; users CAN NOT OVERRIDE this setting forceamp= 0 ; force the Pegasus to a specific power level for the external amp ; number is power level in watts ; users CAN NOT OVERRIDE THIS SETTING ; also overrides tcampmin and txampmax above ; active ONLY if forceamp above is set greater than 0 (ZERO) forcepwr= 30 ; set default receiver bandwidth rxband= 2550 ; setup antenna variables here ; unused antenna ports can be commented out with a semicolon (;) ; NOTE REMOVE HTML CODE FOR UNUSED antenna ports in the pegasus.txt file ant1= B&W Folded Dipole 160 - 10 M ant2= Beam - 20, 15, 10 M ant3= Cushcraft R5 - 20,17,15,12,10 M ant4= Vertical - 160,80,40,20,15,10 M ant5= Antenna 5 ant6= Antenna 6 ; set up AUX relay values here ; unused aux relays can be sommented out with a semicolon (;) ; used for raleys connected to the PC's PARALLEL PORT ONLY aux1on= Aux1 On aux2on= Aux2 On aux1off= Aux1 Off aux2off= Aux2 Off ; external relay control for the Kachina rotor controller ; these variables are used in the freqpage.txt file to make re-defining relay ; functions easier. rl1on= ON rl1off= OFF rl2on= ON rl2off= OFF rl3on= ON rl3off= OFF rl4on= ON rl4off= OFF rl5on= ON rl5off= OFF While most of the items in the setup file are easy to change it's important to remember that the software uses the concept of KEYWORDS in the HTML files sent to the user. Some of the variables in the setup.cfg file define the text returned by keywords used in the HTML files. Things like the antenna descriptions and relay functions can be defined here and inserted into the HTML files by using the right keyword in the HTML file. This is done so the software can be customized for your particular application to a limited degree. When editing this file please remember that there are NO SPACES between the variable name and the "=" sign. Spaces there render the variable unreadable to the software. You need to set the server and email variables to values proper for your own operation. The server name can be the actual name (like phantom.ralabs.com) of your computer or it can be the TCP/IP address of the computer (like 192.168.12.124). This information is inserted into the various places in the support files as they are read to the user. The same is true of the email variable. It's inserted as needed into the various files as they are read out to the user. The login file: The file first displayed to a user accessing the system is the plogin.txt file. It looks like this "out of the box": Please note that some of the lines below are all on a single line in the actual file. They may appear on two lines due to format problems in the word processor used to prepare the documentation. N2JEU Remote Base - Software Test System

N2JEU Remote Base - Software Test System

Call Sign : Password :

Click To send

Return to home page You may edit the page as needed but PLEASE LEAVE THE FORM INTACT. The variable names are critical to the proper operation of the program. You'll note that server name in the form line is represented by the keyword ^server^. The keywords used in the various support files always begin and end with the "^" (carat) symbol. When the page is read by the program all of the keywords are translated into their respective information and sent to the user as HTML code by the program. When the user enters a login name and password not in the password file the program returns the NOACCESS.TXT file as a reply. It looks like this: ; this is the noaccess file. EDIT AS NEEDED. NOTE DO NOT CHANGE THE FORM VARIABLES BELOW! ; lines starting with a semi-colon are comments and are NOT sent to the user. N2JEU's Internet Remote Base

N2JEU's Internet Remote Base

Sorry, login name (^lname^) and password (^lpasswd^) you entered were not accepted by the system.
Please contact the system operator at ^lemail^ to resolve this problem.
Please include the login name and password you were using to try to access the system.


This file may be edited as needed. Note the use of more keywords to represent the login name and password the user entered and the keyword used to represent the system operator's email address. If the user enters a login name and password recognized by the system then they see the pegasus.txt file next. Here's what it may look like: ; lines startinf with a semi-coln (;) are comments and are NOT sent to the user ; this is the main page - PEGASUS.TXT ; edit the line containing ^server^ to point to your OWN CGI-BIN folder on ; your OWN WEB SERVER N2JEU's Web Controlled Ten-Tec Pegasus

N2JEU's Web Controlled Ten-Tec Pegasus

; lines below MUST REMAIN UNALTERED to store password and name between changes User: ^lname^ from ^lipaddr^ at ^ldtime^ UTC.
Transmitter Status: ^ltxstat^
System Information: ^lerror^
You have ^timeleft^ remaining in this session.
Please shut down the NetMeeting audio stream when your time expires.
NOTE: For page update - Leave the RX frequency box empty and hit the FREQUENCY CHANGE button below or select Refresh The Page from the System Mode box below. REMEMBER TO LOG OUT OF THE SYSTEM when you are finished using before yout time expires.

The transceiver is tuned to ^freqval^kHz RX, ^txfreq^Khz TX - Split mode is ^split^ in ^lmode^ mode.
; DO NOT ALTER THE VARIABLE NAMES OR CONTENTS OF THE FIELDS BELOW. DOING SO MAY BREAK ; THE SOFTWARE. RETAIN AN UNALTERED COPY OF THIS FILE TO COMPARE AGAINST THE ACTUAL IN-USE ; FILE IF YOU HAVE PROBLEMS WITH FEATURES NOT WORKING. USE THE VARIABLES IN PLACE OF ACTUAL ; TEXT WHEREVER POSSIBLE AND CHANGE THEIR VALUES IN THE PEGASUS.TXT FILE INSTEAD! Select System Mode:
Enter the Receive Freq(kHz): RX Fine Tune (+/- HZ): Split Freq. Mode:
Enter the Transmit Freq(kHz): TX Fine Tune (+/- HZ): Mode:
Enter TX Power (1 to 100 watts): External Amplifier:
Click on this button to

Select receive filter width(hz): Select AGC:
RX Atten: Noise Reduction: Noise Blanker(0=OFF): Auto Notch Filter:

Antenna and Aux function Controls (Relay board connected to PC's Parallel Port)
Select antenna: Aux 1 Relay: Aux 2 Relay:

; comment out these lines if you DO NOT have a Kachina rotor controller (505AR/505ARX) Support items for Kachina 505AR rotor controller
Antenna bearing (0 to 359 degrees):
Relay 1: Relay 2: Relay 3: Relay 4: Relay 5:

; uncomment line below for Hy-gain or Rotor-EZ controllers ;Antenna bearing (0 to 359 degrees):
Click on this button to

About the Filter Width: The AUTO mode lets the software select the bandwidth by the mode in use. You can change it by selecting a filter bandwidth from the pull-down list. Selecting a lower number will reduce interference at the expense of signal clarity. Going too far however will render signals un-usable. Feel free to experiment with this feature to see how it works. A tip: for SSB signals use the 2550 hz bandwidth setting to effectively reduce background noise.

About the AGC mode: The Fast AGC setting will respond quickly to voice signal peaks and sometimes causes noise peaks as the AGC tries to follow the signal. Using a Slow setting will reduce background noise and "pumping" on voice signals. The Medium position is selected as the default.

Enter the frequency in Kilohertz. For example:
 570 for WSYR in Syracuse, NY      620 for WHEN in Syracuse, NY
1600 for WMCR in Oneida, NY       9755 for Radio Canada International - various times

NOTE: You can enter fine tuning information for USB, LSB and CW by adding a
decimal point and up to 3 additional digits like this: 3825.125
The effective receiver frequency range is 100 Khz to 29999.999 Khz.

Have Some Suggestions or Comments?

Please send any suggestions or comments to: ^lemail^.
-------------------------------------------------------------------------------- Again, you can edit this as needed to personalize it for your needs. BE CAREFUL when making changes to the form however. The various names and keywords are critical to the program's operation and changes in this area can cause things to mis-function. If you do not have the Kachina rotor controller you can remove the items dealing with the rotor and relay functions without effecting the program's operation. Other items can be "removed" by turning them into hidden data fields. If you look you'll see two examples that store the login name and password so the system will recognize the user again when they submit the form for processing. The password file: The password file is a comma delimited ASCII file that can edited with the NOTEPAD program that comes with all 32 bit versions of Windows. The file name is passwdsp.cdl and it looks like this: N2JEU,wizard,2,g,1 GUEST,"guest",1,x,0 The first item on a line is the login name (user's call sign). The next iten is their password enclosed in quote signs. The number is an access level from 0 to 9. A 0 (ZERO) access level means the user is locked out of the system. Levels between 1 and 9 may be assigned as needed. Remember that there is a variable in the setup.cfg file that defines the minimum access level required to transmit. It's set at 2 in the distributed version of the setup.cfg file. The letter is the user's LICENSE CLASS. (See the license.cdl file description that follows). The final number is a 1 (ONE) or a 0 (ZERO) to indicate that the user can use an external amp if available. A 1 indicated that the amp can be used if allowed by the user's license class and antenna restrictions. A 0 indicates that no access to the amp is allowed under ANY circumstances. A note: Please make sure that this file DOES NOT CONTAIN BLANK LINES AT THE END. If you get errors from the program on execution by the web server software check this FIRST. The PLICENSE.CDL file: This file sets up the various license classes available and provides frequency and power amp restrictions for the software to meet FCC regulations. It looks like this: n,28300,28500,0 g,1800,2000,1 g,3850,4000,1 g,7225,7300,1 g,14225,14350,1 g,18110,18168,1 g,21300,21450,1 g,24930,24990,1 g,28300,29700,1 a,1800,2000,1 a,3775,4000,1 a,7150,7300,1 a,14175,14350,1 a,18110,18168,1 a,21225,21450,1 a,24930,24990,1 a,28300,29700,1 e,1800,2000,1 e,3750,4000,1 e,7150,7300,1 e,14150,14350,1 e,18110,18168,1 e,21200,21450,1 e,24930,24990,1 e,28300,29700,1 x,0,0,0 0,0,0,0 ; the line above MUST NOT BE ALTERED. It serves as an end of file marker. ; That's why you can't use 0 (zero) as one of the class indicators. ; ; this is the user rights file for the control software ; the format is: ; ; n,lower_freq,upper_freq,extamp ; : where - ; N = license class (letters from A to Z, numbers from 1 to 9 (case not inportant) ; lower_freq = lower frequency limit for the band in kilohertz ; upper_freq = upper frequency limit for the band in kilohertz ; extamp = 0 for no external amp, 1 to allow external amp (for FCC power level limits) ; suggested US allocations are in the standard file above ; N=Novice/Tech Plus ; G=General ; A=Advanced ; E=Extra ; ; note the line that starts with x is for a NO TRANSMIT ANYWHERE type account Again, this file can be edited for various needs. It currently contains the SSB frequencies for all FCC license classes having HF access as part of the license. Please see the comments in the file for format information. The PANTPORT.CDL file: We need a way to let the software know what bands each antenna covers and if it can handle the power of an extermal amp. This file defines all of that for the system. It looks like this: 1,3500,4000,1 1,7000,7300,1 1,14000,14350,1 1,21000,21450,1 1,28000,29700,1 2,0,0,0 0,0,0,0 ; the line above (0,0,0,0) MUST BE THERE as an end of table marker ; the format is: ; ; port number, lower freq limit, upper freq limit, external amp available (0=no or 1=yes) ; ; the frequencies are in kilohertz ; ; a zero on both frequency fields when a port has a single entry means that ; transmitting is disabled on that port. It is possible to configure this file so that there are multiple entries per band for an antenna. For example, you can set it up so the external amp may be used only be used on parts of a band where the SWR is low enough to permit proper operation of the amp. If a user attempts to tune to a band where the antenna can't handle the transmitter the software will disable the transmitter to prevent damage to the radio or the antenna. BE SURE TO CONFIGURE THIS FILE FOR YOUR ANTENNAS. IT'S CRITICAL! The plockout.cdl file: You can use this file to lock out frequencies or frequency ranges from the system. The file looks like this: 29998,29999 -1,-1 The first line locks out the range 29998 to 29999 KHZ. ALL FREQIENCIES IN THIS FILE ARE IN KILOHERTZ. The last line serves as an end of file marker and should be left in place. Ad any new entries BEFORE this line. There is a limit of 40 lines in this file. If a user enters a frequency in this file the locked.txt file is sent back to them. It looks like this: Frequency Lockout

Frequency Lockout

The frequency you have selected has been locked out either due to mis-use by users or because someone complained about offensive material on the frequency. The lockout may or may not be permanent.

Please direct any comments concerning this to: ^lemail^

Please hit your browser's BACK button to re-enter a different frequency.

This file can be edited as needed and should explain to the user why the frequency may be locked out. A link to email the system owner is included. Additional support files - pRotor.cdl and plastfreq.log are files maintained by the software to retain the last known settings for the radio and rotor. THEY MUST BE PRESENT FOR THE SOFTWARE TO FUNCTION. You do NOT need to edit or change these files. pegasus.log is a comma delimited ASCII file that maintains a list of the tuning done by users of the system. It can get rather large so you'll need to delete the file from time to time or use something like WINZIP to archive the file. This file is created by the software the first time it is run and entries are added to it each time the frequency or other paramaters are changed. The file DOES NOT need to be present for the software to work. It will be created or added to as needed. Starting the software: Use the following URL in the web browser after all of the files have been modified to fit your operation. http://your.server.here/cgi-bin/webradio.exe You may need to change the cgi-bin section to point to whatever directory is used by your server software to support standard CGI type programs. If you need help - Help is only available for questions relating DIRECTLY TO THIS SOFTWARE. If you are looking for help in configuring a web server, internet connection or writing HTML code then please seek local help. If you have questions about this software of it's configuration then here's how to get it: The best course is to send email with SPECIFIC INFORMATION to: n2jeu@ralabs.com I'll respond with return email with as much information and suggestions as I can provide. Please DO NOT CALL VIA TELEPHONE. If I need to turn to that type of help I'll arrange to get in touch with you through an email message. The meager documentation will certainly be changed and expanded over the next few weeks as users send in questions concerning the software. It will always be available on the web site in a download directory. Point your browser at: http://www.ralabs.com/remote/ to see what is available.