{"id":19168440,"url":"https://github.com/srwi/espessentials","last_synced_at":"2025-05-07T14:42:09.452Z","repository":{"id":40450596,"uuid":"75249974","full_name":"srwi/ESPEssentials","owner":"srwi","description":"Essentials to get you started with your Arduino projects using the ESP8266 and ESP32.","archived":false,"fork":false,"pushed_at":"2024-05-26T19:23:20.000Z","size":57,"stargazers_count":26,"open_issues_count":3,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-05T05:08:26.515Z","etag":null,"topics":["arduino","esp32","esp32-arduino","esp32-library","esp8266","esp8266-arduino","esp8266-library","espressif","wifimanager"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/srwi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-01T03:08:25.000Z","updated_at":"2025-05-02T02:38:29.000Z","dependencies_parsed_at":"2024-11-09T09:42:51.588Z","dependency_job_id":"f32d155e-5d2f-4649-bdac-c6a05c7e4cfe","html_url":"https://github.com/srwi/ESPEssentials","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srwi%2FESPEssentials","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srwi%2FESPEssentials/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srwi%2FESPEssentials/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/srwi%2FESPEssentials/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/srwi","download_url":"https://codeload.github.com/srwi/ESPEssentials/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252897483,"owners_count":21821449,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arduino","esp32","esp32-arduino","esp32-library","esp8266","esp8266-arduino","esp8266-library","espressif","wifimanager"],"created_at":"2024-11-09T09:42:40.682Z","updated_at":"2025-05-07T14:42:09.426Z","avatar_url":"https://github.com/srwi.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ESPEssentials\n\n![ESP8266](https://img.shields.io/badge/ESP-8266-000000.svg?colorB=blue)\n![ESP32](https://img.shields.io/badge/ESP-32-000000.svg?colorB=blue)\n[![arduino-library-badge](https://www.ardu-badge.com/badge/ESPEssentials.svg)](https://www.ardu-badge.com/ESPEssentials)\n[![LGPL-2.1 license](https://img.shields.io/github/license/srwi/ESPEssentials)](https://github.com/srwi/ESPEssentials/blob/master/LICENSE)\n\nEssentials for the ESP8266 and ESP32 to get you started with your Arduino project without any of the annoying stuff.\n\n## Features\n- Serial output\n- Wifi connection management using [WiFiManager](https://github.com/tzapu/WiFiManager)\n- Webserver including file upload and editing via browser\n- OTA firmware update\n- Web firmware update\n\n## Requirements\n- [WiFiManager](https://github.com/tzapu/WiFiManager) \u0026ge; 2.0.0\n\n## Usage\n\nESPEssentials only needs three lines of additional code:\n\n```cpp\n#include \u003cESPEssentials.h\u003e\n\nvoid setup()\n{\n    ESPEssentials::init(\"Project Name\");\n}\n\nvoid loop()\n{\n    ESPEssentials::handle();\n}\n```\n\n## Notes\n\n### Serial\n\nBy default the baud rate will be 115200. You can specify it with\n```cpp\nESPEssentials::init(\"Project Name\", 9600);\n```\n\n### WiFiManager\n\nAll WiFiManager methods can be accessed through the `Wifi` instance. For example to reset wifi settings:\n\n```cpp\nESPEssentials::Wifi.resetSettings();\n```\n\nMore information can be found [here](https://github.com/tzapu/WiFiManager).\n\n### Webserver\n\nHTTP requests can be initialized within `setup()`. For example to reset wifi settings by accessing `http://\u003cdevice-ip\u003e/reset_wifi`:\n\n```cpp\nESPEssentials::WebServer.on(\"/reset_wifi\", HTTP_GET, [\u0026]() {\n    ESPEssentials::WebServer.send(200, \"text/plain\", \"Wifi settings reset.\");\n    ESPEssentials::Wifi.resetSettings();\n});\n```\n\n*Note:* The routes `/edit`, `/handle_update`, `/list`, `/reboot` and `/update` are already used by ESPEssentials and can not be used.\n\nTo edit files inside your browser upload [`/data/edit.htm.gz`](https://github.com/srwi/ESPEssentials/blob/master/data/edit.htm.gz) to the root directory. The easiest way to do this is by accessing `http://\u003cdevice-ip\u003e/edit` and uploading it from there. Afterwards you can access the file editor via the same URL to edit files directly on the device.\n\nEach file created/uploaded that way can be accessed via the corresponding URL (e.g. `http://\u003cdevice-ip\u003e/myPage` to access `/myPage.htm`).\n\n### OTA firmware update\n\nAn OTA password can be set up with\n\n```cpp\nESPEssentials::init(\"Project Name\", \"hunter2\");\n```\n\n### Web firmware update\n\nOpen `http://\u003cdevice-ip\u003e/update` and select a `.bin` file to upload a new firmware to the ESP8266/ESP32 from within the web browser. If a password has been supplied to `init` you will be asked to authenticate. The username is `admin`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrwi%2Fespessentials","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsrwi%2Fespessentials","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrwi%2Fespessentials/lists"}