Manual WiFi

This is the minimal example of using the library with CircuitPython. This example is serving a simple static text message.

It also manually connects to the WiFi network. SSID and password are stored in the code, but they can as well be stored in the settings.toml file, and then read from there using os.getenv().

examples/httpserver_simpletest_manual_wifi.py

# SPDX-FileCopyrightText: 2022 Dan Halbert for Adafruit Industries
#
# SPDX-License-Identifier: Unlicense

import socketpool
import wifi

from adafruit_httpserver import Server, Request, Response

WIFI_SSID = "..."
WIFI_PASSWORD = "..."

print(f"Connecting to {WIFI_SSID}...")
wifi.radio.connect(WIFI_SSID, WIFI_PASSWORD)
print(f"Connected to {WIFI_SSID}")

pool = socketpool.SocketPool(wifi.radio)

server = Server(pool, "/static", debug=True)


@server.route("/")
def base(request: Request):
    """
    Serve a default static plain text message.
    """
    return Response(request, "Hello from the CircuitPython HTTP Server!")


server.serve_forever(str(wifi.radio.ipv4_address))

Manual AP (access point)

If there is no external network available, it is possible to create an access point (AP) and run a server on it. It is important to note that only devices connected to the AP will be able to access the server and depending on the device, it may not be able to access the internet.

examples/httpserver_simpletest_manual_ap.py

# SPDX-FileCopyrightText: 2024 Michał Pokusa
#
# SPDX-License-Identifier: Unlicense

import socketpool
import wifi

from adafruit_httpserver import Server, Request, Response


AP_SSID = "..."
AP_PASSWORD = "..."

print("Creating access point...")
wifi.radio.start_ap(ssid=AP_SSID, password=AP_PASSWORD)
print(f"Created access point {AP_SSID}")

pool = socketpool.SocketPool(wifi.radio)
server = Server(pool, "/static", debug=True)


@server.route("/")
def base(request: Request):
    """
    Serve a default static plain text message.
    """
    return Response(request, "Hello from the CircuitPython HTTP Server!")


server.serve_forever(str(wifi.radio.ipv4_address_ap))

Manual Ethernet

Most of the time, the WiFi will be a preferred way of connecting to the network. Nevertheless it is also possible to use Ethernet instead of WiFi. The only difference in usage is related to configuring the socket_source differently.

examples/httpserver_simpletest_manual_ethernet.py

# SPDX-FileCopyrightText: 2023 Tim C for Adafruit Industries
#
# SPDX-License-Identifier: MIT

import board
import digitalio

from adafruit_wiznet5k.adafruit_wiznet5k import WIZNET5K
from adafruit_wiznet5k import adafruit_wiznet5k_socket as socket
from adafruit_httpserver import Server, Request, Response


# For Adafruit Ethernet FeatherWing
cs = digitalio.DigitalInOut(board.D10)

# For Particle Ethernet FeatherWing
# cs = digitalio.DigitalInOut(board.D5)

spi_bus = board.SPI()

# Initialize ethernet interface with DHCP
eth = WIZNET5K(spi_bus, cs)

# Set the interface on the socket source
socket.set_interface(eth)

server = Server(socket, "/static", debug=True)


@server.route("/")
def base(request: Request):
    """
    Serve a default static plain text message.
    """
    return Response(request, "Hello from the CircuitPython HTTP Server!")


server.serve_forever(str(eth.pretty_ip(eth.ip_address)))

Automatic WiFi using settings.toml

From the version 8.0.0 of CircuitPython, it is possible to use the environment variables defined in settings.toml file to store secrets and configure the WiFi network using the CIRCUITPY_WIFI_SSID and CIRCUITPY_WIFI_PASSWORD variables.

By default the library uses 0.0.0.0 and port 5000 for the server, as port 80 is reserved for the CircuitPython Web Workflow. If you want to use port 80 , you need to set CIRCUITPY_WEB_API_PORT to any other port, and then set port parameter in Server constructor to 80 .

This is the same example as above, but it uses the settings.toml file to configure the WiFi network.

Note

From now on, all the examples will use the settings.toml file to configure the WiFi network.

settings.toml

# Setting these variables will automatically connect board to WiFi on boot
CIRCUITPY_WIFI_SSID="Your WiFi SSID Here"
CIRCUITPY_WIFI_PASSWORD="Your WiFi Password Here"

Note that we still need to import socketpool and wifi modules.

examples/httpserver_simpletest_auto_settings_toml.py

# SPDX-FileCopyrightText: 2022 Dan Halbert for Adafruit Industries
#
# SPDX-License-Identifier: Unlicense

import socketpool
import wifi

from adafruit_httpserver import Server, Request, Response


pool = socketpool.SocketPool(wifi.radio)
server = Server(pool, "/static", debug=True)


@server.route("/")
def base(request: Request):
    """
    Serve a default static plain text message.
    """
    return Response(request, "Hello from the CircuitPython HTTP Server!")


server.serve_forever(str(wifi.radio.ipv4_address))

Helper for socket pool using adafruit_connection_manager

If you do not want to configure the socket pool manually, you can use the adafruit_connection_manager library, which provides helpers for getting socket pool and SSL context for common boards.

Note that it is not installed by default. You can read more about it here.

examples/httpserver_simpletest_auto_connection_manager.py

# SPDX-FileCopyrightText: 2024 DJDevon3
#
# SPDX-License-Identifier: MIT

import wifi

from adafruit_connection_manager import get_radio_socketpool
from adafruit_httpserver import Server, Request, Response


pool = get_radio_socketpool(wifi.radio)
server = Server(pool, "/static", debug=True)


@server.route("/")
def base(request: Request):
    """
    Serve a default static plain text message.
    """
    return Response(request, "Hello from the CircuitPython HTTP Server!")


server.serve_forever(str(wifi.radio.ipv4_address))