Improved autodetection of TeensyToAny devices (#45)

* Improved autodetection of TeensyToAny devices

* lint

* Provide a teensytoany_list command which lists avialable devices

* Deprecate things and add context manager

Author: hmaarrfk

HISTORY.md

@@ -1,5 +1,10 @@
 # History
 
+## 0.11.0 (2025-06-14)
+
+* Try to automatically connect to devices with Manufacturer TeensyToAny. This
+  requires firmware version 0.13.0 and up.
+
 ## 0.10.2 (2025-06-02)
 
 * Fix I2C scanning command line utility by absorping the errors when no device

setup.py

@@ -53,6 +53,7 @@ def get_version_and_cmdclass(pkg_path):
         'console_scripts': [
             'teensytoany_programmer=teensytoany.programmer:teensytoany_programmer',
             'teensytoany_i2c_scan=teensytoany.i2c_scan:main',
+            'teensytoany_list=teensytoany.list:main',
         ],
     },
     packages=find_packages(include=['teensytoany']),

teensytoany/i2c_scan.py

@@ -1,4 +1,5 @@
 import click
+from packaging.version import Version
 
 import teensytoany
 from teensytoany import TeensyToAny
@@ -97,7 +98,6 @@ def i2c_scan(
     seven_bit_mode=False,
     verbose=False,
 ):
-    from packaging.version import Version
 
     teensy = TeensyToAny(serial_number=serial_number)
     if Version(teensy.version) < Version('0.12.0'):

teensytoany/list.py

@@ -0,0 +1,44 @@
+import sys
+
+import click
+
+import teensytoany
+from teensytoany import TeensyToAny
+
+
+@click.command(epilog=f"Version {teensytoany.__version__}")
+@click.option(
+    '--manufacturer',
+    type=str,
+    default="TeensyToAny",
+    show_default=True,
+    help="Manufacturer of the device to list.",
+)
+@click.option(
+    '--teensyduino',
+    is_flag=True,
+    default=False,
+    help=(
+        "List devices with manufacturer 'TeensyToAny'. "
+        "This is a shortcut for --manufacturer=TeensyToAny"
+    ),
+)
+@click.version_option(teensytoany.__version__)
+def main(
+    manufacturer="TeensyToAny",
+    teensyduino=False,
+):
+    """
+    List available TeensyToAny devices.
+    """
+    if teensyduino:
+        manufacturer = "Teensyduino"
+
+    try:
+        device_serial_numbers = TeensyToAny.device_serial_number_pairs(manufacturer=manufacturer)
+    except RuntimeError:
+        click.echo(f"Error: Could not find any devices with manufacturer '{manufacturer}'.")
+        sys.exit(1)
+
+    for device, serial_number in device_serial_numbers:
+        click.echo(f"Port: {device} -- Serial Number: {serial_number}")

teensytoany/programmer.py

@@ -66,18 +66,17 @@ def teensytoany_programmer(
             )
         return
 
-    print('Programming Teensy with:')
+    print('Programming please wait...')
     teensytoany.TeensyToAny.program_firmware(
         serial_number,
         mcu=mcu,
         version=firmware_version,
         variant=firmware_variant
     )
-    teensy = teensytoany.TeensyToAny(serial_number)
-    print(f"TeensyToAny version: {teensy.version}")
-    print(f"TeensyToAny variant: {firmware_variant}")
-    print(f"TeensyToAny serial_number: {teensy.serial_number}")
-    teensy.close()
+    with teensytoany.TeensyToAny(serial_number) as teensy:
+        print(f"TeensyToAny version: {teensy.version}")
+        print(f"TeensyToAny variant: {firmware_variant}")
+        print(f"TeensyToAny serial_number: {teensy.serial_number}")
 
 
 if __name__ == '__main__':

teensytoany/teensytoany.py

@@ -3,60 +3,13 @@
 from contextlib import contextmanager
 from time import sleep
 from typing import Sequence
+from warnings import warn
 
 from packaging.version import Version
 from serial import LF, Serial
 from serial.tools.list_ports import comports
 
-__all__ = ['TeensyToAny', 'known_devices', 'known_serial_numbers']
-
-known_devices = [
-    # Example device structure
-    # These include useful information about the hardware that is created and
-    # burned in with the serial numbers.
-    # Since the same VID/PID can be assigned to multiple devices,
-    # We must log the individual serial numbers to know what they all do.
-    {
-        'serial_number': '4725230',
-        'device_name': 'teensytoany',
-        'mcu': 'TEENSY32',
-    },
-    {
-        'serial_number': '5032260',
-        'device_name': 'teensytoany',
-        'mcu': 'TEENSY32',
-    },
-    {
-        'serial_number': '4725070',
-        'device_name': 'teensytoany',
-        'mcu': 'TEENSY32',
-    },
-    {
-        'serial_number': '4726520',
-        'device_name': 'teensytoany',
-        'mcu': 'TEENSY32',
-    },
-    {
-        'serial_number': '5032540',
-        'device_name': 'teensytoany',
-        'mcu': 'TEENSY32',
-    },
-    {
-        'serial_number': '4728790',
-        'device_name': 'teensytoany',
-        'mcu': 'TEENSY32',
-    },
-    {
-        'serial_number': '5955040',
-        'device_name': 'teensytoany',
-        'mcu': 'TEENSY32',
-    },
-]
-
-known_serial_numbers = [
-    d['serial_number']
-    for d in known_devices
-]
+__all__ = ['TeensyToAny']
 
 
 class TeensyToAny:
@@ -76,8 +29,6 @@ class TeensyToAny:
     ]
 
     _device_name = "TeensyToAny"
-    _known_device = known_devices
-    _known_serial_numbers = known_serial_numbers
 
     @staticmethod
     def find(serial_numbers=None):
@@ -101,13 +52,18 @@ def find(serial_numbers=None):
         computer but that may not be associated with the TeensyToAny boards.
 
         """
-        pairs = TeensyToAny._device_serial_number_pairs(
+        pairs = TeensyToAny.device_serial_number_pairs(
             serial_numbers=serial_numbers)
         devices, _ = zip(*pairs)
         return devices
 
     @staticmethod
-    def list_all_serial_numbers(serial_numbers=None, *, device_name=None):
+    def list_all_serial_numbers(
+        serial_numbers=None,
+        *,
+        device_name=None,
+        manufacturer="TeensyToAny",
+    ):
         """Find all the currently connected TeensyToAny serial numbers.
 
         Parameters
@@ -128,8 +84,11 @@ def list_all_serial_numbers(serial_numbers=None, *, device_name=None):
         computer but that may not be associated with the TeensyToAny boards.
 
         """
-        pairs = TeensyToAny._device_serial_number_pairs(
-            serial_numbers=serial_numbers, device_name=device_name)
+        pairs = TeensyToAny.device_serial_number_pairs(
+            serial_numbers=serial_numbers,
+            device_name=device_name,
+            manufacturer=manufacturer,
+        )
         _, serial_numbers = zip(*pairs)
         return serial_numbers
 
@@ -177,16 +136,39 @@ def _get_latest_available_firmware_online(*, timeout=2):
         return latest_release_version
 
     @staticmethod
-    def _device_serial_number_pairs(serial_numbers=None, *, device_name=None):
+    def _device_serial_number_pairs(
+        serial_numbers=None,
+        *,
+        device_name=None,
+        manufacturer="TeensyToAny",
+    ):
+        warn(
+            "The TeensyToAny._device_serial_number_pairs function is deprecated. "
+            "Use TeensyToAny.device_serial_number_pairs instead.",
+            stacklevel=2,
+        )
+        return TeensyToAny.device_serial_number_pairs(
+            serial_numbers=serial_numbers,
+            device_name=device_name,
+            manufacturer=manufacturer,
+        )
+
+    @staticmethod
+    def device_serial_number_pairs(
+        serial_numbers=None,
+        *,
+        device_name=None,
+        manufacturer="TeensyToAny",
+    ):
         if device_name is None:
             device_name = TeensyToAny._device_name
         com = comports()
         pairs = [
             (c.device, c.serial_number)
             for c in com
             if ((c.vid, c.pid) in TeensyToAny.VID_PID_s and
-                (serial_numbers is None or
-                 c.serial_number in serial_numbers))
+                ((serial_numbers is None and c.manufacturer == manufacturer) or
+                 (serial_numbers and c.serial_number in serial_numbers)))
         ]
         if len(pairs) == 0:
             raise RuntimeError(
@@ -397,13 +379,24 @@ def open(self):
             self.close()
             raise e
 
+    def __enter__(self):
+        """Context manager for opening the device."""
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        """Context manager for closing the device."""
+        self.close()
+        if exc_type is not None:
+            raise exc_value.with_traceback(traceback)
+        return False
+
     def _open(self):
         if self._requested_serial_number is None:
-            serial_numbers = self._known_serial_numbers
+            serial_numbers = None
         else:
             serial_numbers = [self._requested_serial_number]
 
-        port, found_serial_number = self._device_serial_number_pairs(
+        port, found_serial_number = self.device_serial_number_pairs(
             serial_numbers=serial_numbers, device_name=self._device_name)[0]
 
         self._serial = Serial(