{"id":37876832,"url":"https://github.com/74th/esp32-serial-wifi-setup","last_synced_at":"2026-01-16T16:45:28.849Z","repository":{"id":304425783,"uuid":"1018749006","full_name":"74th/esp32-serial-wifi-setup","owner":"74th","description":null,"archived":false,"fork":false,"pushed_at":"2025-08-17T01:53:34.000Z","size":168,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-10T11:54:19.894Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/74th.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}},"created_at":"2025-07-13T00:34:52.000Z","updated_at":"2025-08-17T01:53:38.000Z","dependencies_parsed_at":"2025-08-10T13:12:42.711Z","dependency_job_id":"24aa00af-4cc5-4494-ac02-b83663a2c2fb","html_url":"https://github.com/74th/esp32-serial-wifi-setup","commit_stats":null,"previous_names":["74th/esp32-serial-wifi-setup"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/74th/esp32-serial-wifi-setup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/74th%2Fesp32-serial-wifi-setup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/74th%2Fesp32-serial-wifi-setup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/74th%2Fesp32-serial-wifi-setup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/74th%2Fesp32-serial-wifi-setup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/74th","download_url":"https://codeload.github.com/74th/esp32-serial-wifi-setup/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/74th%2Fesp32-serial-wifi-setup/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28480079,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"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":[],"created_at":"2026-01-16T16:45:25.124Z","updated_at":"2026-01-16T16:45:28.842Z","avatar_url":"https://github.com/74th.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ESP32 Serial WiFi Setup\n\n*[日本語版 (Japanese Version)](README_ja.md)*\n\nA library for ESP32 that enables WiFi configuration via serial communication using JSON-RPC protocol.\n\n## Features\n\n- WiFi configuration using JSON-RPC 2.0 protocol\n- Persistent settings using NVS (Non-Volatile Storage)\n- Simple and easy-to-use API\n- Compatible with both Arduino IDE and PlatformIO\n\n## Installation\n\n### Arduino IDE\n\n1. Install ArduinoJson library\n   - In Arduino IDE, go to \"Tools\" → \"Manage Libraries\"\n   - Search for \"ArduinoJson\"\n   - Install \"ArduinoJson\" by Benoit Blanchon (version 7.x)\n2. Download this repository as ZIP\n3. In Arduino IDE, go to \"Sketch\" → \"Include Library\" → \"Add .ZIP Library\"\n4. Select the downloaded ZIP file\n\nDependencies (ArduinoJson) will be installed automatically.\n\n### PlatformIO\n\nAdd the following to your `platformio.ini`:\n\n```ini\nlib_deps =\n    https://github.com/74th/esp32-serial-wifi-setup.git\n```\n\n## Usage\n\n### Basic Usage\n\n```cpp\n#include \u003cEsp32SerialWiFiSetup.h\u003e\n\nEsp32SerialWifiSetup::WiFiSetupManager wifiSetup;\n\nvoid setup() {\n    wifiSetup.begin();\n}\n\nvoid loop() {\n    wifiSetup.handleSerialCommands();\n}\n```\n\n### Web Interface\n\nYou can configure WiFi settings from your browser using WebUSB Serial API:\n\n**🌐 Visit [https://esp32-serial-wifi-setup.74th.tech](https://esp32-serial-wifi-setup.74th.tech)**\n\nWeb interface features:\n- Direct connection to ESP32 from browser (using WebUSB Serial API)\n- WiFi credentials configuration (SSID/Password)\n- Real-time serial communication monitoring\n- IP address and MAC address retrieval\n- No additional software installation required\n\n**Requirements:**\n- WebUSB-compatible browser (Chrome/Edge, etc.)\n- HTTPS connection (required)\n\n### JSON-RPC Commands\n\nConfigure WiFi by sending the following JSON-RPC commands to the serial port:\n\n#### Set WiFi Credentials\n\n```json\n{\"jsonrpc\": \"2.0\", \"method\": \"set_wifi_creds\", \"params\": {\"ssid\": \"your_wifi_ssid\", \"pass\": \"your_password\"}, \"id\": 1}\n```\n\nResponse:\n\n```json\n{\"jsonrpc\": \"2.0\", \"id\": 1, \"result\": \"ok\"}\n```\n\n**Note**: The ESP32 will automatically restart after setting credentials.\n\n#### Get WiFi Credentials\n\n```json\n{\"jsonrpc\": \"2.0\", \"method\": \"get_wifi_creds\", \"id\": 1}\n```\n\nResponse:\n\n```json\n{\"jsonrpc\": \"2.0\", \"id\": 1, \"result\": {\"ssid\": \"your_wifi_ssid\", \"pass\": \"your_password\"}}\n```\n\n#### Get IP Address\n\n```json\n{\"jsonrpc\": \"2.0\", \"method\": \"get_ip\", \"id\": 1}\n```\n\nResponse:\n\n```json\n{\"jsonrpc\": \"2.0\", \"id\": 1, \"result\": {\"ip\": \"192.168.1.109\"}}\n```\n\n#### Get MAC Address\n\n```json\n{\"jsonrpc\": \"2.0\", \"method\": \"get_mac_address\", \"id\": 1}\n```\n\nResponse:\n\n```json\n{\"jsonrpc\": \"2.0\", \"id\": 1, \"result\": {\"mac_address\": \"A0:76:4E:B3:67:DC\"}}\n```\n\n## Limitations\n\n- **Line Endings**: Only CRLF (`\\r\\n`) line endings are supported when sending JSON-RPC commands\n- **Baud Rate**: Serial communication baud rate is fixed at 115200\n\n## API Reference\n\n### `WiFiSetupManager`\n\n#### `void begin()`\n\nInitializes the library and automatically attempts to connect using saved WiFi credentials if available.\n\n#### `void handleSerialCommands()`\n\nProcesses JSON-RPC commands from the serial port. Call this continuously in your main loop.\n\n#### `bool isConnected()`\n\nReturns the WiFi connection status.\n\n#### `String getIPAddress()`\n\nReturns the current IP address as a string.\n\n#### `String getMacAddress()`\n\nReturns the MAC address as a string.\n\n## Dependencies\n\n- ArduinoJson (version 7.x)\n- ESP32 Arduino Core\n\n## License\n\nMIT License\n\n## Contributing\n\nPlease report bugs and feature requests through GitHub Issues.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F74th%2Fesp32-serial-wifi-setup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F74th%2Fesp32-serial-wifi-setup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F74th%2Fesp32-serial-wifi-setup/lists"}