Home

Jump to bottom

RapierXbox edited this page Jul 13, 2026 · 14 revisions

ShellyElevate Wiki

Welcome. This is the long version of the documentation. The README is intentionally short.

If you're new here, the path is roughly:

Check that your device is on the Supported Devices list.
Follow Installation to get the APK onto your display.
Run through First-Time Setup to point it at Home Assistant (or whatever else).
From there, pick the integration that fits your setup.

Setup

Supported Devices: every Shelly Wall Display model, what hardware they have, what works.
Installation: developer mode, ADB, sideloading the APK, permissions.
Jailbreak: the harder route via UART (soldering) or MTKClient. Only needed on the original Stargate and a few locked builds.
First-Time Setup: first launch, how to get back into settings, what the bare minimum config is.
Updating: reinstalling, the in-app updater, and the WebView update on Stargate.
Configuration Reference: every setting key, what it does, the default. The one to bookmark.

Talking to it

Home Assistant Integration: MQTT auto-discovery, what entities appear in HA, automation examples.
MQTT: the full topic structure if you're not using HA's auto-discovery (or you're using ioBroker, etc.).
HTTP API: REST on port 8080. Every endpoint, with curl examples.
JavaScript Interface: for when you want your dashboard page to read sensors or flip relays directly.

Features

Screensavers: types, idle timeout, wake-on-proximity, touch-to-wake.
Voice Assistant: Home Assistant Assist pipeline, wake word detection, model handling.
Bluetooth Proxy: pretend to be an ESPHome BT proxy for HA.
Kiosk & Lite Mode: the watchdog, auto-start on boot, crash recovery, and how to run without the WebView at all.

Reference

Hardware Reference: how the sensors, relays, buttons, brightness and dimmer actually work under the hood. Useful if something's off.
Building from Source: gradle, devcontainer, the GitHub Actions release flow.
Troubleshooting: the questions that keep showing up.

Original project by RapierXbox. Maintained with great help from dbochicchio. Report issues here.