cli: make run command name argument optional

When you only have one hub/brick, it should not be required to spend
time typing the hub name.

Author: dlech

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `pybricksdev.ble.lwp3` module.
 - `pybricksdev.ble.nus` module.
 - `pybricksdev.ble.pybricks` module.
+## Changed
+- Name parameter to `pybricksdev run ble` command is now optional.
 ## Fixed
 - Connecting to BLE devices based on Bluetooth address.
 

README.md

@@ -120,23 +120,23 @@ firmware.
     #
 
     # Run a one-liner on a Pybricks hub
-    pybricksdev run ble "Pybricks Hub" "print('Hello!'); print('world!');"
+    pybricksdev run ble "print('Hello!'); print('world!');"
 
     # Run script on the first device we find called Pybricks hub
-    pybricksdev run ble "Pybricks Hub" demo/shortdemo.py
+    pybricksdev run ble --name "Pybricks Hub" demo/shortdemo.py
 
     # Run script on device with address 90:84:2B:4A:2B:75 (doesn't work on Mac)
-    pybricksdev run ble 90:84:2B:4A:2B:75 demo/shortdemo.py
+    pybricksdev run ble --name 90:84:2B:4A:2B:75 demo/shortdemo.py
 
     #
     # Other connection examples:
     #
 
     # Run script on ev3dev at 192.168.0.102
-    pybricksdev run ssh 192.168.0.102 demo/shortdemo.py
+    pybricksdev run ssh --name 192.168.0.102 demo/shortdemo.py
 
     # Run script on primehub at
-    pybricksdev run usb "Pybricks Hub" demo/shortdemo.py
+    pybricksdev run usb --name "Pybricks Hub" demo/shortdemo.py
 
 
 ### Compiling Pybricks MicroPython programs without running

pybricksdev/cli/__init__.py

@@ -95,18 +95,19 @@ def add_parser(self, subparsers: argparse._SubParsersAction):
             help="connection type: %(choices)s",
             choices=["ble", "usb", "ssh"],
         )
-        parser.add_argument(
-            "device",
-            metavar="<device>",
-            help="hostname or IP address for SSH connection; "
-            "Bluetooth device name or Bluetooth address for BLE connection; "
-            "serial port name for USB connection",
-        )
         parser.add_argument(
             "script",
             metavar="<script>",
             help="path to a MicroPython script or inline script",
         )
+        parser.add_argument(
+            "--name",
+            metavar="<name>",
+            required=False,
+            help="hostname or IP address for SSH connection; "
+            "Bluetooth device name or Bluetooth address for BLE connection; "
+            "serial port name for USB connection",
+        )
         parser.add_argument(
             "--wait",
             help="Await program completion (True) or disconnect immediately (False)",
@@ -130,22 +131,31 @@ async def run(self, args: argparse.Namespace):
         # Pick the right connection
         if args.conntype == "ssh":
             # So it's an ev3dev
-            if not validators.ip_address.ipv4(args.device):
+            if args.name is None:
+                print("--name is required for SSH connections", file=sys.stderr)
+                exit(1)
+
+            if not validators.ip_address.ipv4(args.name):
                 raise ValueError("Device must be IP address.")
+
             hub = EV3Connection()
-            device_or_address = args.device
+            device_or_address = args.name
         elif args.conntype == "ble":
             # It is a Pybricks Hub with BLE. Device name or address is given.
             hub = PybricksHub()
-            device_or_address = await find_device(args.device)
-        elif args.conntype == "usb" and args.device == "lego":
+            device_or_address = await find_device(args.name)
+        elif args.conntype == "usb" and args.name == "lego":
             # It's LEGO stock firmware Hub with USB.
             hub = USBRPCConnection()
             device_or_address = "LEGO Technic Large Hub in FS Mode"
         elif args.conntype == "usb":
+            if args.name is None:
+                print("--name is required for USB connections", file=sys.stderr)
+                exit(1)
+
             # It's a Pybricks Hub with USB. Port name is given.
             hub = USBPUPConnection()
-            device_or_address = args.device
+            device_or_address = args.name
         else:
             raise ValueError(f"Unknown connection type: {args.conntype}")