{"id":48109415,"url":"https://github.com/Dwarf1er/esp-wifi-provisioning","last_synced_at":"2026-04-20T01:01:15.377Z","repository":{"id":343321639,"uuid":"1176400847","full_name":"Dwarf1er/esp-wifi-provisioning","owner":"Dwarf1er","description":"Captive-portal WiFi provisioning for ESP32 targets via esp-idf-svc","archived":false,"fork":false,"pushed_at":"2026-04-09T14:00:57.000Z","size":221,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-04-09T16:31:29.383Z","etag":null,"topics":["captive-portal","embedded","embedded-rust","esp-idf","esp32","iot","provisioning","rust","wifi"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/esp-wifi-provisioning","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Dwarf1er.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-09T01:34:37.000Z","updated_at":"2026-04-09T14:01:00.000Z","dependencies_parsed_at":"2026-04-02T03:02:49.096Z","dependency_job_id":null,"html_url":"https://github.com/Dwarf1er/esp-wifi-provisioning","commit_stats":null,"previous_names":["dwarf1er/esp-wifi-provisioning"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Dwarf1er/esp-wifi-provisioning","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dwarf1er%2Fesp-wifi-provisioning","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dwarf1er%2Fesp-wifi-provisioning/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dwarf1er%2Fesp-wifi-provisioning/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dwarf1er%2Fesp-wifi-provisioning/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dwarf1er","download_url":"https://codeload.github.com/Dwarf1er/esp-wifi-provisioning/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dwarf1er%2Fesp-wifi-provisioning/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32028547,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T00:18:06.643Z","status":"ssl_error","status_checked_at":"2026-04-20T00:17:31.068Z","response_time":55,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["captive-portal","embedded","embedded-rust","esp-idf","esp32","iot","provisioning","rust","wifi"],"created_at":"2026-04-04T16:00:33.627Z","updated_at":"2026-04-20T01:01:15.371Z","avatar_url":"https://github.com/Dwarf1er.png","language":"Rust","funding_links":[],"categories":["Projects"],"sub_categories":["`std`"],"readme":"\u003cdiv align=\"center\"\u003e\n\n# esp-wifi-provisioning\n#### Captive-portal WiFi provisioning for ESP32 targets via esp-idf-svc\n\n\u003cimg alt=\"esp-wifi-provisioning logo\" src=\"https://raw.githubusercontent.com/Dwarf1er/esp-wifi-provisioning/master/assets/esp-wifi-provisioning-logo.png\" height=\"250\" /\u003e\n\n![License](https://img.shields.io/github/license/Dwarf1er/esp-wifi-provisioning?style=for-the-badge)\n![Issues](https://img.shields.io/github/issues/Dwarf1er/esp-wifi-provisioning?style=for-the-badge)\n![PRs](https://img.shields.io/github/issues-pr/Dwarf1er/esp-wifi-provisioning?style=for-the-badge)\n![Contributors](https://img.shields.io/github/contributors/Dwarf1er/esp-wifi-provisioning?style=for-the-badge)\n![Stars](https://img.shields.io/github/stars/Dwarf1er/esp-wifi-provisioning?style=for-the-badge)\n\n\u003c/div\u003e\n\n## Project Description\n\nWiFi provisioning via a captive-portal soft-AP for ESP32 targets, built on [`esp-idf-svc`](https://github.com/esp-rs/esp-idf-svc). When a device has no stored credentials, it broadcasts a setup access point and serves a small web UI. Users connect to the AP, are redirected to the portal automatically, pick their network, and enter a password. The device saves the credentials to NVS and connects. No hardcoded SSIDs, no serial flashing required.\n\n## Table of Contents\n\n\u003c!-- mtoc-start --\u003e\n\n* [Screenshot](#screenshot)\n* [Repository layout](#repository-layout)\n* [Getting started](#getting-started)\n  * [Prerequisites](#prerequisites)\n  * [Setup Script](#setup-script)\n  * [User Permissions for Serial](#user-permissions-for-serial)\n  * [Build and flash the example](#build-and-flash-the-example)\n* [Using the library in your own project](#using-the-library-in-your-own-project)\n* [Development](#development)\n* [License](#license)\n\n\u003c!-- mtoc-end --\u003e\n\n## Screenshot\n\nThe captive portal web UI:\n\n![Captive portal UI screenshot](./assets/screenshot.png)\n\n## Repository layout\n\n```\nesp-wifi-provisioning/\n├── esp-wifi-provisioning/   # the library crate (published to crates.io)\n├── example/                 # a complete ESP32 binary that uses the crate\n├── setup.sh                 # installs toolchain dependencies\n└── Cargo.toml               # workspace root\n```\n\n## Getting started\n\n### Prerequisites\n\nTo get started with this project, make sure to install the following dependencies on your system.\n\nArch based (via Pacman):\n```bash\nsudo pacman -S git cmake ninja python python-pip python-virtualenv dfu-util libusb ccache gcc pkg-config clang llvm libxml2 libxml2-legacy dotenv\n```\n\nDebian based (via apt):\n```bash\nsudo apt-get install git wget flex bison gperf python3 python3-pip python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0 dotenv\n```\n\n### Setup Script\n\nAfter having installed the dependencies and having cloned the repository, run the setup script at the root of the repository:\n```bash\nchmod +x ./setup.sh\n./setup.sh\n```\n\nRestart your shell (or source your profile) after the script completes so the toolchain is on your `PATH`.\n\n### User Permissions for Serial\n\nOn Arch-based distros, the `uucp` group controls access to `/dev/ttyUSB*` devices (equivalent to `dialout` on Debian-based distros). Add your user to the appropriate group:\n\nArch-based:\n\n```bash\nsudo usermod -aG uucp $USER\nnewgrp uucp\n```\n\nDebian-based:\n\n```bash\nsudo usermod -aG dialout $USER\nnewgrp dialout\n```\n\n### Build and flash the example\n\nConnect your ESP32, then:\n\n```bash\ncd example\ncargo run --release\n```\n\n`cargo run` will build, flash, and open a serial monitor. On first boot the device will broadcast a `ESP32-Setup` access point. Connect to it from any phone or laptop, the captive portal should appear automatically.\n\n## Using the library in your own project\n\nAdd it to your workspace or crate:\n\n```toml\n[dependencies]\nesp-wifi-provisioning = \"0.1\"\n```\n\nMinimal integration:\n\n```rust\nuse esp_wifi_provisioning::Provisioner;\n\nlet wifi = Provisioner::new(wifi, nvs)\n    .ap_ssid(\"MyDevice-Setup\")\n    .provision()\n    .expect(\"provisioning failed\");\n```\n\nSee the [`example/`](example/) directory for a complete working binary, and the [crate documentation](https://docs.rs/esp-wifi-provisioning) for the full API reference.\n\n## Development\n\nAll crates in this repository share a workspace. To run a full build:\n\n```bash\ncargo build --workspace\n```\n\nThe portal web UI lives in `esp-wifi-provisioning/src/web/`. HTML, CSS, and JS are combined and minified at build time by `build.rs`, no separate frontend build step is needed.\n\nTo iterate on the portal UI without flashing hardware, open `esp-wifi-provisioning/src/web/index.html` directly in a browser. The `DEV_NETWORKS` block in `app.js` provides mock network data so the UI is fully functional offline. That block is automatically stripped from the production build.\n\n## License\n\nThis software is licensed under the [MIT license](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDwarf1er%2Fesp-wifi-provisioning","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDwarf1er%2Fesp-wifi-provisioning","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDwarf1er%2Fesp-wifi-provisioning/lists"}