Skip to content

1.0.2

Latest
Latest
Compare
Choose a tag to compare
@Init-io Init-io released this 20 Nov 10:24
1.0.2
df3d8ba
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

🌐 OTAEsp: Effortless Over-the-Air Updates for ESP8266 🚀

Are you tired of manually flashing your ESP8266 for every little update? Want to serve sleek HTML interfaces on your Access Point? Or maybe you just need a smoother way to connect to Wi-Fi? Look no further, because OTAEsp is here to simplify your development life like never before. 🙌

This library is like the Swiss Army Knife of OTA updates and Wi-Fi management—built to make your ESP8266 projects not only functional but downright elegant. 💡

🔑 Key Features (or why OTAEsp is a game-changer):

📡 Access Point (AP) Mode

  • Start and stop your ESP8266’s AP mode with just a single call.
  • Set custom SSIDs and passwords, because naming your network “PrettyFlyForAWiFi” is a must.
  • Includes static IP configuration to make your AP rock-solid.

🌐 HTML Hosting

  • Serve custom HTML pages from your ESP, like a mini web server in your pocket.
  • Perfect for hosting interactive interfaces, forms, or even just a page that says, “Hello, World!” 🌍
  • Built-in debugging and LED indicators to let you know when someone’s poking around your hosted pages.

🌎 Wi-Fi Station Mode

  • Connect to existing Wi-Fi networks without pulling your hair out.
  • Includes retry logic (because life isn’t perfect and neither is your router).
  • Fetch the ESP’s local IP address on successful connection, because knowing where your ESP lives is important. 🏠

📝 Form Data Handling

  • Easily fetch values from HTML form submissions. No more messy parsing—just clean, straightforward API calls.

🤩 Why You’ll Love OTAEsp

OTAEsp doesn’t just work—it’s a joy to use. With intuitive methods and powerful features, this library makes developing IoT projects feel like a breeze. Plus, it’s so versatile, you might find yourself dreaming up projects just so you can use it more. (Go ahead, we won’t judge.) 😏

Here’s how it feels when using OTAEsp:

  • You start an Access Point: "Boom, instant network."
  • You host HTML content: "Wow, that was easy."
  • You fetch form data: "Wait, that's all I had to do?"
  • You push an OTA update: "Am I a wizard?" 🧙‍♂️✨

🛠️ API Overview

🔥 Start and Stop AP Mode

  • start(ssid, password) → Launches your ESP as an Access Point with the given SSID and password.
  • end() → Stops the AP mode gracefully (because ghosting your clients isn’t cool).

🖥️ Host HTML Content

  • host(html) → Serves the specified HTML content on the root route (/).
  • Handles client requests automatically, so you can focus on being awesome.

📑 Retrieve Form Data

  • get(fieldName) → Fetches the value of the form field submitted via HTTP. No fuss, no mess.

🌐 Connect to Wi-Fi

  • connect(ssid, password) → Connects your ESP to a Wi-Fi network. Includes a retry mechanism because patience is a virtue.
  • isConnected() → Checks wheter your esp is connected to a wifi or not.

💡 Example Usage

Here’s a quick example to show off OTAEsp’s magic:

#include <OTAEsp.h>  

OTAEsp ota;  

void setup() {  
    Serial.begin(115200);  

    // Start Access Point mode  
    ota.start("MyAP_SSID", "MyAP_Password");  

    // Serve a simple HTML page  
    ota.host("<html><body><h1>Welcome to OTAEsp</h1></body></html>");  
}  

void loop() {  
    ota.server.handleClient(); // Handle incoming client requests  
}

That’s it. You just started an AP, served a webpage, and handled clients—all in less than 20 lines of code. Talk about efficiency! 🤯

💾 Requirements

  • Hardware: ESP8266-based devices
  • Software: Arduino IDE or compatible development environment
  • Dependencies:
    • ESP8266WiFi.h
    • ESP8266WebServer.h

🤝 Contributions Welcome!

Got ideas to make OTAEsp even better? Found a bug? Want to add more features? We’d love your input! Open an issue or submit a pull request on [GitHub](https://github.com/Init-io/OTAEsp).

📝 License

This project is licensed under the MIT License. Feel free to use it in your personal or commercial projects. Just don’t forget to share your awesome creations with the world. 🌎

🔥 TL;DR

OTAEsp is your one-stop shop for managing OTA updates, hosting web interfaces, and handling Wi-Fi connections on your ESP8266. It’s fast, easy, and fun to use.

Install it today, and turn your ESP projects into something truly magical. Warning: May cause an uncontrollable urge to automate everything. 😎

Assets 2
Loading