https://github.com/jimbobbennett/circuitpython_esp32connection

A WiFi connection helper for ESP32-based boards. This works on PyBadges with Airlift FeatherWings, or PyPortals.
https://github.com/jimbobbennett/circuitpython_esp32connection

Last synced: 5 days ago
JSON representation

A WiFi connection helper for ESP32-based boards. This works on PyBadges with Airlift FeatherWings, or PyPortals.

• Host: GitHub
• URL: https://github.com/jimbobbennett/circuitpython_esp32connection
• Owner: jimbobbennett
• License: mit
• Created: 2020-04-03T01:13:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-07T14:00:49.000Z (almost 4 years ago)
• Last Synced: 2024-09-24T20:47:34.753Z (9 days ago)
• Language: Python
• Size: 27.3 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://readthedocs.org/projects/circuitpython-esp32connection/badge/?version=latest

    :target: https://circuitpython.readthedocs.io/projects/esp32connection/en/latest/

    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://discord.gg/nBQh6qu

    :alt: Discord

.. image:: https://github.com/jimbobbennett/CircuitPython_ESP32Connection/workflows/Build%20CI/badge.svg

    :target: https://github.com/jimbobbennett/CCircuitPython_ESP32Connection/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

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:

.. code-block:: shell

    pip3 install circuitpython-esp32connection

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

.. code-block:: shell

    sudo pip3 install circuitpython-esp32connection

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name

    python3 -m venv .env

    source .env/bin/activate

    pip3 install circuitpython-esp32connection

Usage Example

=============

.. code-block:: python

    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 `_.