Merge pull request #3 from FoamyGuy/i2c_spi_combo

I2C/SPI Combined Driver

Author: FoamyGuy

adafruit_bmp5xx.py

@@ -1,4 +1,3 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 # SPDX-FileCopyrightText: Copyright (c) 2025 Tim Cocks for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
@@ -34,15 +33,17 @@
 import time
 
 from adafruit_bus_device.i2c_device import I2CDevice
-from adafruit_register.i2c_bit import ROBit, RWBit
-from adafruit_register.i2c_bits import ROBits, RWBits
-from adafruit_register.i2c_struct import ROUnaryStruct, UnaryStruct
+from adafruit_bus_device.spi_device import SPIDevice  # noqa: PLC0415
+from adafruit_register.register_accessor import I2CRegisterAccessor, SPIRegisterAccessor
+from adafruit_register.register_bit import ROBit, RWBit
+from adafruit_register.register_bits import ROBits, RWBits
 from micropython import const
 
 try:
-    from typing import Optional
+    from typing import Optional, Union
 
-    from busio import I2C
+    from busio import I2C, SPI
+    from digitalio import DigitalInOut
 except ImportError:
     pass
 
@@ -138,12 +139,12 @@
 BMP585_CHIP_ID = const(0x51)
 
 
-class BMP5XX_I2C:
+class BMP5XX:
     """
     Bosche BMP5xx temperature and pressure sensor breakout CircuitPython driver.
     """
 
-    chip_id: int = ROUnaryStruct(BMP5_REG_ID, "B")
+    chip_id: int = ROBits(8, BMP5_REG_ID, 0)
 
     # Status register bits
     status_nvm_ready: bool = ROBit(BMP5_REG_STATUS, 1)  # NVM ready
@@ -219,14 +220,41 @@ class BMP5XX_I2C:
     output_data_rate = RWBits(5, BMP5XX_REG_ODR_CONFIG, 2)
     """Output data rate. Must be one of the ODR constants."""
 
-    command = UnaryStruct(BMP5_REG_CMD, "B")  # command register
+    command = RWBits(8, BMP5_REG_CMD, 0)  # command register
     """Command register"""
 
-    def __init__(self, i2c: I2C, address: int = DEFAULT_ADAFRUIT_ADDR) -> None:
-        try:
-            self.i2c_device = I2CDevice(i2c, address)
-        except ValueError:
-            raise ValueError(f"No I2C device found at address 0x{address:02X}")
+    @staticmethod
+    def over_spi(spi: SPI, cs: DigitalInOut):
+        """
+        Initialize BMP5XX breakout over SPI bus.
+
+        :param spi: busio.SPI instance to communicate over
+        :param cs: DigitalInOut instance to use for chip select
+        :return: Initialized BMP5XX object
+        """
+        spi_device = SPIDevice(spi, cs)
+        return BMP5XX(spi_device)
+
+    @staticmethod
+    def over_i2c(i2c: I2C, address=DEFAULT_ADAFRUIT_ADDR):
+        """
+        Initialize BMP5XX breakout over I2C bus.
+
+        :param i2c: busio.I2C instance to communicate over
+        :param address: The I2C address to use. Defaults to DEFAULT_ADAFRUIT_ADDR
+        :return: Initialized BMP5XX object
+        """
+        i2c_device = I2CDevice(i2c, address)
+        return BMP5XX(i2c_device)
+
+    def __init__(self, bus_device: Union[I2CDevice, SPIDevice]):
+        if isinstance(bus_device, SPIDevice):
+            self.register_accessor = SPIRegisterAccessor(bus_device)
+
+        elif isinstance(bus_device, I2CDevice):
+            self.register_accessor = I2CRegisterAccessor(bus_device)
+        else:
+            raise ValueError("bus_device must be an instance of I2CDevice or SPIDevice.")
 
         self.sea_level_pressure = 1013.25
         self.reset()
@@ -271,10 +299,11 @@ def altitude(self) -> float:
     def reset(self) -> None:
         """Reset the BMP5xx device."""
         self.command = BMP5_SOFT_RESET_CMD
-        time.sleep(0.006)
+        time.sleep(0.012)
+        _throwaway = self.chip_id
 
         if self.chip_id not in {BMP581_CHIP_ID, BMP585_CHIP_ID}:
-            raise ValueError(f"CHIP_ID was zero")
+            raise ValueError(f"CHIP_ID was incorrect")
         if not self.status_nvm_ready:
             raise ValueError("NVM not ready")
         if self.status_nvm_err:
@@ -309,3 +338,13 @@ def mode(self, new_mode: int) -> None:
 
         self.deep_disabled = True
         self._mode = new_mode
+
+
+def BMP5XX_I2C(i2c: I2C, address: int = DEFAULT_ADAFRUIT_ADDR) -> BMP5XX:
+    import warnings  # noqa: PLC0415, import outside top level
+
+    warnings.warn(
+        "Warning: BMP5XX_I2C class is deprecated and will be removed in a future version. "
+        "User code should be updated to use BMP5XX.over_i2c()"
+    )
+    return BMP5XX.over_i2c(i2c, address)

docs/examples.rst

@@ -6,3 +6,11 @@ Ensure your device works with this simple test.
 .. literalinclude:: ../examples/bmp5xx_simpletest.py
     :caption: examples/bmp5xx_simpletest.py
     :linenos:
+
+.. literalinclude:: ../examples/bmp5xx_spi_simpletest.py
+    :caption: examples/bmp5xx_spi_simpletest.py
+    :linenos:
+
+.. literalinclude:: ../examples/bmp5xx_spi_multi_device.py
+    :caption: examples/bmp5xx_spi_multi_device.py
+    :linenos:

examples/bmp5xx_simpletest.py

@@ -5,15 +5,15 @@
 
 import board
 
-from adafruit_bmp5xx import BMP5XX_I2C
+from adafruit_bmp5xx import BMP5XX
 
 SEALEVELPRESSURE_HPA = 1013.25
 
 # I2C setup
 i2c = board.I2C()  # uses board.SCL and board.SDA
 # i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
 
-bmp = BMP5XX_I2C(i2c)
+bmp = BMP5XX.over_i2c(i2c)
 
 bmp.sea_level_pressure = SEALEVELPRESSURE_HPA
 

examples/bmp5xx_spi_multi_device.py

@@ -0,0 +1,44 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Tim Cocks for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+import time
+
+import board
+from digitalio import DigitalInOut, Direction
+
+from adafruit_bmp5xx import BMP5XX
+
+SEALEVELPRESSURE_HPA = 1013.25
+
+# SPI setup
+spi = board.SPI()
+
+# first sensor setup
+cs1 = DigitalInOut(board.D10)
+cs1.direction = Direction.OUTPUT
+bmp1 = BMP5XX.over_spi(spi=spi, cs=cs1)
+
+# second sensor setup, different CS pin, same SPI bus
+cs2 = DigitalInOut(board.D11)
+cs2.direction = Direction.OUTPUT
+bmp2 = BMP5XX.over_spi(spi=spi, cs=cs2)
+
+bmp1.sea_level_pressure = SEALEVELPRESSURE_HPA
+bmp2.sea_level_pressure = SEALEVELPRESSURE_HPA
+
+while True:
+    if bmp1.data_ready:
+        print(
+            f"BMP1 temp F: {bmp1.temperature * (9 / 5) + 32} "
+            f"pressure: {bmp1.pressure} hPa "
+            f"Approx altitude: {bmp1.altitude} m"
+        )
+
+    if bmp2.data_ready:
+        print(
+            f"BMP2 temp F: {bmp2.temperature * (9 / 5) + 32} "
+            f"pressure: {bmp2.pressure} hPa "
+            f"Approx altitude: {bmp2.altitude} m"
+        )
+    print("-----")
+    time.sleep(1)

examples/bmp5xx_spi_simpletest.py

@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Tim Cocks for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+import time
+
+import board
+from digitalio import DigitalInOut, Direction
+
+from adafruit_bmp5xx import BMP5XX
+
+SEALEVELPRESSURE_HPA = 1013.25
+
+# SPI setup
+spi = board.SPI()
+cs = DigitalInOut(board.D10)
+cs.direction = Direction.OUTPUT
+bmp = BMP5XX.over_spi(spi=spi, cs=cs)
+
+
+bmp.sea_level_pressure = SEALEVELPRESSURE_HPA
+
+while True:
+    if bmp.data_ready:
+        print(
+            f"temp F: {bmp.temperature * (9 / 5) + 32} "
+            f"pressure: {bmp.pressure} hPa "
+            f"Approx altitude: {bmp.altitude} m"
+        )
+        time.sleep(1)