Try to fix the i2c scan command line utility (#42)

* Try to fix the i2c scan command line utility

* Show the default

* Expand cli tests to also test i2c_scan help

* Update

Author: hmaarrfk

.github/workflows/test.yml

@@ -33,7 +33,9 @@ jobs:
       run: pylint teensytoany
     - name: isort
       run: isort --check-only .
-    - name: teensytoany_programmer
-      run: teensytoany_programmer --help
+    - name: cli
+      run: |
+        teensytoany_programmer --help
+        teensytoany_i2c_scan --help
     - name: Test with tox
       run: tox

HISTORY.md

@@ -1,5 +1,9 @@
 # History
 
+## 0.10.1 (2025-05-27)
+
+* Attempt to fix i2c command line utility by correctly initializing the I2C bus.
+
 ## 0.10.0 (2025-05-26)
 
 * Provide an i2c scan capabilities through the python api as well as a command

teensytoany/i2c_scan.py

@@ -5,30 +5,69 @@
 
 
 @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.option(
+    '--serial-number', '-s',
+    type=str,
+    default=None,
+    show_default=False,
+    help='Serial number of the Teensy device.'
+)
+@click.option(
+    '--interface',
+    '-i',
+    type=int,
+    default=0,
+    show_default=True,
+    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. '
+        'By default, addresses are reported in 8-bit mode.'
+    ),
+)
+@click.option(
+    '--baud-rate',
+    type=int,
+    default=100_100,
+    show_default=True,
+    help='Baud rate for the I2C bus.',
+)
+@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,
+    baud_rate=100_100,
     verbose=False,
 ):
     i2c_scan(
         serial_number=serial_number,
         interface=interface,
+        baud_rate=baud_rate,
         seven_bit_mode=seven_bit_mode,
         verbose=verbose,
     )
 
 
-def _scan_and_print(teensy, interface, seven_bit_mode, verbose):
+def _scan_and_print(teensy, interface, baud_rate, seven_bit_mode, verbose):
+    if interface == 0:
+        teensy.i2c_init(baud_rate=baud_rate)
+    elif interface == 1:
+        teensy.i2c_1_init(baud_rate=baud_rate)
+    else:
+        raise ValueError(f"Unknown interface {interface}. Must be 0 or 1")
+
     for address_7bit in range(1, 128):
         address = address_7bit << 1
         try:
@@ -49,12 +88,19 @@ def _scan_and_print(teensy, interface, seven_bit_mode, verbose):
             #     pass
 
 
-def i2c_scan(serial_number=None, interface=0, seven_bit_mode=False, verbose=False):
+def i2c_scan(
+    serial_number=None,
+    interface=0,
+    baud_rate=100_100,
+    seven_bit_mode=False,
+    verbose=False,
+):
     teensy = TeensyToAny(serial_number=serial_number)
     try:
         _scan_and_print(
             teensy,
             interface=interface,
+            baud_rate=baud_rate,
             seven_bit_mode=seven_bit_mode,
             verbose=verbose,
         )