Skip to main content

A WiFi connection helper for ESP32-based boards

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

circuitpython-esp32connection-0.2.2.tar.gz (20.1 kB view details)

Uploaded Source

File details

Details for the file circuitpython-esp32connection-0.2.2.tar.gz.

File metadata

  • Download URL: circuitpython-esp32connection-0.2.2.tar.gz
  • Upload date:
  • Size: 20.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for circuitpython-esp32connection-0.2.2.tar.gz
Algorithm Hash digest
SHA256 eb84a1b44e93e444d79b681c6cdd13b3d0dc668c2cb6a6c229f3dd8c39d07f9f
MD5 467e96b1e7a6ebbf59e9e7c52be10550
BLAKE2b-256 5811b1117e846172f777b4c54ea133c249dd200898d60d5da7c51cbd65d4efa7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page