https://github.com/p-doyle/Micropython-DNSServer-Captive-Portal

Micropython WiFi AP Captive Portal with DNS and Web Server
https://github.com/p-doyle/Micropython-DNSServer-Captive-Portal

Last synced: 2 months ago
JSON representation

Micropython WiFi AP Captive Portal with DNS and Web Server

• Host: GitHub
• URL: https://github.com/p-doyle/Micropython-DNSServer-Captive-Portal
• Owner: p-doyle
• License: apache-2.0
• Created: 2019-08-05T13:50:17.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-04-17T13:12:34.000Z (about 3 years ago)
• Last Synced: 2024-01-29T20:34:32.820Z (5 months ago)
• Language: Python
• Homepage:
• Size: 6.84 KB
• Stars: 15
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-micropython - Micropython-DNSServer-Captive-Portal - MicroPython WiFi AP Captive Portal with DNS and Web Server. (Libraries / Communications)

README

        
# Micropython-DNSServer-Captive-Portal

This is MicroPython script that creates a Wifi AP with both a DNS and Web Server 

that act as a 'Captive Portal' by returning its own IP to all DNS queries in

an attempt to force connecting clients to its Web Server on port 80.  

When connecting from an Android phone it should automatically prompt you to

 'Sign in to the network', which, if clicked, redirects to the Web Server.  If you try

 browsing to a random domain it *should* redirect you to the web server however

 if the request was HTTPS you will just get a Connected Refused error. 

The code is based on several other examples of a MicroPython Captive Portal that I found

on Github however they were 1+ years old and relied on a single loop to accept connection

for both the DNS and Web servers:

- https://github.com/Matt4/micropython-captive-portal-network-setup

- https://github.com/amora-labs/micropython-captive-portal

My version uses asyncio to separate the servers and so can be easily extended with

additional tasks.  Performance and reliability seem better as well.

This was tested with an ESP32 using the latest firmware from https://micropython.org/download#esp32.  

The specific version I tested with was `esp32-20190805-v1.11-187-g00e7fe8ab.bin`.  

This should work with an ESP8266 and others as well but I have not fully tested it.

# Initial Setup (ESP32 only)

Since asyncio is not included in the binary for the ESP32 however it must be installed first.  

Unless you prefer to build your own binary, this requires that your ESP be able to connect 

to the internet to install.

-  Open a python terminal with the ESP32 and use the below to connect to your preferred network:

 ```

import network

sta_if = network.WLAN(network.STA_IF)

sta_if.active(True)

sta_if.connect('yourssid', 'yourpw')

```

- Then run:

```

import upip

upip.install('micropython-uasyncio')

```

# To Do

I'd like to be able to serve HTTPS as well, which would make this a lot more useful however 

I was unable to get the Micropython example code working https://github.com/micropython/micropython/blob/master/examples/network/http_server_ssl.py