                           tk2

             Copyright 2001 - 2004, Bob Parnass
                      2350 Douglas Rd
                 Oswego, IL 60543-9794 USA
                      http://parnass.com

tk2 is open source software designed for the ICOM IC-R2
receiver.

I implemented tk2 in the Tcl/Tk scripting language which
enables it to run on a variety of operating systems,
including Linux, MacOS X, BSD, Solaris, Unix, Microsoft
Windows (95 and later), etc.

The free Tcl/Tk interpreter software, version 8.4 or later,
must be installed on your computer prior to using tk2.

If you are running Windows, upgrading your Tcl/Tk software
from an earlier version, and using my other tk radio programs,
you may have to update them to use the new Tcl/Tk version.
The update is a simple one line change to a .bat file.

If you use tk3, for example, look at the C:\tk3\tk3.bat file.
Change the last line of that file from:
"C:\tcl\bin\wish83.exe"  "C:\tk3\tk3.tcl" 
to
"C:\tcl\bin\wish.exe"  "C:\tk3\tk3.tcl"
 

tk2 and Tcl/Tk installation instructions may be found on the web at
http://parnass.com

Please become familiar with the IC-R2 and ICOM's instruction
manual before using tk2.

                          Notes


The Linux version of tk2 presumes the wish windowing shell
is in your PATH.



                          License

tk2 is neither shareware nor in the public domain.  It is
a copyrighted work; you can redistribute it and/or modify it
under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

tk2 is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
the GNU General Public License for more details.

You should have received a file named "COPYING" which
contains a copy of the GNU General Public License along with
tk2; if not, write to the Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307  USA


			Acknowledgments

Some of the Tcl/Tk procedures used in tk2 were devised by
other authors and their contributions are marked accordingly
within the source code.


                     Bob Parnass, AJ9S
                       March 20, 2003



USAGE NOTES

Obtain the proper TTL-to-RS232 adapter for mating the
computer to the receiver.  Do not use a direct connect
cable.  I use the adapter sold by RT Systems (http://rtsars.com).

In general, it's a good idea to connect the computer and radio
while the power to both is off.  It's inconvenient to turn the PC
off and on just to disconnect the radio so I use a serial port
switch box which connects my PC's serial port to one of four
devices and merely switch the radio in and out of the line.

If you are running Windows, you must reboot your PC
after downloading and installing the software on your computer,

When you first start the program, you will asked to identify
which serial port is connected to the radio. (If you ever
relocate the radio to a different serial port,
you should remove the tk2.ini file and restart tk2.
tk2 will recreate the tk2.ini file for you).

Once you've identified the proper serial port,
tk2 will open a couple of windows and display what
looks like a few forms.

This version of tk2 supports the USA and other version radios.
Use the Radio pulldown menu and select "Model with 9 kHz
BCB steps" or "Model with 10 kHz BCB steps," depending
on which version radio you have.  The USA and Canadian versions
employ 10 kHz steps in the AM Broadcast Band.

Important: Before trying to reprogram your radio, you should first
read the image from your radio using the
Radio --> Read from radio...
menus and save it in a file using the
File --> Save As...
menus.  You can name is something like "original.tr2".
Back up this file.

There are two ways to view memory channel settings:
in a tabbed notebook or in a scrolled window.
You can choose between them using the View pulldown menu.

The tabbed notebook is the default, but it requires more
memory and causes tk2 to run more slowly.  If you have
an older computer or less than 512 MB of RAM, or have
problems with the tabbed notebook window not appearing
clearly on your screen, you may wish to choose the
scrolled window display instead.

You can change the memory settings within tk2 if you use
the tabbed notebook, but the scrolled window only permits
you to view the memory settings. (In both cases, you can
edit the memory channel data outside tk2 by exporting
the data to a .csv file.)

Once data has been read from the radio,
you can then export the memory channel information to
a .csv file, using the File --> Export memory channels menu.
Exit tk2.

You can use a text editor or spreadsheet
program to change or pretty-print the data in the .csv file.
Just be sure to write the data out in .csv format again.

You can restart tk2 and read the memory image file
(original.tr2 or whatever you named it) you created earlier,
using the File --> Open menus.

You can then view and change any of the settings.
If you have changed any of the memory channel data
in the .csv file, import it into tk2 using the
File --> Import memory channels menu.

You can check for errors in the data by using the
Data --> Validate menu.

If there are no errors, you should write the information
to a new image file (file name ends in .tr2) using the
File --> Save As menu.

You can now program your radio using the
Radio --> Write to radio menu.

Note:  You cannot both read from and write to the radio
during the same tk2 session.




IMPORTING A FREQUENCY LIST FROM A .CSV FILE

Start the program.

Read in an image file (.tr2 extension) using

File -> Open

Import the memory channel information from
your .csv file using:

File -->  Import Memory Channels


Save the updated image in a new .tr2 file using
File --> Save As ...

Write the new image to the radio using

Radio --> Write to radio

After the cloning is complete, you should power off the IC-R2.

OTHER NOTES

Before writing a memory image to the radio, tk2 validates
the data, encodes the image, then writes the data. 
You can validate the data and encode the image without
writing to the radio using the Data pulldown menu, though
that's unnecessary and useful chiefly for debugging tk2.

All Limit Search banks are set to Simplex, with an offset
of 0 MHz, and Tone Squelch off.  A future version of tk2 may
provide user control of these fields.

A setting of "Hide" in the Skip field means that the memory
channel will be deleted without moving the higher channels
downward.

All memory channel labels will be cleared when reading a memory
image from the radio.

Due to a quirk in ICOM's IC-R2 firmware design, only the
lower and upper frequency fields are used when starting
a limit search. The following fields in the Limit Search banks are
not used when starting a limit search: mode, step, tone squelch,
CTCSS, duplex, skip.

Instead, the IC-R2 uses the settings from the relevant bandstacking
register (VFO).  A popular workaround is to recall a Search Limit bank
to the VFO before starting a search.  That operation copies all
the Limit Search settings to the bandstacking register.
