circuitpython-fake-bme280 1.0.0__py3-none-any.whl

circuitpython_fake_bme280-1.0.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Brent Rubell for Adafruit Industries
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

circuitpython_fake_bme280-1.0.0.dist-info/METADATA

@@ -0,0 +1,116 @@
+Metadata-Version: 2.1
+Name: circuitpython-fake-bme280
+Version: 1.0.0
+Summary: BME280 Driver for CircuitPython used for testing functionality with no hardware attached
+Author-email: Adafruit Industries <circuitpython@adafruit.com>
+License: MIT
+Project-URL: Homepage, https://github.com/brentru/CircuitPython_Fake_BME280
+Keywords: adafruit,blinka,circuitpython,micropython,fake_bme280,bme280,,test,,fake,,mock,,stub
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: System :: Hardware
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: Adafruit-Blinka
+Requires-Dist: adafruit-circuitpython-busdevice
+Requires-Dist: adafruit-circuitpython-register
+Provides-Extra: optional
+
+Introduction
+============
+
+
+
+
+.. image:: https://img.shields.io/discord/327254708534116352.svg
+    :target: https://adafru.it/discord
+    :alt: Discord
+
+
+.. image:: https://github.com/brentru/CircuitPython_Fake_BME280/workflows/Build%20CI/badge.svg
+    :target: https://github.com/brentru/CircuitPython_Fake_BME280/actions
+    :alt: Build Status
+
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/psf/black
+    :alt: Code Style: Black
+
+**This code is for testing purposes only!** If you are looking for a Bosch BME280 driver, please use the `Adafruit_CircuitPython_BME280 <https://github.com/adafruit/Adafruit_CircuitPython_BME280>`_.
+
+This driver mocks the functionality of the `Adafruit_CircuitPython_BME280 <https://github.com/adafruit/Adafruit_CircuitPython_BME280>`_, allowing you to test your code without
+attaching physical hardware.
+
+Instead of using random data, weather data is instead pulled from `the OpenWeatherMaps API <https://openweathermap.org/>`_
+and returned as if it were coming from the BME280 sensor properties. A free OpenWeatherMap API key is **required** to use this library (see the Usage section below for more information).
+
+Dependencies
+=============
+This driver depends on:
+
+* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
+* `Adafruit_CircuitPython_Requests <https://github.com/adafruit/Adafruit_CircuitPython_Requests>`_
+
+Please ensure all dependencies are available on the CircuitPython filesystem.
+This is easily achieved by downloading
+`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
+or individual libraries can be installed using
+`circup <https://github.com/adafruit/circup>`_.
+
+Installing from PyPI
+=====================
+
+On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
+PyPI <https://pypi.org/project/circuitpython-fake-bme280/>`_.
+To install for current user:
+
+.. code-block:: shell
+
+    pip3 install circuitpython-fake-bme280
+
+To install system-wide (this may be required in some cases):
+
+.. code-block:: shell
+
+    sudo pip3 install circuitpython-fake-bme280
+
+To install in a virtual environment in your current project:
+
+.. code-block:: shell
+
+    mkdir project-name && cd project-name
+    python3 -m venv .venv
+    source .env/bin/activate
+    pip3 install circuitpython-fake-bme280
+
+Usage Example
+=============
+
+To obtain an OpenWeatherMaps API key, sign up for a free account at `OpenWeatherMaps <https://openweathermap.org/>`_ and generate an API key. Then, in the root of this
+project, add a file called "settings.toml" with the following information:
+
+openweather_token = "my_api_key"
+openweather_location = "New York, US"
+openweather_units = "metric"
+
+
+Where openweather_token is your OpenWeatherMaps API key, openweather_location is the location you want to pull weather data from, and openweather_units is the units you want the temperature to be returned in (either "metric" or "imperial").
+
+Then, run the code within "examples/fake_bme280.py" to use the "fake" BME280 sensor.
+
+Documentation
+=============
+API documentation for this library can be found on `Read the Docs <https://circuitpython-fake-bme280.readthedocs.io/>`_.
+
+For information on building library documentation, please check out
+`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
+
+Contributing
+============
+
+Contributions are welcome! Please read our `Code of Conduct
+<https://github.com/brentru/CircuitPython_Fake_BME280/blob/HEAD/CODE_OF_CONDUCT.md>`_
+before contributing to help this project stay welcoming.

circuitpython_fake_bme280-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+fake_bme280/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fake_bme280/basic.py,sha256=50n_i9pqkRGjQDFuYuFq6ORj6tbgVu045EdCHm13QeU,9778
+fake_bme280/protocol.py,sha256=56B02wVkQOt6W_sEwfSPuSKEanBTryJKpg24H8wKpgA,983
+circuitpython_fake_bme280-1.0.0.dist-info/LICENSE,sha256=tXgkGXjihZP5R0fW0-IyViyV_rB8TXrzKdiLP4crJn0,1103
+circuitpython_fake_bme280-1.0.0.dist-info/METADATA,sha256=l1UyzzNf_jSSOU_WztzRbaqbsEkQQbzM0e4sQSp7x_g,4590
+circuitpython_fake_bme280-1.0.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+circuitpython_fake_bme280-1.0.0.dist-info/top_level.txt,sha256=zYm6UwRd0tbyREvYLz0zQcP9NY4GvkMWQ19rZYbwO0Q,12
+circuitpython_fake_bme280-1.0.0.dist-info/RECORD,,

circuitpython_fake_bme280-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

circuitpython_fake_bme280-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+fake_bme280

fake_bme280/basic.py

@@ -0,0 +1,312 @@
+# SPDX-FileCopyrightText: 2017 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+`fake_bme280.basic`
+=========================================================================================
+
+CircuitPython driver from BME280 Temperature, Humidity and Barometric
+Pressure sensor
+
+* Author(s): ladyada, Jose David M.
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Adafruit BME280 Temperature, Humidity and Barometric Pressure sensor
+  <https://www.adafruit.com/product/2652>`_ (Product ID: 2652)
+
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+"""
+import math
+import os
+import socket as pool
+import ssl
+import typing  # pylint: disable=unused-import
+from micropython import const
+import adafruit_requests
+from fake_bme280.protocol import I2C_Impl, SPI_Impl
+
+try:
+    from busio import I2C, SPI
+    from digitalio import DigitalInOut
+except ImportError:
+    pass
+
+__version__ = "2.6.4"
+__repo__ = "https://github.com/brentru/CircuitPython_Fake_BME280.git"
+
+#    I2C ADDRESS/BITS/SETTINGS
+#    -----------------------------------------------------------------------
+
+"""General Information"""
+_BME280_ADDRESS = const(0x77)
+_BME280_CHIPID = const(0x60)
+_BME280_REGISTER_CHIPID = const(0xD0)
+"""overscan values for temperature, pressure, and humidity"""
+OVERSCAN_X1 = const(0x01)
+OVERSCAN_X16 = const(0x05)
+"""mode values"""
+_BME280_MODES = (0x00, 0x01, 0x03)
+"""iir_filter values"""
+IIR_FILTER_DISABLE = const(0)
+"""
+standby timeconstant values
+TC_X[_Y] where X=milliseconds and Y=tenths of a millisecond
+"""
+STANDBY_TC_125 = const(0x02)  # 125ms
+"""mode values"""
+MODE_SLEEP = const(0x00)
+MODE_FORCE = const(0x01)
+MODE_NORMAL = const(0x03)
+"""Other Registers"""
+_BME280_REGISTER_SOFTRESET = const(0xE0)
+_BME280_REGISTER_CTRL_HUM = const(0xF2)
+_BME280_REGISTER_STATUS = const(0xF3)
+_BME280_REGISTER_CTRL_MEAS = const(0xF4)
+_BME280_REGISTER_CONFIG = const(0xF5)
+_BME280_REGISTER_TEMPDATA = const(0xFA)
+_BME280_REGISTER_HUMIDDATA = const(0xFD)
+
+# OpenWeatherMap API
+# GET weather data for a specific location
+# TODO: this could be cleaned up a bit..
+DATA_SOURCE = (
+    "http://api.openweathermap.org/data/2.5/weather?q="
+    + os.getenv("openweather_location")
+    + "&units="
+    + os.getenv("openweather_units")
+    + "&mode=json"
+    + "&appid="
+    + os.getenv("openweather_token")
+)
+
+
+class Adafruit_BME280:
+    """Driver from BME280 Temperature, Humidity and Barometric Pressure sensor
+
+    .. note::
+        The operational range of the BME280 is 300-1100 hPa.
+        Pressure measurements outside this range may not be as accurate.
+
+    """
+
+    # pylint: disable=too-many-instance-attributes
+    def __init__(self, bus_implementation: typing.Union[I2C_Impl, SPI_Impl]) -> None:
+        """Mock a BME280 sensor object that was found on an I2C bus."""
+        # Check device ID.
+        self._bus_implementation = bus_implementation
+        # Set some reasonable defaults.
+        self._iir_filter = IIR_FILTER_DISABLE
+        self.overscan_humidity = OVERSCAN_X1
+        self.overscan_temperature = OVERSCAN_X1
+        self.overscan_pressure = OVERSCAN_X16
+        self._t_standby = STANDBY_TC_125
+        self._mode = MODE_SLEEP
+        self.sea_level_pressure = 1013.25
+        """Pressure in hectoPascals at sea level. Used to calibrate `altitude`."""
+        self._t_fine = None
+        # Configure OpenWeather for mock data
+        self.openweather_token = os.getenv("OPENWEATHER_TOKEN", "default_token")
+        self.openweather_location = os.getenv(
+            "OPENWEATHER_LOCATION", "default_location"
+        )
+        # Configure a CPython adafruit_requests session
+        self.requests = adafruit_requests.Session(pool, ssl.create_default_context())
+        self._current_forcast = None
+        # Test call get_forecast
+        self.get_forecast()
+
+    def get_forecast(self):
+        """Fetch weather from OpenWeatherMap API"""
+        # print("Fetching json from", DATA_SOURCE)
+        response = self.requests.get(DATA_SOURCE)
+        self._current_forcast = response.json()
+        # print(self._current_forcast)
+
+    def _read_temperature(self) -> None:
+        # Get the OpenWeather temperature and store it in _t_fine
+        self.get_forecast()
+        self._t_fine = self._current_forcast["main"]["temp"]
+
+    @property
+    def mode(self) -> int:
+        """
+        Operation mode
+        Allowed values are the constants MODE_*
+        """
+        return self._mode
+
+    @mode.setter
+    def mode(self, value: int) -> None:
+        if not value in _BME280_MODES:
+            raise ValueError("Mode '%s' not supported" % (value))
+        self._mode = value
+
+    @property
+    def _config(self) -> int:
+        """Value to be written to the device's config register"""
+        config = 0
+        if self.mode == 0x03:  # MODE_NORMAL
+            config += self._t_standby << 5
+        if self._iir_filter:
+            config += self._iir_filter << 2
+        return config
+
+    @property
+    def _ctrl_meas(self) -> int:
+        """Value to be written to the device's ctrl_meas register"""
+        ctrl_meas = self.overscan_temperature << 5
+        ctrl_meas += self.overscan_pressure << 2
+        ctrl_meas += self.mode
+        return ctrl_meas
+
+    @property
+    def temperature(self) -> float:
+        """The compensated temperature in degrees Celsius."""
+        self._read_temperature()
+        return self._t_fine
+
+    @property
+    def pressure(self) -> float:
+        """
+        The compensated pressure in hectoPascals.
+        """
+        self._read_temperature()
+        return self._current_forcast["main"]["pressure"]
+
+    @property
+    def relative_humidity(self) -> float:
+        """
+        The relative humidity in RH %
+        """
+        return self.humidity
+
+    @property
+    def humidity(self) -> float:
+        """
+        The relative humidity in RH %
+        """
+        self._read_temperature()
+        humidity = self._current_forcast["main"]["humidity"]
+        if humidity > 100:
+            return 100
+        if humidity < 0:
+            return 0
+        return humidity
+
+    @property
+    def altitude(self) -> float:
+        """The altitude based on current :attr:`pressure` versus the sea level pressure
+        (``sea_level_pressure``) - which you must enter ahead of time)"""
+        pressure = self.pressure  # in Si units for hPascal
+        return 44330 * (1.0 - math.pow(pressure / self.sea_level_pressure, 0.1903))
+
+
+class Adafruit_BME280_I2C(Adafruit_BME280):
+    """Driver for BME280 connected over I2C
+
+    :param ~busio.I2C i2c: The I2C bus the BME280 is connected to.
+    :param int address: I2C device address. Defaults to :const:`0x77`.
+                        but another address can be passed in as an argument
+
+    .. note::
+        The operational range of the BMP280 is 300-1100 hPa.
+        Pressure measurements outside this range may not be as accurate.
+
+    **Quickstart: Importing and using the BME280**
+
+    Here is an example of using the :class:`Adafruit_BME280_I2C`.
+    First you will need to import the libraries to use the sensor
+
+    .. code-block:: python
+
+        import board
+        from adafruit_bme280 import basic as adafruit_bme280
+
+    Once this is done you can define your `board.I2C` object and define your sensor object
+
+    .. code-block:: python
+
+        i2c = board.I2C()   # uses board.SCL and board.SDA
+        bme280 = adafruit_bme280.Adafruit_BME280_I2C(i2c)
+
+    You need to setup the pressure at sea level
+
+    .. code-block:: python
+
+        bme280.sea_level_pressure = 1013.25
+
+    Now you have access to the :attr:`temperature`, :attr:`relative_humidity`
+    :attr:`pressure` and :attr:`altitude` attributes
+
+    .. code-block:: python
+
+        temperature = bme280.temperature
+        relative_humidity = bme280.relative_humidity
+        pressure = bme280.pressure
+        altitude = bme280.altitude
+
+    """
+
+    def __init__(self, i2c: I2C, address: int = 0x77) -> None:  # BME280_ADDRESS
+        super().__init__(I2C_Impl(i2c, address))
+
+
+class Adafruit_BME280_SPI(Adafruit_BME280):
+    """Driver for BME280 connected over SPI
+
+    :param ~busio.SPI spi: SPI device
+    :param ~digitalio.DigitalInOut cs: Chip Select
+    :param int baudrate: Clock rate, default is 100000. Can be changed with :meth:`baudrate`
+
+    .. note::
+        The operational range of the BMP280 is 300-1100 hPa.
+        Pressure measurements outside this range may not be as accurate.
+
+    **Quickstart: Importing and using the BME280**
+
+        Here is an example of using the :class:`Adafruit_BME280_SPI` class.
+        First you will need to import the libraries to use the sensor
+
+        .. code-block:: python
+
+            import board
+            from digitalio import DigitalInOut
+            from adafruit_bme280 import basic as adafruit_bme280
+
+        Once this is done you can define your `board.SPI` object and define your sensor object
+
+        .. code-block:: python
+
+            cs = digitalio.DigitalInOut(board.D10)
+            spi = board.SPI()
+            bme280 = adafruit_bme280.Adafruit_BME280_SPI(spi, cs)
+
+        You need to setup the pressure at sea level
+
+        .. code-block:: python
+
+            bme280.sea_level_pressure = 1013.25
+
+        Now you have access to the :attr:`temperature`, :attr:`relative_humidity`
+        :attr:`pressure` and :attr:`altitude` attributes
+
+        .. code-block:: python
+
+            temperature = bme280.temperature
+            relative_humidity = bme280.relative_humidity
+            pressure = bme280.pressure
+            altitude = bme280.altitude
+
+    """
+
+    def __init__(self, spi: SPI, cs: DigitalInOut, baudrate: int = 100000) -> None:
+        super().__init__(SPI_Impl(spi, cs, baudrate))

fake_bme280/protocol.py

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: 2022 Randall Bohn (dexter)
+#
+# SPDX-License-Identifier: MIT
+"Provides the protocol objects for I2C and SPI"
+
+from busio import I2C, SPI
+from digitalio import DigitalInOut
+
+
+class I2C_Impl:
+    "Protocol implementation for the I2C bus."
+
+    # pylint: disable=too-few-public-methods
+    def __init__(self, i2c: I2C, address: int) -> None:
+        from adafruit_bus_device import (  # pylint: disable=import-outside-toplevel
+            i2c_device,
+        )
+
+        self._i2c = i2c_device.I2CDevice(i2c, address)
+
+
+class SPI_Impl:
+    """Protocol implemenation for the SPI bus."""
+
+    # pylint: disable=too-few-public-methods
+    def __init__(
+        self,
+        spi: SPI,
+        chip_select: DigitalInOut,
+        baudrate: int = 100000,
+    ) -> None:
+        from adafruit_bus_device import (  # pylint: disable=import-outside-toplevel
+            spi_device,
+        )
+
+        self._spi = spi_device.SPIDevice(spi, chip_select, baudrate=baudrate)