probonopd / esp8266githubnotificator Goto Github PK

View Code? Open in Web Editor NEW

2.0 3.0 3.0 7 KB

ESP8266 GitHub notifications

License: MIT License

C++ 100.00%

esp8266 github notifications

esp8266githubnotificator's Introduction

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 is running a simple 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.

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 and send pull requests.

esp8266githubnotificator's People

Contributors

Stargazers

Watchers

Forkers

theassassin nixinator

esp8266githubnotificator's Issues

Make it check GMail and Twitter, too

https://github.com/jalmeroth/ESP8266-OAUTH2/blob/master/ESP8266-Gmail-Noot/ESP8266-Gmail-Noot.ino

Only the first connection request works

For some strange reason, only the first connection request works and all subsequent ones fail. Why?

connecting to api.github.com
GET request sent
2

headers received
connecting to api.github.com
connection failed
connecting to api.github.com
connection failed
connecting to api.github.com
connection failed

Check the fingerprint

We should compare the TLS fingerprint against a hardcoded one in the sketch.

Separate visualization of PRs

We could visualize waiting PRs separately (e.g., special blink pattern)

Make token configurable in Web UI

https://github.com/tzapu/WiFiManager#custom-parameters

You can use WiFiManager to collect more parameters than just SSID and password. This could be helpful for configuring stuff like MQTT host and port, blynk or emoncms tokens, just to name a few.

Obey the X-Poll-Interval header and "304 Not Modified" response

https://developer.github.com/v3/activity/notifications/ says:

Notifications are optimized for polling with the "Last-Modified" header. If there are no new notifications, you will see a "304 Not Modified" response, leaving your current rate limit untouched. There is an "X-Poll-Interval" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header.

# Add authentication to your requests
curl -I https://api.github.com/notifications
HTTP/1.1 200 OK
Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT
X-Poll-Interval: 60
# Pass the Last-Modified header exactly
curl -I https://api.github.com/notifications
   -H "If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT"
HTTP/1.1 304 Not Modified
X-Poll-Interval: 60

If home network is not there, then wait and periodically retry

If I power on my devices, then it takes a while for my WLAN to appear. If the ESP is booted faster than the WLAN, then it would open the AP.

Hence we should change the behavior:
If home network is not there, then wait and periodically retry.

Use https://github.com/jakerabid/WiFiManager#on-demand-configuration-portal to start the portal only if a button is pressed.

Blink the number of notifications

When the light goes on, we could periodically blink (=light goes off) the number of waiting notifications