Introduction

A WiFi connection helper for ESP32-based boards. This works on PyBadges with Airlift FeatherWings, or PyPortals. It may work on other ESP32 devices, but hasn't been tested.

Dependencies

This driver depends on:

• Adafruit CircuitPython

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 circuitpython-esp32connection

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

sudo pip3 install circuitpython-esp32connection

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 circuitpython-esp32connection

Usage Example

from esp32connection import Connection
import secrets

# Create the connection
connection = Connection()

# secrets must be a dictionary containing two values:
# ssid - the ssid of the WiFi to connect to
# password - the password of the WiFi to connect to
connection.connect(secrets)

Contributing

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

Documentation

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