From 79c8e1820557e9a2c9092e2b44427531119ef06d Mon Sep 17 00:00:00 2001 From: Edward Firmo <94725493+edwardtfn@users.noreply.github.com> Date: Mon, 6 Nov 2023 08:10:43 +0100 Subject: [PATCH] Add `esp-idf` and `bluetooth_proxy` --- (EN)-Customization.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/(EN)-Customization.md b/(EN)-Customization.md index 40a0a11..e86225c 100644 --- a/(EN)-Customization.md +++ b/(EN)-Customization.md @@ -23,6 +23,8 @@ Table of contents: - [Scheduled actions](#scheduled-actions) - [Scheduled relay](#scheduled-relay) - [Scheduled climate](#scheduled-climate) + - [Framework `esp-idf`](#framework-esp-idf) + - [Bluetooth proxy](#bluetooth-proxy)     @@ -457,4 +459,33 @@ time: id: thermostat_embedded mode: auto target_temperature: 18°C -``` \ No newline at end of file +``` + +  +### Framework `esp-idf` +> Requires v4.1 or higher + +> When switching from `arduino` to `esp-idf`, 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. + +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/). + +For more info about frameworks, please visit [ESPHome docs](https://esphome.io/components/esp32). + +```yaml +# Change framework to `esp-idf` +esp32: + framework: + type: esp-idf +``` + +  +### Bluetooth proxy +> Requires v4.1 or higher + +> The [ESP32 Platform](#framework-esp-idf) component should be configured to use the `esp-idf` framework, as the `arduino` framework uses significantly more memory and performs poorly with the Bluetooth proxy enabled. + +```yaml +# Enable Bluetooth proxy +bluetooth_proxy: +``` +