https://github.com/probonopd/esp8266githubnotificator
ESP8266 GitHub notifications
https://github.com/probonopd/esp8266githubnotificator
esp8266 github notifications
Last synced: 4 months ago
JSON representation
ESP8266 GitHub notifications
- Host: GitHub
- URL: https://github.com/probonopd/esp8266githubnotificator
- Owner: probonopd
- License: mit
- Created: 2018-04-01T22:29:28.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-15T22:54:09.000Z (over 6 years ago)
- Last Synced: 2025-05-07T06:44:03.918Z (about 1 year ago)
- Topics: esp8266, github, notifications
- Language: C++
- Size: 6.84 KB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ESP8266GitHubNotificator
The ESP8266 lights up the built-in blue LED if you have GitHub notifications waiting.
## Theory of operation
An ESP8266 module such as a [WEMOS D1 mini](https://wiki.wemos.cc/products:d1:d1_mini) is running a simple [esp8266/Arduino](https://github.com/esp8266/Arduino) sketch. The sketch polls the GitHub Notfications API every 60 seconds using a personal GitHub token and lights the built-in LED if there ware notifications available.
## Hardware assembly
3D print a nice looking case. Use transparent filament for the area where the blue LED will shine through.
## Software setup
Compile and upload the sketch to the WEMOS D1 mini (or another ESP8266 board) using the Arduino IDE and [esp8266/Arduino](https://github.com/esp8266/Arduino).
Go to https://github.com/settings/tokens, click on "Generate new token", check "notifications", click "Generate token". Copy the resulting token into the sketch at
```
const String github_token = "...";
```
Upload the sketch. Connect to the `AutoConnectAP` WLAN access point, set up your WLAN credentials.
## Your contributions are welcome
This is a simple sketch but we still have many ideas, [have a look here](https://github.com/probonopd/ESP8266GitHubNotificator/issues) and send pull requests.