Skip to content
ESP32 as wifi with SPI interface
Branch: master
Clone or download
Latest commit 92182ea Jun 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
adafruit_esp32spi test the pixel attributes within pixel_status Jun 11, 2019
docs Travis fix Feb 15, 2019
examples add an externally defined rgbled status_led to _wifimanager Jun 11, 2019
.gitignore new cookie Feb 7, 2019
.pylintrc
.readthedocs.yml new cookie Feb 7, 2019
.travis.yml lowercase-t true... I'll remember eventually. Feb 11, 2019
CODE_OF_CONDUCT.md new cookie Feb 7, 2019
LICENSE new cookie Feb 7, 2019
README.rst Updated WPA2 Enterprise example code to check ESP32 firmware version;… Apr 6, 2019
requirements.txt new cookie Feb 7, 2019
setup.py PyPI setup. Feb 11, 2019

README.rst

Introduction

Documentation Status Discord Build Status

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 .env
source .env/bin/activate
pip3 install adafruit-circuitpython-esp32spi

Usage Example

Check the examples folder for various demos for connecting and fetching data!

Contributing

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

Building locally

Zip release files

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-esp32spi --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

You can’t perform that action at this time.