https://github.com/gmparis/circuitpython_pyportal_multissid

Class that adds multiple-SSID support to Adafruit's PyPortal
https://github.com/gmparis/circuitpython_pyportal_multissid

circuitpython

Last synced: 24 days ago
JSON representation

Class that adds multiple-SSID support to Adafruit's PyPortal

• Host: GitHub
• URL: https://github.com/gmparis/circuitpython_pyportal_multissid
• Owner: gmparis
• License: mit
• Created: 2019-12-16T22:48:37.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-12-08T01:03:37.000Z (almost 4 years ago)
• Last Synced: 2024-10-03T06:42:10.324Z (about 1 month ago)
• Topics: circuitpython
• Language: Python
• Size: 25.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• 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-pyportal_multissid/badge/?version=latest

    :target: https://circuitpython-pyportal_multissid.readthedocs.io/

    :alt: Documentation Status

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

    :target: https://adafru.it/discord

    :alt: Discord

.. Unfortunately, Travis build fails because adafruit_pyportal is not in PyPi.

.. .. image:: https://travis-ci.com/gmparis/CircuitPython_pyportal_multissid.svg?branch=master

    :target: https://travis-ci.com/gmparis/CircuitPython_pyportal_multissid

    :alt: Build Status

Allows PyPortal to connect to multiple SSIDs

Dependencies

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

This driver depends on:

* `Adafruit CircuitPython `_

* `Adafruit CircuitPython PyPortal `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_.

Usage Example

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

This module implements a child class build upon Adafruit's PyPortal class.

The class implements just one method, overriding a base method, allowing

the PyPortal device to connect to more than one SSID. To use, invoke this

class where you would have used the PyPortal class. For example::

    from pyportal_multissid import PyPortal_MultiSSID

    pyportal = PyPortal_MultiSSID(status_neopixel=board.NEOPIXEL)

Configure your "home" network as 'ssid' and 'password'

as usual in your *secrets.py* file,

then add any additional networks (such as phone hotspot, *MiFi* devices,

and networks at places the PyPortal will visit) as described below.

The PyPortal then becomes portable.

The alteration of *secrets.py* is to include one extra key/value pair.

The key is 'hotspots' and the value is a list of

pairs of ssid and password strings::

    secrets = {

        # Whatever is already in your secrets dict remains.

        # Be sure to add a now-needed comma if there isn't one.

        'hotspots': [

            ['myphonessid', 'thepassword'],

            ['mymifissid', 'itspassword'],

            ['myvacationhomessid', 'dontyouwish'],

        ],

    }

See examples/pyportal_multissid_simpletest.py

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