Skip to content

Commit

Permalink
Document deep sleep mode
Browse files Browse the repository at this point in the history
  • Loading branch information
sidoh committed Mar 30, 2020
1 parent 60d4d8f commit c456dcd
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Template-oriented driver for e-paper displays using Arduino. Define a layout wi
- [Setup](#setup)
- [Requirements](#requirements)
- [Quickstart](#quickstart)
- [Deep Sleep](#deep-sleep)
- [Concepts](#concepts)
- [Variables](#variables)
- [Regions](#regions)
Expand Down Expand Up @@ -61,6 +62,17 @@ The [examples directory](./examples) has a few sample templates. Here are a few
1. Setup WiFi. A setup AP will appear named `epaper_XXXXXX`. The default password is **waveshare**.
1. Visit the Web UI to configure further.

## Deep Sleep

e-paper templates can function in _deep sleep_ mode. When configured, the system will continuously:

1. Wake from sleep
2. Check if a configurable GPIO pin is set. If it is, stays awake until next reboot
3. Otherwise, stay awake for a configurable period to receive updates and refresh the screen.
4. Put both the ESP32 and the e-paper display into deep sleep mode.

This is useful if trying to conserve power. Deep sleep mode can be configured in the "Power" tab within the web UI.

# Concepts

This project aims to strike a particular balance of flexibility and ease-of-use. In order to understand how to make use of it, let's briefly discuss some primitives:
Expand Down

0 comments on commit c456dcd

Please sign in to comment.