▦
ESP ScreensTiles for your CYD and Guition, without reflashing

HOME ASSISTANT

Manage your remote screens here.

Connecting…
▦

Start with a screen

Connect a CYD or Guition via USB to your Home Assistant machine. Profile, firmware, and the first flash happen in one window.

NEW SCREEN

Connect and install.

Connect the screen with a USB data cable to the machine running Home Assistant. ESP Screens creates its own profile with unique keys, builds the firmware, and puts it straight on the screen.

Which screen do you have?

FIRMWARE & USB

Build and install screen firmware

The built-in ESPHome CLI uses your own profile (YAML with keys) and secrets. Choose the screen's profile, then a USB port (screen connected to the Home Assistant machine) or Wi-Fi / OTA with the hostname. Check only validates, Build only compiles, Build & install puts the firmware on the screen. Your tiles stay as they are in ESP Screens. The first build takes a few minutes. 


    
    
    
    
      

        

          
ALERTS · CHEATSHEET

          
A full-screen notification, from an automation.

        

        
      

      

        Every screen has the show_alert action. It places a card over everything,
        wakes the screen, and keeps the backlight at normal brightness until someone taps
        the button or the timeout runs out. Home Assistant itself shows no explanation or
        dropdowns for ESPHome actions; everything you can fill in is listed here.
      

      

        
        
      

      

        
Your screens

        

          Every screen has its own action, with the device name in it. From firmware
          0.2.31; update an older screen with its
          Update button under My screens.
        

        

      

      

        
In an automation

        
    
          
  1. Add action and search for ESPHome. Choose your screen's action:
            Home Assistant calls it "Performs the action show_alert of the node
            device name".
    2. 
          
  2. Fill in the fields. Home Assistant asks for all seven; leave what you don't
            use empty ("", 0, off).
    3. 
          
  3. Prefer YAML? Choose Edit in YAML on the action and paste the example
            below.
    4. 
        

        

          
          

            

            
          

        

      

      

        
All screens at once

        

          Fire the event esp_screens_show_alert with the same
          fields, and ESP Screens passes the alert on to every screen that is online, including
          screens you add later. esp_screens_dismiss_alert
          clears it everywhere. In an automation, add the Event action or paste the example
          under Edit in YAML. Leave out the fields you don't use. ESP Screens has to be
          running for this.
        

        

          

          
        

      

      

        
The fields

        

          Text is free-form; the limit is in bytes, and an accented letter counts as two.
          What doesn't fit gets an ellipsis (title) or is dropped (subtitle).
        

        

      

      

        
Icons

        

          Fill in the name in icon, for example doorbell.
          mdi:doorbell and the hex codepoint (F12E6) also work.
          Only these icons are included in the firmware; any other name shows the
          warning triangle. Tap an icon to copy its name.
        

        
Handy for notifications

        

        
        

      

      

        
Colors

        

          Fill in the name in color. These are the pastel shades of the tiles,
          with dark text. Empty or unknown gives the white card. Tap to copy.
        

        

      

      

        
Behavior

        
      

      

        
Events

        

          Every end fires the event esphome.screen_alert
          with action, title, screen (the device name)
          and the device_id that Home Assistant adds. Visible under
          Settings → Tools → Events.
        

        

        
Waiting until someone presses the button

        

          

          
        

      

      

        
Tips