Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-esp32spi/badge/?version=latest
:target: https://docs.circuitpython.org/projects/esp32spi/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_ESP32SPI/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/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
CircuitPython driver library for using ESP32 as WiFi co-processor using SPI.
The companion firmware `is available on GitHub
<https://github.com/adafruit/nina-fw>`_. Please be sure to check the example code for
any specific firmware version dependencies that may exist.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Adafruit CircuitPython ConnectionManager <https://github.com/adafruit/Adafruit_CircuitPython_ConnectionManager/>`_
* `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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
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-esp32spi/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-esp32spi
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-esp32spi
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-esp32spi
Usage Example
=============
Check the examples folder for various demos for connecting and fetching data!
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/esp32spi/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_ESP32SPI/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-esp32spi",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, esp32spi, wifi, esp32",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/9f/76/8b17d9471e0769746a20ca5a8c6d1acf423e83097de4f4dfa4e219e9df3f/adafruit_circuitpython_esp32spi-8.4.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-esp32spi/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/esp32spi/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_ESP32SPI/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/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\nCircuitPython driver library for using ESP32 as WiFi co-processor using SPI.\nThe companion firmware `is available on GitHub\n<https://github.com/adafruit/nina-fw>`_. Please be sure to check the example code for\nany specific firmware version dependencies that may exist.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Adafruit CircuitPython ConnectionManager <https://github.com/adafruit/Adafruit_CircuitPython_ConnectionManager/>`_\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-esp32spi/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-esp32spi\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-esp32spi\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-esp32spi\n\nUsage Example\n=============\n\nCheck the examples folder for various demos for connecting and fetching data!\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/esp32spi/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_ESP32SPI/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver library for using ESP32 as WiFi co-processor using SPI",
"version": "8.4.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" esp32spi",
" wifi",
" esp32"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2c663b36a7990d2ec79136e557006c9efca6d9702dc9f9a072c6c5d144bf4626",
"md5": "e67364a2146a0b0f91ca468cb10744cd",
"sha256": "90f51918372ea66b86bdd94b376c2901b810c1fe799c83848ba0ce9bf0e95324"
},
"downloads": -1,
"filename": "adafruit_circuitpython_esp32spi-8.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e67364a2146a0b0f91ca468cb10744cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 22729,
"upload_time": "2024-09-29T18:52:43",
"upload_time_iso_8601": "2024-09-29T18:52:43.019283Z",
"url": "https://files.pythonhosted.org/packages/2c/66/3b36a7990d2ec79136e557006c9efca6d9702dc9f9a072c6c5d144bf4626/adafruit_circuitpython_esp32spi-8.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9f768b17d9471e0769746a20ca5a8c6d1acf423e83097de4f4dfa4e219e9df3f",
"md5": "7bcf97b5d94f849929199e5190f51853",
"sha256": "5104390f56029a3c59be0bc5411e7fbb3e35ebb28b9599831795dabe9f8a3f74"
},
"downloads": -1,
"filename": "adafruit_circuitpython_esp32spi-8.4.1.tar.gz",
"has_sig": false,
"md5_digest": "7bcf97b5d94f849929199e5190f51853",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 50774,
"upload_time": "2024-09-29T18:52:44",
"upload_time_iso_8601": "2024-09-29T18:52:44.812511Z",
"url": "https://files.pythonhosted.org/packages/9f/76/8b17d9471e0769746a20ca5a8c6d1acf423e83097de4f4dfa4e219e9df3f/adafruit_circuitpython_esp32spi-8.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-29 18:52:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_ESP32SPI",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-connectionmanager",
"specs": []
},
{
"name": "adafruit-circuitpython-requests",
"specs": []
}
],
"lcname": "adafruit-circuitpython-esp32spi"
}
JSON
