Release 1.0

Author: aa2il

Release_Notes.txt

@@ -0,0 +1,27 @@
+pyKeyer - by AA2IL
+----------------------
+
+A CW contest keyer and logger in written Python.
+Also can be used as a sending and receiving CW trainer.
+
+This app is written in python 3.  The python script pyKeyer.py can be run under linux or windoz 10/11. You will also need the libraries in github.com/aa2il/libs and to installed the python modules listed in "requirements.txt".
+
+Stand-alone execuatables for linux and windoz 10/11 have been made using pyinstaller.  Complete source code and build files are available at https://github.com/aa2il/wclock .
+
+Please email constructive comments/suggestions to aa2il AT arrl DOT net.
+
+Windows Installer:  pyKeyer_setup.exe
+
+After installation, double click the desktop shortcut or open a command prompt (cmd.exe) and execute "C:\Program Files (x86)\AA2IL\pyKeyer.exe".
+
+Known issues:
+
+- Rig control is not yet available under windoz.  (All capabilities are avaiable under linux.)
+
+------------------------------------------------------------------------------
+
+Revision history:
+
+Version 1.0 - Jan. 2023
+
+This is the first version-controlled release.

cwt.py

@@ -220,7 +220,7 @@ def enable_boxes(self,gui):
         gui.name_lab.grid(columnspan=cspan,column=col)
         gui.name.grid(column=col,columnspan=cspan)
         col+=cspan
-        cspan=1
+        cspan=2
         gui.exch_lab.grid(columnspan=cspan,column=col)
         gui.exch.grid(column=col,columnspan=cspan)
 

dist/pyKeyer.iss

@@ -2,7 +2,7 @@
 ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
 
 #define MyAppName "pyKeyer"
-#define MyAppVersion "1..0.0"
+#define MyAppVersion "1..0"
 #define MyAppPublisher "AA2IL"
 #define MyAppURL "https://github.com/aa2il/pyKeyer"
 #define MyAppExeName "pyKeyer.exe"

gui.py

@@ -69,6 +69,7 @@
 from utilities import cut_numbers,freq2band
 import platform
 import pyautogui
+from utilities import find_resource_file
 
 ############################################################################################
 
@@ -118,7 +119,8 @@ def __init__(self,P):
             self.splash.overrideredirect(1)
             self.splash.geometry('+500+500')
 
-        pic = tk.PhotoImage(file='keyer_splash.png')
+        fname=find_resource_file('keyer_splash.png')
+        pic = tk.PhotoImage(file=fname)
         lab = tk.Label(self.splash, bg='white', image=pic)
         lab.pack()
         self.root.withdraw()
@@ -175,7 +177,7 @@ def construct_gui(self):
         # Open simple log file & read its contents
         # It probably time to jetison this & just use the adif file 
         MY_CALL = P.SETTINGS['MY_CALL']
-        fname = P.DATA_DIR+MY_CALL.replace('/','_')+".LOG"
+        fname = P.WORK_DIR+MY_CALL.replace('/','_')+".LOG"
         self.log_book = []
         print('Opening log file',fname,'...')
         if not os.path.exists(fname):
@@ -208,7 +210,7 @@ def construct_gui(self):
 
         # Read adif log also
         if P.LOG_FILE==None:
-            P.LOG_FILE = P.DATA_DIR+MY_CALL.replace('/','_')+".adif"
+            P.LOG_FILE = P.WORK_DIR+MY_CALL.replace('/','_')+".adif"
         if P.USE_ADIF_HISTORY:
             print('fname_adif=',P.LOG_FILE)
             qsos = parse_adif(P.LOG_FILE,upper_case=True,verbosity=0)
@@ -229,7 +231,7 @@ def construct_gui(self):
         print("GUI: ADIF file name=", self.fp_adif) 
 
         # Also save all sent text to a file
-        self.fp_txt = open(P.DATA_DIR+MY_CALL.replace('/','_')+".TXT","a+")
+        self.fp_txt = open(P.WORK_DIR+MY_CALL.replace('/','_')+".TXT","a+")
 
         # Create pop-up window for Settings and Paddle Practice - Need these before we can create the menu
         self.SettingsWin = SETTINGS_GUI(self.root,self.P)
@@ -1424,7 +1426,7 @@ def SaveState(self):
                'freqs'      : frqs,
                'fields'     : flds }
         print('STATE=',STATE)
-        with open('state.json', "w") as outfile:
+        with open(self.P.WORK_DIR+'state.json', "w") as outfile:
             json.dump(STATE, outfile)
         if False:
             with open('keyer.log', "a") as outfile2:
@@ -1448,7 +1450,7 @@ def ClearState(self):
     # Restore program state
     def RestoreState(self):
         try:
-            with open('state.json') as json_data_file:
+            with open(self.P.WORK_DIR+'state.json') as json_data_file:
                 STATE = json.load(json_data_file)
             print('STATE=',STATE)
             now = datetime.utcnow().replace(tzinfo=UTC)

paddling.py

@@ -92,7 +92,7 @@ def __init__(self,root,P):
 
         # Read Book
         self.Book = read_text_file('Book.txt',KEEP_BLANKS=False)
-        
+
         # Form list of calls - just use what we loaded from the master list
         self.calls = P.calls
         self.Ncalls = len(self.calls)

params.py

@@ -108,8 +108,8 @@ def __init__(self):
                               help='Sidetone Osc')
         arg_proc.add_argument('-split', action='store_true',
                               help='Split Text Window')
-        arg_proc.add_argument('-nohints', action='store_true',
-                              help='No hints')
+        arg_proc.add_argument('-hints', action='store_true',
+                              help='Show hints')
         arg_proc.add_argument('-capture', action='store_true',
                               help='Record Rig Audio')
         arg_proc.add_argument('-force', action='store_true',
@@ -183,7 +183,7 @@ def __init__(self):
         self.AUTOFILL      = args.autofill
         self.PRACTICE_MODE = args.practice or args.rig[0]=="NONE"
         self.ADJUST_SPEED  = args.adjust and args.practice
-        self.NO_HINTS      = args.nohints
+        self.NO_HINTS      = not args.hints
         self.CA_ONLY       = args.ca_only
         self.WPM           = args.wpm
         self.INIT_MODE     = args.mode
@@ -262,7 +262,7 @@ def __init__(self):
         elif args.skcc:
             self.contest_name='SKCC'
             MAX_AGE_HOURS=2
-            self.SHOW_TEXT_BOX2=True
+            #self.SHOW_TEXT_BOX2=True
         elif args.calls:
             self.contest_name='RANDOM CALLS'
             MAX_AGE_HOURS=2
@@ -315,18 +315,18 @@ def __init__(self):
         elif args.sat:
             self.contest_name='SATELLITES'
             MAX_AGE_HOURS=9999
-            self.SHOW_TEXT_BOX2=True
+            #self.SHOW_TEXT_BOX2=True
         elif args.ragchew:
             self.contest_name='Ragchew'
             MAX_AGE_HOURS=9999
-            self.SHOW_TEXT_BOX2=True
+            #self.SHOW_TEXT_BOX2=True
         elif args.dx:
             self.contest_name='DX-QSO'
-            self.SHOW_TEXT_BOX2=True
+            #self.SHOW_TEXT_BOX2=True
             MAX_AGE_HOURS=9999
         else:
             self.contest_name='Default'
-            self.SHOW_TEXT_BOX2=True
+            #self.SHOW_TEXT_BOX2=True
         self.ROTOR_CONNECTION = args.rotor
         self.PORT9            = args.port9
         self.Immediate_TX     = args.immediate
@@ -355,12 +355,20 @@ def __init__(self):
         self.HIST_DIR=os.path.expanduser('~/'+MY_CALL2+'/')
         if not os.path.isdir(self.HIST_DIR):
             fname=find_resource_file('master.csv')
-            self.HIST_DIR=os.path.dirname(fname)
+            self.HIST_DIR=os.path.dirname(fname)+'/'
         self.HISTORY = self.HIST_DIR+'master.csv'
 
-        self.DATA_DIR=os.path.expanduser('~/'+MY_CALL2+'/')
-        if not os.path.isdir(self.DATA_DIR):
-            self.DATA_DIR='./'
+        self.WORK_DIR=os.path.expanduser('~/'+MY_CALL2+'/')
+        if not os.path.isdir(self.WORK_DIR):
+            HOME=os.path.expanduser('~/')
+            print('HOME=',HOME)
+            CURRENT=os.path.expanduser('./')
+            print('CURRENT=',CURRENT)
+            if CURRENT in HOME:
+                self.WORK_DIR=CURRENT
+            else:
+                self.WORK_DIR=HOME
+        print('WORK_DIR=',self.WORK_DIR)
 
         #sys,exit(0)
 

practice

@@ -19,7 +19,7 @@ set CONTEST="cwt"
 ###############################################################################
 
 # Start keyer
-set OPTS="-prac -wpm 30 -adjust -sending $NANO -$CONTEST -nohints"
+set OPTS="-prac -wpm 30 -adjust -sending $NANO -$CONTEST"
 #echo OPTS=$OPTS
 
 cd ~/Python/pyKeyer/dist

practice.bat

@@ -0,0 +1,30 @@
+@echo off
+rem ###########################################################################
+rem #
+rem # practice.bat - J.B.Attili - 2023
+rem #
+rem # Script showing how to start the keyer for practice.
+rem #
+rem ###########################################################################
+
+set NANO=
+rem set NANO=-nano
+
+rem Pick one
+set CONTEST=cwt
+rem set CONTEST=sst
+rem set CONTEST=mst
+rem set CONTEST=naqp
+
+rem ###########################################################################
+
+# Start keyer
+set OPTS=-prac -wpm 30 -adjust -sending %NANO% -%CONTEST%
+echo OPTS=%OPTS%
+
+set CMD="c:\Program File (x86)\pyKeyer.exe %OPTS%"
+echo CMD=%CMD%
+%CMD%
+
+
+

pyKeyer.py

@@ -280,7 +280,7 @@
             P.sock.set_freq(f1+30) 
 
 # Read satellite grids confirmed - this will be used to alert station in new grid
-FNAME = P.DATA_DIR+'states.xls'
+FNAME = P.HIST_DIR+'states.xls'
 P.grids=[]
 if os.path.isfile(FNAME):
     print('Reading Sat Grids - fname=',FNAME)

start

@@ -38,7 +38,8 @@ set NANO="-nano"
 #set NANO="-nano -sidetone"
 
 set WPM=25
-set HINTS="-nohints"
+set HINTS=""
+#set HINTS="-hints"
 
 set CA_ONLY=""
 #set CA_ONLY="-ca_only"
@@ -112,34 +113,34 @@ if( $CONTEST == "paddling" )then
     endif
     set WPM=20
     set CONTEST="ragchew"
-    set HINTS="-nohints -adjust -sending  -immediate"
+    set HINTS="-adjust -sending  -immediate"
     #exit
 
 ########################################################################
 
 # Settings for NAQP contest
 else if( $CONTEST == "naqp" )then
     set WPM=30
-    set HINTS="-nohints -adjust"
-    #set HINTS="-nohints -adjust -autofill -scp"
+    set HINTS="-adjust"
+    #set HINTS="-adjust -autofill -scp"
 
 # Settings for CW Ops mini tests
 else if( $CONTEST == "cwt" )then
     set WPM=30
-    set HINTS="-nohints -adjust"
+    set HINTS="-adjust"
     #set HINTS=""
 
 # Settings for K1USN slow speed tests
 else if( $CONTEST == "sst" )then
     set WPM=20
-    set HINTS="-nohints -adjust"
-    #set HINTS="-nohints -adjust -autofill"
-    #set HINTS="-use_log_hist -nohints -autofill -nrows 1"
+    set HINTS="-adjust"
+    #set HINTS="-adjust -autofill"
+    #set HINTS="-use_log_hist -autofill -nrows 1"
 
 # Settings for ICWC Medium speed tests
 else if( $CONTEST == "mst" )then
     set WPM=25
-    set HINTS="-nohints -adjust"
+    set HINTS="-adjust"
 
 # Settings for NCCC CW Sprints
 else if( $CONTEST == "sprint" )then
@@ -165,8 +166,7 @@ else if( $CONTEST == "cqww" )then
 # Settings for field day
 else if( $CONTEST == "fd" )then
     set WPM=25
-    #set HINTS="-nohints"
-    set HINTS="-nohints -adjust"
+    set HINTS="-adjust"
 
 # Settings for IARU HF Champs
 else if( $CONTEST == "iaru" )then
@@ -176,7 +176,7 @@ else if( $CONTEST == "iaru" )then
 # Settings for CA QSO Party
 else if( $CONTEST == "cqp" )then
     set WPM=30
-    set HINTS="-nohints -adjust $CA_ONLY"
+    set HINTS="-adjust $CA_ONLY"
 
 # Settings for ARRL & CQ VHF
 else if( $CONTEST == "vhf" || $CONTEST == "cqvhf" )then
@@ -215,7 +215,6 @@ else if( $CONTEST == "ss" )then
     set WPM=30
     set HINTS=""
     set HINTS="-adjust"
-    #set HINTS="-nohints -adjust"
 
 # Settings for SKCC practice
 else if( $CONTEST == "skcc" )then
@@ -230,8 +229,7 @@ else if( $CONTEST == "calls" )then
 # Settings for Default Quick, Ragchew or QSOs
 else if( $CONTEST == "default" || $CONTEST == "ragchew"  || $CONTEST == "dx" )then
     set WPM=22
-    set HINTS=""
-    set HINTS="-use_log_hist -nohints -autofill -nrows 0 -lock -sending"
+    set HINTS="-use_log_hist -autofill -nrows 0 -lock -sending"
 
 # Settings for various state QPs
 else if( $CONTEST == "state" )then