diff --git a/README.rst b/README.rst index 96f9c67..e78f5cd 100644 --- a/README.rst +++ b/README.rst @@ -62,11 +62,10 @@ Usage Example .. code-block:: python import time - import busio import board import adafruit_sht4x - i2c = busio.I2C(board.SCL, board.SDA) + i2c = board.I2C() # uses board.SCL and board.SDA sht = adafruit_sht4x.SHT4x(i2c) print("Found SHT4x with serial number", hex(sht.serial_number)) diff --git a/adafruit_sht4x.py b/adafruit_sht4x.py index 74371f0..b1b2d70 100644 --- a/adafruit_sht4x.py +++ b/adafruit_sht4x.py @@ -86,26 +86,25 @@ class SHT4x: """ A driver for the SHT4x temperature and humidity sensor. - :param ~busio.I2C i2c_bus: The `busio.I2C` object to use. - :param int address: The I2C device address for the sensor. Default is :const:`0x44` + :param ~busio.I2C i2c_bus: The I2C bus the SHT4x is connected to. + :param int address: The I2C device address. Default is :const:`0x44` **Quickstart: Importing and using the SHT4x temperature and humidity sensor** - Here is one way of importing the `SHT4x` class so you can use it with the name ``sht``. + Here is an example of using the :class:`SHT4x`. First you will need to import the libraries to use the sensor .. code-block:: python - import busio import board import adafruit_sht4x - Once this is done you can define your `busio.I2C` object and define your sensor object + Once this is done you can define your `board.I2C` object and define your sensor object .. code-block:: python - i2c = busio.I2C(board.SCL, board.SDA) + i2c = board.I2C() # uses board.SCL and board.SDA sht = adafruit_sht4x.SHT4x(i2c) You can now make some initial settings on the sensor diff --git a/docs/index.rst b/docs/index.rst index 6455512..b7c24f4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,8 @@ Table of Contents .. toctree:: :caption: Tutorials + Adafruit Sensirion SHT40 Temperature & Humidity Sensor + .. toctree:: :caption: Related Products diff --git a/examples/sht4x_simpletest.py b/examples/sht4x_simpletest.py index 3ae2572..86ee7d0 100644 --- a/examples/sht4x_simpletest.py +++ b/examples/sht4x_simpletest.py @@ -3,11 +3,10 @@ # SPDX-License-Identifier: MIT import time -import busio import board import adafruit_sht4x -i2c = busio.I2C(board.SCL, board.SDA) +i2c = board.I2C() sht = adafruit_sht4x.SHT4x(i2c) print("Found SHT4x with serial number", hex(sht.serial_number))