Skip to content

Latest commit

 

History

History
151 lines (101 loc) · 5.66 KB

README.md

File metadata and controls

151 lines (101 loc) · 5.66 KB
Raw

HomePlate

Home Assistant E-Ink Dashboard on the Inkplate 10

homeplate

Activities Screenshots

Features

  • Display Home Assistant dashboards on a beautiful e-ink display
  • Display WiFi QR Codes for guests/friends to connect to home/guest wifi
  • Can display messages directly from Home Assistant over MQTT
  • Makes full use of the ESP32's cores with FreeRTOS
  • Reports sensor data to Home Assistant over MQTT (Temperature, Battery, WiFi, etc..)
  • Can change Activity displayed via MQTT Command (HASS dashboard, WiFi QR, Stats, text message, etc..)
  • Syncs RTC over NTP
  • Touch-pad buttons can start activities and wake from sleep
  • 1 month+ battery life!
  • Low battery warning displayed and sent over MQTT
  • OTA updates over WiFi
  • Partial screen updates in grayscale mode.
  • Power saving sleep mode.
  • Display any PNG image from MQTT Command

Future Ideas

Setup

Hardware

See hardware.md

Home Assistant Dashboard

Create a Home Assistant Dashboard you want to display. I recommend using the kiosk-mode, card-mod and layout-card plugins to customize and tune the dashboard for your display.

Setup sibbl's hass-lovelace-kindle-screensaver or my fork hass-screenshot to regularly screenshot the desired dashboards for the HomePlate.

More information in hass.md and dashboard.md

Inkplate

Install PlatformIO.

Configuring

Copy config_example.h to config.h and add/change your settings.

Variable sleep intervals

If you want your inkplate to sleep with different intervals, copy config_example.cpp to config.cpp and uncomment the 4 lines in config.h starting from #define CONFIG_CPP. Then configure your sleepSchedule in config.cpp.

Note that schedule slots do not span multiple days, this means that the day of week setting is similar to configuring a cronjob. F.e. the settings below should be read as between Xam to Ypm on every weekday, and not as from monday Xam to friday Ypm.

To help with debugging the current sleep duration is also send to mqtt, so you can monitor it in home assistant.

{
    // on every weekday sleep for 1 hour between 12am and 8am
    .start_dow = 1, .start_hour = 0, .start_minute = 0,
    .end_dow = 5, .end_hour = 8, .end_minute = 0,
    .sleep_in_seconds = 3600
},
{
    // on every weekday sleep for 5min between 8am and 8pm
    .start_dow = 1, .start_hour = 8, .start_minute = 0,
    .end_dow = 5, .end_hour = 20, .end_minute = 0,
    .sleep_in_seconds = 300
},
{
    // on every weekday sleep for 30min between 8pm and 12am
    .start_dow = 1, .start_hour = 20, .start_minute = 0,
    .end_dow = 5, .end_hour = 24, .end_minute = 0,
    .sleep_in_seconds = 1800
}
MQTT Expiration

MQTT data sent by homeplate will by default expire after 2 * TIME_TO_SLEEP_MIN. When using a custom sleep schedule, this could mean that MQTT data expires before homeplate wakes up and sent new values. You should adjust MQTT_EXPIRE_AFTER_SEC in config.h to a value greater than your longest sleep schedule to avoid this.

Build & run

pio run

If you have the Inkplate10v2 (without the additional MCP expander and touchpads), use the inkplate10v2 environment:

pio run -e inkplate10v2

The first flash/installation needs to be done over USB. Future updates can be done over USB or WiFi with:

pio run -e ota

To monitor serial output without re-flashing:

pio device monitor

Updating

git pull
pio upgrade
pio pkg update
pio run --target clean

Debugging

Touchpad Sensitivity

On some devices, the touchpads can be overly sensitive. This can cause lots of phantom touch events preventing the Homeplate from going into sleep and using up a lot of power.

Sometimes running pio run --target=clean can resolve this before you build & flash the firmware.

The touchpad sensitivity is set in hardware by resistors, but the touch sensors are calibrated on bootup when the Device first gets power. I have found that USB power can mess with this calibration. If you are using battery power, restarting the Homeplate (by using the power switch on the side of the PCB) without USB power attached is enough to fix the sensitivity.

Alternatively, the touchpads can be completely disabled by setting #define TOUCHPAD_ENABLE false in config.h.

Waveform

If you get the following error while booting your inkplate, run the Inkplate_Wavefrom_EEPROM_Programming example to update your Inkplate's waveform.

Waveform load failed! Upload new waveform in EEPROM. Using default waveform.

Older Inkplates don't appear to ship with an updated waveform. I found waveform 3 looks the best for mine.

Tests

The available unit tests use the 'native' environment and can be run by either:

  • running them manually
pio test -v
  • in VSCode use Testing -> native -> Run Test
  • in VSCode use PlatformIO -> Project Tasks -> native -> Advanced -> Test