h3n3/NSPanel_HA_Blueprint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update 'compiling errors' doc

Browse Source
This commit is contained in:
Andy Thomas
2024-03-07 09:25:42 +01:00
parent 940f1d90fe
commit 631516f7c6
1 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/error_compiling.md
View File

@@ -1,17 +1,20 @@
# Compiling Errors Guide
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.
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 meny related to your device and then "**Clean Build Files**":
Go to your ESPHome Dashboard, click the 3-dot menu 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):
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):
```yaml
# Limit the amount of resources used for compiling
@@ -23,15 +26,15 @@ Go to your ESPHome Dashboard, click the 3-dot meny related to your device and th
> Place this in a dedicated customization section in your YAML for easier maintenance,
similar to [this example](https://github.com/Blackymas/NSPanel_HA_Blueprint/blob/main/docs/customization.md#instructions).
2. 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.
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.
3. Temporarily stop non-essential add-ons in Home Assistant, especially resource-intensive ones like Studio Code Server.
4. Temporarily stop non-essential add-ons in Home Assistant, especially resource-intensive ones like Studio Code Server.
4. [Clean up build files](#clean-up-build-files)
5. [Clean up build files](#clean-up-build-files)
5. Try compiling again.
6. Try compiling again.
6. After completion, restart your host system to reactivate the stopped add-ons.
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](https://esphome.io/guides/installing_esphome.html).