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.
Raw data
{
"_id": null,
"home_page": null,
"name": "circuitpython-fake-bme280",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, fake_bme280, bme280, , test, , fake, , mock, , stub",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/6b/b3/f5106b0ea18bd2a2e524bdc70fb60bd19ade4e24de331727872f2d10e9de/circuitpython_fake_bme280-1.0.4.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/brentru/CircuitPython_Fake_BME280/workflows/Build%20CI/badge.svg\n :target: https://github.com/brentru/CircuitPython_Fake_BME280/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\n**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>`_.\n\nThis driver mocks the functionality of the `Adafruit_CircuitPython_BME280 <https://github.com/adafruit/Adafruit_CircuitPython_BME280>`_, allowing you to test your code without\nattaching physical hardware.\n\nInstead of using random data, weather data is instead pulled from `the OpenWeatherMaps API <https://openweathermap.org/>`_\nand 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).\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit_CircuitPython_Requests <https://github.com/adafruit/Adafruit_CircuitPython_Requests>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-fake-bme280/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-fake-bme280\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-fake-bme280\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install circuitpython-fake-bme280\n\nUsage Example\n=============\n\nTo 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\nproject, add a file called \"settings.toml\" with the following information:\n\nopenweather_token = \"my_api_key\"\nopenweather_location = \"New York, US\"\nopenweather_units = \"metric\"\n\n\nWhere 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\").\n\nThen, run the code within \"examples/fake_bme280.py\" to use the \"fake\" BME280 sensor.\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-fake-bme280.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/brentru/CircuitPython_Fake_BME280/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "BME280 Driver for CircuitPython used for testing functionality with no hardware attached",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/brentru/CircuitPython_Fake_BME280"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" fake_bme280",
" bme280",
" ",
" test",
" ",
" fake",
" ",
" mock",
" ",
" stub"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4715082c8286c171ef29fde650bde65b4ecadbd34ae5a5bfb2028dff976d42c",
"md5": "4ddbdcbce3ab20d3d85d3f2b46d65fac",
"sha256": "112492652f1823bc04a01b55408c892648e5174db96ead98e8046cf9501aab5f"
},
"downloads": -1,
"filename": "circuitpython_fake_bme280-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ddbdcbce3ab20d3d85d3f2b46d65fac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7655,
"upload_time": "2024-10-10T15:51:50",
"upload_time_iso_8601": "2024-10-10T15:51:50.954350Z",
"url": "https://files.pythonhosted.org/packages/c4/71/5082c8286c171ef29fde650bde65b4ecadbd34ae5a5bfb2028dff976d42c/circuitpython_fake_bme280-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6bb3f5106b0ea18bd2a2e524bdc70fb60bd19ade4e24de331727872f2d10e9de",
"md5": "6795c668ab948f43f146dc0a79aadc01",
"sha256": "fceff913075339d7d44eb7d1ee541e9f0a20f6e2f9fd37dcd542fbf077fc8990"
},
"downloads": -1,
"filename": "circuitpython_fake_bme280-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "6795c668ab948f43f146dc0a79aadc01",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26035,
"upload_time": "2024-10-10T15:51:52",
"upload_time_iso_8601": "2024-10-10T15:51:52.590750Z",
"url": "https://files.pythonhosted.org/packages/6b/b3/f5106b0ea18bd2a2e524bdc70fb60bd19ade4e24de331727872f2d10e9de/circuitpython_fake_bme280-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 15:51:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brentru",
"github_project": "CircuitPython_Fake_BME280",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-fake-bme280"
}
JSON
