Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.18 KB

error_compiling.md

File metadata and controls

45 lines (29 loc) · 2.18 KB
Raw

Compiling Errors Guide

The most common cases for compiling errors are related to build files needing to be cleaned up and the lack of resources on your ESPHome compiler host. These are our suggestions for both cases:

Clean-up build files

Go to your ESPHome Dashboard, click the 3-dot menu related to your device and then "Clean Build Files":

image

Limited resources on ESPHome compiler host

Free Up Server Resources

  1. First, please check the available memory of the ESPHome compiler host. 4GB of memory are recommended if you are installing ESPHome as a Home Assistant add-on. Therefore, a RasPi 4 with 4GB RAM is the minimum if you are using a Raspberry Pi. A manual installation requires at least 2GB of memory and 500MB of swap space or 3GB of memory. With less memory the compiler will crash!

  2. Add the following to your device's YAML to reduce resource usage (this may slow down the compilation process):

    # Limit the amount of resources used for compiling
esphome:
  compile_process_limit: 1

    [!TIP] Place this in a dedicated customization section in your YAML for easier maintenance, similar to this example.

  3. Restart your host system, not just Home Assistant. Use the advanced options to Reboot system, which also restarts add-ons and can free up memory.

  4. Temporarily stop non-essential add-ons in Home Assistant, especially resource-intensive ones like Studio Code Server.

  5. Clean up build files

  6. Try compiling again.

  7. After completion, restart your host system to reactivate the stopped add-ons.

Compile Using Your Computer

  1. Install ESPHome on your computer (Windows, Mac, or Linux) following this guide: Installing ESPHome Manually.

  2. With ESPHome installed locally, you can use the ESPHome Dashboard or the ESPHome Command Line Interface for compilation.