# Author: Igor Ferreira
# License: MIT
# Version: 2.1.0
# Description: WiFi Manager for ESP8266 and ESP32 using MicroPython.
import machine
import network
import socket
import re
import time
class WifiManager:
def __init__(self, ssid = 'WifiManager', password = 'wifimanager', reboot = True, debug = False):
self.wlan_sta = network.WLAN(network.STA_IF)
self.wlan_sta.active(True)
self.wlan_ap = network.WLAN(network.AP_IF)
# Avoids simple mistakes with wifi ssid and password lengths, but doesn't check for forbidden or unsupported characters.
if len(ssid) > 32:
raise Exception('The SSID cannot be longer than 32 characters.')
else:
self.ap_ssid = ssid
if len(password) < 8:
raise Exception('The password cannot be less than 8 characters long.')
else:
self.ap_password = password
# Set the access point authentication mode to WPA2-PSK.
self.ap_authmode = 3
# The file were the credentials will be stored.
# There is no encryption, it's just a plain text archive. Be aware of this security problem!
self.wifi_credentials = 'wifi.dat'
# Prevents the device from automatically trying to connect to the last saved network without first going through the steps defined in the code.
self.wlan_sta.disconnect()
# Change to True if you want the device to reboot after configuration.
# Useful if you're having problems with web server applications after WiFi configuration.
self.reboot = reboot
self.debug = debug
def connect(self):
if self.wlan_sta.isconnected():
return
profiles = self.read_credentials()
for ssid, *_ in self.wlan_sta.scan():
ssid = ssid.decode("utf-8")
if ssid in profiles:
password = profiles[ssid]
if self.wifi_connect(ssid, password):
return
print('Could not connect to any WiFi network. Starting the configuration portal...')
self.web_server()
def disconnect(self):
if self.wlan_sta.isconnected():
self.wlan_sta.disconnect()
def is_connected(self):
return self.wlan_sta.isconnected()
def get_address(self):
return self.wlan_sta.ifconfig()
def write_credentials(self, profiles):
lines = []
for ssid, password in profiles.items():
lines.append('{0};{1}\n'.format(ssid, password))
with open(self.wifi_credentials, 'w') as file:
file.write(''.join(lines))
def read_credentials(self):
lines = []
try:
with open(self.wifi_credentials) as file:
lines = file.readlines()
except Exception as error:
if self.debug:
print(error)
pass
profiles = {}
for line in lines:
ssid, password = line.strip().split(';')
profiles[ssid] = password
return profiles
def wifi_connect(self, ssid, password):
print('Trying to connect to:', ssid)
self.wlan_sta.connect(ssid, password)
for _ in range(100):
if self.wlan_sta.isconnected():
print('\nConnected! Network information:', self.wlan_sta.ifconfig())
return True
else:
print('.', end='')
time.sleep_ms(100)
print('\nConnection failed!')
self.wlan_sta.disconnect()
return False
def web_server(self):
self.wlan_ap.active(True)
self.wlan_ap.config(essid = self.ap_ssid, password = self.ap_password, authmode = self.ap_authmode)
server_socket = socket.socket()
server_socket.close()
server_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
server_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
server_socket.bind(('', 80))
server_socket.listen(1)
print('Connect to', self.ap_ssid, 'with the password', self.ap_password, 'and access the captive portal at', self.wlan_ap.ifconfig()[0])
while True:
if self.wlan_sta.isconnected():
self.wlan_ap.active(False)
if self.reboot:
print('The device will reboot in 5 seconds.')
time.sleep(5)
machine.reset()
self.client, addr = server_socket.accept()
try:
self.client.settimeout(5.0)
self.request = b''
try:
while True:
if '\r\n\r\n' in self.request:
# Fix for Safari browser
self.request += self.client.recv(512)
break
self.request += self.client.recv(128)
except Exception as error:
# It's normal to receive timeout errors in this stage, we can safely ignore them.
if self.debug:
print(error)
pass
if self.request:
if self.debug:
print(self.url_decode(self.request))
url = re.search('(?:GET|POST) /(.*?)(?:\\?.*?)? HTTP', self.request).group(1).decode('utf-8').rstrip('/')
if url == '':
self.handle_root()
elif url == 'configure':
self.handle_configure()
else:
self.handle_not_found()
except Exception as error:
if self.debug:
print(error)
return
finally:
self.client.close()
def send_header(self, status_code = 200):
self.client.send("""HTTP/1.1 {0} OK\r\n""".format(status_code))
self.client.send("""Content-Type: text/html\r\n""")
self.client.send("""Connection: close\r\n""")
def send_response(self, payload, status_code = 200):
self.send_header(status_code)
self.client.sendall("""
<!DOCTYPE html>
<html lang="en">
<head>
<title>WiFi Manager</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" href="data:,">
</head>
<body>
{0}
</body>
</html>
""".format(payload))
self.client.close()
def handle_root(self):
self.send_header()
self.client.sendall("""
<!DOCTYPE html>
<html lang="en">
<head>
<title>WiFi Manager</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" href="data:,">
</head>
<body>
<h1>WiFi Manager</h1>
<form action="/configure" method="post" accept-charset="utf-8">
""".format(self.ap_ssid))
for ssid, *_ in self.wlan_sta.scan():
ssid = ssid.decode("utf-8")
self.client.sendall("""
<p><input type="radio" name="ssid" value="{0}" id="{0}"><label for="{0}"> {0}</label></p>
""".format(ssid))
self.client.sendall("""
<p><label for="password">Password: </label><input type="password" id="password" name="password"></p
