{ "info": { "author": "Adafruit Industries", "author_email": "circuitpython@adafruit.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Libraries", "Topic :: System :: Hardware" ], "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-sgp30/badge/?version=latest\n :target: https://circuitpython.readthedocs.io/projects/sgp30/en/latest/\n :alt: Documentation Status\n\n.. image :: https://img.shields.io/discord/327254708534116352.svg\n :target: https://discord.gg/nBQh6qu\n :alt: Discord\n\n.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_SGP30.svg?branch=master\n :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_SGP30\n :alt: Build Status\n\nA CircuitPython driver for the Sensirion SGP30 gas sensor with eCO2 and TVOC output. This sensor uses I2C!\n\nInstallation and Dependencies\n=============================\nThis driver depends on:\n\n* `Adafruit CircuitPython `_\n* `Bus Device `_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle `_.\n\nInstalling from PyPI\n--------------------\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI `_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-sgp30\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-sgp30\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 .env\n source .env/bin/activate\n pip3 install adafruit-circuitpython-sgp30\n\nUsage Notes\n=============\n\nSee `the guide `_\nfor wiring and installation instructions.\n\nFirst, import the library:\n\n.. code-block:: python\n\n import busio\n import adafruit_sgp30\n\nNext, initialize the I2C bus object:\n\n.. code-block:: python\n\n import board\n i2c_bus = busio.I2C(board.SCL, board.SDA, frequency=100000)\n\nSince we have the I2C bus object, we can now use it to instantiate the SGP30 object:\n\n.. code-block:: python\n\n sgp30 = adafruit_sgp30.Adafruit_SGP30(i2c_bus)\n\nReading from the Sensor\n------------------------\n\nTo read from the sensor:\n\n.. code-block:: python\n\n eCO2, TVOC = sgp30.iaq_measure()\n print(\"eCO2 = %d ppm \\t TVOC = %d ppb\" % (eCO2, TVOC))\n\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n`_\nbefore contributing to help this project stay welcoming.\n\nBuilding locally\n================\n\nTo build this library locally you'll need to install the\n`circuitpython-build-tools `_ package.\n\n.. code-block:: shell\n\n python3 -m venv .env\n source .env/bin/activate\n pip install circuitpython-build-tools\n\nOnce installed, make sure you are in the virtual environment:\n\n.. code-block:: shell\n\n source .env/bin/activate\n\nThen run the build:\n\n.. code-block:: shell\n\n circuitpython-build-bundles --filename_prefix adafruit-circuitpython-sgp30 --library_location .\n\nSphinx documentation\n-----------------------\n\nSphinx is used to build the documentation based on rST files and comments in the code. First,\ninstall dependencies (feel free to reuse the virtual environment from above):\n\n.. code-block:: shell\n\n python3 -m venv .env\n source .env/bin/activate\n pip install Sphinx sphinx-rtd-theme\n\nNow, once you have the virtual environment activated:\n\n.. code-block:: shell\n\n cd docs\n sphinx-build -E -W -b html . _build/html\n\nThis will output the documentation to ``docs/_build/html``. Open the index.html in your browser to\nview them. It will also (due to -W) error out on any warning like Travis will. This is a good way to\nlocally verify it will pass.", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/adafruit/Adafruit_CircuitPython_SGP30", "keywords": "adafruit sensiron sgp30 gas sensor eco2 tvoc i2c hardware micropython circuitpython", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "adafruit-circuitpython-sgp30", "package_url": "https://pypi.org/project/adafruit-circuitpython-sgp30/", "platform": "", "project_url": "https://pypi.org/project/adafruit-circuitpython-sgp30/", "project_urls": { "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SGP30" }, "release_url": "https://pypi.org/project/adafruit-circuitpython-sgp30/2.0.3/", "requires_dist": null, "requires_python": "", "summary": "CircuitPython library for Sensirion SGP30 gas sensor with eCO2 and TVOC.", "version": "2.0.3" }, "last_serial": 5669424, "releases": { "1.1.0": [ { "comment_text": "", "digests": { "md5": "717bf89178c9165e997cf7f55f23e567", "sha256": "578b9521784194fbadf40e9d5bb3b7a6c39efc204fbaed9703a722b26691ec45" }, "downloads": -1, "filename": "adafruit-circuitpython-sgp30-1.1.0.tar.gz", "has_sig": false, "md5_digest": "717bf89178c9165e997cf7f55f23e567", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20883, "upload_time": "2018-08-07T22:32:56", "url": "https://files.pythonhosted.org/packages/14/d4/83b880406196a21d6d7680dd5efff2bd782ae06982ef7b56d8e2839e5bbd/adafruit-circuitpython-sgp30-1.1.0.tar.gz" } ], "2.0.0": [ { "comment_text": "", "digests": { "md5": "02d73b711dd4b1822f4cde7ccceef29d", "sha256": "aef66b31d8aeb89d6ef70b3fddc73f8fcffaeb3c6dc34aea9fecf9c97ec9fb47" }, "downloads": -1, "filename": "adafruit-circuitpython-sgp30-2.0.0.tar.gz", "has_sig": false, "md5_digest": "02d73b711dd4b1822f4cde7ccceef29d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21341, "upload_time": "2018-11-12T21:43:04", "url": "https://files.pythonhosted.org/packages/c0/7d/07fd6807b1c3837398b77b0a59eda2f09aa95fdcdfa73625802b4630bad9/adafruit-circuitpython-sgp30-2.0.0.tar.gz" } ], "2.0.1": [ { "comment_text": "", "digests": { "md5": "5d7f7b51d1b9c086e5a4d8ae4d38ce12", "sha256": "3767675402b4b1529a4434771030bd1c6c230c1fe7300f2a7e5570deb65419cd" }, "downloads": -1, "filename": "adafruit-circuitpython-sgp30-2.0.1.tar.gz", "has_sig": false, "md5_digest": "5d7f7b51d1b9c086e5a4d8ae4d38ce12", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19745, "upload_time": "2019-01-15T00:39:04", "url": "https://files.pythonhosted.org/packages/31/e7/74267415141b1b831cdf298998855b41d0a5ffb1078288be167c3d62cd06/adafruit-circuitpython-sgp30-2.0.1.tar.gz" } ], "2.0.2": [ { "comment_text": "", "digests": { "md5": "0cf416380737680a2f4dfecd813e0108", "sha256": "372c9e2331ba696cea1be94559c04fdd696d3290d1fea355de16f55e53c83849" }, "downloads": -1, "filename": "adafruit-circuitpython-sgp30-2.0.2.tar.gz", "has_sig": false, "md5_digest": "0cf416380737680a2f4dfecd813e0108", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19751, "upload_time": "2019-05-13T05:11:50", "url": "https://files.pythonhosted.org/packages/28/8a/b20f2dc5ffd6f1c139b97f336dd16f0f24adad4876c0eac146b4d1f4b76e/adafruit-circuitpython-sgp30-2.0.2.tar.gz" } ], "2.0.3": [ { "comment_text": "", "digests": { "md5": "82e84420046e08d92e6f7226651b3d1e", "sha256": "8cccfc4d915ffaf9751275a05d0819ef095adc0efcb3b232555ece3204ddeb8a" }, "downloads": -1, "filename": "adafruit-circuitpython-sgp30-2.0.3.tar.gz", "has_sig": false, "md5_digest": "82e84420046e08d92e6f7226651b3d1e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19743, "upload_time": "2019-08-13T00:54:00", "url": "https://files.pythonhosted.org/packages/8a/ac/d460d258776933bb46d67e5e1d0a4e8325762c9a32f3d8488b98a221eff0/adafruit-circuitpython-sgp30-2.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "82e84420046e08d92e6f7226651b3d1e", "sha256": "8cccfc4d915ffaf9751275a05d0819ef095adc0efcb3b232555ece3204ddeb8a" }, "downloads": -1, "filename": "adafruit-circuitpython-sgp30-2.0.3.tar.gz", "has_sig": false, "md5_digest": "82e84420046e08d92e6f7226651b3d1e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19743, "upload_time": "2019-08-13T00:54:00", "url": "https://files.pythonhosted.org/packages/8a/ac/d460d258776933bb46d67e5e1d0a4e8325762c9a32f3d8488b98a221eff0/adafruit-circuitpython-sgp30-2.0.3.tar.gz" } ] }