Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/henri98/esp32-e-paper-weatherdisplay
An ESP32 and 4.2" ePaper Display reads Dark Sky weather API and displays the weather using ESP-IDF
https://github.com/henri98/esp32-e-paper-weatherdisplay
dark-sky-api eink epaper esp-idf esp32 iot low-power weather
Last synced: 2 months ago
JSON representation
An ESP32 and 4.2" ePaper Display reads Dark Sky weather API and displays the weather using ESP-IDF
- Host: GitHub
- URL: https://github.com/henri98/esp32-e-paper-weatherdisplay
- Owner: henri98
- License: mit
- Created: 2018-12-20T19:40:38.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-31T11:02:07.000Z (over 3 years ago)
- Last Synced: 2024-01-29T23:34:13.522Z (5 months ago)
- Topics: dark-sky-api, eink, epaper, esp-idf, esp32, iot, low-power, weather
- Language: C
- Homepage:
- Size: 130 KB
- Stars: 133
- Watchers: 15
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-esp - EPaperWeatherDisplay - A very cute e-ink weather display using the ESP32. (Projects / Smart Home and IoT)
README
# esp32-e-paper-weatherdisplay
[](https://travis-ci.com/henri98/esp32-e-paper-weatherdisplay)  
An ESP32 and 4.2" ePaper Display reads Dark Sky weather API and displays the weather using the [Espressif IoT Development Framework](https://github.com/espressif/esp-idf)
## Getting Started
### Hardware
For this project an ESP32 development module and a Waveshare 4.2inch e-Paper module are used. Documentation about this e-Paper module can be found [here](https://www.waveshare.com/wiki/4.2inch_e-Paper_Module). As ESP32 development board the DOIT ESP32 DEVKIT V1 can be used used.
To save battery power, the SILABS CP210x USB to UART Bridge and the AMS1117 voltage regulator can be removed from the development board. An external USB to UART converter can be used for programming.
#### Pin configuration
| Waveshare e-Paper | DOIT ESP32 DEVKIT V1 |
| ----------------- | -------------------- |
| MOSI_PIN | GPIO_NUM_27 |
| CLK_PIN | GPIO_NUM_26 |
| CS_PIN | GPIO_NUM_25 |
| DC_PIN | GPIO_NUM_33 |
| RST_PIN | GPIO_NUM_32 |
| BUSY_PIN | GPIO_NUM_35 |
| VCC | 3V3 |
| GND | GND |
| Update Button | DOIT ESP32 DEVKIT V1 |
| ----------------- | -------------------- |
| Pin A | GPIO_NUM_4 PIN |
| Pin B | GND |
| Reset Button | DOIT ESP32 DEVKIT V1 |
| ----------------- | -------------------- |
| Pin A | RESET PIN |
| Pin B | GND |
Connect a LiPo battery to the VCC of the Waveshare e-Paper module.
### Software
#### Prerequisites
Please check [ESP-IDF docs](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html) for getting started instructions.
#### Clone the project
```bash
git clone https://github.com/henri98/esp32-e-paper-weatherdisplay.git
```
#### Build and flash the project
Navigate to the project folder:
```bash
cd esp32-e-paper-weatherdisplay
```
Configure the project:
```bash
make menuconfig
```
The configuration menu will be displayed. Navigate to WiFi Configuration and enter credentials to connect to the WiFi. Navigate to Dark Sky configuration and configure the Latitude, Longitude and the Dark Sky API key. You can get an API key [here](https://darksky.net/dev). With an API key you can make up to 1000 free requests, so enough to keep the weather display up to date.
Build and flash the firmware on the ESP32:
```bash
make flash
```
To monitor the programm use:
```bash
make monitor
```
You can also choose to update the firmware over the air. This requires that a previous version of the firmware has already flashed. The update will be downloaded over HTTP. The update URL can be configured:
```bash
make menuconfig
```
The configuration menu will be displayed. Navigate to WiFi Configuration and enter the URL where the firmware can be found. After compiling the binary file can be found in the build directory: e-paper-weatherdisplay.bin
A simple HTTP server can be created using python:
```bash
python3 -m http.server 8080
```
If you start the HTTP server in the root of the project, the firmware can be retrieved using:
http://ip:8080/build/e-paper-weatherdisplay.bin
By pressing the update button (connect pin 4 to GND) after a reset the update will be started.
## Casing
A case has been made for the hardware. This can be found on Thingiverse: https://www.thingiverse.com/thing:3357579
## License
This source of this project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
## Icons and fonts
The weather icon images used are from https://github.com/erikflowers/weather-icons. The images are licensed under [SIL OFL 1.1](http://scripts.sil.org/OFL). The font used is the Ubuntu font, the license can be found [here](https://www.ubuntu.com/legal/font-licence).
The images and font are converted to "C" source format using [LCD Image Converter](https://github.com/riuson/lcd-image-converter).
## Images
