Browse Source

gw: Tweak the command line:
1. Greaseweazle device is now a proper optional argument, not positional.
2. Tidy up the usage line by hiding the full list of optional arguments.

Keir Fraser 4 years ago
parent
commit
61971d0541

+ 2 - 2
scripts/greaseweazle/tools/bandwidth.py

@@ -55,8 +55,8 @@ def measure_bandwidth(usb, args):
 
 def main(argv):
 
-    parser = util.ArgumentParser()
-    parser.add_argument("device", nargs="?", help="serial device")
+    parser = util.ArgumentParser(usage='%(prog)s [options]')
+    parser.add_argument("--device", help="greaseweazle device name")
     parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])

+ 2 - 2
scripts/greaseweazle/tools/delays.py

@@ -17,7 +17,8 @@ from greaseweazle import usb as USB
 
 def main(argv):
 
-    parser = util.ArgumentParser()
+    parser = util.ArgumentParser(usage='%(prog)s [options]')
+    parser.add_argument("--device", help="greaseweazle device name")
     parser.add_argument("--select", type=int,
                         help="delay after drive select (usecs)")
     parser.add_argument("--step", type=int,
@@ -28,7 +29,6 @@ def main(argv):
                         help="delay after motor on (msecs)")
     parser.add_argument("--auto-off", type=int,
                         help="quiescent time until auto deselect (msecs)")
-    parser.add_argument("device", nargs="?", help="serial device")
     parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])

+ 2 - 2
scripts/greaseweazle/tools/erase.py

@@ -33,7 +33,8 @@ def erase(usb, args):
 
 def main(argv):
 
-    parser = util.ArgumentParser()
+    parser = util.ArgumentParser(usage='%(prog)s [options]')
+    parser.add_argument("--device", help="greaseweazle device name")
     parser.add_argument("--drive", type=util.drive_letter, default='A',
                         help="drive to write (A,B,0,1,2)")
     parser.add_argument("--scyl", type=int, default=0,
@@ -42,7 +43,6 @@ def main(argv):
                         help="last cylinder to write")
     parser.add_argument("--single-sided", action="store_true",
                         help="single-sided write")
-    parser.add_argument("device", nargs="?", help="serial device")
     parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])

+ 2 - 2
scripts/greaseweazle/tools/info.py

@@ -31,8 +31,8 @@ def print_info_line(name, value, tab=0):
 
 def main(argv):
 
-    parser = util.ArgumentParser()
-    parser.add_argument("device", nargs="?", help="serial device")
+    parser = util.ArgumentParser(usage='%(prog)s [options]')
+    parser.add_argument("--device", help="greaseweazle device name")
     parser.add_argument("--bootloader", action="store_true",
                         help="display bootloader info (F7 only)")
     parser.description = description

+ 4 - 6
scripts/greaseweazle/tools/pin.py

@@ -22,12 +22,10 @@ def level(letter):
 
 def main(argv):
 
-    parser = util.ArgumentParser()
-    parser.add_argument("pin", type=int,
-                        help="pin number")
-    parser.add_argument("level", type=level,
-                        help="pin level (H,L)")
-    parser.add_argument("device", nargs="?", help="serial device")
+    parser = util.ArgumentParser(usage='%(prog)s [options] pin level')
+    parser.add_argument("--device", help="greaseweazle device name")
+    parser.add_argument("pin", type=int, help="pin number")
+    parser.add_argument("level", type=level, help="pin level (H,L)")
     parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])

+ 5 - 7
scripts/greaseweazle/tools/read.py

@@ -81,7 +81,8 @@ def read_to_image(usb, args, image):
 
 def main(argv):
 
-    parser = util.ArgumentParser()
+    parser = util.ArgumentParser(usage='%(prog)s [options] file')
+    parser.add_argument("--device", help="greaseweazle device name")
     parser.add_argument("--drive", type=util.drive_letter, default='A',
                         help="drive to read (A,B,0,1,2)")
     parser.add_argument("--revs", type=int, default=3,
@@ -94,19 +95,16 @@ def main(argv):
                         help="single-sided read")
     parser.add_argument("--double-step", action="store_true",
                         help="double-step drive heads")
-    parser.add_argument("--rate", type=int, nargs="?",
-                        help="data rate (kbit/s)")
-    parser.add_argument("--rpm", type=int, nargs="?",
-                        help="normalise to RPM")
+    parser.add_argument("--rate", type=int, help="data rate (kbit/s)")
+    parser.add_argument("--rpm", type=int, help="convert drive speed to RPM")
     parser.add_argument("file", help="output filename")
-    parser.add_argument("device", nargs="?", help="serial device")
     parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])
     args.nr_sides = 1 if args.single_sided else 2
 
     args.file, args.file_opts = util.split_opts(args.file)
-    
+
     try:
         usb = util.usb_open(args.device)
         image = open_image(args)

+ 2 - 2
scripts/greaseweazle/tools/reset.py

@@ -16,8 +16,8 @@ from greaseweazle import usb as USB
 
 def main(argv):
 
-    parser = util.ArgumentParser()
-    parser.add_argument("device", nargs="?", help="serial device")
+    parser = util.ArgumentParser(usage='%(prog)s [options]')
+    parser.add_argument("--device", help="greaseweazle device name")
     parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])

+ 2 - 2
scripts/greaseweazle/tools/update.py

@@ -101,9 +101,9 @@ def update_firmware(usb, args):
 
 def main(argv):
 
-    parser = util.ArgumentParser(allow_abbrev=False)
+    parser = util.ArgumentParser(allow_abbrev=False, usage='%(prog)s [options] [file]')
     parser.add_argument("file", nargs="?", help="update filename")
-    parser.add_argument("device", nargs="?", help="serial device")
+    parser.add_argument("--device", help="greaseweazle device name")
     parser.add_argument("--bootloader", action="store_true",
                         help="update the bootloader (use with caution!)")
     parser.description = description

+ 1 - 1
scripts/greaseweazle/tools/util.py

@@ -128,7 +128,7 @@ def find_port(old_port=None):
             best_score, best_port = score, x
     if best_port:
         return best_port.device
-    raise serial.SerialException('Could not auto-probe Greaseweazle device')
+    raise serial.SerialException('Cannot find the Greaseweazle device')
 
 def port_info(devname):
     for x in serial.tools.list_ports.comports():

+ 2 - 2
scripts/greaseweazle/tools/write.py

@@ -74,7 +74,8 @@ def write_from_image(usb, args, image):
 
 def main(argv):
 
-    parser = util.ArgumentParser()
+    parser = util.ArgumentParser(usage='%(prog)s [options] file')
+    parser.add_argument("--device", help="greaseweazle device name")
     parser.add_argument("--drive", type=util.drive_letter, default='A',
                         help="drive to write (A,B,0,1,2)")
     parser.add_argument("--scyl", type=int, default=0,
@@ -88,7 +89,6 @@ def main(argv):
     parser.add_argument("--erase-empty", action="store_true",
                         help="erase empty tracks (default: skip)")
     parser.add_argument("file", help="input filename")
-    parser.add_argument("device", nargs="?", help="serial device")
     parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])