{"id":16274995,"url":"https://github.com/sv443/esp-notifier","last_synced_at":"2026-04-15T06:32:10.453Z","repository":{"id":47014009,"uuid":"398571546","full_name":"Sv443/ESP-Notifier","owner":"Sv443","description":"WiFi enabled IoT button based on ESP8266","archived":false,"fork":false,"pushed_at":"2022-02-14T10:30:19.000Z","size":145,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-08T16:21:16.515Z","etag":null,"topics":["arduino","esp8266","iot"],"latest_commit_sha":null,"homepage":"","language":"C++","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/Sv443.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null},"funding":{"github":["Sv443"],"patreon":"Sv443","open_collective":null,"ko_fi":"Sv443_","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["PayPal.me/Sv443"]}},"created_at":"2021-08-21T13:58:20.000Z","updated_at":"2022-02-18T17:48:19.000Z","dependencies_parsed_at":"2022-09-02T23:11:03.217Z","dependency_job_id":null,"html_url":"https://github.com/Sv443/ESP-Notifier","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Sv443/ESP-Notifier","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sv443%2FESP-Notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sv443%2FESP-Notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sv443%2FESP-Notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sv443%2FESP-Notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sv443","download_url":"https://codeload.github.com/Sv443/ESP-Notifier/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sv443%2FESP-Notifier/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31829851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T18:05:02.291Z","status":"online","status_checked_at":"2026-04-15T02:00:06.175Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["arduino","esp8266","iot"],"created_at":"2024-10-10T18:31:27.123Z","updated_at":"2026-04-15T06:32:10.426Z","avatar_url":"https://github.com/Sv443.png","language":"C++","funding_links":["https://github.com/sponsors/Sv443","https://patreon.com/Sv443","https://ko-fi.com/Sv443_","PayPal.me/Sv443"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\" style=\"text-align: center;\"\u003e\n\n# ESP-Notifier\nWiFi enabled IoT button based on ESP8266 - intended to be used with [Node-Notifier](https://github.com/Sv443/Node-Notifier)\n\n\u003cbr\u003e\n\n![TODO: image](./.github/esp-notifier.png)\n\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n\n# WORK IN PROGRESS\nThis is very early software, please tread carefully and at your own risk\n\n\u003c/div\u003e\n\n\u003cbr\u003e\u003cbr\u003e\n\n### Table of contents:\n- [Setup](#setup)\n- [Example build](#example-build)\n    - [Schematic](#schematic)\n    - [Parts list](#parts-list)\n    - [Instructions](#instructions)\n    - [Troubleshooting](#troubleshooting)\n- [Legal stuff](#legal-stuff)\n\nOther documents:\n- [License (MIT)](./LICENSE.txt)\n- [Changelog](./changelog.md#readme)\n    - [Planned Features](./changelog.md#planned-features)\n- [Security Policy](./.github/SECURITY.md#readme)\n\n\u003cbr\u003e\u003cbr\u003e\n\n## Setup:\n1. Clone or download and extract this repository (see [releases](https://github.com/Sv443/ESP-Notifier/releases))\n2. Rename the file `config.h.template` to `config.h` and open it with a text editor\n3. Set your WiFi settings in `config.h` (make sure to adequately protect this file)\n4. Start the [desktop client](https://github.com/Sv443/Node-Notifier) and copy its IP address\n5. Open the file [`ESP-Notifier.ino`](./ESP-Notifier.ino) in the [Arduino IDE](https://www.arduino.cc/en/software)\n6. Install your ESP board in the IDE ([follow this guide](https://arduino-esp8266.readthedocs.io/en/latest/installing.html))\n7. Install the library [ArduinoJson](https://arduinojson.org/) in the IDE\n8. Edit settings at the top of this file (like the server IP address)\n9. Upload the sketch with the Arduino IDE (\u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eU\u003c/kbd\u003e)\n10. Follow the [example build](#example-build) or the [schematic](#schematic)\n\n\u003cbr\u003e\u003cbr\u003e\n\n## Example build:\n### Schematic:\nFollow this schematic to build the base model of ESP-Notifier:  \n\n[![schematic image](./.github/schematic_headers.png)](./.github/schematic_headers.png)\n  \nI used an ESP8266EX development board but this should work on any ESP dev board,  \nonce GPIO pin mappings are changed accordingly in the .ino file.  \n  \nThe resistor's value is approximate.  \n  \nThe blue diamond shape indicates the points where I used headers to make the button and power supply detachable.  \nTo see the original schematic without these markers, [click here.](./.github/schematic.png)\n\n\u003cbr\u003e\n\n### Parts list:\n- ESP8266EX development board (you can also use the non-EX ESP but it's larger)\n- a 4.7kΩ resistor\n- about 3x4cm of perforated circuit board, matching the size of the ESP dev board\n- female and male headers\n- a momentary push button (pretty sure you're looking for an SPST type switch)\n- a 5v power supply with at least 500mA (like an old phone charger)\n\n\u003cbr\u003e\n\n### Instructions:\n1. \u003e Install the firmware on the ESP (follow the [setup guide](#setup)).\n\n\u003cbr\u003e\n\n2. \u003e Place the resistor on the perforated board, between the ESP's GPIO pin you've chosen (14 aka D5 by default) and  \n   \u003e the G or GND pin of the ESP, to act as a pull-down resistor for the switch.  \n   \u003e In my example, the resistor is physically sandwiched between the dev board and the perforated board, so the whole thing stays as compact as possible.\n\n\u003cbr\u003e\n\n3. \u003e Hook up the momentary switch between the ESP's GPIO pin you've chosen (default 14 aka D5) and the 3.3V pin of the ESP development board.  \n   \u003e If you don't use a development board, you can also probably use the 5V / VV pin.\n\n\u003cbr\u003e\n\n4. \u003e Use the female and male headers to make the button and power wires detachable (optional).  \n   \u003e Power headers should be hooked up to the ESP dev board's pins VV or VIN and GND or G.  \n   \u003e Button headers are hooked up between chosen GPIO pin (default 14 aka D5) and 3V3 or alternatively the 5V source from the power supply.\n\n\u003cbr\u003e\n\n5. \u003e Hook up the 5V power supply to the VV or VIN pin (+) and the GND or G pin (-) of the ESP dev board.\n\n\u003cbr\u003e\n\n6. \u003e Hook up the button to the headers or directly to the pins described in step 4.\n\n\u003cbr\u003e\n\n7. \u003e Check if it works by pressing the button :)\n\n\u003cbr\u003e\n\n### Troubleshooting:\nIf something didn't work out for you, please hook up the ESP dev board to your PC, open the serial monitor in the Arduino IDE and check what's going wrong.  \nIf you still need help, feel free to join my Discord server to ask me:  \n  \n[![Discord](https://img.shields.io/discord/565933531214118942)](https://dc.sv443.net/)\n\n\u003cbr\u003e\u003cbr\u003e\n\n## Legal stuff:\n\n### License:\nESP-Notifier's firmware is licensed under the [MIT License](./LICENSE.txt)\n\n\u003cbr\u003e\n\n### Disclaimer:\nThis is very early software, please tread carefully and at your own risk.  \nAlso make sure you adequately protect the `config.h` file, as it contains your WiFi password.\n\n\u003cbr\u003e\n\n### Dependencies:\n- [ESP8266WiFi](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WiFi)\n- [ESP8266HTTPClient](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266HTTPClient)\n- [ArduinoJson](https://arduinojson.org/)\n\n\u003cbr\u003e\u003cbr\u003e\n\u003cbr\u003e\u003cbr\u003e\n\n\u003cdiv align=\"center\" style=\"text-align: center;\"\u003e\n\nMade with ❤️ by [Sv443](https://github.com/Sv443)  \nIf you like ESP-Notifier please consider [supporting me](https://github.com/sponsors/Sv443)\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsv443%2Fesp-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsv443%2Fesp-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsv443%2Fesp-notifier/lists"}