From 7ed8bd60a414205446c4849eb0420433c9d77895 Mon Sep 17 00:00:00 2001 From: Edward Firmo <94725493+edwardtfn@users.noreply.github.com> Date: Mon, 15 Jan 2024 00:56:12 +0100 Subject: [PATCH] Added pic for clean build files --- docs/error_compiling.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/error_compiling.md b/docs/error_compiling.md index c45728d..d8a2158 100644 --- a/docs/error_compiling.md +++ b/docs/error_compiling.md @@ -1,8 +1,16 @@ # Compiling Errors Guide -It seems the issue is due to insufficient resources on your server for compiling. -Here are two suggestions: -## Free Up Server Resources +The most common cases for compiling errors are related to build files needing to be cleaned up and to lack of resourced on your ESPHome comoiler host. +These are our suggestions for both cases: + +## Clean-up build files + +Go to your ESPHome Dashboard, click the 3-dot meny related to your device and then "**Clean Build Files**": + +![image](https://raw.githubusercontent.com/Blackymas/NSPanel_HA_Blueprint/dev/docs/pics/esphome_dashboard_clean_build_files.png) + +## Limited resources on ESPHome compiler host +### Free Up Server Resources 1. Add the following to your device's YAML to reduce resource usage (this may slow down the compilation process): ```yaml @@ -19,13 +27,13 @@ Here are two suggestions: 3. Temporarily stop non-essential add-ons in Home Assistant, especially resource-intensive ones like Studio Code Server. -4. Clean up build files (on the ESPHome Dashboard, click the 3-dot meny related to your device and then "**Clean Build Files**"). +4. [Clean up build files](#clean-up-build-files) 5. Try compiling again. 6. After completion, restart your host system to reactivate the stopped add-ons. -## Compile Using Your Computer +### Compile Using Your Computer 1. Install ESPHome on your computer (Windows, Mac, or Linux) following this guide: [Installing ESPHome Manually](https://esphome.io/guides/installing_esphome.html). 2. With ESPHome installed locally, you can use the ESPHome Dashboard or the [ESPHome Command Line Interface](https://esphome.io/guides/cli.html#command-line-interface) for compilation.