Skip to content

Commit cb7a886

Browse files
committed
add I2C to class name. Document that driver is I2C only currently.
1 parent 0a33b73 commit cb7a886

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

README.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Introduction
2323

2424
CircuitPython library for the BMP580 / BMP581 / BMP585 / etc barometric pressure sensors.
2525

26+
Please note: This driver currently only supports I2C communication. If you have a need for SPI support in the CircuitPython driver please file an issue.
27+
2628

2729
Dependencies
2830
=============

adafruit_bmp5xx.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@
138138
BMP585_CHIP_ID = const(0x51)
139139

140140

141-
class BMP5XX:
141+
class BMP5XX_I2C:
142142
"""
143143
Bosche BMP5xx temperature and pressure sensor breakout CircuitPython driver.
144144
"""

examples/bmp5xx_simpletest.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55

66
import board
77

8-
from adafruit_bmp5xx import BMP5XX
8+
from adafruit_bmp5xx import BMP5XX_I2C
99

1010
SEALEVELPRESSURE_HPA = 1013.25
1111

1212
# I2C setup
1313
i2c = board.I2C() # uses board.SCL and board.SDA
1414
# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller
1515

16-
bmp = BMP5XX(i2c)
16+
bmp = BMP5XX_I2C(i2c)
1717

1818
bmp.sea_level_pressure = SEALEVELPRESSURE_HPA
1919

0 commit comments

Comments
 (0)