@@ -21,57 +21,58 @@ also handle formatting of CAT commands and their associated parameters,

 while 'get' functions handle parsing of data returned from CAT commands

 that return status information.

-Email bug reports and comments to: fractal@intravisions.com

+Email bug reports and comments to: ka7jlo@gmail.com

 Notes

 -----

 1. The files ft991utility.py and ft991.py should be downloaded from the

    github repository and placed in the same folder.

-2. To run the utility, open a terminal session in directory containing

+2. Before running the utility you may need to edit line 39 or line 40 in

+   the "environment setup" section of the file "ft991utility.py".  Be sure

+   the com port is correct.  This will depend on whether you are running

+   Linux or Windows and on the default serial port assigned to the FT991.  

+3. To run the utility, open a terminal session in directory containing

    the ft991utility.py and ft991.py files.  Then simply type the utility

    file name after the command line prompt, e.g.,

        ~$ ./ft991utility.py

    If necessary, change the permissions on ft991utility.py to allow the file

-   to be run as an executable.  To change the permissions run the command

-       chmod +x ft991utility.py

-3. Windows users will need to have the python 2.7 framework installed.

+   to be run as an executable.  To change the permissions on Linux run the

+   command

+       ~$ chmod +x ft991utility.py

+4. Windows users will need to have the python 3.8 framework installed.

    Probably, the easiest way to get the framework is to install the

    Windows Subsystem for Linux Ubuntu platform.  Note that the utility

-   has not been tested on Windows and the developer makes no guarentees.

-4. While it is possible to run the utility completely from the command

-   line using options, beginning users are encouraged to use the

-   interactive mode.  To use the interactive mode simply type the file

+   has not been tested on Windows and the developer makes no guarantees.

+5. While it is possible to run the utility completely from the command

+   line using command line options, beginning users are encouraged to use

+   the interactive mode.  To use the interactive mode simply type the file

    name of the utility with no command line arguments, e.g.,

            ./ft991utility.py

-5. The utility saves memory settings in a comma-delimited file that

+6. The utility saves memory settings in a comma-delimited file that

    can be imported into a spreadsheet application for ease in viewing

-   and editing.  A LibreOffice Calc template 'ft991_memory_settings.ots'

-   has been provided to facilitate creating a spreadsheet to upload memory

-   settings to the FT991.

-6. The verbose mode, available both as a command line option and in

+   and editing.

+7. The verbose mode, available both as a command line option and in

    interactive mode, echos raw commands sent to the FT991, as well as

    raw status returned by the FT991.  This feature is useful for development

    and debugging purposes.

-7. If you already have repeater frequencies and such programmed

+8. If you already have repeater frequencies and such programmed

    in memory, you should first run the 'bm' command in interactive mode

    to back up your current memory settings.  Unless you change the default

    file name, this file should appear in your current working directory as

    'ft991mem.csv'.  Change this file name to something else such as

    'ft991mem_todaysDate.csv so that you can restore from this file at a

    later date if necessary.

-8. By the same token you should immediately back up your menu settings using

+9. By the same token you should immediately back up your menu settings using

    the 'bu' command in interactive mode.  The default file name is

    'ft991menu.cfg'.  Likewise change this file name to something else.

-9. The example file 'example.csv' shows how a memory settings file should

-   appear.  To load these settings in your FT991, run the 'rm' command in

-   interactive mode.  When prompted to enter a file name type 'example.csv'. 

-   For example,

-       Enter file name or <CR> for default: example.csv

-10. Backup and restore of split frequency memory settings is not yet implemented.

-    The 'Tx Frequency' and 'Offset' columns in the memory settings file should

-    be left blank.

-11. Please do not edit the menu settings file unless you absolutely know

+10. The example file 'example.csv' shows how a memory settings file should

+    appear.  To load these settings in your FT991, run the 'rm' command in

+    interactive mode.  When prompted to enter a file name type 'example.csv'. 

+    For example,

+        Enter file name or <CR> for default: example.csv

+11. Backup and restore of VHF/UHF split frequency repeater settings is not

+    supported by the FT991.

+12. Please do not edit the menu settings file unless you absolutely know

     what you are doing.  There should rarely be a need to edit this file.

     Menu changes should be made on the FT991, itself, and then backed up.

-

@@ -1,4 +1,4 @@

-#!/usr/bin/python -u

+#!/usr/bin/python3 -u

 # The -u option turns off block buffering of python output. This assures

 # that output streams to stdout when output happens.

 #

@@ -31,11 +31,12 @@

 #

 # Revision History

 #   * v10 24 Nov 2019 by J L Owrey; first release

+#   * v11 03 Oct 2020 by J L owrey; upgraded to Python 3

 #

 # This script has been tested with the following

 #

-#     Python 2.7.15rc1 (default, Nov 12 2018, 14:31:15) 

-#     [GCC 7.3.0] on linux2

+#     Python 3.8.10 (default, Mar 15 2022, 12:22:08) 

+#     [GCC 9.4.0] on linux

 #2345678901234567890123456789012345678901234567890123456789012345678901234567890

 import sys, serial, time

@@ -68,7 +69,7 @@ dMode = { 'LSB':'1', 'USB':'2', 'CW':'3', 'FM':'4', 'AM':'5',

 dShift = { 'OFF':'0', '+RPT':'1', '-RPT':'2' }

 # Power settings

-dPower = { 'LOW':5, 'MID':020, 'HIGH':50, 'MAX':100 }

+dPower = { 'LOW':'5', 'MID':'020', 'HIGH':'50', 'MAX':'100' }

 # Repeater signaling modes

 dEncode = { 'OFF':'0', 'ENC/DEC':'1', 'TONE ENC':'2',

@@ -154,11 +155,11 @@ def getMemory(memloc):

     dMem['memloc'] = str(int(memloc))

     dMem['vfoa'] = str(float(vfoa) / 10**6)

     dMem['clarfreq'] = str(int(clarfreq))

-    dMem['rxclar'] = bState.keys()[bState.values().index(rxclar)]

-    dMem['txclar'] = bState.keys()[bState.values().index(txclar)]

-    dMem['mode'] = dMode.keys()[dMode.values().index(mode)]

-    dMem['encode'] = dEncode.keys()[dEncode.values().index(encode)]

-    dMem['rpoffset'] = dShift.keys()[dShift.values().index(rpoffset)]

+    dMem['rxclar'] = list(bState.keys())[list(bState.values()).index(rxclar)]

+    dMem['txclar'] = list(bState.keys())[list(bState.values()).index(txclar)]

+    dMem['mode'] = list(dMode.keys())[list(dMode.values()).index(mode)]

+    dMem['encode'] = list(dEncode.keys())[list(dEncode.values()).index(encode)]

+    dMem['rpoffset'] = list(dShift.keys())[list(dShift.values()).index(rpoffset)]

     dMem['tag'] = tag.strip()

     return dMem

@@ -173,7 +174,7 @@ def getCTCSS():

     # Get result CTCSS tone

     sResult = sendCommand('CN00;')

     tone = sResult[4:7]

-    return dTones.keys()[dTones.values().index(tone)]

+    return list(dTones.keys())[list(dTones.values()).index(tone)]

 ## end def

 def getDCS():

@@ -185,7 +186,7 @@ def getDCS():

     # Get result of CN01 command

     sResult = sendCommand('CN01;')

     dcs = sResult[4:7]

-    return dDcs.keys()[dDcs.values().index(dcs)]

+    return list(dDcs.keys())[list(dDcs.values()).index(dcs)]

 ## end def

 def getRxClarifier():

@@ -198,7 +199,7 @@ def getRxClarifier():

     # supplied - most likely a "key not found" error.

     sResult = sendCommand('RT;')

     state = sResult[2]

-    return bState.keys()[bState.values().index(state)]

+    return list(bState.keys())[list(bState.values()).index(state)]

 ## end def

 def getTxClarifier():

@@ -211,7 +212,7 @@ def getTxClarifier():

     # supplied - most likely a "key not found" error.

     sResult = sendCommand('XT;')

     state = sResult[2]

-    return bState.keys()[bState.values().index(state)]

+    return list(bState.keys())[list(bState.values()).index(state)]

 ## end def

 def getPower():

@@ -233,7 +234,7 @@ def getPreamp():

     # Get result of PA0 command

     sResult = sendCommand('PA0;')

     ipo = sResult[3:4]

-    return dPreamp.keys()[dPreamp.values().index(ipo)]

+    return list(dPreamp.keys())[list(dPreamp.values()).index(ipo)]

 ## end def

 def getRfAttn():

@@ -246,7 +247,7 @@ def getRfAttn():

     if sResult == '?;':

         return 'NA'

     attn = sResult[3:4]

-    return bState.keys()[bState.values().index(attn)]

+    return list(bState.keys())[list(bState.values()).index(attn)]

 ## end def

 def getNoiseBlanker():

@@ -257,7 +258,7 @@ def getNoiseBlanker():

     """

     sResult = sendCommand('NB0;')

     nb = sResult[3:4]

-    return bState.keys()[bState.values().index(nb)]

+    return list(bState.keys())[list(bState.values()).index(nb)]

 ## end def

 def getIFshift():

@@ -324,7 +325,7 @@ def getDNRstate():

     if sResult == '?;':

         return 'NA'

     state = sResult[3:4]

-    return bState.keys()[bState.values().index(state)]

+    return list(bState.keys())[list(bState.values()).index(state)]

 ## end def

 def getDNRalgorithm():

@@ -348,7 +349,7 @@ def getDNFstate():

     if sResult == '?;':

         return 'NA'

     state = sResult[3:4]

-    return bState.keys()[bState.values().index(state)]

+    return list(bState.keys())[list(bState.values()).index(state)]

 ## end def

 def getNARstate():

@@ -361,7 +362,7 @@ def getNARstate():

     if sResult == '?;':

         return 'NA'

     state = sResult[3:4]

-    return dNAR.keys()[dNAR.values().index(state)]

+    return list(dNAR.keys())[list(dNAR.values()).index(state)]

 ## end def

 def getNotchState():

@@ -376,7 +377,7 @@ def getNotchState():

     if sResult == '?;':

         return ('NA', 'NA')

     state = sResult[6:7]

-    state = bState.keys()[bState.values().index(state)]

+    state = list(bState.keys())[list(bState.values()).index(state)]

     sResult = sendCommand('BP01;')

     freq = int(sResult[4:7])

     return (state, freq)

@@ -792,7 +793,7 @@ def sendCommand(sCmd):

     # correct formatting of commands before they are actually sent

     # to the FT991.

     if verbose:

-        print sCmd,

+        print(sCmd, end='')

     # In debug mode do not actually send commands to the FT991.

     if debug:

         return ''

@@ -804,7 +805,7 @@ def sendCommand(sCmd):

     sendSerial(sCmd)

     sResult  = receiveSerial();

     if verbose:

-        print sResult

+        print(sResult)

     return sResult

 ## end def

@@ -812,7 +813,7 @@ def sendCommand(sCmd):

 # Low level serial communications functions.                                #

 #############################################################################

-def begin(baud=9600):

+def begin(comPort, baud=9600):

     """

     Description: Initiates a serial connection the the FT991. Should

                  always be called before sending commands to or

@@ -823,28 +824,21 @@ def begin(baud=9600):

     """

     global ptrDevice

-    # Determine OS type and set device port accordingly.

-    OS_type = sys.platform

-    if 'WIN' in OS_type.upper():

-        port = 'COM5'

-    else:

-        port = '/dev/ttyUSB0'

-

     # In debug mode do not actually send commands to the FT991.

     if debug:

         return

     # Create a FT991 object for serial communication

     try:

-        ptrDevice = serial.Serial(port, baud,      

+        ptrDevice = serial.Serial(comPort, baud,      

                                   timeout=_INTERFACE_TIMEOUT)

-    except Exception, error:

+    except Exception as error:

         if str(error).find('could not open port') > -1:

-            print 'Please be sure the usb cable is properly connected to\n' \

+            print('Please be sure the usb cable is properly connected to\n' \

                   'your FT991 and to your computer, and that the FT991 is\n' \

-                  'turned ON.  Then restart this program.'

+                  'turned ON.  Then restart this program.')

         else:

-            print 'Serial port error: %s\n' % error

+            print('Serial port error: %s\n' % error)

         exit(1)         

     time.sleep(.1) # give the connection a moment to settle

     return ptrDevice

@@ -874,9 +868,14 @@ def receiveSerial(termchar=';'):

             if time.time() - startTime > _SERIAL_READ_TIMEOUT:

                 break # Character waiting timer has timed out.

         # Return empty string if a character has not become available.

-        if c == '':

+        if c == '' or c == b'\xfe':

             break;

-        answer += c # Form a string from the received characters.

+        try:

+            # Form a string from the received characters.

+            answer += c.decode('utf_8')

+        except Exception as e:

+            print('serial rx error: %s' % e)

+        #answer += str(c) # Form a string from the received characters.

         charCount += 1 # Increment character count.

         # If a semicolon has arrived then the FT991 has completed

         # sending output to the serial port so stop reading characters.

@@ -898,7 +897,7 @@ def sendSerial(command):

     # In debug we only want to see the output of the command formatter,

     # not actually send commands to the FT991.  Debug mode should be

     # used in conjunction with verbose mode.

-    ptrDevice.write(command) # Send command string to FT991

+    ptrDevice.write(command.encode('utf_8')) # Send command string to FT991

     ptrDevice.flushOutput() # Flush serial buffer to prevent overflows

 ## end def

@@ -918,8 +917,16 @@ def main():

     verbose = True

     debug = False

+    # Determine OS type and set device port accordingly.

+    OS_type = sys.platform

+    if 'WIN' in OS_type.upper():

+        port = 'COM5'

+    else:

+        port = '/dev/ttyUSB0'

+

     # Instantiate serial connection to FT991

-    begin()

+    begin(port, 9600)

+

     # Set and receive a memory channel

     dMem = {'memloc': '98', 'vfoa': '146.52', 'shift': 'OFF', \

             'mode': 'FM', 'encode': 'TONE ENC', 'tag': 'KA7JLO', \

deleted file mode 100644

Binary files a/ft991/ft991utility/ft991_memory_settings.ots and /dev/null differ

@@ -1,4 +1,4 @@

-#!/usr/bin/python -u

+#!/usr/bin/python3 -u

 # The -u option turns off block buffering of python output. This assures

 # that output streams to stdout when output happens.

 #

@@ -25,14 +25,21 @@

 #    along with this program.  If not, see http://www.gnu.org/license.

 #

 # Revision History

-#   * v10 23 Nov 2019 by J L Owrey; first release

+#   * v10 24 Nov 2019 by J L Owrey; first release

+#   * v11 03 Oct 2020 by J L owrey; upgraded to Python 3

 #

 # This script has been tested with the following

 #

-#     Python 2.7.15rc1 (default, Nov 12 2018, 14:31:15) 

-#     [GCC 7.3.0] on linux2

+#     Python 3.8.10 (default, Mar 15 2022, 12:22:08) 

+#     [GCC 9.4.0] on linux

 #2345678901234567890123456789012345678901234567890123456789012345678901234567890

+# Environment Setup

+

+_WINDOWS_COM_PORT = 'COM5'

+_LINUX_COM_PORT = '/dev/ttyUSB0'

+_FT991_BAUD_RATE = 9600

+

 import os, sys, serial, time

 import ft991 # module should be in same directory as this utility

@@ -67,7 +74,7 @@ def doUserCommand():

     # When command line arguments have not been provided,

     # use interactive mode and give the user a prompt.

     if commandLineOption == '':

-        cmd = raw_input('>').strip()

+        cmd = input('>').strip()

     # If command line arguments have been provided, then

     # execute the command non-interactively.

     else:

@@ -93,7 +100,7 @@ def doUserCommand():

     elif cmd == 'x':

         exit(0)

     else:

-        print "invalid command"

+        print("invalid command")

 ## end def

 def backupMemorySettings():

@@ -108,11 +115,11 @@ def backupMemorySettings():

     # backed up memory settings.

     fileName = getFileName(memoryBackupFile)

     # Read the memory settings from the FT991...

-    print 'Backing up memory settings...'

+    print('Backing up memory settings...')

     settings = readMemorySettings()

     # and write them to the file.

     writeToFile(settings, fileName)

-    print 'Memory settings backed up to \'%s\'' % fileName

+    print('Memory settings backed up to \'%s\'' % fileName)

 ## end def

 def restoreMemorySettings():

@@ -127,16 +134,16 @@ def restoreMemorySettings():

     # memory settings.  Also make sure the file exists.

     fileName = getFileName(memoryBackupFile)

     if not os.path.isfile(fileName):

-        print 'File not found.\n' \

+        print('File not found.\n' \

               'Please enter a valid file name.  Be sure to correctly ' \

-              'enter\nthe full path name or relative path name of the file.'

+              'enter\nthe full path name or relative path name of the file.')

         return

     # Read the memory settings from the file...

-    print 'Restoring memory settings...'

+    print('Restoring memory settings...')

     settings = readFromFile(fileName)

     # and write them to the FT991.

     writeMemorySettings(settings)

-    print 'Memory settings restored from \'%s\'' % fileName

+    print('Memory settings restored from \'%s\'' % fileName)

 ## end def

 def backupMenuSettings():

@@ -151,11 +158,11 @@ def backupMenuSettings():

     # backed up menu settings.

     fileName = getFileName(menuBackupFile)

     # Read the menu settings from the FT991...

-    print 'Backing up menu settings...'

+    print('Backing up menu settings...')

     settings = readMenuSettings()

     # and write them to the file.

     writeToFile(settings, fileName)

-    print 'Menu settings backed up to \'%s\'' % fileName

+    print('Menu settings backed up to \'%s\'' % fileName)

 ## end def

 def restoreMenuSettings():

@@ -170,16 +177,16 @@ def restoreMenuSettings():

     # menu settings.  Also make sure the file exists.

     fileName = getFileName(menuBackupFile)

     if not os.path.isfile(fileName):

-        print 'File not found.\n' \

+        print('File not found.\n' \

               'Please enter a valid file name.  Be sure to correctly ' \

-              'enter\nthe full path name or relative path name of the file.'

+              'enter\nthe full path name or relative path name of the file.')

         return

     # Read the menu settings from the file...

-    print 'Restoring menu settings...'

+    print('Restoring menu settings...')

     settings = readFromFile(fileName)

     # and write them to the FT991.

     writeMenuSettings(settings)

-    print 'Menu settings restored from \'%s\'' % fileName

+    print('Menu settings restored from \'%s\'' % fileName)

 ## end def

 def passThroughMode():

@@ -190,11 +197,11 @@ def passThroughMode():

     Parameters: none

     Returns: nothing

     """

-    print 'Entering passthrough mode. Type \'exit\' to exit mode.'

+    print('Entering passthrough mode. Type \'exit\' to exit mode.')

     while(True):

         # Prompt the user to enter an FT991 CAT command, and

         # process the  command string.

-        sCommand = raw_input('CAT# ').upper()

+        sCommand = input('CAT# ').upper()

         if sCommand == 'EXIT': # exit this utility

             break

         # If the user fails to end a CAT command with a semi-colon,

@@ -208,7 +215,7 @@ def passThroughMode():

             ft991.sendSerial(sCommand)

             sResult = ft991.receiveSerial();

             if sResult != '':

-                print sResult

+                print(sResult)

 ## end def

 def toggleVerboseMode():

@@ -222,10 +229,10 @@ def toggleVerboseMode():

     """

     if ft991.verbose:

         ft991.verbose = False

-        print 'Verbose is OFF'

+        print('Verbose is OFF')

     else:

         ft991.verbose = True

-        print 'Verbose is ON'  

+        print('Verbose is ON')  

 ## end def

 def getFileName(defaultFile):

@@ -242,7 +249,7 @@ def getFileName(defaultFile):

     if commandLineOption != '':

         return defaultFile

     # Otherwise query the user for a file name

-    fileName = raw_input('Enter file name or <CR> for default: ')

+    fileName = input('Enter file name or <CR> for default: ')

     if fileName == '':

         return defaultFile

     else:

@@ -366,11 +373,11 @@ def writeMemorySettings(lSettings):

             ft991.setNARstate(dItem['narstate'])

             # Set Notch state

             ft991.setNotchState((dItem['notchstate'], dItem['notchfreq']))

-        except Exception, e:

-            print 'Memory settings restore operation failed. Most likely\n' \

+        except Exception as e:

+            print('Memory settings restore operation failed. Most likely\n' \

                   'this is due to the backup settings file corrupted or\n' \

-                  'incorrectly formatted. Look for the following error: \n'

-            print e

+                  'incorrectly formatted. Look for the following error: \n')

+            print(e)

             raise

             #exit(1)

     # end for

@@ -411,7 +418,7 @@ def writeMenuSettings(lSettings):

         # Send the pre-formatted menu setting to the FT991.

         sResult = ft991.sendCommand(item)

         if sResult.find('?;') > -1:

-            print 'error restoring menu setting: %s' % item

+            print('error restoring menu setting: %s') % item

             exit(1)

 ## end def

@@ -486,7 +493,7 @@ p - enter pass through mode

 v - toggle verbose mode

 x - exit this program

 """

-    print splash

+    print(splash)

 ## end def

 def getCLarguments():

@@ -518,7 +525,7 @@ def getCLarguments():

         if sys.argv[index] == '-f': # Backup file provided.

             # Get the backup file name.

             if len(sys.argv) < index + 2:

-                print "-f option requires file name"

+                print("-f option requires file name")

                 exit(1);

             fileName = sys.argv[index + 1]

             index += 1

@@ -535,7 +542,7 @@ def getCLarguments():

         elif sys.argv[index] == '-d': # set debug mode 'ON'

             ft991.debug = True

         else:

-            print usage

+            print(usage)

             exit(-1)

         index += 1

     ## end while

@@ -553,8 +560,16 @@ def main():

     Returns: nothing

     """

     getCLarguments() # get command line options

-    

-    ft991.begin() # open com port session to FT991

+

+    # Determine OS type and set device port accordingly.

+    #OS_type = sys.platform

+    #if 'WIN' in OS_type.upper():

+    if 'WIN' in sys.platform.upper():

+        port = _WINDOWS_COM_PORT

+    else:

+        port = _LINUX_COM_PORT

+

+    ft991.begin(port, _FT991_BAUD_RATE) # open com port session to FT991

     # Process command line options (if any).

     if commandLineOption != '':