NOAA/NWS version of nook-weather rewritten in Typescript to better handle errors with weather.gov API.
- A rooted Nook Simple Touch
- ElectricSign installed. APK can be downloaded from here
or here.
- Source code available jfriesne/Electric-Sign
- Docker to run the server
For those who own a personal weather station or have an outdoor thermometer, local weather conditions can be appied
using an API response through src/apis/localWeather.ts
. Any values provided by this API response will supercede those
fetched from Weather.gov.
- As this pulls data from NOAA stations, it will likely only work for locations in the United States.
- Not all postal codes seem to work. Querying zip codes using OpenStreetMaps' Nominatim API that associated with only Post Office boxes do not return a location despite being assigned a city. If this occurs, please choose another local zip code.
- The postal code is used to find the nearest NOAA station. Depending on your location, this may be far away. Find the nearest station on the NOAA/NWS website.
The icons provided with the NWS forecasts are not designed for e-ink displays and look like crap. Instead, icons are mapped to equivalent ones from erikflowers/weather-icons.
Enviromental parameter | Required | Description |
---|---|---|
EMAIL |
Yes | NWS API requires a non-validated API key to prevent abuse. It can be anything but prefers to use your email address. |
ZIP_CODE |
Yes | Location of weather forecast. See limitations above if experiencing difficulties. |
BIND_PORT |
No | Port to bind HTTP server to. Default is 3099 |
Download or clone the NWS branch of this repo. Build the docker image and run the container.
docker build -t "nook-weather" .
docker run -d \
-p 3099:3099 \
-e EMAIL="test@example.com" \
-e ZIP_CODE=<YOUR_ZIP_CODE> \
--name "nook-weather" \
nook-weather