Max Gramser
8a587303d7
Override YAML on a screen edits <name>.local.yaml, a package loaded after the shared board package. New profiles get an empty one; an existing profile is attached on the first save without reformatting the file. The editor validates YAML, refuses the managed sections and substitutions, and Save & check runs ESPHome's full validation of the complete profile. The example uses !extend: ESPHome appends package lists instead of merging them by id, so a bare id added a second display without a platform and failed the build. An override is 12 KB at most and a too-large body answers as JSON instead of a bare 413. The sidecar is written before the profile includes it, and a symlinked sidecar is refused. Firmware stays 0.2.52. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
40 lines
2.6 KiB
Markdown
40 lines
2.6 KiB
Markdown
# Installation and everyday use
|
|
|
|
See [the full installation guide](https://github.com/MaxGramser/homeassistant_espscreen/blob/main/docs/EASY_SETUP.md).
|
|
|
|
Open **Settings → New screen** to install a screen: connect it via USB to the
|
|
Home Assistant machine, choose the board, name and USB port, then click **Install**.
|
|
The profile with unique keys goes into the ESPHome folder of the HA configuration,
|
|
any missing Wi-Fi goes into `secrets.yaml` (existing secrets are left untouched), and the
|
|
build and flash run in the same window; it then shows the API key
|
|
for pairing. Pairing itself happens in Home Assistant under **Settings → Devices & services** (a button in the window and on the *not yet in Home Assistant* card under My screens). Each screen has its own profile. **Settings → Firmware & USB** is
|
|
for existing profiles: check, build or reinstall via USB or
|
|
the IP address (OTA). Existing ESPHome profiles in the HA config folder are
|
|
found automatically.
|
|
|
|
**Settings** (top right) also has the nightly firmware updates, the **Alerts** cheatsheet
|
|
(an alert on one screen, or on every screen with the `esp_screens_show_alert` event)
|
|
and **Claude**: install the ESP Screens skill for Claude Code in Home Assistant, or
|
|
download it for claude.ai, and ask Claude for the alert automation.
|
|
|
|
At the top of the editor you set the **Top bar** for each screen: the name on the left, up
|
|
to six items on the right (time, analog clock, date, or an entity with an icon, such as
|
|
temperature, a door, the alarm, or "last changed"). Drag to reorder, tap
|
|
to configure; firmware 0.2.32 or newer renders them.
|
|
|
|
After pairing via the HA ESPHome integration, choose the tiles in ESP Screens.
|
|
**Tile settings** has click behavior, larger values and mini-sliders.
|
|
**Screen settings** has brightness and standby. **Inspector** helps with
|
|
missing attributes or an offline screen. New cards require firmware 0.2.0.
|
|
Each screen also has **Override YAML** for a persistent, hardware-specific
|
|
`<screen>.local.yaml` file. It is loaded after the shared package and does not
|
|
replace the managed name, credentials, Wi-Fi, OTA or package connection.
|
|
|
|
The screen carries the same settings itself (firmware 0.2.44 or newer): hold the top bar for
|
|
about a second and a half, or put the built-in **Settings** card on a page. What is changed
|
|
there appears here within a second, and the other way around.
|
|
|
|
In Home Assistant every screen also has a **Wake** and a **Sleep** button (firmware 0.2.45 or
|
|
newer). Press them from an automation with `button.press`: Wake does what a tap does, Sleep puts
|
|
the screen in standby right away, also with Auto standby off.
|