{ "info": { "author": "Gaston Williams", "author_email": "fourstix@gmail.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/sparkfun-circuitpython-qwiicas3935/badge/?version=latest\n :target: https://sparkfun-circuitpython-qwiicas3935.readthedocs.io/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.org/fourstix/Sparkfun_CircuitPython_Qwiicas3935.svg?branch=master\n :target: https://travis-ci.org/fourstix/Sparkfun_CircuitPython_Qwiicas3935\n :alt: Build Status\n\nCircuitPython library for Sparkfun Qwiic AS3935 Lightning Detector. This library is ported from\n`SparkFun Qwiic AS3935 Lightning Detector Arduino Library `_\n\n.. image:: https://cdn.sparkfun.com//assets/parts/1/3/7/5/1/15276-SparkFun_Lightning_Detector_-_AS3935__Qwiic_-01.jpg\n :target: https://www.sparkfun.com/products/15276\n :alt: SparkFun Qwiic AS3935 Lightning Detector (SEN-15276)\n\n`SparkFun Qwiic AS3935 Lightning Detector (SEN-15276) `_\n \n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython `_\n* `Adafruit Bus Device `_\n* `Sparkfun Qwiic AS3935 Lightning Detector Hardware `_\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\nRaspberry Pi Setup\n------------------\nAdafruit has an excellent tutorial on `Installing CircuitPython Libraries on Raspberry Pi\n`_.\n \nQuick Start Summary:\n\n* Start with the latest version of Raspbian with Wifi configured.\n\n* Enable SSH, I2C and SPI.\n\n.. code-block:: shell\n\n sudo raspi-config\n\n* Update your system to the latest version.\n\n.. code-block:: shell\n\n sudo apt-get update\n sudo apt-get upgrade\n\n* Update the python tools\n\n.. code-block:: shell\n\n sudo pip3 install --upgrade setuptools\n\n(If pip3 is not installed, install it and rerun the command)\n\n.. code-block:: shell\n\n sudo apt-get install python3-pip\n\n* Install the CircuitPython libraries\n\n.. code-block:: shell\n\n pip3 install RPI.GPIO\n pip3 install adafruit-blinka\n\nInstalling from PyPI\n--------------------\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI `_.\n\nInstalling this library will also install the dependency adafruit-circuitpython-busdevice.\n\nInstalling from PyPI\n\n.. code-block:: shell\n\n pip3 install sparkfun-circuitpython-qwiicas3935\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install sparkfun-circuitpython-qwiicas3935\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 sparkfun-circuitpython-qwiicas3935\n\nUsage Example\n=============\n* `Qwiic AS3935 Lightning Detector Hookup Guide `_ - The Arduino examples in the Hookup Guide are available for Python with this library\n* `CircuitPython on a Raspberry Pi `_ - Basic information on how to install CircuitPython on a Raspberry Pi.\n\n* Code Example:\n\n .. code-block:: shell\n \n # import the CircuitPython board and busio libraries\n import board\n import busio\n import sparkfun_qwiicas3935\n\n # Create bus object using the board's I2C port\n i2c = busio.I2C(board.SCL, board.SDA)\n\n as3935 = QwiicAS3935_I2C(i2c) # default address is 0x03\n\n # OR create a library object using the board's SPI port\n # spi = busio.SPI(board.SCK, board.MOSI, board.MISO)\n # cs = digitalio.DigitalInOut(board.CE0)\n # cs.direction = digitalio.Direction.OUTPUT\n # as3935 = QwiicAS3935_SPI(spi, cs)\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\nZip release files\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 sparkfun-circuitpython-qwiicas3935 --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.\n\nLicense Information\n-----------------------\nThis product is **open source**! \n\nPlease review the LICENSE.md file for license information. \n\nPlease use, reuse, and modify these files as you see fit. \n\nPlease maintain the attributions to SparkFun Electronics and Adafruit and release any derivative under the same license.\n\nDistributed as-is; no warranty is given.", "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/fourstix/Sparkfun_CircuitPython_QwiicAS3935", "keywords": "adafruit blinka circuitpython micropython qwiicas3935 sparkfun as3935 lightning detector", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sparkfun-circuitpython-qwiicas3935", "package_url": "https://pypi.org/project/sparkfun-circuitpython-qwiicas3935/", "platform": "", "project_url": "https://pypi.org/project/sparkfun-circuitpython-qwiicas3935/", "project_urls": { "Homepage": "https://github.com/fourstix/Sparkfun_CircuitPython_QwiicAS3935" }, "release_url": "https://pypi.org/project/sparkfun-circuitpython-qwiicas3935/1.0.3/", "requires_dist": null, "requires_python": "", "summary": "CircuitPython driver library for the Sparkfun AS3935 Lightning Detector", "version": "1.0.3" }, "last_serial": 5513471, "releases": { "0.0.3": [ { "comment_text": "", "digests": { "md5": "57685b1e9c308dc8f573b0f31caf5a26", "sha256": "b2a99994d5c62b45f1c229a9ce6a92262941d8ed1a2ba9bf0f1ac388852cd515" }, "downloads": -1, "filename": "sparkfun-circuitpython-qwiicas3935-0.0.3.tar.gz", "has_sig": false, "md5_digest": "57685b1e9c308dc8f573b0f31caf5a26", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 32413, "upload_time": "2019-07-09T20:09:12", "url": "https://files.pythonhosted.org/packages/96/1e/03789310ce0a9b38a664bcb48044fe47f43037455c13065296a940b9755f/sparkfun-circuitpython-qwiicas3935-0.0.3.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "ee1b4431b83ebd47de94bed70255ed11", "sha256": "d23386191a58f167a2e19fb1ce774260a2139cdeacba9ad2b9940e90572972ca" }, "downloads": -1, "filename": "sparkfun-circuitpython-qwiicas3935-1.0.2.tar.gz", "has_sig": false, "md5_digest": "ee1b4431b83ebd47de94bed70255ed11", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30795, "upload_time": "2019-07-10T00:37:31", "url": "https://files.pythonhosted.org/packages/f1/40/f2c8681d1f975db81df7cb1778d21f227ceaed8c96d418057b548947ccf0/sparkfun-circuitpython-qwiicas3935-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "c544325435579edfccfe2cbe5f9846c1", "sha256": "f8e4157e357411ff458ce458a5d1b27290385646683e6bede0d5972627a03c31" }, "downloads": -1, "filename": "sparkfun-circuitpython-qwiicas3935-1.0.3.tar.gz", "has_sig": false, "md5_digest": "c544325435579edfccfe2cbe5f9846c1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30917, "upload_time": "2019-07-10T18:36:37", "url": "https://files.pythonhosted.org/packages/34/3f/1affca13d5f4739d3d5f80740c05ddba0338a9299f68739ccd2de6ac64b2/sparkfun-circuitpython-qwiicas3935-1.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c544325435579edfccfe2cbe5f9846c1", "sha256": "f8e4157e357411ff458ce458a5d1b27290385646683e6bede0d5972627a03c31" }, "downloads": -1, "filename": "sparkfun-circuitpython-qwiicas3935-1.0.3.tar.gz", "has_sig": false, "md5_digest": "c544325435579edfccfe2cbe5f9846c1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30917, "upload_time": "2019-07-10T18:36:37", "url": "https://files.pythonhosted.org/packages/34/3f/1affca13d5f4739d3d5f80740c05ddba0338a9299f68739ccd2de6ac64b2/sparkfun-circuitpython-qwiicas3935-1.0.3.tar.gz" } ] }