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

Update customization.md

Browse Source
This commit is contained in:
Andy Thomas
2024-03-29 09:51:01 +01:00
parent 386d39d85a
commit ea459c8bf4
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/customization.md
View File

@@ -541,11 +541,7 @@ time:
### Frameworks ### Frameworks
> [!IMPORTANT] > [!IMPORTANT]
> When switching between frameworks, make sure to update the device with a serial cable as the partition table is different between the two frameworks > When switching between frameworks, make sure to update the device with a serial cable as the partition table is different between the two frameworks
as [OTA Update Component](https://esphome.io/components/ota) updates will not change the partition table. as [OTA Update Component](https://esphome.io/components/ota) updates will not change the partition table. While it will appear to work, the device will boot the old framework after a reset.
The `arduino` protocol still more popular and therefore more components are available, but as `esp-idf` is maintained by EspressIF and is kept updated,
more boards are supported and the memory management is better, making it ideal if you wanna customize your panel to support memory consumption functionalities,
like `bluetooth_proxy` or [Improv](https://www.improv-wifi.com/).
This project currently uses `esp-idf` as default framework. This project currently uses `esp-idf` as default framework.
You can overlap the settings with this customization. You can overlap the settings with this customization.
@@ -553,6 +549,12 @@ You can overlap the settings with this customization.
> [!NOTE] > [!NOTE]
> For more info about frameworks, please visit [ESPHome docs](https://esphome.io/components/esp32). > For more info about frameworks, please visit [ESPHome docs](https://esphome.io/components/esp32).
`esp-idf` is maintained by EspressIF and is kept updated,
more boards are supported and the memory management is better, making it ideal if you wanna customize your panel to support memory consumption functionalities,
like `bluetooth_proxy` or [Improv](https://www.improv-wifi.com/). Consequently, this project uses `esp-idf` as the default framework since `v4.3`.
However, the `arduino` protocol still very popular and, therefore, more components are available and the project allows to switch between the frameworks by adding the following lines in your panel's yaml file.
#### Framework `arduino` #### Framework `arduino`
```yaml ```yaml
# Change framework to `arduino` # Change framework to `arduino`
@@ -563,6 +565,7 @@ esp32:
#### Framework `esp-idf` #### Framework `esp-idf`
```yaml ```yaml
# Change framework to `esp-idf` # Change framework to `esp-idf`
# (should not be required)
esp32: esp32:
framework: framework:
type: esp-idf type: esp-idf