Skip to content

adafruit/Adafruit_CircuitPython_ESP32SPI

Repository files navigation

Introduction

Documentation Status Discord Build Status 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:

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:

pip3 install adafruit-circuitpython-esp32spi

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

sudo pip3 install adafruit-circuitpython-esp32spi

To install in a virtual environment in your current project:

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.