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

Merge pull request #1720 from andythomas/dev

Browse Source 
Dev Update docs (install.md) with memory requirements
This commit is contained in:
Edward Firmo
2024-01-24 13:41:01 +01:00
committed by GitHub
parent d5c21adec3 81a2597ced
commit da3e1d57d1
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/install.md
View File

@@ -8,7 +8,7 @@ Let’s embark on this journey together to create a smart home that’s uniquely
<!-- markdownlint-disable MD028 -->
> [!TIP]
> For troubleshooting TFT transfer issues, the most popular topic for new sers, please consult our [TFT Transfer Troubleshooting Guide](tft_upload.md).
> For troubleshooting TFT transfer issues, the most popular topic for new users, please consult our [TFT Transfer Troubleshooting Guide](tft_upload.md).
> [!NOTE]
> We encourage users with absolute beginner-level knowledge in Home Assistant, ESPHome, or YAML editing to familiarize themselves with the basics of these platforms.
@@ -60,6 +60,12 @@ To flash your NSPanel, ESPHome firmware is required.
ESPHome can be integrated into your setup in various ways, including as a Home Assistant add-on or through a local installation on your computer.
This guide is based on using the ESPHome dashboard, which is available in all standard implementations.
> [!NOTE]
> 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!
- **Installing ESPHome as a Home Assistant Add-On**: For seamless integration with Home Assistant, ESPHome can be installed as an add-on.
This method provides an easy-to-navigate interface and direct integration with your Home Assistant setup.
For detailed instructions on this installation method, refer to [Getting Started with ESPHome and Home Assistant](https://esphome.io/guides/getting_started_hassio).