An open API service indexing awesome lists of open source software.

https://github.com/adafruit/adafruit_circuitpython_esp32spi

ESP32 as wifi with SPI interface
https://github.com/adafruit/adafruit_circuitpython_esp32spi

hacktoberfest

Last synced: over 1 year ago
JSON representation

ESP32 as wifi with SPI interface

Awesome Lists containing this project

README

          

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
`_. Please be sure to check the example code for
any specific firmware version dependencies that may exist.

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

* `Adafruit CircuitPython `_
* `Adafruit Bus Device `_
* `Adafruit CircuitPython ConnectionManager `_
* `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 `_.

Installing from PyPI
====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI `_. 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 `_.

For information on building library documentation, please check out `this guide `_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
`_
before contributing to help this project stay welcoming.