OTAEsp is a simple library for the ESP8266 platform that allows you to easily set up an access point (AP) to serve an HTML page, retrieve form data, and connect the device to a Wi-Fi network. It is ideal for implementing Over-the-Air (OTA) updates, web interfaces, or simple device configuration over a network.
- Start an Access Point (AP): Allows the ESP8266 to create a Wi-Fi access point that clients can connect to.
- Serve an HTML Page: Hosts an HTML page on the ESP8266, accessible via the AP's IP address.
- Form Handling: Retrieves form data submitted by clients in an HTTP request.
- Wi-Fi Connection: Connects the ESP8266 to a Wi-Fi network in station mode (STA).
- Download or clone the repository to your Arduino libraries folder or your custom project folder.
- Include the
OTAEsplibrary in your Arduino sketch.
#include <OTAEsp.h>To start the AP mode, use the start() method with the SSID and password for the AP.
OTAEsp ota;
ota.start("MyESP8266", "password123");Use the host() method to serve an HTML page to connected clients.
String htmlPage = "<html><body><h1>Hello, World!</h1></body></html>";
ota.host(htmlPage);To retrieve the value of a specific form field submitted via the HTML page, use the get() method.
String fieldValue = ota.get("fieldName");
Serial.println("Received field value: " + fieldValue);To connect the ESP8266 to a Wi-Fi network, use the connect() method.
if (ota.connect("yourSSID", "yourPassword")) {
// Successfully connected to Wi-Fi
} else {
// Failed to connect to Wi-Fi
}If you want to check if the wifi is connected, use the isConnected() method.
ota.isConnected();If you want to stop the AP mode, use the end() method.
ota.end();Here’s an example of how to use the library in a full sketch:
#include <OTAEsp.h>
OTAEsp ota;
void setup() {
Serial.begin(115200);
ota.start("ESP8266-AP", "12345678");
String htmlPage = "<html><body><h1>ESP8266 Web Interface</h1></body></html>";
ota.host(htmlPage);
}
void loop() {
ota.server.handleClient();
}- Description: Starts the ESP8266 in Access Point (AP) mode with the specified SSID and password.
- Parameters:
ssid: The SSID of the access point.password: The password for the access point.
- Description: Stops the AP mode and disconnects the ESP8266 from the network.
- Description: Hosts an HTML page at the root endpoint (
/) of the server. - Parameters:
html: The HTML content to serve.
- Description: Retrieves the value of a specific form field submitted by a client.
- Parameters:
fieldName: The name of the form field to retrieve.
- Returns: The value of the form field as a string, or an empty string if not found.
- Description: Connects the ESP8266 to a specified Wi-Fi network.
- Parameters:
ssid: The SSID of the Wi-Fi network.password: The password for the Wi-Fi network.
- Returns:
trueif the connection is successful,falseif it fails.
The library prints status messages to the Serial Monitor to help with debugging:
- When starting or stopping the AP.
- When the HTML page is served.
- When the device is connecting to a Wi-Fi network.
- When form data is received.
This project is licensed under the MIT License - see the LICENSE file for details.
- This library is designed for the ESP8266 platform, which is part of the ESP32/ESP8266 series of Wi-Fi microcontrollers.
- The code makes use of the
ESP8266WiFiandESP8266WebServerlibraries.
Feel free to fork this repository, make improvements, and submit pull requests. Any contributions are welcome!
[Init]
Your GitHub Profile