circuitpython-fake-bme280 1.2

BME280 Driver for CircuitPython used for testing functionality with no hardware attached

Introduction

This code is for testing purposes only! If you are looking for a Bosch BME280 driver, please use the Adafruit_CircuitPython_BME280.

This driver mocks the functionality of the 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 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

• 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 or individual libraries can be installed using circup.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install circuitpython-fake-bme280

To install system-wide (this may be required in some cases):

sudo pip3 install circuitpython-fake-bme280

To install in a virtual environment in your current project:

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 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.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.