Add an i2c scanner ping (#40)

* Add an i2c scanner ping

* pylint

* lint again

* Add release note and verbose mode

* Update

* Fixup

Author: hmaarrfk

HISTORY.md

@@ -1,5 +1,10 @@
 # History
 
+## 0.10.0 (2025-05-26)
+
+* Provide an i2c scan capabilities through the python api as well as a command
+  line utility: `teensytoany_i2c_scan`.
+
 ## 0.9.0 (2025-05-16)
 
 * Provide capabilities to program devices with board specific firmwares. #38

setup.py

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

teensytoany/i2c_scan.py

@@ -0,0 +1,66 @@
+import click
+
+import teensytoany
+from teensytoany import TeensyToAny
+
+
+@click.command(epilog=f"Version {teensytoany.__version__}")
+@click.option('--serial-number', '-s', type=str, default=None,
+              help='Serial number of the Teensy device.')
+@click.option('--interface', '-i', type=int, default=0,
+              help='I2C interface to use (0 for I2C, 1 for I2C1).')
+@click.option('--seven-bit-mode', '-7', is_flag=True, default=False,
+              help='Report addresses in 7-bit mode instead of 8-bit mode.')
+@click.option('--verbose', is_flag=True, default=False,
+              help='Report in verbose mode, print out all pinged addresses.')
+@click.version_option(teensytoany.__version__)
+def main(
+    serial_number=None,
+    interface=0,
+    seven_bit_mode=False,
+    verbose=False,
+):
+    i2c_scan(
+        serial_number=serial_number,
+        interface=interface,
+        seven_bit_mode=seven_bit_mode,
+        verbose=verbose,
+    )
+
+
+def _scan_and_print(teensy, interface, seven_bit_mode, verbose):
+    for address_7bit in range(1, 128):
+        address = address_7bit << 1
+        try:
+            if interface == 0:
+                teensy.i2c_ping(address=address)
+            elif interface == 1:
+                teensy.i2c_1_ping(address=address)
+            if seven_bit_mode:
+                print(f"Found device at address 0x{address_7bit:02X}")
+            else:
+                print(f"Found device at address 0x{address:02X}")
+        finally:
+            if verbose and seven_bit_mode:
+                print(f"No device found at addr 0x{address_7bit:02X}")
+            elif verbose and not seven_bit_mode:
+                print(f"No device found at addr 0x{address:02X}")
+            # else not verbose:
+            #     pass
+
+
+def i2c_scan(serial_number=None, interface=0, seven_bit_mode=False, verbose=False):
+    teensy = TeensyToAny(serial_number=serial_number)
+    try:
+        _scan_and_print(
+            teensy,
+            interface=interface,
+            seven_bit_mode=seven_bit_mode,
+            verbose=verbose,
+        )
+    finally:
+        teensy.close()
+
+
+if __name__ == "__main__":
+    main()

teensytoany/teensytoany.py

@@ -595,6 +595,11 @@ def i2c_read_payload_no_register(self, address: int, num_bytes: int):
         register_data = [int(val, base=0) for val in returned.split()]  # returns big endian
         return register_data
 
+    def i2c_ping(self, address: int):
+        """Return None if device found. Raises error if no device found."""
+        cmd = f"i2c_ping 0x{address:02x}"
+        self._ask(cmd)
+
     def i2c_1_init(self, baud_rate: int=100_100, timeout=200_000, register_space=1):
         cmd = f"i2c_1_init {baud_rate:d} {timeout:d} {register_space:d}"
         self._ask(cmd)
@@ -687,6 +692,11 @@ def i2c_1_read_payload_no_register(self, address: int, num_bytes: int):
         register_data = [int(val, base=0) for val in returned.split()]  # returns big endian
         return register_data
 
+    def i2c_1_ping(self, address: int):
+        """Return None if device found. Raises error if no device found."""
+        cmd = f"i2c_1_ping 0x{address:02x}"
+        self._ask(cmd)
+
     def gpio_digital_write(self, pin, value):
         """Call the ardunio DigitalWrite function.