adafruit-circuitpython-dps310


Nameadafruit-circuitpython-dps310 JSON
Version 2.1.13 PyPI version JSON
download
home_page
SummaryLibrary for the DPS310 Precision Barometric Pressure Sensor
upload_time2023-09-25 15:39:02
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython dps310 pressure sensor barometric altimeter altitude
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-dsp310/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/dps310/en/latest/
    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
    :target: https://adafru.it/discord
    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_DPS310/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_DPS310/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

Library for the DPS310 Precision Barometric Pressure Sensor


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_

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

Installing from PyPI
=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-dps310/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-dps310

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-dps310

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .venv/bin/activate
    pip3 install adafruit-circuitpython-dps310


Installing to a connected CircuitPython Device
==============================================
Some devices, eg. the QT-PY, are very limited in memory. The DPS310 library contains
two variants - basic and advanced - which give different levels of functionality.

Installing the DPS310 library could have the following outcomes:

    * It installs successfully and your code runs successfully. Woo-hoo! Continue with
      your amazing project.
    * It installs successfully and your code fails to run with a memory allocation
      error. Try one of the following:

        * If your ``code.py`` is large, especially if it has lots of comments, you
          can shrink it into a ``.mpy`` file instead. See the Adafruit
          `Learn Guide <https://learn.adafruit.com/Memory-saving-tips-for-CircuitPython/non-volatile-not-enough-disk-space>`_
          on shrinking your code.
        * Only use the basic DPS310 implementation, and remove the following file:
          ``<CIRCUITPY>/lib/adafruit_dps310/advanced.mpy`` where <CIRCUITPY> is the
          mounted location of your device. Make sure that your code only uses the basic
          implementation.


Usage Example
=============

.. code-block:: python3

    import time
    import board
    from adafruit_dps310.basic import DPS310

    i2c = board.I2C()   # uses board.SCL and board.SDA

    dps310 = DPS310(i2c)

    while True:
        print("Temperature = %.2f *C"%dps310.temperature)
        print("Pressure = %.2f hPa"%dps310.pressure)
        print("")
        time.sleep(1.0)


Known Issues
============
Library extensive features might not be compatible with memory limited boards. For these kind of
boards you need to use the ``adafruit_dps310/basic.mpy``, the file needs to be in the ``mpy``
format in order to fit in memory.
For boards with more memory available you could use the code present
in ``adafruit_dps310/advanced.py``. For usage refer to ``dps310_simpletest_advanced.py``


Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/dps310/en/latest/>`_.

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/adafruit/Adafruit_CircuitPython_DPS310/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-dps310",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,blinka,circuitpython,micropython,dps310,pressure,sensor,barometric,altimeter,altitude",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/77/57/81e3a5d59a058232c7a361f75c937568ea15b8fb136e3c383fe55e6eacd2/adafruit-circuitpython-dps310-2.1.13.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-dsp310/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/dps310/en/latest/\n    :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n    :target: https://adafru.it/discord\n    :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_DPS310/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_DPS310/actions\n    :alt: Build Status\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\nLibrary for the DPS310 Precision Barometric Pressure Sensor\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\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>`_.\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/adafruit-circuitpython-dps310/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-dps310\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-dps310\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 .venv/bin/activate\n    pip3 install adafruit-circuitpython-dps310\n\n\nInstalling to a connected CircuitPython Device\n==============================================\nSome devices, eg. the QT-PY, are very limited in memory. The DPS310 library contains\ntwo variants - basic and advanced - which give different levels of functionality.\n\nInstalling the DPS310 library could have the following outcomes:\n\n    * It installs successfully and your code runs successfully. Woo-hoo! Continue with\n      your amazing project.\n    * It installs successfully and your code fails to run with a memory allocation\n      error. Try one of the following:\n\n        * If your ``code.py`` is large, especially if it has lots of comments, you\n          can shrink it into a ``.mpy`` file instead. See the Adafruit\n          `Learn Guide <https://learn.adafruit.com/Memory-saving-tips-for-CircuitPython/non-volatile-not-enough-disk-space>`_\n          on shrinking your code.\n        * Only use the basic DPS310 implementation, and remove the following file:\n          ``<CIRCUITPY>/lib/adafruit_dps310/advanced.mpy`` where <CIRCUITPY> is the\n          mounted location of your device. Make sure that your code only uses the basic\n          implementation.\n\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n    import time\n    import board\n    from adafruit_dps310.basic import DPS310\n\n    i2c = board.I2C()   # uses board.SCL and board.SDA\n\n    dps310 = DPS310(i2c)\n\n    while True:\n        print(\"Temperature = %.2f *C\"%dps310.temperature)\n        print(\"Pressure = %.2f hPa\"%dps310.pressure)\n        print(\"\")\n        time.sleep(1.0)\n\n\nKnown Issues\n============\nLibrary extensive features might not be compatible with memory limited boards. For these kind of\nboards you need to use the ``adafruit_dps310/basic.mpy``, the file needs to be in the ``mpy``\nformat in order to fit in memory.\nFor boards with more memory available you could use the code present\nin ``adafruit_dps310/advanced.py``. For usage refer to ``dps310_simpletest_advanced.py``\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/dps310/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_DPS310/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Library for the DPS310 Precision Barometric Pressure Sensor",
    "version": "2.1.13",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DPS310"
    },
    "split_keywords": [
        "adafruit",
        "blinka",
        "circuitpython",
        "micropython",
        "dps310",
        "pressure",
        "sensor",
        "barometric",
        "altimeter",
        "altitude"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6545b032e12ebab31018c6416df7e2a6f969f42b851bd029f8527de0704ceaf2",
                "md5": "562cab0a0e323741806fc7d8f9798ddc",
                "sha256": "6873549c8ba3f641af0b03f4d4ade4c60c6fb7609ef9e43c39327d5ad93b2eec"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_dps310-2.1.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "562cab0a0e323741806fc7d8f9798ddc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 10949,
            "upload_time": "2023-09-25T15:39:00",
            "upload_time_iso_8601": "2023-09-25T15:39:00.732446Z",
            "url": "https://files.pythonhosted.org/packages/65/45/b032e12ebab31018c6416df7e2a6f969f42b851bd029f8527de0704ceaf2/adafruit_circuitpython_dps310-2.1.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "775781e3a5d59a058232c7a361f75c937568ea15b8fb136e3c383fe55e6eacd2",
                "md5": "435ddddb306b54edeae9f0eb8a0eae53",
                "sha256": "4ea95a1793dfd5895c8a301445195bfee76c322c2c1625642294acd24f0ba794"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-dps310-2.1.13.tar.gz",
            "has_sig": false,
            "md5_digest": "435ddddb306b54edeae9f0eb8a0eae53",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 30809,
            "upload_time": "2023-09-25T15:39:02",
            "upload_time_iso_8601": "2023-09-25T15:39:02.072986Z",
            "url": "https://files.pythonhosted.org/packages/77/57/81e3a5d59a058232c7a361f75c937568ea15b8fb136e3c383fe55e6eacd2/adafruit-circuitpython-dps310-2.1.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-25 15:39:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_DPS310",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-dps310"
}
        
Elapsed time: 2.95540s