diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 3bf9c4e1f6..5703d39be1 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -7,11 +7,16 @@
- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Code quality improvements to existing code or addition of tests
- [ ] Other
-**Related issue or feature (if applicable):** fixes
+**Related issue or feature (if applicable):**
-**Pull request in [esphome-docs](https://github.com/esphome/esphome-docs) with documentation (if applicable):** esphome/esphome-docs#
+- fixes
+
+**Pull request in [esphome-docs](https://github.com/esphome/esphome-docs) with documentation (if applicable):**
+
+- esphome/esphome-docs#
## Test Environment
@@ -23,12 +28,6 @@
- [ ] RTL87xx
## Example entry for `config.yaml`:
-
```yaml
# Example config.yaml
diff --git a/.github/actions/restore-python/action.yml b/.github/actions/restore-python/action.yml
index c618a5ca97..c6978f68c5 100644
--- a/.github/actions/restore-python/action.yml
+++ b/.github/actions/restore-python/action.yml
@@ -22,7 +22,7 @@ runs:
python-version: ${{ inputs.python-version }}
- name: Restore Python virtual environment
id: cache-venv
- uses: actions/cache/restore@v4.0.2
+ uses: actions/cache/restore@v4.1.2
with:
path: venv
# yamllint disable-line rule:line-length
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 7c4fa65695..0d2f1c877d 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -46,7 +46,7 @@ jobs:
python-version: ${{ env.DEFAULT_PYTHON }}
- name: Restore Python virtual environment
id: cache-venv
- uses: actions/cache@v4.0.2
+ uses: actions/cache@v4.1.2
with:
path: venv
# yamllint disable-line rule:line-length
@@ -302,20 +302,22 @@ jobs:
- name: Cache platformio
if: github.ref == 'refs/heads/dev'
- uses: actions/cache@v4.0.2
+ uses: actions/cache@v4.1.2
with:
path: ~/.platformio
key: platformio-${{ matrix.pio_cache_key }}
- name: Cache platformio
if: github.ref != 'refs/heads/dev'
- uses: actions/cache/restore@v4.0.2
+ uses: actions/cache/restore@v4.1.2
with:
path: ~/.platformio
key: platformio-${{ matrix.pio_cache_key }}
- name: Install clang-tidy
- run: sudo apt-get install clang-tidy-14
+ run: |
+ sudo apt-get update
+ sudo apt-get install clang-tidy-14
- name: Register problem matchers
run: |
@@ -397,7 +399,9 @@ jobs:
file: ${{ fromJson(needs.list-components.outputs.components) }}
steps:
- name: Install dependencies
- run: sudo apt-get install libsdl2-dev
+ run: |
+ sudo apt-get update
+ sudo apt-get install libsdl2-dev
- name: Check out code from GitHub
uses: actions/checkout@v4.1.7
@@ -451,7 +455,9 @@ jobs:
run: echo ${{ matrix.components }}
- name: Install dependencies
- run: sudo apt-get install libsdl2-dev
+ run: |
+ sudo apt-get update
+ sudo apt-get install libsdl2-dev
- name: Check out code from GitHub
uses: actions/checkout@v4.1.7
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 8995c500ef..26a213f170 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -141,7 +141,7 @@ jobs:
echo name=$(cat /tmp/platform) >> $GITHUB_OUTPUT
- name: Upload digests
- uses: actions/upload-artifact@v4.4.0
+ uses: actions/upload-artifact@v4.4.3
with:
name: digests-${{ steps.sanitize.outputs.name }}
path: /tmp/digests
diff --git a/CODEOWNERS b/CODEOWNERS
index ed9c13a975..f96e43d5b7 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -48,7 +48,9 @@ esphome/components/at581x/* @X-Ryl669
esphome/components/atc_mithermometer/* @ahpohl
esphome/components/atm90e26/* @danieltwagner
esphome/components/atm90e32/* @circuitsetup @descipher
+esphome/components/audio/* @kahrendt
esphome/components/audio_dac/* @kbx81
+esphome/components/axs15231/* @clydebarrow
esphome/components/b_parasite/* @rbaron
esphome/components/ballu/* @bazuchan
esphome/components/bang_bang/* @OttoWinter
@@ -196,10 +198,11 @@ esphome/components/htu31d/* @betterengineering
esphome/components/hydreon_rgxx/* @functionpointer
esphome/components/hyt271/* @Philippe12
esphome/components/i2c/* @esphome/core
+esphome/components/i2c_device/* @gabest11
esphome/components/i2s_audio/* @jesserockz
esphome/components/i2s_audio/media_player/* @jesserockz
esphome/components/i2s_audio/microphone/* @jesserockz
-esphome/components/i2s_audio/speaker/* @jesserockz
+esphome/components/i2s_audio/speaker/* @jesserockz @kahrendt
esphome/components/iaqcore/* @yozik04
esphome/components/ili9xxx/* @clydebarrow @nielsnl68
esphome/components/improv_base/* @esphome/core
@@ -237,6 +240,7 @@ esphome/components/ltr_als_ps/* @latonita
esphome/components/lvgl/* @clydebarrow
esphome/components/m5stack_8angle/* @rnauber
esphome/components/matrix_keypad/* @ssieb
+esphome/components/max17043/* @blacknell
esphome/components/max31865/* @DAVe3283
esphome/components/max44009/* @berfenger
esphome/components/max6956/* @looping40
@@ -324,7 +328,7 @@ esphome/components/pvvx_mithermometer/* @pasiz
esphome/components/pylontech/* @functionpointer
esphome/components/qmp6988/* @andrewpc
esphome/components/qr_code/* @wjtje
-esphome/components/qspi_amoled/* @clydebarrow
+esphome/components/qspi_dbi/* @clydebarrow
esphome/components/qwiic_pir/* @kahrendt
esphome/components/radon_eye_ble/* @jeffeb3
esphome/components/radon_eye_rd200/* @jeffeb3
@@ -373,7 +377,7 @@ esphome/components/smt100/* @piechade
esphome/components/sn74hc165/* @jesserockz
esphome/components/socket/* @esphome/core
esphome/components/sonoff_d1/* @anatoly-savchenkov
-esphome/components/speaker/* @jesserockz
+esphome/components/speaker/* @jesserockz @kahrendt
esphome/components/spi/* @clydebarrow @esphome/core
esphome/components/spi_device/* @clydebarrow
esphome/components/spi_led_strip/* @clydebarrow
@@ -403,6 +407,7 @@ esphome/components/sun/* @OttoWinter
esphome/components/sun_gtil2/* @Mat931
esphome/components/switch/* @esphome/core
esphome/components/t6615/* @tylermenezes
+esphome/components/tc74/* @sethgirvan
esphome/components/tca9548a/* @andreashergert1984
esphome/components/tca9555/* @mobrembski
esphome/components/tcl112/* @glmnet
diff --git a/docker/Dockerfile b/docker/Dockerfile
index 85823687c2..52a4794f24 100644
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@@ -86,7 +86,7 @@ RUN \
pip3 install \
--break-system-packages --no-cache-dir \
# Keep platformio version in sync with requirements.txt
- platformio==6.1.15 \
+ platformio==6.1.16 \
# Change some platformio settings
&& platformio settings set enable_telemetry No \
&& platformio settings set check_platformio_interval 1000000 \
diff --git a/esphome/automation.py b/esphome/automation.py
index 0bd6cf0af0..34159561c2 100644
--- a/esphome/automation.py
+++ b/esphome/automation.py
@@ -1,6 +1,8 @@
import esphome.codegen as cg
import esphome.config_validation as cv
from esphome.const import (
+ CONF_ALL,
+ CONF_ANY,
CONF_AUTOMATION_ID,
CONF_CONDITION,
CONF_COUNT,
@@ -73,6 +75,13 @@ def validate_potentially_and_condition(value):
return validate_condition(value)
+def validate_potentially_or_condition(value):
+ if isinstance(value, list):
+ with cv.remove_prepend_path(["or"]):
+ return validate_condition({"or": value})
+ return validate_condition(value)
+
+
DelayAction = cg.esphome_ns.class_("DelayAction", Action, cg.Component)
LambdaAction = cg.esphome_ns.class_("LambdaAction", Action)
IfAction = cg.esphome_ns.class_("IfAction", Action)
@@ -166,6 +175,18 @@ async def or_condition_to_code(config, condition_id, template_arg, args):
return cg.new_Pvariable(condition_id, template_arg, conditions)
+@register_condition("all", AndCondition, validate_condition_list)
+async def all_condition_to_code(config, condition_id, template_arg, args):
+ conditions = await build_condition_list(config, template_arg, args)
+ return cg.new_Pvariable(condition_id, template_arg, conditions)
+
+
+@register_condition("any", OrCondition, validate_condition_list)
+async def any_condition_to_code(config, condition_id, template_arg, args):
+ conditions = await build_condition_list(config, template_arg, args)
+ return cg.new_Pvariable(condition_id, template_arg, conditions)
+
+
@register_condition("not", NotCondition, validate_potentially_and_condition)
async def not_condition_to_code(config, condition_id, template_arg, args):
condition = await build_condition(config, template_arg, args)
@@ -223,15 +244,21 @@ async def delay_action_to_code(config, action_id, template_arg, args):
IfAction,
cv.All(
{
- cv.Required(CONF_CONDITION): validate_potentially_and_condition,
+ cv.Exclusive(
+ CONF_CONDITION, CONF_CONDITION
+ ): validate_potentially_and_condition,
+ cv.Exclusive(CONF_ANY, CONF_CONDITION): validate_potentially_or_condition,
+ cv.Exclusive(CONF_ALL, CONF_CONDITION): validate_potentially_and_condition,
cv.Optional(CONF_THEN): validate_action_list,
cv.Optional(CONF_ELSE): validate_action_list,
},
cv.has_at_least_one_key(CONF_THEN, CONF_ELSE),
+ cv.has_at_least_one_key(CONF_CONDITION, CONF_ANY, CONF_ALL),
),
)
async def if_action_to_code(config, action_id, template_arg, args):
- conditions = await build_condition(config[CONF_CONDITION], template_arg, args)
+ cond_conf = next(el for el in config if el in (CONF_ANY, CONF_ALL, CONF_CONDITION))
+ conditions = await build_condition(config[cond_conf], template_arg, args)
var = cg.new_Pvariable(action_id, template_arg, conditions)
if CONF_THEN in config:
actions = await build_action_list(config[CONF_THEN], template_arg, args)
diff --git a/esphome/components/audio/__init__.py b/esphome/components/audio/__init__.py
new file mode 100644
index 0000000000..4ffdc401dc
--- /dev/null
+++ b/esphome/components/audio/__init__.py
@@ -0,0 +1,9 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+
+CODEOWNERS = ["@kahrendt"]
+audio_ns = cg.esphome_ns.namespace("audio")
+
+CONFIG_SCHEMA = cv.All(
+ cv.Schema({}),
+)
diff --git a/esphome/components/audio/audio.h b/esphome/components/audio/audio.h
new file mode 100644
index 0000000000..b0968dc8da
--- /dev/null
+++ b/esphome/components/audio/audio.h
@@ -0,0 +1,21 @@
+#pragma once
+
+#include
+#include
+
+namespace esphome {
+namespace audio {
+
+struct AudioStreamInfo {
+ bool operator==(const AudioStreamInfo &rhs) const {
+ return (channels == rhs.channels) && (bits_per_sample == rhs.bits_per_sample) && (sample_rate == rhs.sample_rate);
+ }
+ bool operator!=(const AudioStreamInfo &rhs) const { return !operator==(rhs); }
+ size_t get_bytes_per_sample() const { return bits_per_sample / 8; }
+ uint8_t channels = 1;
+ uint8_t bits_per_sample = 16;
+ uint32_t sample_rate = 16000;
+};
+
+} // namespace audio
+} // namespace esphome
diff --git a/esphome/components/axs15231/__init__.py b/esphome/components/axs15231/__init__.py
new file mode 100644
index 0000000000..3246dbed24
--- /dev/null
+++ b/esphome/components/axs15231/__init__.py
@@ -0,0 +1,6 @@
+import esphome.codegen as cg
+
+CODEOWNERS = ["@clydebarrow"]
+DEPENDENCIES = ["i2c"]
+
+axs15231_ns = cg.esphome_ns.namespace("axs15231")
diff --git a/esphome/components/axs15231/touchscreen/__init__.py b/esphome/components/axs15231/touchscreen/__init__.py
new file mode 100644
index 0000000000..8c18d8ca75
--- /dev/null
+++ b/esphome/components/axs15231/touchscreen/__init__.py
@@ -0,0 +1,36 @@
+from esphome import pins
+import esphome.codegen as cg
+from esphome.components import i2c, touchscreen
+import esphome.config_validation as cv
+from esphome.const import CONF_ID, CONF_INTERRUPT_PIN, CONF_RESET_PIN
+
+from .. import axs15231_ns
+
+AXS15231Touchscreen = axs15231_ns.class_(
+ "AXS15231Touchscreen",
+ touchscreen.Touchscreen,
+ i2c.I2CDevice,
+)
+
+CONFIG_SCHEMA = (
+ touchscreen.touchscreen_schema("50ms")
+ .extend(
+ {
+ cv.GenerateID(): cv.declare_id(AXS15231Touchscreen),
+ cv.Optional(CONF_INTERRUPT_PIN): pins.internal_gpio_input_pin_schema,
+ cv.Optional(CONF_RESET_PIN): pins.gpio_output_pin_schema,
+ }
+ )
+ .extend(i2c.i2c_device_schema(0x3B))
+)
+
+
+async def to_code(config):
+ var = cg.new_Pvariable(config[CONF_ID])
+ await touchscreen.register_touchscreen(var, config)
+ await i2c.register_i2c_device(var, config)
+
+ if interrupt_pin := config.get(CONF_INTERRUPT_PIN):
+ cg.add(var.set_interrupt_pin(await cg.gpio_pin_expression(interrupt_pin)))
+ if reset_pin := config.get(CONF_RESET_PIN):
+ cg.add(var.set_reset_pin(await cg.gpio_pin_expression(reset_pin)))
diff --git a/esphome/components/axs15231/touchscreen/axs15231_touchscreen.cpp b/esphome/components/axs15231/touchscreen/axs15231_touchscreen.cpp
new file mode 100644
index 0000000000..54b39a6bb9
--- /dev/null
+++ b/esphome/components/axs15231/touchscreen/axs15231_touchscreen.cpp
@@ -0,0 +1,64 @@
+#include "axs15231_touchscreen.h"
+
+#include "esphome/core/helpers.h"
+#include "esphome/core/log.h"
+
+namespace esphome {
+namespace axs15231 {
+
+static const char *const TAG = "ax15231.touchscreen";
+
+constexpr static const uint8_t AXS_READ_TOUCHPAD[11] = {0xb5, 0xab, 0xa5, 0x5a, 0x0, 0x0, 0x0, 0x8};
+
+#define ERROR_CHECK(err) \
+ if ((err) != i2c::ERROR_OK) { \
+ this->status_set_warning("Failed to communicate"); \
+ return; \
+ }
+
+void AXS15231Touchscreen::setup() {
+ ESP_LOGCONFIG(TAG, "Setting up AXS15231 Touchscreen...");
+ if (this->reset_pin_ != nullptr) {
+ this->reset_pin_->setup();
+ this->reset_pin_->digital_write(false);
+ delay(5);
+ this->reset_pin_->digital_write(true);
+ delay(10);
+ }
+ if (this->interrupt_pin_ != nullptr) {
+ this->interrupt_pin_->pin_mode(gpio::FLAG_INPUT);
+ this->interrupt_pin_->setup();
+ this->attach_interrupt_(this->interrupt_pin_, gpio::INTERRUPT_FALLING_EDGE);
+ }
+ this->x_raw_max_ = this->display_->get_native_width();
+ this->y_raw_max_ = this->display_->get_native_height();
+ ESP_LOGCONFIG(TAG, "AXS15231 Touchscreen setup complete");
+}
+
+void AXS15231Touchscreen::update_touches() {
+ i2c::ErrorCode err;
+ uint8_t data[8]{};
+
+ err = this->write(AXS_READ_TOUCHPAD, sizeof(AXS_READ_TOUCHPAD), false);
+ ERROR_CHECK(err);
+ err = this->read(data, sizeof(data));
+ ERROR_CHECK(err);
+ this->status_clear_warning();
+ if (data[0] != 0) // no touches
+ return;
+ uint16_t x = encode_uint16(data[2] & 0xF, data[3]);
+ uint16_t y = encode_uint16(data[4] & 0xF, data[5]);
+ this->add_raw_touch_position_(0, x, y);
+}
+
+void AXS15231Touchscreen::dump_config() {
+ ESP_LOGCONFIG(TAG, "AXS15231 Touchscreen:");
+ LOG_I2C_DEVICE(this);
+ LOG_PIN(" Interrupt Pin: ", this->interrupt_pin_);
+ LOG_PIN(" Reset Pin: ", this->reset_pin_);
+ ESP_LOGCONFIG(TAG, " Width: %d", this->x_raw_max_);
+ ESP_LOGCONFIG(TAG, " Height: %d", this->y_raw_max_);
+}
+
+} // namespace axs15231
+} // namespace esphome
diff --git a/esphome/components/axs15231/touchscreen/axs15231_touchscreen.h b/esphome/components/axs15231/touchscreen/axs15231_touchscreen.h
new file mode 100644
index 0000000000..a55c5c0d32
--- /dev/null
+++ b/esphome/components/axs15231/touchscreen/axs15231_touchscreen.h
@@ -0,0 +1,27 @@
+#pragma once
+
+#include "esphome/components/i2c/i2c.h"
+#include "esphome/components/touchscreen/touchscreen.h"
+#include "esphome/core/component.h"
+#include "esphome/core/hal.h"
+
+namespace esphome {
+namespace axs15231 {
+
+class AXS15231Touchscreen : public touchscreen::Touchscreen, public i2c::I2CDevice {
+ public:
+ void setup() override;
+ void dump_config() override;
+
+ void set_interrupt_pin(InternalGPIOPin *pin) { this->interrupt_pin_ = pin; }
+ void set_reset_pin(GPIOPin *pin) { this->reset_pin_ = pin; }
+
+ protected:
+ void update_touches() override;
+
+ InternalGPIOPin *interrupt_pin_{};
+ GPIOPin *reset_pin_{};
+};
+
+} // namespace axs15231
+} // namespace esphome
diff --git a/esphome/components/ble_rssi/sensor.py b/esphome/components/ble_rssi/sensor.py
index e3ba1abfd7..c4e767aa21 100644
--- a/esphome/components/ble_rssi/sensor.py
+++ b/esphome/components/ble_rssi/sensor.py
@@ -45,7 +45,7 @@ CONFIG_SCHEMA = cv.All(
cv.Optional(CONF_SERVICE_UUID): esp32_ble_tracker.bt_uuid,
cv.Optional(CONF_IBEACON_MAJOR): cv.uint16_t,
cv.Optional(CONF_IBEACON_MINOR): cv.uint16_t,
- cv.Optional(CONF_IBEACON_UUID): cv.uuid,
+ cv.Optional(CONF_IBEACON_UUID): esp32_ble_tracker.bt_uuid,
}
)
.extend(esp32_ble_tracker.ESP_BLE_DEVICE_SCHEMA)
@@ -79,7 +79,7 @@ async def to_code(config):
cg.add(var.set_service_uuid128(uuid128))
if ibeacon_uuid := config.get(CONF_IBEACON_UUID):
- ibeacon_uuid = esp32_ble_tracker.as_hex_array(str(ibeacon_uuid))
+ ibeacon_uuid = esp32_ble_tracker.as_reversed_hex_array(ibeacon_uuid)
cg.add(var.set_ibeacon_uuid(ibeacon_uuid))
if (ibeacon_major := config.get(CONF_IBEACON_MAJOR)) is not None:
diff --git a/esphome/components/bme68x_bsec2/__init__.py b/esphome/components/bme68x_bsec2/__init__.py
index 1930c7c9e3..d6dbb52f18 100644
--- a/esphome/components/bme68x_bsec2/__init__.py
+++ b/esphome/components/bme68x_bsec2/__init__.py
@@ -16,7 +16,7 @@ CODEOWNERS = ["@neffs", "@kbx81"]
DOMAIN = "bme68x_bsec2"
-BSEC2_LIBRARY_VERSION = "v1.7.2502"
+BSEC2_LIBRARY_VERSION = "v1.8.2610"
CONF_ALGORITHM_OUTPUT = "algorithm_output"
CONF_BME68X_BSEC2_ID = "bme68x_bsec2_id"
diff --git a/esphome/components/cse7766/cse7766.cpp b/esphome/components/cse7766/cse7766.cpp
index 47058badce..48240464b3 100644
--- a/esphome/components/cse7766/cse7766.cpp
+++ b/esphome/components/cse7766/cse7766.cpp
@@ -244,7 +244,7 @@ void CSE7766Component::dump_config() {
LOG_SENSOR(" ", "Apparent Power", this->apparent_power_sensor_);
LOG_SENSOR(" ", "Reactive Power", this->reactive_power_sensor_);
LOG_SENSOR(" ", "Power Factor", this->power_factor_sensor_);
- this->check_uart_settings(4800);
+ this->check_uart_settings(4800, 1, uart::UART_CONFIG_PARITY_EVEN);
}
} // namespace cse7766
diff --git a/esphome/components/cst816/touchscreen/__init__.py b/esphome/components/cst816/touchscreen/__init__.py
index a3603ef575..288ca17593 100644
--- a/esphome/components/cst816/touchscreen/__init__.py
+++ b/esphome/components/cst816/touchscreen/__init__.py
@@ -1,11 +1,10 @@
-import esphome.codegen as cg
-import esphome.config_validation as cv
-
from esphome import pins
+import esphome.codegen as cg
from esphome.components import i2c, touchscreen
-from esphome.const import CONF_INTERRUPT_PIN, CONF_ID, CONF_RESET_PIN
-from .. import cst816_ns
+import esphome.config_validation as cv
+from esphome.const import CONF_ID, CONF_INTERRUPT_PIN, CONF_RESET_PIN
+from .. import cst816_ns
CST816Touchscreen = cst816_ns.class_(
"CST816Touchscreen",
@@ -14,11 +13,14 @@ CST816Touchscreen = cst816_ns.class_(
)
CST816ButtonListener = cst816_ns.class_("CST816ButtonListener")
+
+CONF_SKIP_PROBE = "skip_probe"
CONFIG_SCHEMA = touchscreen.TOUCHSCREEN_SCHEMA.extend(
{
cv.GenerateID(): cv.declare_id(CST816Touchscreen),
cv.Optional(CONF_INTERRUPT_PIN): pins.internal_gpio_input_pin_schema,
cv.Optional(CONF_RESET_PIN): pins.gpio_output_pin_schema,
+ cv.Optional(CONF_SKIP_PROBE, default=False): cv.boolean,
}
).extend(i2c.i2c_device_schema(0x15))
@@ -28,6 +30,7 @@ async def to_code(config):
await touchscreen.register_touchscreen(var, config)
await i2c.register_i2c_device(var, config)
+ cg.add(var.set_skip_probe(config[CONF_SKIP_PROBE]))
if interrupt_pin := config.get(CONF_INTERRUPT_PIN):
cg.add(var.set_interrupt_pin(await cg.gpio_pin_expression(interrupt_pin)))
if reset_pin := config.get(CONF_RESET_PIN):
diff --git a/esphome/components/cst816/touchscreen/cst816_touchscreen.cpp b/esphome/components/cst816/touchscreen/cst816_touchscreen.cpp
index 9e59810c7e..7dcb130e20 100644
--- a/esphome/components/cst816/touchscreen/cst816_touchscreen.cpp
+++ b/esphome/components/cst816/touchscreen/cst816_touchscreen.cpp
@@ -8,32 +8,33 @@ void CST816Touchscreen::continue_setup_() {
this->interrupt_pin_->setup();
this->attach_interrupt_(this->interrupt_pin_, gpio::INTERRUPT_FALLING_EDGE);
}
- if (!this->read_byte(REG_CHIP_ID, &this->chip_id_)) {
+ if (this->read_byte(REG_CHIP_ID, &this->chip_id_)) {
+ switch (this->chip_id_) {
+ case CST820_CHIP_ID:
+ case CST826_CHIP_ID:
+ case CST716_CHIP_ID:
+ case CST816S_CHIP_ID:
+ case CST816D_CHIP_ID:
+ case CST816T_CHIP_ID:
+ break;
+ default:
+ this->mark_failed();
+ this->status_set_error(str_sprintf("Unknown chip ID 0x%02X", this->chip_id_).c_str());
+ return;
+ }
+ this->write_byte(REG_IRQ_CTL, IRQ_EN_MOTION);
+ } else if (!this->skip_probe_) {
+ this->status_set_error("Failed to read chip id");
this->mark_failed();
- esph_log_e(TAG, "Failed to read chip id");
return;
}
- switch (this->chip_id_) {
- case CST820_CHIP_ID:
- case CST826_CHIP_ID:
- case CST716_CHIP_ID:
- case CST816S_CHIP_ID:
- case CST816D_CHIP_ID:
- case CST816T_CHIP_ID:
- break;
- default:
- this->mark_failed();
- esph_log_e(TAG, "Unknown chip ID 0x%02X", this->chip_id_);
- return;
- }
- this->write_byte(REG_IRQ_CTL, IRQ_EN_MOTION);
if (this->x_raw_max_ == this->x_raw_min_) {
this->x_raw_max_ = this->display_->get_native_width();
}
if (this->y_raw_max_ == this->y_raw_min_) {
this->y_raw_max_ = this->display_->get_native_height();
}
- esph_log_config(TAG, "CST816 Touchscreen setup complete");
+ ESP_LOGCONFIG(TAG, "CST816 Touchscreen setup complete");
}
void CST816Touchscreen::update_button_state_(bool state) {
@@ -45,7 +46,7 @@ void CST816Touchscreen::update_button_state_(bool state) {
}
void CST816Touchscreen::setup() {
- esph_log_config(TAG, "Setting up CST816 Touchscreen...");
+ ESP_LOGCONFIG(TAG, "Setting up CST816 Touchscreen...");
if (this->reset_pin_ != nullptr) {
this->reset_pin_->setup();
this->reset_pin_->digital_write(true);
@@ -73,7 +74,7 @@ void CST816Touchscreen::update_touches() {
uint16_t x = encode_uint16(data[REG_XPOS_HIGH] & 0xF, data[REG_XPOS_LOW]);
uint16_t y = encode_uint16(data[REG_YPOS_HIGH] & 0xF, data[REG_YPOS_LOW]);
- esph_log_v(TAG, "Read touch %d/%d", x, y);
+ ESP_LOGV(TAG, "Read touch %d/%d", x, y);
if (x >= this->x_raw_max_) {
this->update_button_state_(true);
} else {
diff --git a/esphome/components/cst816/touchscreen/cst816_touchscreen.h b/esphome/components/cst816/touchscreen/cst816_touchscreen.h
index 24e664e7ee..dc00e675ba 100644
--- a/esphome/components/cst816/touchscreen/cst816_touchscreen.h
+++ b/esphome/components/cst816/touchscreen/cst816_touchscreen.h
@@ -45,6 +45,7 @@ class CST816Touchscreen : public touchscreen::Touchscreen, public i2c::I2CDevice
void set_interrupt_pin(InternalGPIOPin *pin) { this->interrupt_pin_ = pin; }
void set_reset_pin(GPIOPin *pin) { this->reset_pin_ = pin; }
+ void set_skip_probe(bool skip_probe) { this->skip_probe_ = skip_probe; }
protected:
void continue_setup_();
@@ -53,6 +54,7 @@ class CST816Touchscreen : public touchscreen::Touchscreen, public i2c::I2CDevice
InternalGPIOPin *interrupt_pin_{};
GPIOPin *reset_pin_{};
uint8_t chip_id_{};
+ bool skip_probe_{}; // if set, do not expect to be able to probe the controller on the i2c bus.
std::vector button_listeners_;
bool button_touched_{};
};
diff --git a/esphome/components/debug/debug_esp32.cpp b/esphome/components/debug/debug_esp32.cpp
index 34aea9e26b..cb4330f422 100644
--- a/esphome/components/debug/debug_esp32.cpp
+++ b/esphome/components/debug/debug_esp32.cpp
@@ -36,7 +36,8 @@ std::string DebugComponent::get_reset_reason_() {
break;
#if defined(USE_ESP32_VARIANT_ESP32)
case SW_RESET:
-#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
+#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S2) || \
+ defined(USE_ESP32_VARIANT_ESP32S3) || defined(USE_ESP32_VARIANT_ESP32C6)
case RTC_SW_SYS_RESET:
#endif
reset_reason = "Software Reset Digital Core";
@@ -72,14 +73,16 @@ std::string DebugComponent::get_reset_reason_() {
case TGWDT_CPU_RESET:
reset_reason = "Timer Group Reset CPU";
break;
-#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
+#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S2) || \
+ defined(USE_ESP32_VARIANT_ESP32S3) || defined(USE_ESP32_VARIANT_ESP32C6)
case TG0WDT_CPU_RESET:
reset_reason = "Timer Group 0 Reset CPU";
break;
#endif
#if defined(USE_ESP32_VARIANT_ESP32)
case SW_CPU_RESET:
-#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
+#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S2) || \
+ defined(USE_ESP32_VARIANT_ESP32S3) || defined(USE_ESP32_VARIANT_ESP32C6)
case RTC_SW_CPU_RESET:
#endif
reset_reason = "Software Reset CPU";
@@ -98,27 +101,32 @@ std::string DebugComponent::get_reset_reason_() {
case RTCWDT_RTC_RESET:
reset_reason = "RTC Watch Dog Reset Digital Core And RTC Module";
break;
-#if defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
+#if defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3) || \
+ defined(USE_ESP32_VARIANT_ESP32C6)
case TG1WDT_CPU_RESET:
reset_reason = "Timer Group 1 Reset CPU";
break;
case SUPER_WDT_RESET:
reset_reason = "Super Watchdog Reset Digital Core And RTC Module";
break;
- case GLITCH_RTC_RESET:
- reset_reason = "Glitch Reset Digital Core And RTC Module";
- break;
case EFUSE_RESET:
reset_reason = "eFuse Reset Digital Core";
break;
#endif
-#if defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S3)
+#if defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
+ case GLITCH_RTC_RESET:
+ reset_reason = "Glitch Reset Digital Core And RTC Module";
+ break;
+#endif
+#if defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S3) || defined(USE_ESP32_VARIANT_ESP32C6)
case USB_UART_CHIP_RESET:
reset_reason = "USB UART Reset Digital Core";
break;
case USB_JTAG_CHIP_RESET:
reset_reason = "USB JTAG Reset Digital Core";
break;
+#endif
+#if defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S3)
case POWER_GLITCH_RESET:
reset_reason = "Power Glitch Reset Digital Core And RTC Module";
break;
diff --git a/esphome/components/display/display.cpp b/esphome/components/display/display.cpp
index 63c74e09ca..145a4f5278 100644
--- a/esphome/components/display/display.cpp
+++ b/esphome/components/display/display.cpp
@@ -156,6 +156,148 @@ void Display::filled_circle(int center_x, int center_y, int radius, Color color)
}
} while (dx <= 0);
}
+void Display::filled_ring(int center_x, int center_y, int radius1, int radius2, Color color) {
+ int rmax = radius1 > radius2 ? radius1 : radius2;
+ int rmin = radius1 < radius2 ? radius1 : radius2;
+ int dxmax = -int32_t(rmax), dxmin = -int32_t(rmin);
+ int dymax = 0, dymin = 0;
+ int errmax = 2 - 2 * rmax, errmin = 2 - 2 * rmin;
+ int e2max, e2min;
+ do {
+ // 8 dots for borders
+ this->draw_pixel_at(center_x - dxmax, center_y + dymax, color);
+ this->draw_pixel_at(center_x + dxmax, center_y + dymax, color);
+ this->draw_pixel_at(center_x - dxmin, center_y + dymin, color);
+ this->draw_pixel_at(center_x + dxmin, center_y + dymin, color);
+ this->draw_pixel_at(center_x + dxmax, center_y - dymax, color);
+ this->draw_pixel_at(center_x - dxmax, center_y - dymax, color);
+ this->draw_pixel_at(center_x + dxmin, center_y - dymin, color);
+ this->draw_pixel_at(center_x - dxmin, center_y - dymin, color);
+ if (dymin < rmin) {
+ // two parts - four lines
+ int hline_width = -(dxmax - dxmin) + 1;
+ this->horizontal_line(center_x + dxmax, center_y + dymax, hline_width, color);
+ this->horizontal_line(center_x - dxmin, center_y + dymax, hline_width, color);
+ this->horizontal_line(center_x + dxmax, center_y - dymax, hline_width, color);
+ this->horizontal_line(center_x - dxmin, center_y - dymax, hline_width, color);
+ } else {
+ // one part - top and bottom
+ int hline_width = 2 * (-dxmax) + 1;
+ this->horizontal_line(center_x + dxmax, center_y + dymax, hline_width, color);
+ this->horizontal_line(center_x + dxmax, center_y - dymax, hline_width, color);
+ }
+ e2max = errmax;
+ // tune external
+ if (e2max < dymax) {
+ errmax += ++dymax * 2 + 1;
+ if (-dxmax == dymax && e2max <= dxmax) {
+ e2max = 0;
+ }
+ }
+ if (e2max > dxmax) {
+ errmax += ++dxmax * 2 + 1;
+ }
+ // tune internal
+ while (dymin < dymax && dymin < rmin) {
+ e2min = errmin;
+ if (e2min < dymin) {
+ errmin += ++dymin * 2 + 1;
+ if (-dxmin == dymin && e2min <= dxmin) {
+ e2min = 0;
+ }
+ }
+ if (e2min > dxmin) {
+ errmin += ++dxmin * 2 + 1;
+ }
+ }
+ } while (dxmax <= 0);
+}
+void Display::filled_gauge(int center_x, int center_y, int radius1, int radius2, int progress, Color color) {
+ int rmax = radius1 > radius2 ? radius1 : radius2;
+ int rmin = radius1 < radius2 ? radius1 : radius2;
+ int dxmax = -int32_t(rmax), dxmin = -int32_t(rmin), upd_dxmax, upd_dxmin;
+ int dymax = 0, dymin = 0;
+ int errmax = 2 - 2 * rmax, errmin = 2 - 2 * rmin;
+ int e2max, e2min;
+ progress = std::max(0, std::min(progress, 100)); // 0..100
+ int draw_progress = progress > 50 ? (100 - progress) : progress;
+ float tan_a = (progress == 50) ? 65535 : tan(float(draw_progress) * M_PI / 100); // slope
+
+ do {
+ // outer dots
+ this->draw_pixel_at(center_x + dxmax, center_y - dymax, color);
+ this->draw_pixel_at(center_x - dxmax, center_y - dymax, color);
+ if (dymin < rmin) { // side parts
+ int lhline_width = -(dxmax - dxmin) + 1;
+ if (progress >= 50) {
+ if (float(dymax) < float(-dxmax) * tan_a) {
+ upd_dxmax = ceil(float(dymax) / tan_a);
+ } else {
+ upd_dxmax = -dxmax;
+ }
+ this->horizontal_line(center_x + dxmax, center_y - dymax, lhline_width, color); // left
+ if (!dymax)
+ this->horizontal_line(center_x - dxmin, center_y, lhline_width, color); // right horizontal border
+ if (upd_dxmax > -dxmin) { // right
+ int rhline_width = (upd_dxmax + dxmin) + 1;
+ this->horizontal_line(center_x - dxmin, center_y - dymax,
+ rhline_width > lhline_width ? lhline_width : rhline_width, color);
+ }
+ } else {
+ if (float(dymin) > float(-dxmin) * tan_a) {
+ upd_dxmin = ceil(float(dymin) / tan_a);
+ } else {
+ upd_dxmin = -dxmin;
+ }
+ lhline_width = -(dxmax + upd_dxmin) + 1;
+ if (!dymax)
+ this->horizontal_line(center_x - dxmin, center_y, lhline_width, color); // right horizontal border
+ if (lhline_width > 0)
+ this->horizontal_line(center_x + dxmax, center_y - dymax, lhline_width, color);
+ }
+ } else { // top part
+ int hline_width = 2 * (-dxmax) + 1;
+ if (progress >= 50) {
+ if (dymax < float(-dxmax) * tan_a) {
+ upd_dxmax = ceil(float(dymax) / tan_a);
+ hline_width = -dxmax + upd_dxmax + 1;
+ }
+ } else {
+ if (dymax < float(-dxmax) * tan_a) {
+ upd_dxmax = ceil(float(dymax) / tan_a);
+ hline_width = -dxmax - upd_dxmax + 1;
+ } else
+ hline_width = 0;
+ }
+ if (hline_width > 0)
+ this->horizontal_line(center_x + dxmax, center_y - dymax, hline_width, color);
+ }
+ e2max = errmax;
+ if (e2max < dymax) {
+ errmax += ++dymax * 2 + 1;
+ if (-dxmax == dymax && e2max <= dxmax) {
+ e2max = 0;
+ }
+ }
+ if (e2max > dxmax) {
+ errmax += ++dxmax * 2 + 1;
+ }
+ while (dymin <= dymax && dymin <= rmin && dxmin <= 0) {
+ this->draw_pixel_at(center_x + dxmin, center_y - dymin, color);
+ this->draw_pixel_at(center_x - dxmin, center_y - dymin, color);
+ e2min = errmin;
+ if (e2min < dymin) {
+ errmin += ++dymin * 2 + 1;
+ if (-dxmin == dymin && e2min <= dxmin) {
+ e2min = 0;
+ }
+ }
+ if (e2min > dxmin) {
+ errmin += ++dxmin * 2 + 1;
+ }
+ }
+ } while (dxmax <= 0);
+}
void HOT Display::triangle(int x1, int y1, int x2, int y2, int x3, int y3, Color color) {
this->line(x1, y1, x2, y2, color);
this->line(x1, y1, x3, y3, color);
diff --git a/esphome/components/display/display.h b/esphome/components/display/display.h
index 34feafea6e..54e897cdec 100644
--- a/esphome/components/display/display.h
+++ b/esphome/components/display/display.h
@@ -285,6 +285,13 @@ class Display : public PollingComponent {
/// Fill a circle centered around [center_x,center_y] with the radius radius with the given color.
void filled_circle(int center_x, int center_y, int radius, Color color = COLOR_ON);
+ /// Fill a ring centered around [center_x,center_y] between two circles with the radius1 and radius2 with the given
+ /// color.
+ void filled_ring(int center_x, int center_y, int radius1, int radius2, Color color = COLOR_ON);
+ /// Fill a half-ring "gauge" centered around [center_x,center_y] between two circles with the radius1 and radius2
+ /// with he given color and filled up to 'progress' percent
+ void filled_gauge(int center_x, int center_y, int radius1, int radius2, int progress, Color color = COLOR_ON);
+
/// Draw the outline of a triangle contained between the points [x1,y1], [x2,y2] and [x3,y3] with the given color.
void triangle(int x1, int y1, int x2, int y2, int x3, int y3, Color color = COLOR_ON);
diff --git a/esphome/components/esp32/__init__.py b/esphome/components/esp32/__init__.py
index 8a73f2020d..61fbb53e3a 100644
--- a/esphome/components/esp32/__init__.py
+++ b/esphome/components/esp32/__init__.py
@@ -395,6 +395,13 @@ ARDUINO_FRAMEWORK_SCHEMA = cv.All(
cv.Optional(CONF_VERSION, default="recommended"): cv.string_strict,
cv.Optional(CONF_SOURCE): cv.string_strict,
cv.Optional(CONF_PLATFORM_VERSION): _parse_platform_version,
+ cv.Optional(CONF_ADVANCED, default={}): cv.Schema(
+ {
+ cv.Optional(
+ CONF_IGNORE_EFUSE_CUSTOM_MAC, default=False
+ ): cv.boolean,
+ }
+ ),
}
),
_arduino_check_versions,
@@ -494,6 +501,9 @@ async def to_code(config):
conf = config[CONF_FRAMEWORK]
cg.add_platformio_option("platform", conf[CONF_PLATFORM_VERSION])
+ if CONF_ADVANCED in conf and conf[CONF_ADVANCED][CONF_IGNORE_EFUSE_CUSTOM_MAC]:
+ cg.add_define("USE_ESP32_IGNORE_EFUSE_CUSTOM_MAC")
+
add_extra_script(
"post",
"post_build.py",
@@ -540,8 +550,6 @@ async def to_code(config):
for name, value in conf[CONF_SDKCONFIG_OPTIONS].items():
add_idf_sdkconfig_option(name, RawSdkconfigValue(value))
- if conf[CONF_ADVANCED][CONF_IGNORE_EFUSE_CUSTOM_MAC]:
- cg.add_define("USE_ESP32_IGNORE_EFUSE_CUSTOM_MAC")
if conf[CONF_ADVANCED].get(CONF_IGNORE_EFUSE_MAC_CRC):
add_idf_sdkconfig_option("CONFIG_ESP_MAC_IGNORE_MAC_CRC_ERROR", True)
if (framework_ver.major, framework_ver.minor) >= (4, 4):
diff --git a/esphome/components/esp32/boards.py b/esphome/components/esp32/boards.py
index 60abcd447c..02744ecb6f 100644
--- a/esphome/components/esp32/boards.py
+++ b/esphome/components/esp32/boards.py
@@ -103,6 +103,173 @@ ESP32_BOARD_PINS = {
"LED": 13,
"LED_BUILTIN": 13,
},
+ "adafruit_feather_esp32s3": {
+ "BUTTON": 0,
+ "A0": 18,
+ "A1": 17,
+ "A2": 16,
+ "A3": 15,
+ "A4": 14,
+ "A5": 8,
+ "SCK": 36,
+ "MOSI": 35,
+ "MISO": 37,
+ "RX": 38,
+ "TX": 39,
+ "SCL": 4,
+ "SDA": 3,
+ "NEOPIXEL": 33,
+ "PIN_NEOPIXEL": 33,
+ "NEOPIXEL_POWER": 21,
+ "I2C_POWER": 7,
+ "LED": 13,
+ "LED_BUILTIN": 13,
+ },
+ "adafruit_feather_esp32s3_nopsram": {
+ "BUTTON": 0,
+ "A0": 18,
+ "A1": 17,
+ "A2": 16,
+ "A3": 15,
+ "A4": 14,
+ "A5": 8,
+ "SCK": 36,
+ "MOSI": 35,
+ "MISO": 37,
+ "RX": 38,
+ "TX": 39,
+ "SCL": 4,
+ "SDA": 3,
+ "NEOPIXEL": 33,
+ "PIN_NEOPIXEL": 33,
+ "NEOPIXEL_POWER": 21,
+ "I2C_POWER": 7,
+ "LED": 13,
+ "LED_BUILTIN": 13,
+ },
+ "adafruit_feather_esp32s3_tft": {
+ "BUTTON": 0,
+ "A0": 18,
+ "A1": 17,
+ "A2": 16,
+ "A3": 15,
+ "A4": 14,
+ "A5": 8,
+ "SCK": 36,
+ "MOSI": 35,
+ "MISO": 37,
+ "RX": 2,
+ "TX": 1,
+ "SCL": 41,
+ "SDA": 42,
+ "NEOPIXEL": 33,
+ "PIN_NEOPIXEL": 33,
+ "NEOPIXEL_POWER": 34,
+ "TFT_I2C_POWER": 21,
+ "TFT_CS": 7,
+ "TFT_DC": 39,
+ "TFT_RESET": 40,
+ "TFT_BACKLIGHT": 45,
+ "LED": 13,
+ "LED_BUILTIN": 13,
+ },
+ "adafruit_funhouse_esp32s2": {
+ "BUTTON_UP": 5,
+ "BUTTON_DOWN": 3,
+ "BUTTON_SELECT": 4,
+ "DOTSTAR_DATA": 14,
+ "DOTSTAR_CLOCK": 15,
+ "PIR_SENSE": 16,
+ "A0": 17,
+ "A1": 2,
+ "A2": 1,
+ "CAP6": 6,
+ "CAP7": 7,
+ "CAP8": 8,
+ "CAP9": 9,
+ "CAP10": 10,
+ "CAP11": 11,
+ "CAP12": 12,
+ "CAP13": 13,
+ "SPEAKER": 42,
+ "LED": 37,
+ "LIGHT": 18,
+ "TFT_MOSI": 35,
+ "TFT_SCK": 36,
+ "TFT_CS": 40,
+ "TFT_DC": 39,
+ "TFT_RESET": 41,
+ "TFT_BACKLIGHT": 21,
+ "RED_LED": 31,
+ "BUTTON": 0,
+ },
+ "adafruit_itsybitsy_esp32": {
+ "A0": 25,
+ "A1": 26,
+ "A2": 4,
+ "A3": 38,
+ "A4": 37,
+ "A5": 36,
+ "SCK": 19,
+ "MOSI": 21,
+ "MISO": 22,
+ "SCL": 27,
+ "SDA": 15,
+ "TX": 20,
+ "RX": 8,
+ "NEOPIXEL": 0,
+ "PIN_NEOPIXEL": 0,
+ "NEOPIXEL_POWER": 2,
+ "BUTTON": 35,
+ },
+ "adafruit_magtag29_esp32s2": {
+ "A1": 18,
+ "BUTTON_A": 15,
+ "BUTTON_B": 14,
+ "BUTTON_C": 12,
+ "BUTTON_D": 11,
+ "SDA": 33,
+ "SCL": 34,
+ "SPEAKER": 17,
+ "SPEAKER_ENABLE": 16,
+ "VOLTAGE_MONITOR": 4,
+ "ACCELEROMETER_INT": 9,
+ "ACCELEROMETER_INTERRUPT": 9,
+ "LIGHT": 3,
+ "NEOPIXEL": 1,
+ "PIN_NEOPIXEL": 1,
+ "NEOPIXEL_POWER": 21,
+ "EPD_BUSY": 5,
+ "EPD_RESET": 6,
+ "EPD_DC": 7,
+ "EPD_CS": 8,
+ "EPD_MOSI": 35,
+ "EPD_SCK": 36,
+ "EPD_MISO": 37,
+ "BUTTON": 0,
+ "LED": 13,
+ "LED_BUILTIN": 13,
+ },
+ "adafruit_metro_esp32s2": {
+ "A0": 17,
+ "A1": 18,
+ "A2": 1,
+ "A3": 2,
+ "A4": 3,
+ "A5": 4,
+ "RX": 38,
+ "TX": 37,
+ "SCL": 34,
+ "SDA": 33,
+ "MISO": 37,
+ "SCK": 36,
+ "MOSI": 35,
+ "NEOPIXEL": 45,
+ "PIN_NEOPIXEL": 45,
+ "LED": 42,
+ "LED_BUILTIN": 42,
+ "BUTTON": 0,
+ },
"adafruit_qtpy_esp32c3": {
"A0": 4,
"A1": 3,
@@ -141,6 +308,26 @@ ESP32_BOARD_PINS = {
"BUTTON": 0,
"SWITCH": 0,
},
+ "adafruit_qtpy_esp32s3_nopsram": {
+ "A0": 18,
+ "A1": 17,
+ "A2": 9,
+ "A3": 8,
+ "SDA": 7,
+ "SCL": 6,
+ "MOSI": 35,
+ "MISO": 37,
+ "SCK": 36,
+ "RX": 16,
+ "TX": 5,
+ "SDA1": 41,
+ "SCL1": 40,
+ "NEOPIXEL": 39,
+ "PIN_NEOPIXEL": 39,
+ "NEOPIXEL_POWER": 38,
+ "BUTTON": 0,
+ "SWITCH": 0,
+ },
"adafruit_qtpy_esp32": {
"A0": 26,
"A1": 25,
@@ -1068,7 +1255,18 @@ ESP32_BOARD_PINS = {
"_VBAT": 35,
},
"wemosbat": {"LED": 16},
- "wesp32": {"MISO": 32, "SCL": 4, "SDA": 15},
+ "wesp32": {
+ "MISO": 32,
+ "MOSI": 23,
+ "SCK": 18,
+ "SCL": 4,
+ "SDA": 15,
+ "MISO1": 12,
+ "MOSI1": 13,
+ "SCK1": 14,
+ "SCL1": 5,
+ "SDA1": 33,
+ },
"widora-air": {
"A1": 39,
"A2": 35,
diff --git a/esphome/components/esp32_ble/const_esp32c6.h b/esphome/components/esp32_ble/const_esp32c6.h
index 69f9adcf6b..89179d8dd9 100644
--- a/esphome/components/esp32_ble/const_esp32c6.h
+++ b/esphome/components/esp32_ble/const_esp32c6.h
@@ -40,6 +40,9 @@ static const esp_bt_controller_config_t BT_CONTROLLER_CONFIG = {
.controller_run_cpu = 0,
.enable_qa_test = RUN_QA_TEST,
.enable_bqb_test = RUN_BQB_TEST,
+#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 3, 1)
+ // The following fields have been removed since ESP IDF version 5.3.1, see commit:
+ // https://github.com/espressif/esp-idf/commit/e761c1de8f9c0777829d597b4d5a33bb070a30a8
.enable_uart_hci = HCI_UART_EN,
.ble_hci_uart_port = DEFAULT_BT_LE_HCI_UART_PORT,
.ble_hci_uart_baud = DEFAULT_BT_LE_HCI_UART_BAUD,
@@ -47,6 +50,7 @@ static const esp_bt_controller_config_t BT_CONTROLLER_CONFIG = {
.ble_hci_uart_stop_bits = DEFAULT_BT_LE_HCI_UART_STOP_BITS,
.ble_hci_uart_flow_ctrl = DEFAULT_BT_LE_HCI_UART_FLOW_CTRL,
.ble_hci_uart_uart_parity = DEFAULT_BT_LE_HCI_UART_PARITY,
+#endif
.enable_tx_cca = DEFAULT_BT_LE_TX_CCA_ENABLED,
.cca_rssi_thresh = 256 - DEFAULT_BT_LE_CCA_RSSI_THRESH,
.sleep_en = NIMBLE_SLEEP_ENABLE,
@@ -58,6 +62,9 @@ static const esp_bt_controller_config_t BT_CONTROLLER_CONFIG = {
.cpu_freq_mhz = CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ,
.ignore_wl_for_direct_adv = 0,
.enable_pcl = DEFAULT_BT_LE_POWER_CONTROL_ENABLED,
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 1, 3)
+ .csa2_select = DEFAULT_BT_LE_50_FEATURE_SUPPORT,
+#endif
.config_magic = CONFIG_MAGIC,
};
diff --git a/esphome/components/esp32_rmt_led_strip/led_strip.cpp b/esphome/components/esp32_rmt_led_strip/led_strip.cpp
index 71ab099de5..c2209f7a6c 100644
--- a/esphome/components/esp32_rmt_led_strip/led_strip.cpp
+++ b/esphome/components/esp32_rmt_led_strip/led_strip.cpp
@@ -22,7 +22,7 @@ void ESP32RMTLEDStripLightOutput::setup() {
size_t buffer_size = this->get_buffer_size_();
- ExternalRAMAllocator allocator(ExternalRAMAllocator::ALLOW_FAILURE);
+ RAMAllocator allocator(this->use_psram_ ? 0 : RAMAllocator::ALLOC_INTERNAL);
this->buf_ = allocator.allocate(buffer_size);
if (this->buf_ == nullptr) {
ESP_LOGE(TAG, "Cannot allocate LED buffer!");
@@ -37,7 +37,7 @@ void ESP32RMTLEDStripLightOutput::setup() {
return;
}
- ExternalRAMAllocator rmt_allocator(ExternalRAMAllocator::ALLOW_FAILURE);
+ RAMAllocator rmt_allocator(this->use_psram_ ? 0 : RAMAllocator::ALLOC_INTERNAL);
this->rmt_buf_ = rmt_allocator.allocate(buffer_size * 8 +
1); // 8 bits per byte, 1 rmt_item32_t per bit + 1 rmt_item32_t for reset
diff --git a/esphome/components/esp32_rmt_led_strip/led_strip.h b/esphome/components/esp32_rmt_led_strip/led_strip.h
index 43215cf12b..d21bd86e75 100644
--- a/esphome/components/esp32_rmt_led_strip/led_strip.h
+++ b/esphome/components/esp32_rmt_led_strip/led_strip.h
@@ -45,6 +45,7 @@ class ESP32RMTLEDStripLightOutput : public light::AddressableLight {
void set_num_leds(uint16_t num_leds) { this->num_leds_ = num_leds; }
void set_is_rgbw(bool is_rgbw) { this->is_rgbw_ = is_rgbw; }
void set_is_wrgb(bool is_wrgb) { this->is_wrgb_ = is_wrgb; }
+ void set_use_psram(bool use_psram) { this->use_psram_ = use_psram; }
/// Set a maximum refresh rate in µs as some lights do not like being updated too often.
void set_max_refresh_rate(uint32_t interval_us) { this->max_refresh_rate_ = interval_us; }
@@ -75,6 +76,7 @@ class ESP32RMTLEDStripLightOutput : public light::AddressableLight {
uint16_t num_leds_;
bool is_rgbw_;
bool is_wrgb_;
+ bool use_psram_;
rmt_item32_t bit0_, bit1_, reset_;
RGBOrder rgb_order_;
diff --git a/esphome/components/esp32_rmt_led_strip/light.py b/esphome/components/esp32_rmt_led_strip/light.py
index 1e3c2d4f72..79f339e248 100644
--- a/esphome/components/esp32_rmt_led_strip/light.py
+++ b/esphome/components/esp32_rmt_led_strip/light.py
@@ -55,7 +55,7 @@ CHIPSETS = {
"SM16703": LEDStripTimings(300, 900, 900, 300, 0, 0),
}
-
+CONF_USE_PSRAM = "use_psram"
CONF_IS_WRGB = "is_wrgb"
CONF_BIT0_HIGH = "bit0_high"
CONF_BIT0_LOW = "bit0_low"
@@ -77,6 +77,7 @@ CONFIG_SCHEMA = cv.All(
cv.Optional(CONF_CHIPSET): cv.one_of(*CHIPSETS, upper=True),
cv.Optional(CONF_IS_RGBW, default=False): cv.boolean,
cv.Optional(CONF_IS_WRGB, default=False): cv.boolean,
+ cv.Optional(CONF_USE_PSRAM, default=True): cv.boolean,
cv.Inclusive(
CONF_BIT0_HIGH,
"custom",
@@ -145,6 +146,7 @@ async def to_code(config):
cg.add(var.set_rgb_order(config[CONF_RGB_ORDER]))
cg.add(var.set_is_rgbw(config[CONF_IS_RGBW]))
cg.add(var.set_is_wrgb(config[CONF_IS_WRGB]))
+ cg.add(var.set_use_psram(config[CONF_USE_PSRAM]))
cg.add(
var.set_rmt_channel(
diff --git a/esphome/components/event/__init__.py b/esphome/components/event/__init__.py
index 9deee8f90b..4adcc0672e 100644
--- a/esphome/components/event/__init__.py
+++ b/esphome/components/event/__init__.py
@@ -1,6 +1,6 @@
from esphome import automation
import esphome.codegen as cg
-from esphome.components import mqtt
+from esphome.components import mqtt, web_server
import esphome.config_validation as cv
from esphome.const import (
CONF_DEVICE_CLASS,
@@ -11,6 +11,7 @@ from esphome.const import (
CONF_MQTT_ID,
CONF_ON_EVENT,
CONF_TRIGGER_ID,
+ CONF_WEB_SERVER,
DEVICE_CLASS_BUTTON,
DEVICE_CLASS_DOORBELL,
DEVICE_CLASS_EMPTY,
@@ -40,17 +41,21 @@ EventTrigger = event_ns.class_("EventTrigger", automation.Trigger.template())
validate_device_class = cv.one_of(*DEVICE_CLASSES, lower=True, space="_")
-EVENT_SCHEMA = cv.ENTITY_BASE_SCHEMA.extend(cv.MQTT_COMPONENT_SCHEMA).extend(
- {
- cv.OnlyWith(CONF_MQTT_ID, "mqtt"): cv.declare_id(mqtt.MQTTEventComponent),
- cv.GenerateID(): cv.declare_id(Event),
- cv.Optional(CONF_DEVICE_CLASS): validate_device_class,
- cv.Optional(CONF_ON_EVENT): automation.validate_automation(
- {
- cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(EventTrigger),
- }
- ),
- }
+EVENT_SCHEMA = (
+ cv.ENTITY_BASE_SCHEMA.extend(web_server.WEBSERVER_SORTING_SCHEMA)
+ .extend(cv.MQTT_COMPONENT_SCHEMA)
+ .extend(
+ {
+ cv.OnlyWith(CONF_MQTT_ID, "mqtt"): cv.declare_id(mqtt.MQTTEventComponent),
+ cv.GenerateID(): cv.declare_id(Event),
+ cv.Optional(CONF_DEVICE_CLASS): validate_device_class,
+ cv.Optional(CONF_ON_EVENT): automation.validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(EventTrigger),
+ }
+ ),
+ }
+ )
)
_UNDEF = object()
@@ -97,6 +102,9 @@ async def setup_event_core_(var, config, *, event_types: list[str]):
mqtt_ = cg.new_Pvariable(mqtt_id, var)
await mqtt.register_mqtt_component(mqtt_, config)
+ if web_server_config := config.get(CONF_WEB_SERVER):
+ await web_server.add_entity_config(var, web_server_config)
+
async def register_event(var, config, *, event_types: list[str]):
if not CORE.has_id(config[CONF_ID]):
diff --git a/esphome/components/font/__init__.py b/esphome/components/font/__init__.py
index b5ed02e89a..dacd0779b1 100644
--- a/esphome/components/font/__init__.py
+++ b/esphome/components/font/__init__.py
@@ -98,13 +98,13 @@ def validate_pillow_installed(value):
except ImportError as err:
raise cv.Invalid(
"Please install the pillow python package to use this feature. "
- '(pip install "pillow==10.2.0")'
+ '(pip install "pillow==10.4.0")'
) from err
- if version.parse(PIL.__version__) != version.parse("10.2.0"):
+ if version.parse(PIL.__version__) != version.parse("10.4.0"):
raise cv.Invalid(
- "Please update your pillow installation to 10.2.0. "
- '(pip install "pillow==10.2.0")'
+ "Please update your pillow installation to 10.4.0. "
+ '(pip install "pillow==10.4.0")'
)
return value
diff --git a/esphome/components/host/__init__.py b/esphome/components/host/__init__.py
index e83bf2dba8..eb8cfbd984 100644
--- a/esphome/components/host/__init__.py
+++ b/esphome/components/host/__init__.py
@@ -16,7 +16,7 @@ from .const import KEY_HOST
from .gpio import host_pin_to_code # noqa
CODEOWNERS = ["@esphome/core", "@clydebarrow"]
-AUTO_LOAD = ["network"]
+AUTO_LOAD = ["network", "preferences"]
def set_core_data(config):
diff --git a/esphome/components/i2c_device/__init__.py b/esphome/components/i2c_device/__init__.py
new file mode 100644
index 0000000000..e145ba56f8
--- /dev/null
+++ b/esphome/components/i2c_device/__init__.py
@@ -0,0 +1,26 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import i2c
+from esphome.const import CONF_ID
+
+DEPENDENCIES = ["i2c"]
+CODEOWNERS = ["@gabest11"]
+MULTI_CONF = True
+
+i2c_device_ns = cg.esphome_ns.namespace("i2c_device")
+
+I2CDeviceComponent = i2c_device_ns.class_(
+ "I2CDeviceComponent", cg.Component, i2c.I2CDevice
+)
+
+CONFIG_SCHEMA = cv.Schema(
+ {
+ cv.GenerateID(CONF_ID): cv.declare_id(I2CDeviceComponent),
+ }
+).extend(i2c.i2c_device_schema(None))
+
+
+async def to_code(config):
+ var = cg.new_Pvariable(config[CONF_ID])
+ await cg.register_component(var, config)
+ await i2c.register_i2c_device(var, config)
diff --git a/esphome/components/i2c_device/i2c_device.cpp b/esphome/components/i2c_device/i2c_device.cpp
new file mode 100644
index 0000000000..455c68fbed
--- /dev/null
+++ b/esphome/components/i2c_device/i2c_device.cpp
@@ -0,0 +1,17 @@
+#include "i2c_device.h"
+#include "esphome/core/log.h"
+#include "esphome/core/hal.h"
+#include
+
+namespace esphome {
+namespace i2c_device {
+
+static const char *const TAG = "i2c_device";
+
+void I2CDeviceComponent::dump_config() {
+ ESP_LOGCONFIG(TAG, "I2CDevice");
+ LOG_I2C_DEVICE(this);
+}
+
+} // namespace i2c_device
+} // namespace esphome
diff --git a/esphome/components/i2c_device/i2c_device.h b/esphome/components/i2c_device/i2c_device.h
new file mode 100644
index 0000000000..ab118e3e89
--- /dev/null
+++ b/esphome/components/i2c_device/i2c_device.h
@@ -0,0 +1,18 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/components/i2c/i2c.h"
+
+namespace esphome {
+namespace i2c_device {
+
+class I2CDeviceComponent : public Component, public i2c::I2CDevice {
+ public:
+ void dump_config() override;
+ float get_setup_priority() const override { return setup_priority::DATA; }
+
+ protected:
+};
+
+} // namespace i2c_device
+} // namespace esphome
diff --git a/esphome/components/i2s_audio/speaker/__init__.py b/esphome/components/i2s_audio/speaker/__init__.py
index bba886b39b..dd43d6cb39 100644
--- a/esphome/components/i2s_audio/speaker/__init__.py
+++ b/esphome/components/i2s_audio/speaker/__init__.py
@@ -16,7 +16,8 @@ from .. import (
register_i2s_audio_component,
)
-CODEOWNERS = ["@jesserockz"]
+AUTO_LOAD = ["audio"]
+CODEOWNERS = ["@jesserockz", "@kahrendt"]
DEPENDENCIES = ["i2s_audio"]
I2SAudioSpeaker = i2s_audio_ns.class_(
@@ -72,7 +73,7 @@ BASE_SCHEMA = (
.extend(
{
cv.Optional(
- CONF_TIMEOUT, default="100ms"
+ CONF_TIMEOUT, default="500ms"
): cv.positive_time_period_milliseconds,
}
)
diff --git a/esphome/components/i2s_audio/speaker/i2s_audio_speaker.cpp b/esphome/components/i2s_audio/speaker/i2s_audio_speaker.cpp
index 97c1d86c36..cf6c3bbbba 100644
--- a/esphome/components/i2s_audio/speaker/i2s_audio_speaker.cpp
+++ b/esphome/components/i2s_audio/speaker/i2s_audio_speaker.cpp
@@ -4,6 +4,8 @@
#include
+#include "esphome/components/audio/audio.h"
+
#include "esphome/core/application.h"
#include "esphome/core/hal.h"
#include "esphome/core/log.h"
@@ -11,186 +13,342 @@
namespace esphome {
namespace i2s_audio {
-static const size_t BUFFER_COUNT = 20;
+static const size_t DMA_BUFFER_SIZE = 512;
+static const size_t DMA_BUFFERS_COUNT = 4;
+static const size_t FRAMES_IN_ALL_DMA_BUFFERS = DMA_BUFFER_SIZE * DMA_BUFFERS_COUNT;
+static const size_t RING_BUFFER_SAMPLES = 8192;
+static const size_t TASK_DELAY_MS = 10;
+static const size_t TASK_STACK_SIZE = 4096;
+static const ssize_t TASK_PRIORITY = 23;
static const char *const TAG = "i2s_audio.speaker";
+enum SpeakerEventGroupBits : uint32_t {
+ COMMAND_START = (1 << 0), // Starts the main task purpose
+ COMMAND_STOP = (1 << 1), // stops the main task
+ COMMAND_STOP_GRACEFULLY = (1 << 2), // Stops the task once all data has been written
+ MESSAGE_RING_BUFFER_AVAILABLE_TO_WRITE = (1 << 5), // Locks the ring buffer when not set
+ STATE_STARTING = (1 << 10),
+ STATE_RUNNING = (1 << 11),
+ STATE_STOPPING = (1 << 12),
+ STATE_STOPPED = (1 << 13),
+ ERR_INVALID_FORMAT = (1 << 14),
+ ERR_TASK_FAILED_TO_START = (1 << 15),
+ ERR_ESP_INVALID_STATE = (1 << 16),
+ ERR_ESP_INVALID_ARG = (1 << 17),
+ ERR_ESP_INVALID_SIZE = (1 << 18),
+ ERR_ESP_NO_MEM = (1 << 19),
+ ERR_ESP_FAIL = (1 << 20),
+ ALL_ERR_ESP_BITS = ERR_ESP_INVALID_STATE | ERR_ESP_INVALID_ARG | ERR_ESP_INVALID_SIZE | ERR_ESP_NO_MEM | ERR_ESP_FAIL,
+ ALL_BITS = 0x00FFFFFF, // All valid FreeRTOS event group bits
+};
+
+// Translates a SpeakerEventGroupBits ERR_ESP bit to the coressponding esp_err_t
+static esp_err_t err_bit_to_esp_err(uint32_t bit) {
+ switch (bit) {
+ case SpeakerEventGroupBits::ERR_ESP_INVALID_STATE:
+ return ESP_ERR_INVALID_STATE;
+ case SpeakerEventGroupBits::ERR_ESP_INVALID_ARG:
+ return ESP_ERR_INVALID_ARG;
+ case SpeakerEventGroupBits::ERR_ESP_INVALID_SIZE:
+ return ESP_ERR_INVALID_SIZE;
+ case SpeakerEventGroupBits::ERR_ESP_NO_MEM:
+ return ESP_ERR_NO_MEM;
+ default:
+ return ESP_FAIL;
+ }
+}
+
+/// @brief Multiplies the input array of Q15 numbers by a Q15 constant factor
+///
+/// Based on `dsps_mulc_s16_ansi` from the esp-dsp library:
+/// https://github.com/espressif/esp-dsp/blob/master/modules/math/mulc/fixed/dsps_mulc_s16_ansi.c
+/// (accessed on 2024-09-30).
+/// @param input Array of Q15 numbers
+/// @param output Array of Q15 numbers
+/// @param len Length of array
+/// @param c Q15 constant factor
+static void q15_multiplication(const int16_t *input, int16_t *output, size_t len, int16_t c) {
+ for (int i = 0; i < len; i++) {
+ int32_t acc = (int32_t) input[i] * (int32_t) c;
+ output[i] = (int16_t) (acc >> 15);
+ }
+}
+
+// Lists the Q15 fixed point scaling factor for volume reduction.
+// Has 100 values representing silence and a reduction [49, 48.5, ... 0.5, 0] dB.
+// dB to PCM scaling factor formula: floating_point_scale_factor = 2^(-db/6.014)
+// float to Q15 fixed point formula: q15_scale_factor = floating_point_scale_factor * 2^(15)
+static const std::vector Q15_VOLUME_SCALING_FACTORS = {
+ 0, 116, 122, 130, 137, 146, 154, 163, 173, 183, 194, 206, 218, 231, 244,
+ 259, 274, 291, 308, 326, 345, 366, 388, 411, 435, 461, 488, 517, 548, 580,
+ 615, 651, 690, 731, 774, 820, 868, 920, 974, 1032, 1094, 1158, 1227, 1300, 1377,
+ 1459, 1545, 1637, 1734, 1837, 1946, 2061, 2184, 2313, 2450, 2596, 2750, 2913, 3085, 3269,
+ 3462, 3668, 3885, 4116, 4360, 4619, 4893, 5183, 5490, 5816, 6161, 6527, 6914, 7324, 7758,
+ 8218, 8706, 9222, 9770, 10349, 10963, 11613, 12302, 13032, 13805, 14624, 15491, 16410, 17384, 18415,
+ 19508, 20665, 21891, 23189, 24565, 26022, 27566, 29201, 30933, 32767};
+
void I2SAudioSpeaker::setup() {
ESP_LOGCONFIG(TAG, "Setting up I2S Audio Speaker...");
- this->buffer_queue_ = xQueueCreate(BUFFER_COUNT, sizeof(DataEvent));
- if (this->buffer_queue_ == nullptr) {
- ESP_LOGE(TAG, "Failed to create buffer queue");
- this->mark_failed();
- return;
+ if (this->event_group_ == nullptr) {
+ this->event_group_ = xEventGroupCreate();
}
- this->event_queue_ = xQueueCreate(BUFFER_COUNT, sizeof(TaskEvent));
- if (this->event_queue_ == nullptr) {
- ESP_LOGE(TAG, "Failed to create event queue");
+ if (this->event_group_ == nullptr) {
+ ESP_LOGE(TAG, "Failed to create event group");
this->mark_failed();
return;
}
}
+void I2SAudioSpeaker::loop() {
+ uint32_t event_group_bits = xEventGroupGetBits(this->event_group_);
+
+ if (event_group_bits & SpeakerEventGroupBits::STATE_STARTING) {
+ ESP_LOGD(TAG, "Starting Speaker");
+ this->state_ = speaker::STATE_STARTING;
+ xEventGroupClearBits(this->event_group_, SpeakerEventGroupBits::STATE_STARTING);
+ }
+ if (event_group_bits & SpeakerEventGroupBits::STATE_RUNNING) {
+ ESP_LOGD(TAG, "Started Speaker");
+ this->state_ = speaker::STATE_RUNNING;
+ xEventGroupClearBits(this->event_group_, SpeakerEventGroupBits::STATE_RUNNING);
+ this->status_clear_warning();
+ this->status_clear_error();
+ }
+ if (event_group_bits & SpeakerEventGroupBits::STATE_STOPPING) {
+ ESP_LOGD(TAG, "Stopping Speaker");
+ this->state_ = speaker::STATE_STOPPING;
+ xEventGroupClearBits(this->event_group_, SpeakerEventGroupBits::STATE_STOPPING);
+ }
+ if (event_group_bits & SpeakerEventGroupBits::STATE_STOPPED) {
+ if (!this->task_created_) {
+ ESP_LOGD(TAG, "Stopped Speaker");
+ this->state_ = speaker::STATE_STOPPED;
+ xEventGroupClearBits(this->event_group_, SpeakerEventGroupBits::ALL_BITS);
+ this->speaker_task_handle_ = nullptr;
+ }
+ }
+
+ if (event_group_bits & SpeakerEventGroupBits::ERR_TASK_FAILED_TO_START) {
+ this->status_set_error("Failed to start speaker task");
+ xEventGroupClearBits(this->event_group_, SpeakerEventGroupBits::ERR_TASK_FAILED_TO_START);
+ }
+
+ if (event_group_bits & SpeakerEventGroupBits::ERR_INVALID_FORMAT) {
+ this->status_set_error("Failed to adjust I2S bus to match the incoming audio");
+ ESP_LOGE(TAG,
+ "Incompatible audio format: sample rate = %" PRIu32 ", channels = %" PRIu8 ", bits per sample = %" PRIu8,
+ this->audio_stream_info_.sample_rate, this->audio_stream_info_.channels,
+ this->audio_stream_info_.bits_per_sample);
+ }
+
+ if (event_group_bits & SpeakerEventGroupBits::ALL_ERR_ESP_BITS) {
+ uint32_t error_bits = event_group_bits & SpeakerEventGroupBits::ALL_ERR_ESP_BITS;
+ ESP_LOGW(TAG, "Error writing to I2S: %s", esp_err_to_name(err_bit_to_esp_err(error_bits)));
+ this->status_set_warning();
+ }
+}
+
+void I2SAudioSpeaker::set_volume(float volume) {
+ this->volume_ = volume;
+#ifdef USE_AUDIO_DAC
+ if (this->audio_dac_ != nullptr) {
+ if (volume > 0.0) {
+ this->audio_dac_->set_mute_off();
+ }
+ this->audio_dac_->set_volume(volume);
+ } else
+#endif
+ {
+ // Fallback to software volume control by using a Q15 fixed point scaling factor
+ ssize_t decibel_index = remap(volume, 0.0f, 1.0f, 0, Q15_VOLUME_SCALING_FACTORS.size() - 1);
+ this->q15_volume_factor_ = Q15_VOLUME_SCALING_FACTORS[decibel_index];
+ }
+}
+
+void I2SAudioSpeaker::set_mute_state(bool mute_state) {
+ this->mute_state_ = mute_state;
+#ifdef USE_AUDIO_DAC
+ if (this->audio_dac_) {
+ if (mute_state) {
+ this->audio_dac_->set_mute_on();
+ } else {
+ this->audio_dac_->set_mute_off();
+ }
+ } else
+#endif
+ {
+ if (mute_state) {
+ // Fallback to software volume control and scale by 0
+ this->q15_volume_factor_ = 0;
+ } else {
+ // Revert to previous volume when unmuting
+ this->set_volume(this->volume_);
+ }
+ }
+}
+
+size_t I2SAudioSpeaker::play(const uint8_t *data, size_t length, TickType_t ticks_to_wait) {
+ if (this->is_failed()) {
+ ESP_LOGE(TAG, "Cannot play audio, speaker failed to setup");
+ return 0;
+ }
+ if (this->state_ != speaker::STATE_RUNNING && this->state_ != speaker::STATE_STARTING) {
+ this->start();
+ }
+
+ // Wait for the ring buffer to be available
+ uint32_t event_bits =
+ xEventGroupWaitBits(this->event_group_, SpeakerEventGroupBits::MESSAGE_RING_BUFFER_AVAILABLE_TO_WRITE, pdFALSE,
+ pdFALSE, pdMS_TO_TICKS(TASK_DELAY_MS));
+
+ if (event_bits & SpeakerEventGroupBits::MESSAGE_RING_BUFFER_AVAILABLE_TO_WRITE) {
+ // Ring buffer is available to write
+
+ // Lock the ring buffer, write to it, then unlock it
+ xEventGroupClearBits(this->event_group_, SpeakerEventGroupBits::MESSAGE_RING_BUFFER_AVAILABLE_TO_WRITE);
+ size_t bytes_written = this->audio_ring_buffer_->write_without_replacement((void *) data, length, ticks_to_wait);
+ xEventGroupSetBits(this->event_group_, SpeakerEventGroupBits::MESSAGE_RING_BUFFER_AVAILABLE_TO_WRITE);
+
+ return bytes_written;
+ }
+
+ return 0;
+}
+
+bool I2SAudioSpeaker::has_buffered_data() const {
+ if (this->audio_ring_buffer_ != nullptr) {
+ return this->audio_ring_buffer_->available() > 0;
+ }
+ return false;
+}
+
+void I2SAudioSpeaker::speaker_task(void *params) {
+ I2SAudioSpeaker *this_speaker = (I2SAudioSpeaker *) params;
+ uint32_t event_group_bits =
+ xEventGroupWaitBits(this_speaker->event_group_,
+ SpeakerEventGroupBits::COMMAND_START | SpeakerEventGroupBits::COMMAND_STOP |
+ SpeakerEventGroupBits::COMMAND_STOP_GRACEFULLY, // Bit message to read
+ pdTRUE, // Clear the bits on exit
+ pdFALSE, // Don't wait for all the bits,
+ portMAX_DELAY); // Block indefinitely until a bit is set
+
+ if (event_group_bits & (SpeakerEventGroupBits::COMMAND_STOP | SpeakerEventGroupBits::COMMAND_STOP_GRACEFULLY)) {
+ // Received a stop signal before the task was requested to start
+ this_speaker->delete_task_(0);
+ }
+
+ xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::STATE_STARTING);
+
+ audio::AudioStreamInfo audio_stream_info = this_speaker->audio_stream_info_;
+ const ssize_t bytes_per_sample = audio_stream_info.get_bytes_per_sample();
+ const uint8_t number_of_channels = audio_stream_info.channels;
+
+ const size_t dma_buffers_size = FRAMES_IN_ALL_DMA_BUFFERS * bytes_per_sample * number_of_channels;
+
+ if (this_speaker->send_esp_err_to_event_group_(
+ this_speaker->allocate_buffers_(dma_buffers_size, RING_BUFFER_SAMPLES * bytes_per_sample))) {
+ // Failed to allocate buffers
+ xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::ERR_ESP_NO_MEM);
+ this_speaker->delete_task_(dma_buffers_size);
+ }
+
+ if (this_speaker->send_esp_err_to_event_group_(this_speaker->start_i2s_driver_())) {
+ // Failed to start I2S driver
+ this_speaker->delete_task_(dma_buffers_size);
+ } else {
+ // Ring buffer is allocated, so indicate its can be written to
+ xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::MESSAGE_RING_BUFFER_AVAILABLE_TO_WRITE);
+ }
+
+ if (!this_speaker->send_esp_err_to_event_group_(this_speaker->reconfigure_i2s_stream_info_(audio_stream_info))) {
+ // Successfully set the I2S stream info, ready to write audio data to the I2S port
+
+ xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::STATE_RUNNING);
+
+ bool stop_gracefully = false;
+ uint32_t last_data_received_time = millis();
+
+ while ((millis() - last_data_received_time) <= this_speaker->timeout_) {
+ event_group_bits = xEventGroupGetBits(this_speaker->event_group_);
+
+ if (event_group_bits & SpeakerEventGroupBits::COMMAND_STOP) {
+ break;
+ }
+ if (event_group_bits & SpeakerEventGroupBits::COMMAND_STOP_GRACEFULLY) {
+ stop_gracefully = true;
+ }
+
+ size_t bytes_to_read = dma_buffers_size;
+ size_t bytes_read = this_speaker->audio_ring_buffer_->read((void *) this_speaker->data_buffer_, bytes_to_read,
+ pdMS_TO_TICKS(TASK_DELAY_MS));
+
+ if (bytes_read > 0) {
+ last_data_received_time = millis();
+ size_t bytes_written = 0;
+
+ if ((audio_stream_info.bits_per_sample == 16) && (this_speaker->q15_volume_factor_ < INT16_MAX)) {
+ // Scale samples by the volume factor in place
+ q15_multiplication((int16_t *) this_speaker->data_buffer_, (int16_t *) this_speaker->data_buffer_,
+ bytes_read / sizeof(int16_t), this_speaker->q15_volume_factor_);
+ }
+
+ if (audio_stream_info.bits_per_sample == (uint8_t) this_speaker->bits_per_sample_) {
+ i2s_write(this_speaker->parent_->get_port(), this_speaker->data_buffer_, bytes_read, &bytes_written,
+ portMAX_DELAY);
+ } else if (audio_stream_info.bits_per_sample < (uint8_t) this_speaker->bits_per_sample_) {
+ i2s_write_expand(this_speaker->parent_->get_port(), this_speaker->data_buffer_, bytes_read,
+ audio_stream_info.bits_per_sample, this_speaker->bits_per_sample_, &bytes_written,
+ portMAX_DELAY);
+ }
+
+ if (bytes_written != bytes_read) {
+ xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::ERR_ESP_INVALID_SIZE);
+ }
+
+ } else {
+ // No data received
+
+ if (stop_gracefully) {
+ break;
+ }
+
+ i2s_zero_dma_buffer(this_speaker->parent_->get_port());
+ }
+ }
+ } else {
+ // Couldn't configure the I2S port to be compatible with the incoming audio
+ xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::ERR_INVALID_FORMAT);
+ }
+ i2s_zero_dma_buffer(this_speaker->parent_->get_port());
+
+ xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::STATE_STOPPING);
+
+ i2s_stop(this_speaker->parent_->get_port());
+ i2s_driver_uninstall(this_speaker->parent_->get_port());
+
+ this_speaker->parent_->unlock();
+ this_speaker->delete_task_(dma_buffers_size);
+}
+
void I2SAudioSpeaker::start() {
- if (this->is_failed()) {
- ESP_LOGE(TAG, "Cannot start audio, speaker failed to setup");
+ if (this->is_failed() || this->status_has_error())
return;
- }
- if (this->task_created_) {
- ESP_LOGW(TAG, "Called start while task has been already created.");
+ if ((this->state_ == speaker::STATE_STARTING) || (this->state_ == speaker::STATE_RUNNING))
return;
- }
- this->state_ = speaker::STATE_STARTING;
-}
-void I2SAudioSpeaker::start_() {
- if (this->task_created_) {
- return;
- }
- if (!this->parent_->try_lock()) {
- return; // Waiting for another i2s component to return lock
+
+ if (this->speaker_task_handle_ == nullptr) {
+ xTaskCreate(I2SAudioSpeaker::speaker_task, "speaker_task", TASK_STACK_SIZE, (void *) this, TASK_PRIORITY,
+ &this->speaker_task_handle_);
}
- xTaskCreate(I2SAudioSpeaker::player_task, "speaker_task", 8192, (void *) this, 1, &this->player_task_handle_);
- this->task_created_ = true;
-}
-
-template const uint8_t *convert_data_format(const a *from, b *to, size_t &bytes, bool repeat) {
- if (sizeof(a) == sizeof(b) && !repeat) {
- return reinterpret_cast(from);
- }
- const b *result = to;
- for (size_t i = 0; i < bytes; i += sizeof(a)) {
- b value = static_cast(*from++) << (sizeof(b) - sizeof(a)) * 8;
- *to++ = value;
- if (repeat)
- *to++ = value;
- }
- bytes *= (sizeof(b) / sizeof(a)) * (repeat ? 2 : 1); // NOLINT
- return reinterpret_cast(result);
-}
-
-void I2SAudioSpeaker::player_task(void *params) {
- I2SAudioSpeaker *this_speaker = (I2SAudioSpeaker *) params;
-
- TaskEvent event;
- event.type = TaskEventType::STARTING;
- xQueueSend(this_speaker->event_queue_, &event, portMAX_DELAY);
-
- i2s_driver_config_t config = {
- .mode = (i2s_mode_t) (this_speaker->i2s_mode_ | I2S_MODE_TX),
- .sample_rate = this_speaker->sample_rate_,
- .bits_per_sample = this_speaker->bits_per_sample_,
- .channel_format = this_speaker->channel_,
- .communication_format = this_speaker->i2s_comm_fmt_,
- .intr_alloc_flags = ESP_INTR_FLAG_LEVEL1,
- .dma_buf_count = 8,
- .dma_buf_len = 256,
- .use_apll = this_speaker->use_apll_,
- .tx_desc_auto_clear = true,
- .fixed_mclk = 0,
- .mclk_multiple = I2S_MCLK_MULTIPLE_256,
- .bits_per_chan = this_speaker->bits_per_channel_,
- };
-#if SOC_I2S_SUPPORTS_DAC
- if (this_speaker->internal_dac_mode_ != I2S_DAC_CHANNEL_DISABLE) {
- config.mode = (i2s_mode_t) (config.mode | I2S_MODE_DAC_BUILT_IN);
- }
-#endif
-
- esp_err_t err = i2s_driver_install(this_speaker->parent_->get_port(), &config, 0, nullptr);
- if (err != ESP_OK) {
- event.type = TaskEventType::WARNING;
- event.err = err;
- xQueueSend(this_speaker->event_queue_, &event, 0);
- event.type = TaskEventType::STOPPED;
- xQueueSend(this_speaker->event_queue_, &event, 0);
- while (true) {
- delay(10);
- }
- }
-
-#if SOC_I2S_SUPPORTS_DAC
- if (this_speaker->internal_dac_mode_ == I2S_DAC_CHANNEL_DISABLE) {
-#endif
- i2s_pin_config_t pin_config = this_speaker->parent_->get_pin_config();
- pin_config.data_out_num = this_speaker->dout_pin_;
-
- i2s_set_pin(this_speaker->parent_->get_port(), &pin_config);
-#if SOC_I2S_SUPPORTS_DAC
+ if (this->speaker_task_handle_ != nullptr) {
+ xEventGroupSetBits(this->event_group_, SpeakerEventGroupBits::COMMAND_START);
+ this->task_created_ = true;
} else {
- i2s_set_dac_mode(this_speaker->internal_dac_mode_);
- }
-#endif
-
- DataEvent data_event;
-
- event.type = TaskEventType::STARTED;
- xQueueSend(this_speaker->event_queue_, &event, portMAX_DELAY);
-
- int32_t buffer[BUFFER_SIZE];
-
- while (true) {
- if (xQueueReceive(this_speaker->buffer_queue_, &data_event, this_speaker->timeout_ / portTICK_PERIOD_MS) !=
- pdTRUE) {
- break; // End of audio from main thread
- }
- if (data_event.stop) {
- // Stop signal from main thread
- xQueueReset(this_speaker->buffer_queue_); // Flush queue
- break;
- }
-
- const uint8_t *data = data_event.data;
- size_t remaining = data_event.len;
- switch (this_speaker->bits_per_sample_) {
- case I2S_BITS_PER_SAMPLE_8BIT:
- case I2S_BITS_PER_SAMPLE_16BIT: {
- data = convert_data_format(reinterpret_cast(data), reinterpret_cast(buffer),
- remaining, this_speaker->channel_ == I2S_CHANNEL_FMT_ALL_LEFT);
- break;
- }
- case I2S_BITS_PER_SAMPLE_24BIT:
- case I2S_BITS_PER_SAMPLE_32BIT: {
- data = convert_data_format(reinterpret_cast(data), reinterpret_cast(buffer),
- remaining, this_speaker->channel_ == I2S_CHANNEL_FMT_ALL_LEFT);
- break;
- }
- }
-
- while (remaining != 0) {
- size_t bytes_written;
- esp_err_t err =
- i2s_write(this_speaker->parent_->get_port(), data, remaining, &bytes_written, (32 / portTICK_PERIOD_MS));
- if (err != ESP_OK) {
- event = {.type = TaskEventType::WARNING, .err = err};
- if (xQueueSend(this_speaker->event_queue_, &event, 10 / portTICK_PERIOD_MS) != pdTRUE) {
- ESP_LOGW(TAG, "Failed to send WARNING event");
- }
- continue;
- }
- data += bytes_written;
- remaining -= bytes_written;
- }
- }
-
- event.type = TaskEventType::STOPPING;
- if (xQueueSend(this_speaker->event_queue_, &event, 10 / portTICK_PERIOD_MS) != pdTRUE) {
- ESP_LOGW(TAG, "Failed to send STOPPING event");
- }
-
- i2s_zero_dma_buffer(this_speaker->parent_->get_port());
-
- i2s_driver_uninstall(this_speaker->parent_->get_port());
-
- event.type = TaskEventType::STOPPED;
- if (xQueueSend(this_speaker->event_queue_, &event, 10 / portTICK_PERIOD_MS) != pdTRUE) {
- ESP_LOGW(TAG, "Failed to send STOPPED event");
- }
-
- while (true) {
- delay(10);
+ xEventGroupSetBits(this->event_group_, SpeakerEventGroupBits::ERR_TASK_FAILED_TO_START);
}
}
@@ -203,92 +361,169 @@ void I2SAudioSpeaker::stop_(bool wait_on_empty) {
return;
if (this->state_ == speaker::STATE_STOPPED)
return;
- if (this->state_ == speaker::STATE_STARTING) {
- this->state_ = speaker::STATE_STOPPED;
- return;
- }
- this->state_ = speaker::STATE_STOPPING;
- DataEvent data;
- data.stop = true;
+
if (wait_on_empty) {
- xQueueSend(this->buffer_queue_, &data, portMAX_DELAY);
+ xEventGroupSetBits(this->event_group_, SpeakerEventGroupBits::COMMAND_STOP_GRACEFULLY);
} else {
- xQueueSendToFront(this->buffer_queue_, &data, portMAX_DELAY);
+ xEventGroupSetBits(this->event_group_, SpeakerEventGroupBits::COMMAND_STOP);
}
}
-void I2SAudioSpeaker::watch_() {
- TaskEvent event;
- if (xQueueReceive(this->event_queue_, &event, 0) == pdTRUE) {
- switch (event.type) {
- case TaskEventType::STARTING:
- ESP_LOGD(TAG, "Starting I2S Audio Speaker");
- break;
- case TaskEventType::STARTED:
- ESP_LOGD(TAG, "Started I2S Audio Speaker");
- this->state_ = speaker::STATE_RUNNING;
- this->status_clear_warning();
- break;
- case TaskEventType::STOPPING:
- ESP_LOGD(TAG, "Stopping I2S Audio Speaker");
- break;
- case TaskEventType::STOPPED:
- this->state_ = speaker::STATE_STOPPED;
- vTaskDelete(this->player_task_handle_);
- this->task_created_ = false;
- this->player_task_handle_ = nullptr;
- this->parent_->unlock();
- xQueueReset(this->buffer_queue_);
- ESP_LOGD(TAG, "Stopped I2S Audio Speaker");
- break;
- case TaskEventType::WARNING:
- ESP_LOGW(TAG, "Error writing to I2S: %s", esp_err_to_name(event.err));
- this->status_set_warning();
- break;
- }
+bool I2SAudioSpeaker::send_esp_err_to_event_group_(esp_err_t err) {
+ switch (err) {
+ case ESP_OK:
+ return false;
+ case ESP_ERR_INVALID_STATE:
+ xEventGroupSetBits(this->event_group_, SpeakerEventGroupBits::ERR_ESP_INVALID_STATE);
+ return true;
+ case ESP_ERR_INVALID_ARG:
+ xEventGroupSetBits(this->event_group_, SpeakerEventGroupBits::ERR_ESP_INVALID_ARG);
+ return true;
+ case ESP_ERR_INVALID_SIZE:
+ xEventGroupSetBits(this->event_group_, SpeakerEventGroupBits::ERR_ESP_INVALID_SIZE);
+ return true;
+ case ESP_ERR_NO_MEM:
+ xEventGroupSetBits(this->event_group_, SpeakerEventGroupBits::ERR_ESP_NO_MEM);
+ return true;
+ default:
+ xEventGroupSetBits(this->event_group_, SpeakerEventGroupBits::ERR_ESP_FAIL);
+ return true;
}
}
-void I2SAudioSpeaker::loop() {
- switch (this->state_) {
- case speaker::STATE_STARTING:
- this->start_();
- [[fallthrough]];
- case speaker::STATE_RUNNING:
- case speaker::STATE_STOPPING:
- this->watch_();
- break;
- case speaker::STATE_STOPPED:
- break;
+esp_err_t I2SAudioSpeaker::allocate_buffers_(size_t data_buffer_size, size_t ring_buffer_size) {
+ if (this->data_buffer_ == nullptr) {
+ // Allocate data buffer for temporarily storing audio from the ring buffer before writing to the I2S bus
+ ExternalRAMAllocator allocator(ExternalRAMAllocator::ALLOW_FAILURE);
+ this->data_buffer_ = allocator.allocate(data_buffer_size);
}
+
+ if (this->data_buffer_ == nullptr) {
+ return ESP_ERR_NO_MEM;
+ }
+
+ if (this->audio_ring_buffer_ == nullptr) {
+ // Allocate ring buffer
+ this->audio_ring_buffer_ = RingBuffer::create(ring_buffer_size);
+ }
+
+ if (this->audio_ring_buffer_ == nullptr) {
+ return ESP_ERR_NO_MEM;
+ }
+
+ return ESP_OK;
}
-size_t I2SAudioSpeaker::play(const uint8_t *data, size_t length) {
- if (this->is_failed()) {
- ESP_LOGE(TAG, "Cannot play audio, speaker failed to setup");
- return 0;
+esp_err_t I2SAudioSpeaker::start_i2s_driver_() {
+ if (!this->parent_->try_lock()) {
+ return ESP_ERR_INVALID_STATE;
}
- if (this->state_ != speaker::STATE_RUNNING && this->state_ != speaker::STATE_STARTING) {
- this->start();
+
+ i2s_driver_config_t config = {
+ .mode = (i2s_mode_t) (this->i2s_mode_ | I2S_MODE_TX),
+ .sample_rate = this->sample_rate_,
+ .bits_per_sample = this->bits_per_sample_,
+ .channel_format = this->channel_,
+ .communication_format = this->i2s_comm_fmt_,
+ .intr_alloc_flags = ESP_INTR_FLAG_LEVEL1,
+ .dma_buf_count = DMA_BUFFERS_COUNT,
+ .dma_buf_len = DMA_BUFFER_SIZE,
+ .use_apll = this->use_apll_,
+ .tx_desc_auto_clear = true,
+ .fixed_mclk = I2S_PIN_NO_CHANGE,
+ .mclk_multiple = I2S_MCLK_MULTIPLE_256,
+ .bits_per_chan = this->bits_per_channel_,
+#if SOC_I2S_SUPPORTS_TDM
+ .chan_mask = (i2s_channel_t) (I2S_TDM_ACTIVE_CH0 | I2S_TDM_ACTIVE_CH1),
+ .total_chan = 2,
+ .left_align = false,
+ .big_edin = false,
+ .bit_order_msb = false,
+ .skip_msk = false,
+#endif
+ };
+#if SOC_I2S_SUPPORTS_DAC
+ if (this->internal_dac_mode_ != I2S_DAC_CHANNEL_DISABLE) {
+ config.mode = (i2s_mode_t) (config.mode | I2S_MODE_DAC_BUILT_IN);
}
- size_t remaining = length;
- size_t index = 0;
- while (remaining > 0) {
- DataEvent event;
- event.stop = false;
- size_t to_send_length = std::min(remaining, BUFFER_SIZE);
- event.len = to_send_length;
- memcpy(event.data, data + index, to_send_length);
- if (xQueueSend(this->buffer_queue_, &event, 0) != pdTRUE) {
- return index;
- }
- remaining -= to_send_length;
- index += to_send_length;
+#endif
+
+ esp_err_t err = i2s_driver_install(this->parent_->get_port(), &config, 0, nullptr);
+ if (err != ESP_OK) {
+ // Failed to install the driver, so unlock the I2S port
+ this->parent_->unlock();
+ return err;
}
- return index;
+
+#if SOC_I2S_SUPPORTS_DAC
+ if (this->internal_dac_mode_ == I2S_DAC_CHANNEL_DISABLE) {
+#endif
+ i2s_pin_config_t pin_config = this->parent_->get_pin_config();
+ pin_config.data_out_num = this->dout_pin_;
+
+ err = i2s_set_pin(this->parent_->get_port(), &pin_config);
+#if SOC_I2S_SUPPORTS_DAC
+ } else {
+ i2s_set_dac_mode(this->internal_dac_mode_);
+ }
+#endif
+
+ if (err != ESP_OK) {
+ // Failed to set the data out pin, so uninstall the driver and unlock the I2S port
+ i2s_driver_uninstall(this->parent_->get_port());
+ this->parent_->unlock();
+ }
+
+ return err;
}
-bool I2SAudioSpeaker::has_buffered_data() const { return uxQueueMessagesWaiting(this->buffer_queue_) > 0; }
+esp_err_t I2SAudioSpeaker::reconfigure_i2s_stream_info_(audio::AudioStreamInfo &audio_stream_info) {
+ if (this->i2s_mode_ & I2S_MODE_MASTER) {
+ // ESP controls for the the I2S bus, so adjust the sample rate and bits per sample to match the incoming audio
+ this->sample_rate_ = audio_stream_info.sample_rate;
+ this->bits_per_sample_ = (i2s_bits_per_sample_t) audio_stream_info.bits_per_sample;
+ } else if (this->sample_rate_ != audio_stream_info.sample_rate) {
+ // Can't reconfigure I2S bus, so the sample rate must match the configured value
+ return ESP_ERR_INVALID_ARG;
+ }
+
+ if ((i2s_bits_per_sample_t) audio_stream_info.bits_per_sample > this->bits_per_sample_) {
+ // Currently can't handle the case when the incoming audio has more bits per sample than the configured value
+ return ESP_ERR_INVALID_ARG;
+ }
+
+ if (audio_stream_info.channels == 1) {
+ return i2s_set_clk(this->parent_->get_port(), this->sample_rate_, this->bits_per_sample_, I2S_CHANNEL_MONO);
+ } else if (audio_stream_info.channels == 2) {
+ return i2s_set_clk(this->parent_->get_port(), this->sample_rate_, this->bits_per_sample_, I2S_CHANNEL_STEREO);
+ }
+
+ return ESP_ERR_INVALID_ARG;
+}
+
+void I2SAudioSpeaker::delete_task_(size_t buffer_size) {
+ if (this->audio_ring_buffer_ != nullptr) {
+ xEventGroupWaitBits(this->event_group_,
+ MESSAGE_RING_BUFFER_AVAILABLE_TO_WRITE, // Bit message to read
+ pdFALSE, // Don't clear the bits on exit
+ pdTRUE, // Don't wait for all the bits,
+ portMAX_DELAY); // Block indefinitely until a command bit is set
+
+ this->audio_ring_buffer_.reset(); // Deallocates the ring buffer stored in the unique_ptr
+ this->audio_ring_buffer_ = nullptr;
+ }
+
+ if (this->data_buffer_ != nullptr) {
+ ExternalRAMAllocator allocator(ExternalRAMAllocator::ALLOW_FAILURE);
+ allocator.deallocate(this->data_buffer_, buffer_size);
+ this->data_buffer_ = nullptr;
+ }
+
+ xEventGroupSetBits(this->event_group_, SpeakerEventGroupBits::STATE_STOPPED);
+
+ this->task_created_ = false;
+ vTaskDelete(nullptr);
+}
} // namespace i2s_audio
} // namespace esphome
diff --git a/esphome/components/i2s_audio/speaker/i2s_audio_speaker.h b/esphome/components/i2s_audio/speaker/i2s_audio_speaker.h
index 9d1817c86f..3c512d4d4d 100644
--- a/esphome/components/i2s_audio/speaker/i2s_audio_speaker.h
+++ b/esphome/components/i2s_audio/speaker/i2s_audio_speaker.h
@@ -5,38 +5,21 @@
#include "../i2s_audio.h"
#include
-#include
-#include
+#include
+#include
+
+#include "esphome/components/audio/audio.h"
#include "esphome/components/speaker/speaker.h"
+
#include "esphome/core/component.h"
#include "esphome/core/gpio.h"
#include "esphome/core/helpers.h"
+#include "esphome/core/ring_buffer.h"
namespace esphome {
namespace i2s_audio {
-static const size_t BUFFER_SIZE = 1024;
-
-enum class TaskEventType : uint8_t {
- STARTING = 0,
- STARTED,
- STOPPING,
- STOPPED,
- WARNING = 255,
-};
-
-struct TaskEvent {
- TaskEventType type;
- esp_err_t err;
-};
-
-struct DataEvent {
- bool stop;
- size_t len;
- uint8_t data[BUFFER_SIZE];
-};
-
class I2SAudioSpeaker : public I2SAudioOut, public speaker::Speaker, public Component {
public:
float get_setup_priority() const override { return esphome::setup_priority::LATE; }
@@ -55,25 +38,95 @@ class I2SAudioSpeaker : public I2SAudioOut, public speaker::Speaker, public Comp
void stop() override;
void finish() override;
- size_t play(const uint8_t *data, size_t length) override;
+ /// @brief Plays the provided audio data.
+ /// Starts the speaker task, if necessary. Writes the audio data to the ring buffer.
+ /// @param data Audio data in the format set by the parent speaker classes ``set_audio_stream_info`` method.
+ /// @param length The length of the audio data in bytes.
+ /// @param ticks_to_wait The FreeRTOS ticks to wait before writing as much data as possible to the ring buffer.
+ /// @return The number of bytes that were actually written to the ring buffer.
+ size_t play(const uint8_t *data, size_t length, TickType_t ticks_to_wait) override;
+ size_t play(const uint8_t *data, size_t length) override { return play(data, length, 0); }
bool has_buffered_data() const override;
+ /// @brief Sets the volume of the speaker. Uses the speaker's configured audio dac component. If unavailble, it is
+ /// implemented as a software volume control. Overrides the default setter to convert the floating point volume to a
+ /// Q15 fixed-point factor.
+ /// @param volume between 0.0 and 1.0
+ void set_volume(float volume) override;
+
+ /// @brief Mutes or unmute the speaker. Uses the speaker's configured audio dac component. If unavailble, it is
+ /// implemented as a software volume control. Overrides the default setter to convert the floating point volume to a
+ /// Q15 fixed-point factor.
+ /// @param mute_state true for muting, false for unmuting
+ void set_mute_state(bool mute_state) override;
+
protected:
- void start_();
+ /// @brief Function for the FreeRTOS task handling audio output.
+ /// After receiving the COMMAND_START signal, allocates space for the buffers, starts the I2S driver, and reads
+ /// audio from the ring buffer and writes audio to the I2S port. Stops immmiately after receiving the COMMAND_STOP
+ /// signal and stops only after the ring buffer is empty after receiving the COMMAND_STOP_GRACEFULLY signal. Stops if
+ /// the ring buffer hasn't read data for more than timeout_ milliseconds. When stopping, it deallocates the buffers,
+ /// stops the I2S driver, unlocks the I2S port, and deletes the task. It communicates the state and any errors via
+ /// event_group_.
+ /// @param params I2SAudioSpeaker component
+ static void speaker_task(void *params);
+
+ /// @brief Sends a stop command to the speaker task via event_group_.
+ /// @param wait_on_empty If false, sends the COMMAND_STOP signal. If true, sends the COMMAND_STOP_GRACEFULLY signal.
void stop_(bool wait_on_empty);
- void watch_();
- static void player_task(void *params);
+ /// @brief Sets the corresponding ERR_ESP event group bits.
+ /// @param err esp_err_t error code.
+ /// @return True if an ERR_ESP bit is set and false if err == ESP_OK
+ bool send_esp_err_to_event_group_(esp_err_t err);
- TaskHandle_t player_task_handle_{nullptr};
- QueueHandle_t buffer_queue_;
- QueueHandle_t event_queue_;
+ /// @brief Allocates the data buffer and ring buffer
+ /// @param data_buffer_size Number of bytes to allocate for the data buffer.
+ /// @param ring_buffer_size Number of bytes to allocate for the ring buffer.
+ /// @return ESP_ERR_NO_MEM if either buffer fails to allocate
+ /// ESP_OK if successful
+ esp_err_t allocate_buffers_(size_t data_buffer_size, size_t ring_buffer_size);
+
+ /// @brief Starts the ESP32 I2S driver.
+ /// Attempts to lock the I2S port, starts the I2S driver, and sets the data out pin. If it fails, it will unlock
+ /// the I2S port and uninstall the driver, if necessary.
+ /// @return ESP_ERR_INVALID_STATE if the I2S port is already locked.
+ /// ESP_ERR_INVALID_ARG if installing the driver or setting the data out pin fails due to a parameter error.
+ /// ESP_ERR_NO_MEM if the driver fails to install due to a memory allocation error.
+ /// ESP_FAIL if setting the data out pin fails due to an IO error
+ /// ESP_OK if successful
+ esp_err_t start_i2s_driver_();
+
+ /// @brief Adjusts the I2S driver configuration to match the incoming audio stream.
+ /// Modifies I2S driver's sample rate, bits per sample, and number of channel settings. If the I2S is in secondary
+ /// mode, it only modifies the number of channels.
+ /// @param audio_stream_info Describes the incoming audio stream
+ /// @return ESP_ERR_INVALID_ARG if there is a parameter error, if there is more than 2 channels in the stream, or if
+ /// the audio settings are incompatible with the configuration.
+ /// ESP_ERR_NO_MEM if the driver fails to reconfigure due to a memory allocation error.
+ /// ESP_OK if successful.
+ esp_err_t reconfigure_i2s_stream_info_(audio::AudioStreamInfo &audio_stream_info);
+
+ /// @brief Deletes the speaker's task.
+ /// Deallocates the data_buffer_ and audio_ring_buffer_, if necessary, and deletes the task. Should only be called by
+ /// the speaker_task itself.
+ /// @param buffer_size The allocated size of the data_buffer_.
+ void delete_task_(size_t buffer_size);
+
+ TaskHandle_t speaker_task_handle_{nullptr};
+ EventGroupHandle_t event_group_{nullptr};
+
+ uint8_t *data_buffer_;
+ std::unique_ptr audio_ring_buffer_;
+
+ uint32_t timeout_;
+ uint8_t dout_pin_;
- uint32_t timeout_{0};
- uint8_t dout_pin_{0};
bool task_created_{false};
+ int16_t q15_volume_factor_{INT16_MAX};
+
#if SOC_I2S_SUPPORTS_DAC
i2s_dac_mode_t internal_dac_mode_{I2S_DAC_CHANNEL_DISABLE};
#endif
diff --git a/esphome/components/ili9xxx/display.py b/esphome/components/ili9xxx/display.py
index 2182ca9a6d..68e3aa953d 100644
--- a/esphome/components/ili9xxx/display.py
+++ b/esphome/components/ili9xxx/display.py
@@ -10,6 +10,7 @@ from esphome.const import (
CONF_DIMENSIONS,
CONF_HEIGHT,
CONF_ID,
+ CONF_INIT_SEQUENCE,
CONF_INVERT_COLORS,
CONF_LAMBDA,
CONF_MIRROR_X,
@@ -89,7 +90,6 @@ CONF_LED_PIN = "led_pin"
CONF_COLOR_PALETTE_IMAGES = "color_palette_images"
CONF_INVERT_DISPLAY = "invert_display"
CONF_PIXEL_MODE = "pixel_mode"
-CONF_INIT_SEQUENCE = "init_sequence"
def cmd(c, *args):
diff --git a/esphome/components/ili9xxx/ili9xxx_display.h b/esphome/components/ili9xxx/ili9xxx_display.h
index 5033f702de..c141739d2a 100644
--- a/esphome/components/ili9xxx/ili9xxx_display.h
+++ b/esphome/components/ili9xxx/ili9xxx_display.h
@@ -89,6 +89,7 @@ class ILI9XXXDisplay : public display::DisplayBuffer,
void dump_config() override;
void setup() override;
+ void on_shutdown() override { this->command(ILI9XXX_SLPIN); }
display::DisplayType get_display_type() override { return display::DisplayType::DISPLAY_TYPE_COLOR; }
void draw_pixels_at(int x_start, int y_start, int w, int h, const uint8_t *ptr, display::ColorOrder order,
diff --git a/esphome/components/image/image.h b/esphome/components/image/image.h
index ae5a7a814d..a8a8aab2c2 100644
--- a/esphome/components/image/image.h
+++ b/esphome/components/image/image.h
@@ -3,12 +3,7 @@
#include "esphome/components/display/display.h"
#ifdef USE_LVGL
-// required for clang-tidy
-#ifndef LV_CONF_H
-#define LV_CONF_SKIP 1 // NOLINT
-#endif // LV_CONF_H
-
-#include
+#include "esphome/components/lvgl/lvgl_proxy.h"
#endif // USE_LVGL
namespace esphome {
diff --git a/esphome/components/internal_temperature/internal_temperature.cpp b/esphome/components/internal_temperature/internal_temperature.cpp
index 47f516f568..9ef5cbecd5 100644
--- a/esphome/components/internal_temperature/internal_temperature.cpp
+++ b/esphome/components/internal_temperature/internal_temperature.cpp
@@ -7,7 +7,8 @@
extern "C" {
uint8_t temprature_sens_read();
}
-#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
+#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32C6) || \
+ defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
#include "driver/temp_sensor.h"
#endif // USE_ESP32_VARIANT
#endif // USE_ESP32
@@ -34,7 +35,8 @@ void InternalTemperatureSensor::update() {
ESP_LOGV(TAG, "Raw temperature value: %d", raw);
temperature = (raw - 32) / 1.8f;
success = (raw != 128);
-#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
+#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32C6) || \
+ defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3)
temp_sensor_config_t tsens = TSENS_CONFIG_DEFAULT();
temp_sensor_set_config(tsens);
temp_sensor_start();
diff --git a/esphome/components/libretiny/__init__.py b/esphome/components/libretiny/__init__.py
index cc7fae7e70..b29d2e309c 100644
--- a/esphome/components/libretiny/__init__.py
+++ b/esphome/components/libretiny/__init__.py
@@ -46,7 +46,7 @@ from .const import (
_LOGGER = logging.getLogger(__name__)
CODEOWNERS = ["@kuba2k2"]
-AUTO_LOAD = []
+AUTO_LOAD = ["preferences"]
def _detect_variant(value):
diff --git a/esphome/components/light/__init__.py b/esphome/components/light/__init__.py
index a82fc2a2c4..03e0b943ff 100644
--- a/esphome/components/light/__init__.py
+++ b/esphome/components/light/__init__.py
@@ -3,27 +3,39 @@ import esphome.codegen as cg
from esphome.components import mqtt, power_supply, web_server
import esphome.config_validation as cv
from esphome.const import (
+ CONF_BLUE,
+ CONF_BRIGHTNESS,
+ CONF_COLD_WHITE,
CONF_COLD_WHITE_COLOR_TEMPERATURE,
+ CONF_COLOR_BRIGHTNESS,
CONF_COLOR_CORRECT,
+ CONF_COLOR_MODE,
+ CONF_COLOR_TEMPERATURE,
CONF_DEFAULT_TRANSITION_LENGTH,
CONF_EFFECTS,
CONF_FLASH_TRANSITION_LENGTH,
CONF_GAMMA_CORRECT,
+ CONF_GREEN,
CONF_ID,
+ CONF_INITIAL_STATE,
CONF_MQTT_ID,
CONF_ON_STATE,
CONF_ON_TURN_OFF,
CONF_ON_TURN_ON,
CONF_POWER_SUPPLY,
+ CONF_RED,
CONF_RESTORE_MODE,
+ CONF_STATE,
CONF_TRIGGER_ID,
+ CONF_WARM_WHITE,
CONF_WARM_WHITE_COLOR_TEMPERATURE,
CONF_WEB_SERVER,
+ CONF_WHITE,
)
from esphome.core import coroutine_with_priority
from esphome.cpp_helpers import setup_entity
-from .automation import light_control_to_code # noqa
+from .automation import LIGHT_STATE_SCHEMA
from .effects import (
ADDRESSABLE_EFFECTS,
BINARY_EFFECTS,
@@ -35,8 +47,10 @@ from .effects import (
from .types import ( # noqa
AddressableLight,
AddressableLightState,
+ ColorMode,
LightOutput,
LightState,
+ LightStateRTCState,
LightStateTrigger,
LightTurnOffTrigger,
LightTurnOnTrigger,
@@ -85,6 +99,7 @@ LIGHT_SCHEMA = (
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(LightStateTrigger),
}
),
+ cv.Optional(CONF_INITIAL_STATE): LIGHT_STATE_SCHEMA,
}
)
)
@@ -145,6 +160,22 @@ async def setup_light_core_(light_var, output_var, config):
cg.add(light_var.set_restore_mode(config[CONF_RESTORE_MODE]))
+ if (initial_state_config := config.get(CONF_INITIAL_STATE)) is not None:
+ initial_state = LightStateRTCState(
+ initial_state_config.get(CONF_COLOR_MODE, ColorMode.UNKNOWN),
+ initial_state_config.get(CONF_STATE, False),
+ initial_state_config.get(CONF_BRIGHTNESS, 1.0),
+ initial_state_config.get(CONF_COLOR_BRIGHTNESS, 1.0),
+ initial_state_config.get(CONF_RED, 1.0),
+ initial_state_config.get(CONF_GREEN, 1.0),
+ initial_state_config.get(CONF_BLUE, 1.0),
+ initial_state_config.get(CONF_WHITE, 1.0),
+ initial_state_config.get(CONF_COLOR_TEMPERATURE, 1.0),
+ initial_state_config.get(CONF_COLD_WHITE, 1.0),
+ initial_state_config.get(CONF_WARM_WHITE, 1.0),
+ )
+ cg.add(light_var.set_initial_state(initial_state))
+
if (
default_transition_length := config.get(CONF_DEFAULT_TRANSITION_LENGTH)
) is not None:
diff --git a/esphome/components/light/automation.py b/esphome/components/light/automation.py
index ec0375f54a..e5aa8fa0e9 100644
--- a/esphome/components/light/automation.py
+++ b/esphome/components/light/automation.py
@@ -1,41 +1,42 @@
+from esphome import automation
import esphome.codegen as cg
import esphome.config_validation as cv
-from esphome import automation
from esphome.const import (
- CONF_ID,
- CONF_COLOR_MODE,
- CONF_TRANSITION_LENGTH,
- CONF_STATE,
- CONF_FLASH_LENGTH,
- CONF_EFFECT,
- CONF_BRIGHTNESS,
- CONF_COLOR_BRIGHTNESS,
- CONF_RED,
- CONF_GREEN,
CONF_BLUE,
- CONF_WHITE,
- CONF_COLOR_TEMPERATURE,
+ CONF_BRIGHTNESS,
+ CONF_BRIGHTNESS_LIMITS,
CONF_COLD_WHITE,
- CONF_WARM_WHITE,
+ CONF_COLOR_BRIGHTNESS,
+ CONF_COLOR_MODE,
+ CONF_COLOR_TEMPERATURE,
+ CONF_EFFECT,
+ CONF_FLASH_LENGTH,
+ CONF_GREEN,
+ CONF_ID,
+ CONF_LIMIT_MODE,
+ CONF_MAX_BRIGHTNESS,
+ CONF_MIN_BRIGHTNESS,
CONF_RANGE_FROM,
CONF_RANGE_TO,
- CONF_BRIGHTNESS_LIMITS,
- CONF_LIMIT_MODE,
- CONF_MIN_BRIGHTNESS,
- CONF_MAX_BRIGHTNESS,
+ CONF_RED,
+ CONF_STATE,
+ CONF_TRANSITION_LENGTH,
+ CONF_WARM_WHITE,
+ CONF_WHITE,
)
+
from .types import (
- ColorMode,
COLOR_MODES,
LIMIT_MODES,
- DimRelativeAction,
- ToggleAction,
- LightState,
- LightControlAction,
AddressableLightState,
AddressableSet,
- LightIsOnCondition,
+ ColorMode,
+ DimRelativeAction,
+ LightControlAction,
LightIsOffCondition,
+ LightIsOnCondition,
+ LightState,
+ ToggleAction,
)
@@ -62,18 +63,10 @@ async def light_toggle_to_code(config, action_id, template_arg, args):
return var
-LIGHT_CONTROL_ACTION_SCHEMA = cv.Schema(
+LIGHT_STATE_SCHEMA = cv.Schema(
{
- cv.Required(CONF_ID): cv.use_id(LightState),
cv.Optional(CONF_COLOR_MODE): cv.enum(COLOR_MODES, upper=True, space="_"),
cv.Optional(CONF_STATE): cv.templatable(cv.boolean),
- cv.Exclusive(CONF_TRANSITION_LENGTH, "transformer"): cv.templatable(
- cv.positive_time_period_milliseconds
- ),
- cv.Exclusive(CONF_FLASH_LENGTH, "transformer"): cv.templatable(
- cv.positive_time_period_milliseconds
- ),
- cv.Exclusive(CONF_EFFECT, "transformer"): cv.templatable(cv.string),
cv.Optional(CONF_BRIGHTNESS): cv.templatable(cv.percentage),
cv.Optional(CONF_COLOR_BRIGHTNESS): cv.templatable(cv.percentage),
cv.Optional(CONF_RED): cv.templatable(cv.percentage),
@@ -85,6 +78,20 @@ LIGHT_CONTROL_ACTION_SCHEMA = cv.Schema(
cv.Optional(CONF_WARM_WHITE): cv.templatable(cv.percentage),
}
)
+
+LIGHT_CONTROL_ACTION_SCHEMA = LIGHT_STATE_SCHEMA.extend(
+ {
+ cv.Required(CONF_ID): cv.use_id(LightState),
+ cv.Exclusive(CONF_TRANSITION_LENGTH, "transformer"): cv.templatable(
+ cv.positive_time_period_milliseconds
+ ),
+ cv.Exclusive(CONF_FLASH_LENGTH, "transformer"): cv.templatable(
+ cv.positive_time_period_milliseconds
+ ),
+ cv.Exclusive(CONF_EFFECT, "transformer"): cv.templatable(cv.string),
+ }
+)
+
LIGHT_TURN_OFF_ACTION_SCHEMA = automation.maybe_simple_id(
{
cv.Required(CONF_ID): cv.use_id(LightState),
diff --git a/esphome/components/light/effects.py b/esphome/components/light/effects.py
index be50f63321..67c318eb8e 100644
--- a/esphome/components/light/effects.py
+++ b/esphome/components/light/effects.py
@@ -1,59 +1,59 @@
-from esphome.schema_extractors import SCHEMA_EXTRACT, schema_extractor
+from esphome import automation
import esphome.codegen as cg
import esphome.config_validation as cv
-from esphome import automation
-
from esphome.const import (
- CONF_NAME,
- CONF_LAMBDA,
- CONF_UPDATE_INTERVAL,
- CONF_TRANSITION_LENGTH,
- CONF_COLORS,
- CONF_STATE,
- CONF_DURATION,
- CONF_BRIGHTNESS,
- CONF_COLOR_MODE,
- CONF_COLOR_BRIGHTNESS,
- CONF_RED,
- CONF_GREEN,
- CONF_BLUE,
- CONF_WHITE,
- CONF_COLOR_TEMPERATURE,
- CONF_COLD_WHITE,
- CONF_WARM_WHITE,
CONF_ALPHA,
+ CONF_BLUE,
+ CONF_BRIGHTNESS,
+ CONF_COLD_WHITE,
+ CONF_COLOR_BRIGHTNESS,
+ CONF_COLOR_MODE,
+ CONF_COLOR_TEMPERATURE,
+ CONF_COLORS,
+ CONF_DURATION,
+ CONF_GREEN,
CONF_INTENSITY,
- CONF_SPEED,
- CONF_WIDTH,
- CONF_NUM_LEDS,
- CONF_RANDOM,
- CONF_SEQUENCE,
+ CONF_LAMBDA,
CONF_MAX_BRIGHTNESS,
CONF_MIN_BRIGHTNESS,
+ CONF_NAME,
+ CONF_NUM_LEDS,
+ CONF_RANDOM,
+ CONF_RED,
+ CONF_SEQUENCE,
+ CONF_SPEED,
+ CONF_STATE,
+ CONF_TRANSITION_LENGTH,
+ CONF_UPDATE_INTERVAL,
+ CONF_WARM_WHITE,
+ CONF_WHITE,
+ CONF_WIDTH,
)
+from esphome.schema_extractors import SCHEMA_EXTRACT, schema_extractor
from esphome.util import Registry
+
from .types import (
- ColorMode,
COLOR_MODES,
+ AddressableColorWipeEffect,
+ AddressableColorWipeEffectColor,
+ AddressableFireworksEffect,
+ AddressableFlickerEffect,
+ AddressableLambdaLightEffect,
+ AddressableLightRef,
+ AddressableRainbowLightEffect,
+ AddressableRandomTwinkleEffect,
+ AddressableScanEffect,
+ AddressableTwinkleEffect,
+ AutomationLightEffect,
+ Color,
+ ColorMode,
+ FlickerLightEffect,
LambdaLightEffect,
+ LightColorValues,
PulseLightEffect,
RandomLightEffect,
StrobeLightEffect,
StrobeLightEffectColor,
- LightColorValues,
- AddressableLightRef,
- AddressableLambdaLightEffect,
- FlickerLightEffect,
- AddressableRainbowLightEffect,
- AddressableColorWipeEffect,
- AddressableColorWipeEffectColor,
- AddressableScanEffect,
- AddressableTwinkleEffect,
- AddressableRandomTwinkleEffect,
- AddressableFireworksEffect,
- AddressableFlickerEffect,
- AutomationLightEffect,
- Color,
)
CONF_ADD_LED_INTERVAL = "add_led_interval"
diff --git a/esphome/components/light/light_state.cpp b/esphome/components/light/light_state.cpp
index fe6538e65e..16b78a17bd 100644
--- a/esphome/components/light/light_state.cpp
+++ b/esphome/components/light/light_state.cpp
@@ -1,6 +1,7 @@
#include "esphome/core/log.h"
-#include "light_state.h"
+
#include "light_output.h"
+#include "light_state.h"
#include "transformers.h"
namespace esphome {
@@ -16,21 +17,6 @@ LightCall LightState::turn_off() { return this->make_call().set_state(false); }
LightCall LightState::toggle() { return this->make_call().set_state(!this->remote_values.is_on()); }
LightCall LightState::make_call() { return LightCall(this); }
-struct LightStateRTCState {
- ColorMode color_mode{ColorMode::UNKNOWN};
- bool state{false};
- float brightness{1.0f};
- float color_brightness{1.0f};
- float red{1.0f};
- float green{1.0f};
- float blue{1.0f};
- float white{1.0f};
- float color_temp{1.0f};
- float cold_white{1.0f};
- float warm_white{1.0f};
- uint32_t effect{0};
-};
-
void LightState::setup() {
ESP_LOGCONFIG(TAG, "Setting up light '%s'...", this->get_name().c_str());
@@ -48,6 +34,9 @@ void LightState::setup() {
auto call = this->make_call();
LightStateRTCState recovered{};
+ if (this->initial_state_.has_value()) {
+ recovered = *this->initial_state_;
+ }
switch (this->restore_mode_) {
case LIGHT_RESTORE_DEFAULT_OFF:
case LIGHT_RESTORE_DEFAULT_ON:
@@ -175,6 +164,7 @@ void LightState::set_flash_transition_length(uint32_t flash_transition_length) {
uint32_t LightState::get_flash_transition_length() const { return this->flash_transition_length_; }
void LightState::set_gamma_correct(float gamma_correct) { this->gamma_correct_ = gamma_correct; }
void LightState::set_restore_mode(LightRestoreMode restore_mode) { this->restore_mode_ = restore_mode; }
+void LightState::set_initial_state(const LightStateRTCState &initial_state) { this->initial_state_ = initial_state; }
bool LightState::supports_effects() { return !this->effects_.empty(); }
const std::vector &LightState::get_effects() const { return this->effects_; }
void LightState::add_effects(const std::vector &effects) {
diff --git a/esphome/components/light/light_state.h b/esphome/components/light/light_state.h
index b0aaa453b5..acba986f24 100644
--- a/esphome/components/light/light_state.h
+++ b/esphome/components/light/light_state.h
@@ -28,6 +28,35 @@ enum LightRestoreMode {
LIGHT_RESTORE_AND_ON,
};
+struct LightStateRTCState {
+ LightStateRTCState(ColorMode color_mode, bool state, float brightness, float color_brightness, float red, float green,
+ float blue, float white, float color_temp, float cold_white, float warm_white)
+ : color_mode(color_mode),
+ state(state),
+ brightness(brightness),
+ color_brightness(color_brightness),
+ red(red),
+ green(green),
+ blue(blue),
+ white(white),
+ color_temp(color_temp),
+ cold_white(cold_white),
+ warm_white(warm_white) {}
+ LightStateRTCState() = default;
+ ColorMode color_mode{ColorMode::UNKNOWN};
+ bool state{false};
+ float brightness{1.0f};
+ float color_brightness{1.0f};
+ float red{1.0f};
+ float green{1.0f};
+ float blue{1.0f};
+ float white{1.0f};
+ float color_temp{1.0f};
+ float cold_white{1.0f};
+ float warm_white{1.0f};
+ uint32_t effect{0};
+};
+
/** This class represents the communication layer between the front-end MQTT layer and the
* hardware output layer.
*/
@@ -116,6 +145,9 @@ class LightState : public EntityBase, public Component {
/// Set the restore mode of this light
void set_restore_mode(LightRestoreMode restore_mode);
+ /// Set the initial state of this light
+ void set_initial_state(const LightStateRTCState &initial_state);
+
/// Return whether the light has any effects that meet the trait requirements.
bool supports_effects();
@@ -212,6 +244,8 @@ class LightState : public EntityBase, public Component {
float gamma_correct_{};
/// Restore mode of the light.
LightRestoreMode restore_mode_;
+ /// Initial state of the light.
+ optional initial_state_{};
/// List of effects for this light.
std::vector effects_;
diff --git a/esphome/components/light/types.py b/esphome/components/light/types.py
index 64483bcc9c..a586bcbd13 100644
--- a/esphome/components/light/types.py
+++ b/esphome/components/light/types.py
@@ -1,5 +1,5 @@
-import esphome.codegen as cg
from esphome import automation
+import esphome.codegen as cg
# Base
light_ns = cg.esphome_ns.namespace("light")
@@ -12,6 +12,8 @@ AddressableLightRef = AddressableLight.operator("ref")
Color = cg.esphome_ns.class_("Color")
LightColorValues = light_ns.class_("LightColorValues")
+LightStateRTCState = light_ns.struct("LightStateRTCState")
+
# Color modes
ColorMode = light_ns.enum("ColorMode", is_class=True)
COLOR_MODES = {
diff --git a/esphome/components/logger/logger_esp32.cpp b/esphome/components/logger/logger_esp32.cpp
index b0f1051d34..c9de3d815a 100644
--- a/esphome/components/logger/logger_esp32.cpp
+++ b/esphome/components/logger/logger_esp32.cpp
@@ -10,8 +10,12 @@
#ifdef USE_LOGGER_USB_SERIAL_JTAG
#include
+#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 3, 0)
#include
#include
+#else
+#include
+#endif
#endif
#include "freertos/FreeRTOS.h"
@@ -36,10 +40,17 @@ static const char *const TAG = "logger";
static void init_usb_serial_jtag_() {
setvbuf(stdin, NULL, _IONBF, 0); // Disable buffering on stdin
+#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 3, 0)
// Minicom, screen, idf_monitor send CR when ENTER key is pressed
esp_vfs_dev_usb_serial_jtag_set_rx_line_endings(ESP_LINE_ENDINGS_CR);
// Move the caret to the beginning of the next line on '\n'
esp_vfs_dev_usb_serial_jtag_set_tx_line_endings(ESP_LINE_ENDINGS_CRLF);
+#else
+ // Minicom, screen, idf_monitor send CR when ENTER key is pressed
+ usb_serial_jtag_vfs_set_rx_line_endings(ESP_LINE_ENDINGS_CR);
+ // Move the caret to the beginning of the next line on '\n'
+ usb_serial_jtag_vfs_set_tx_line_endings(ESP_LINE_ENDINGS_CRLF);
+#endif
// Enable non-blocking mode on stdin and stdout
fcntl(fileno(stdout), F_SETFL, 0);
@@ -57,7 +68,11 @@ static void init_usb_serial_jtag_() {
}
// Tell vfs to use usb-serial-jtag driver
+#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 3, 0)
esp_vfs_usb_serial_jtag_use_driver();
+#else
+ usb_serial_jtag_vfs_use_driver();
+#endif
}
#endif
diff --git a/esphome/components/lvgl/__init__.py b/esphome/components/lvgl/__init__.py
index ce3843567b..215fdecdb5 100644
--- a/esphome/components/lvgl/__init__.py
+++ b/esphome/components/lvgl/__init__.py
@@ -22,7 +22,7 @@ from esphome.helpers import write_file_if_changed
from . import defines as df, helpers, lv_validation as lvalid
from .automation import disp_update, focused_widgets, update_to_code
-from .defines import CONF_WIDGETS, add_define
+from .defines import add_define
from .encoders import ENCODERS_CONFIG, encoders_to_code, initial_focus_to_code
from .gradient import GRADIENT_SCHEMA, gradients_to_code
from .hello_world import get_hello_world
@@ -33,7 +33,7 @@ from .schemas import (
FLEX_OBJ_SCHEMA,
GRID_CELL_SCHEMA,
LAYOUT_SCHEMAS,
- STATE_SCHEMA,
+ STYLE_SCHEMA,
WIDGET_TYPES,
any_widget_schema,
container_schema,
@@ -48,12 +48,13 @@ from .types import (
FontEngine,
IdleTrigger,
ObjUpdateAction,
+ PauseTrigger,
lv_font_t,
lv_group_t,
lv_style_t,
lvgl_ns,
)
-from .widgets import Widget, add_widgets, lv_scr_act, set_obj_properties, styles_used
+from .widgets import Widget, add_widgets, get_scr_act, set_obj_properties, styles_used
from .widgets.animimg import animimg_spec
from .widgets.arc import arc_spec
from .widgets.button import button_spec
@@ -185,7 +186,7 @@ def final_validation(config):
async def to_code(config):
cg.add_library("lvgl/lvgl", "8.4.0")
- CORE.add_define("USE_LVGL")
+ cg.add_define("USE_LVGL")
# suppress default enabling of extra widgets
add_define("_LV_KCONFIG_PRESENT")
# Always enable - lots of things use it.
@@ -199,7 +200,13 @@ async def to_code(config):
add_define("LV_MEM_CUSTOM_REALLOC", "lv_custom_mem_realloc")
add_define("LV_MEM_CUSTOM_INCLUDE", '"esphome/components/lvgl/lvgl_hal.h"')
- add_define("LV_LOG_LEVEL", f"LV_LOG_LEVEL_{config[df.CONF_LOG_LEVEL]}")
+ add_define(
+ "LV_LOG_LEVEL", f"LV_LOG_LEVEL_{df.LV_LOG_LEVELS[config[df.CONF_LOG_LEVEL]]}"
+ )
+ cg.add_define(
+ "LVGL_LOG_LEVEL",
+ cg.RawExpression(f"ESPHOME_LOG_LEVEL_{config[df.CONF_LOG_LEVEL]}"),
+ )
add_define("LV_COLOR_DEPTH", config[df.CONF_COLOR_DEPTH])
for font in helpers.lv_fonts_used:
add_define(f"LV_FONT_{font.upper()}")
@@ -213,15 +220,9 @@ async def to_code(config):
"LV_COLOR_CHROMA_KEY",
await lvalid.lv_color.process(config[df.CONF_TRANSPARENCY_KEY]),
)
- CORE.add_build_flag("-Isrc")
+ cg.add_build_flag("-Isrc")
cg.add_global(lvgl_ns.using)
- lv_component = cg.new_Pvariable(config[CONF_ID])
- await cg.register_component(lv_component, config)
- Widget.create(config[CONF_ID], lv_component, obj_spec, config)
- for display in config[df.CONF_DISPLAYS]:
- cg.add(lv_component.add_display(await cg.get_variable(display)))
-
frac = config[CONF_BUFFER_SIZE]
if frac >= 0.75:
frac = 1
@@ -231,8 +232,17 @@ async def to_code(config):
frac = 4
else:
frac = 8
- cg.add(lv_component.set_buffer_frac(int(frac)))
- cg.add(lv_component.set_full_refresh(config[df.CONF_FULL_REFRESH]))
+ displays = [await cg.get_variable(display) for display in config[df.CONF_DISPLAYS]]
+ lv_component = cg.new_Pvariable(
+ config[CONF_ID],
+ displays,
+ frac,
+ config[df.CONF_FULL_REFRESH],
+ config[df.CONF_DRAW_ROUNDING],
+ config[df.CONF_RESUME_ON_INPUT],
+ )
+ await cg.register_component(lv_component, config)
+ Widget.create(config[CONF_ID], lv_component, obj_spec, config)
for font in helpers.esphome_fonts_used:
await cg.get_variable(font)
@@ -254,6 +264,7 @@ async def to_code(config):
else:
add_define("LV_FONT_DEFAULT", await lvalid.lv_font.process(default_font))
+ lv_scr_act = get_scr_act(lv_component)
async with LvContext(lv_component):
await touchscreens_to_code(lv_component, config)
await encoders_to_code(lv_component, config)
@@ -263,31 +274,38 @@ async def to_code(config):
await set_obj_properties(lv_scr_act, config)
await add_widgets(lv_scr_act, config)
await add_pages(lv_component, config)
- await add_top_layer(config)
- await msgboxes_to_code(config)
- await disp_update(f"{lv_component}->get_disp()", config)
- # At this point only the setup code should be generated
- assert LvContext.added_lambda_count == 1
- Widget.set_completed()
+ await add_top_layer(lv_component, config)
+ await msgboxes_to_code(lv_component, config)
+ await disp_update(lv_component.get_disp(), config)
+ # Set this directly since we are limited in how many methods can be added to the Widget class.
+ Widget.widgets_completed = True
async with LvContext(lv_component):
await generate_triggers(lv_component)
await generate_page_triggers(lv_component, config)
+ await initial_focus_to_code(config)
for conf in config.get(CONF_ON_IDLE, ()):
templ = await cg.templatable(conf[CONF_TIMEOUT], [], cg.uint32)
idle_trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], lv_component, templ)
await build_automation(idle_trigger, [], conf)
- await initial_focus_to_code(config)
+ for conf in config.get(df.CONF_ON_PAUSE, ()):
+ pause_trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], lv_component, True)
+ await build_automation(pause_trigger, [], conf)
+ for conf in config.get(df.CONF_ON_RESUME, ()):
+ resume_trigger = cg.new_Pvariable(
+ conf[CONF_TRIGGER_ID], lv_component, False
+ )
+ await build_automation(resume_trigger, [], conf)
for comp in helpers.lvgl_components_required:
- CORE.add_define(f"USE_LVGL_{comp.upper()}")
+ cg.add_define(f"USE_LVGL_{comp.upper()}")
if "transform_angle" in styles_used:
add_define("LV_COLOR_SCREEN_TRANSP", "1")
for use in helpers.lv_uses:
add_define(f"LV_USE_{use.upper()}")
lv_conf_h_file = CORE.relative_src_path(LV_CONF_FILENAME)
write_file_if_changed(lv_conf_h_file, generate_lv_conf_h())
- CORE.add_build_flag("-DLV_CONF_H=1")
- CORE.add_build_flag(f'-DLV_CONF_PATH="{LV_CONF_FILENAME}"')
+ cg.add_build_flag("-DLV_CONF_H=1")
+ cg.add_build_flag(f'-DLV_CONF_PATH="{LV_CONF_FILENAME}"')
def display_schema(config):
@@ -296,9 +314,9 @@ def display_schema(config):
def add_hello_world(config):
- if CONF_WIDGETS not in config and CONF_PAGES not in config:
+ if df.CONF_WIDGETS not in config and CONF_PAGES not in config:
LOGGER.info("No pages or widgets configured, creating default hello_world page")
- config[CONF_WIDGETS] = cv.ensure_list(WIDGET_SCHEMA)(get_hello_world())
+ config[df.CONF_WIDGETS] = cv.ensure_list(WIDGET_SCHEMA)(get_hello_world())
return config
@@ -314,16 +332,17 @@ CONFIG_SCHEMA = (
cv.Optional(df.CONF_COLOR_DEPTH, default=16): cv.one_of(16),
cv.Optional(df.CONF_DEFAULT_FONT, default="montserrat_14"): lvalid.lv_font,
cv.Optional(df.CONF_FULL_REFRESH, default=False): cv.boolean,
+ cv.Optional(df.CONF_DRAW_ROUNDING, default=2): cv.positive_int,
cv.Optional(CONF_BUFFER_SIZE, default="100%"): cv.percentage,
cv.Optional(df.CONF_LOG_LEVEL, default="WARN"): cv.one_of(
- *df.LOG_LEVELS, upper=True
+ *df.LV_LOG_LEVELS, upper=True
),
cv.Optional(df.CONF_BYTE_ORDER, default="big_endian"): cv.one_of(
"big_endian", "little_endian"
),
cv.Optional(df.CONF_STYLE_DEFINITIONS): cv.ensure_list(
cv.Schema({cv.Required(CONF_ID): cv.declare_id(lv_style_t)})
- .extend(STATE_SCHEMA)
+ .extend(STYLE_SCHEMA)
.extend(
{
cv.Optional(df.CONF_GRID_CELL_X_ALIGN): grid_alignments,
@@ -341,6 +360,16 @@ CONFIG_SCHEMA = (
),
}
),
+ cv.Optional(df.CONF_ON_PAUSE): validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(PauseTrigger),
+ }
+ ),
+ cv.Optional(df.CONF_ON_RESUME): validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(PauseTrigger),
+ }
+ ),
cv.Exclusive(df.CONF_WIDGETS, CONF_PAGES): cv.ensure_list(WIDGET_SCHEMA),
cv.Exclusive(CONF_PAGES, CONF_PAGES): cv.ensure_list(
container_schema(page_spec)
@@ -356,6 +385,7 @@ CONFIG_SCHEMA = (
cv.Optional(df.CONF_TOUCHSCREENS, default=None): touchscreen_schema,
cv.Optional(df.CONF_ENCODERS, default=None): ENCODERS_CONFIG,
cv.GenerateID(df.CONF_DEFAULT_GROUP): cv.declare_id(lv_group_t),
+ cv.Optional(df.CONF_RESUME_ON_INPUT, default=True): cv.boolean,
}
)
.extend(DISP_BG_SCHEMA)
diff --git a/esphome/components/lvgl/automation.py b/esphome/components/lvgl/automation.py
index cdc7553e81..48472354f8 100644
--- a/esphome/components/lvgl/automation.py
+++ b/esphome/components/lvgl/automation.py
@@ -5,7 +5,7 @@ from esphome import automation
import esphome.codegen as cg
import esphome.config_validation as cv
from esphome.const import CONF_ACTION, CONF_GROUP, CONF_ID, CONF_TIMEOUT
-from esphome.cpp_generator import RawExpression, get_variable
+from esphome.cpp_generator import get_variable
from esphome.cpp_types import nullptr
from .defines import (
@@ -23,7 +23,6 @@ from .lvcode import (
UPDATE_EVENT,
LambdaContext,
LocalVariable,
- LvConditional,
LvglComponent,
ReturnStatement,
add_line_marks,
@@ -47,8 +46,8 @@ from .types import (
)
from .widgets import (
Widget,
+ get_scr_act,
get_widgets,
- lv_scr_act,
set_obj_properties,
wait_for_widgets,
)
@@ -66,8 +65,6 @@ async def action_to_code(
):
await wait_for_widgets()
async with LambdaContext(parameters=args, where=action_id) as context:
- with LvConditional(lv_expr.is_pre_initialise()):
- context.add(RawExpression("return"))
for widget in widgets:
await action(widget)
var = cg.new_Pvariable(action_id, template_arg, await context.get_lambda())
@@ -126,7 +123,7 @@ async def lvgl_is_idle(config, condition_id, template_arg, args):
async def disp_update(disp, config: dict):
if CONF_DISP_BG_COLOR not in config and CONF_DISP_BG_IMAGE not in config:
return
- with LocalVariable("lv_disp_tmp", lv_disp_t, literal(disp)) as disp_temp:
+ with LocalVariable("lv_disp_tmp", lv_disp_t, disp) as disp_temp:
if (bg_color := config.get(CONF_DISP_BG_COLOR)) is not None:
lv.disp_set_bg_color(disp_temp, await lv_color.process(bg_color))
if bg_image := config.get(CONF_DISP_BG_IMAGE):
@@ -136,15 +133,24 @@ async def disp_update(disp, config: dict):
@automation.register_action(
"lvgl.widget.redraw",
ObjUpdateAction,
- cv.Schema(
- {
- cv.Optional(CONF_ID): cv.use_id(lv_obj_t),
- cv.GenerateID(CONF_LVGL_ID): cv.use_id(LvglComponent),
- }
+ cv.Any(
+ cv.maybe_simple_value(
+ {
+ cv.Required(CONF_ID): cv.use_id(lv_obj_t),
+ cv.GenerateID(CONF_LVGL_ID): cv.use_id(LvglComponent),
+ },
+ key=CONF_ID,
+ ),
+ cv.Schema(
+ {
+ cv.GenerateID(CONF_LVGL_ID): cv.use_id(LvglComponent),
+ }
+ ),
),
)
async def obj_invalidate_to_code(config, action_id, template_arg, args):
- widgets = await get_widgets(config) or [lv_scr_act]
+ lv_comp = await cg.get_variable(config[CONF_LVGL_ID])
+ widgets = await get_widgets(config) or [get_scr_act(lv_comp)]
async def do_invalidate(widget: Widget):
lv_obj.invalidate(widget.obj)
@@ -164,7 +170,7 @@ async def obj_invalidate_to_code(config, action_id, template_arg, args):
async def lvgl_update_to_code(config, action_id, template_arg, args):
widgets = await get_widgets(config)
w = widgets[0]
- disp = f"{w.obj}->get_disp()"
+ disp = literal(f"{w.obj}->get_disp()")
async with LambdaContext(LVGL_COMP_ARG, where=action_id) as context:
await disp_update(disp, config)
var = cg.new_Pvariable(action_id, template_arg, await context.get_lambda())
diff --git a/esphome/components/lvgl/defines.py b/esphome/components/lvgl/defines.py
index 02f726e49c..4d48028611 100644
--- a/esphome/components/lvgl/defines.py
+++ b/esphome/components/lvgl/defines.py
@@ -189,14 +189,14 @@ LV_ANIM = LvConstant(
LV_GRAD_DIR = LvConstant("LV_GRAD_DIR_", "NONE", "HOR", "VER")
LV_DITHER = LvConstant("LV_DITHER_", "NONE", "ORDERED", "ERR_DIFF")
-LOG_LEVELS = (
- "TRACE",
- "INFO",
- "WARN",
- "ERROR",
- "USER",
- "NONE",
-)
+LV_LOG_LEVELS = {
+ "VERBOSE": "TRACE",
+ "DEBUG": "TRACE",
+ "INFO": "INFO",
+ "WARN": "WARN",
+ "ERROR": "ERROR",
+ "NONE": "NONE",
+}
LV_LONG_MODES = LvConstant(
"LV_LABEL_LONG_",
@@ -408,6 +408,7 @@ CONF_DEFAULT_FONT = "default_font"
CONF_DEFAULT_GROUP = "default_group"
CONF_DIR = "dir"
CONF_DISPLAYS = "displays"
+CONF_DRAW_ROUNDING = "draw_rounding"
CONF_EDITING = "editing"
CONF_ENCODERS = "encoders"
CONF_END_ANGLE = "end_angle"
@@ -451,6 +452,8 @@ CONF_OFFSET_X = "offset_x"
CONF_OFFSET_Y = "offset_y"
CONF_ONE_CHECKED = "one_checked"
CONF_ONE_LINE = "one_line"
+CONF_ON_PAUSE = "on_pause"
+CONF_ON_RESUME = "on_resume"
CONF_ON_SELECT = "on_select"
CONF_OPA = "opa"
CONF_NEXT = "next"
@@ -466,6 +469,7 @@ CONF_POINTS = "points"
CONF_PREVIOUS = "previous"
CONF_REPEAT_COUNT = "repeat_count"
CONF_RECOLOR = "recolor"
+CONF_RESUME_ON_INPUT = "resume_on_input"
CONF_RIGHT_BUTTON = "right_button"
CONF_ROLLOVER = "rollover"
CONF_ROOT_BACK_BTN = "root_back_btn"
@@ -473,6 +477,7 @@ CONF_ROWS = "rows"
CONF_SCALE_LINES = "scale_lines"
CONF_SCROLLBAR_MODE = "scrollbar_mode"
CONF_SELECTED_INDEX = "selected_index"
+CONF_SELECTED_TEXT = "selected_text"
CONF_SHOW_SNOW = "show_snow"
CONF_SPIN_TIME = "spin_time"
CONF_SRC = "src"
diff --git a/esphome/components/lvgl/light/__init__.py b/esphome/components/lvgl/light/__init__.py
index a0eeded349..8031ae8221 100644
--- a/esphome/components/lvgl/light/__init__.py
+++ b/esphome/components/lvgl/light/__init__.py
@@ -2,9 +2,9 @@ import esphome.codegen as cg
from esphome.components import light
from esphome.components.light import LightOutput
import esphome.config_validation as cv
-from esphome.const import CONF_GAMMA_CORRECT, CONF_LED, CONF_OUTPUT_ID
+from esphome.const import CONF_GAMMA_CORRECT, CONF_OUTPUT_ID
-from ..defines import CONF_LVGL_ID
+from ..defines import CONF_LVGL_ID, CONF_WIDGET
from ..lvcode import LvContext
from ..schemas import LVGL_SCHEMA
from ..types import LvType, lvgl_ns
@@ -15,7 +15,7 @@ LVLight = lvgl_ns.class_("LVLight", LightOutput)
CONFIG_SCHEMA = light.RGB_LIGHT_SCHEMA.extend(
{
cv.Optional(CONF_GAMMA_CORRECT, default=0.0): cv.positive_float,
- cv.Required(CONF_LED): cv.use_id(lv_led_t),
+ cv.Required(CONF_WIDGET): cv.use_id(lv_led_t),
cv.GenerateID(CONF_OUTPUT_ID): cv.declare_id(LVLight),
}
).extend(LVGL_SCHEMA)
@@ -26,7 +26,7 @@ async def to_code(config):
await light.register_light(var, config)
paren = await cg.get_variable(config[CONF_LVGL_ID])
- widget = await get_widgets(config, CONF_LED)
+ widget = await get_widgets(config, CONF_WIDGET)
widget = widget[0]
await wait_for_widgets()
async with LvContext(paren) as ctx:
diff --git a/esphome/components/lvgl/lv_validation.py b/esphome/components/lvgl/lv_validation.py
index fd840cc417..b91b0905df 100644
--- a/esphome/components/lvgl/lv_validation.py
+++ b/esphome/components/lvgl/lv_validation.py
@@ -267,6 +267,9 @@ def angle(value):
return int(cv.float_range(0.0, 360.0)(cv.angle(value)) * 10)
+lv_angle = LValidator(angle, uint32)
+
+
@schema_extractor("one_of")
def size_validator(value):
"""A size in one axis - one of "size_content", a number (pixels) or a percentage"""
@@ -274,10 +277,8 @@ def size_validator(value):
return ["SIZE_CONTENT", "number of pixels", "percentage"]
if isinstance(value, str) and value.lower().endswith("px"):
value = cv.int_(value[:-2])
- if isinstance(value, str) and not value.endswith("%"):
- if value.upper() == "SIZE_CONTENT":
- return "LV_SIZE_CONTENT"
- raise cv.Invalid("must be 'size_content', a percentage or an integer (pixels)")
+ if isinstance(value, str) and value.upper() == "SIZE_CONTENT":
+ return "LV_SIZE_CONTENT"
return pixels_or_percent_validator(value)
@@ -403,6 +404,7 @@ class TextValidator(LValidator):
lv_text = TextValidator()
lv_float = LValidator(cv.float_, cg.float_)
lv_int = LValidator(cv.int_, cg.int_)
+lv_positive_int = LValidator(cv.positive_int, cg.int_)
lv_brightness = LValidator(cv.percentage, cg.float_, retmapper=lambda x: int(x * 255))
diff --git a/esphome/components/lvgl/lvcode.py b/esphome/components/lvgl/lvcode.py
index 3a080d63e9..37d6670b84 100644
--- a/esphome/components/lvgl/lvcode.py
+++ b/esphome/components/lvgl/lvcode.py
@@ -183,17 +183,11 @@ class LvContext(LambdaContext):
super().__init__(parameters=self.args)
self.lv_component = lv_component
- async def add_init_lambda(self):
- if self.code_list:
- cg.add(self.lv_component.add_init_lambda(await self.get_lambda()))
- LvContext.added_lambda_count += 1
-
async def __aexit__(self, exc_type, exc_val, exc_tb):
await super().__aexit__(exc_type, exc_val, exc_tb)
- await self.add_init_lambda()
def add(self, expression: Union[Expression, Statement]):
- self.code_list.append(self.indented_statement(expression))
+ cg.add(expression)
return expression
def __call__(self, *args):
diff --git a/esphome/components/lvgl/lvgl_esphome.cpp b/esphome/components/lvgl/lvgl_esphome.cpp
index b63fb0dab8..70cfb859de 100644
--- a/esphome/components/lvgl/lvgl_esphome.cpp
+++ b/esphome/components/lvgl/lvgl_esphome.cpp
@@ -5,16 +5,12 @@
#include "lvgl_hal.h"
#include "lvgl_esphome.h"
+#include
+
namespace esphome {
namespace lvgl {
static const char *const TAG = "lvgl";
-#if LV_USE_LOG
-static void log_cb(const char *buf) {
- esp_log_printf_(ESPHOME_LOG_LEVEL_INFO, TAG, 0, "%.*s", (int) strlen(buf) - 1, buf);
-}
-#endif // LV_USE_LOG
-
static const char *const EVENT_NAMES[] = {
"NONE",
"PRESSED",
@@ -69,30 +65,39 @@ std::string lv_event_code_name_for(uint8_t event_code) {
}
return str_sprintf("%2d", event_code);
}
+
static void rounder_cb(lv_disp_drv_t *disp_drv, lv_area_t *area) {
- // make sure all coordinates are even
- if (area->x1 & 1)
- area->x1--;
- if (!(area->x2 & 1))
- area->x2++;
- if (area->y1 & 1)
- area->y1--;
- if (!(area->y2 & 1))
- area->y2++;
+ // cater for display driver chips with special requirements for bounds of partial
+ // draw areas. Extend the draw area to satisfy:
+ // * Coordinates must be a multiple of draw_rounding
+ auto *comp = static_cast(disp_drv->user_data);
+ auto draw_rounding = comp->draw_rounding;
+ // round down the start coordinates
+ area->x1 = area->x1 / draw_rounding * draw_rounding;
+ area->y1 = area->y1 / draw_rounding * draw_rounding;
+ // round up the end coordinates
+ area->x2 = (area->x2 + draw_rounding) / draw_rounding * draw_rounding - 1;
+ area->y2 = (area->y2 + draw_rounding) / draw_rounding * draw_rounding - 1;
}
lv_event_code_t lv_api_event; // NOLINT
lv_event_code_t lv_update_event; // NOLINT
-void LvglComponent::dump_config() { ESP_LOGCONFIG(TAG, "LVGL:"); }
+void LvglComponent::dump_config() {
+ ESP_LOGCONFIG(TAG, "LVGL:");
+ ESP_LOGCONFIG(TAG, " Display width/height: %d x %d", this->disp_drv_.hor_res, this->disp_drv_.ver_res);
+ ESP_LOGCONFIG(TAG, " Rotation: %d", this->rotation);
+ ESP_LOGCONFIG(TAG, " Draw rounding: %d", (int) this->draw_rounding);
+}
void LvglComponent::set_paused(bool paused, bool show_snow) {
this->paused_ = paused;
this->show_snow_ = show_snow;
- this->snow_line_ = 0;
if (!paused && lv_scr_act() != nullptr) {
lv_disp_trig_activity(this->disp_); // resets the inactivity time
lv_obj_invalidate(lv_scr_act());
}
+ this->pause_callbacks_.call(paused);
}
+
void LvglComponent::add_event_cb(lv_obj_t *obj, event_callback_t callback, lv_event_code_t event) {
lv_obj_add_event_cb(obj, callback, event, this);
}
@@ -133,19 +138,64 @@ void LvglComponent::show_prev_page(lv_scr_load_anim_t anim, uint32_t time) {
} while (this->pages_[this->current_page_]->skip); // skip empty pages()
this->show_page(this->current_page_, anim, time);
}
-void LvglComponent::draw_buffer_(const lv_area_t *area, const uint8_t *ptr) {
+void LvglComponent::draw_buffer_(const lv_area_t *area, lv_color_t *ptr) {
+ auto width = lv_area_get_width(area);
+ auto height = lv_area_get_height(area);
+ auto x1 = area->x1;
+ auto y1 = area->y1;
+ lv_color_t *dst = this->rotate_buf_;
+ switch (this->rotation) {
+ case display::DISPLAY_ROTATION_90_DEGREES:
+ for (lv_coord_t x = height; x-- != 0;) {
+ for (lv_coord_t y = 0; y != width; y++) {
+ dst[y * height + x] = *ptr++;
+ }
+ }
+ y1 = x1;
+ x1 = this->disp_drv_.ver_res - area->y1 - height;
+ width = height;
+ height = lv_area_get_width(area);
+ break;
+
+ case display::DISPLAY_ROTATION_180_DEGREES:
+ for (lv_coord_t y = height; y-- != 0;) {
+ for (lv_coord_t x = width; x-- != 0;) {
+ dst[y * width + x] = *ptr++;
+ }
+ }
+ x1 = this->disp_drv_.hor_res - x1 - width;
+ y1 = this->disp_drv_.ver_res - y1 - height;
+ break;
+
+ case display::DISPLAY_ROTATION_270_DEGREES:
+ for (lv_coord_t x = 0; x != height; x++) {
+ for (lv_coord_t y = width; y-- != 0;) {
+ dst[y * height + x] = *ptr++;
+ }
+ }
+ x1 = y1;
+ y1 = this->disp_drv_.hor_res - area->x1 - width;
+ width = height;
+ height = lv_area_get_width(area);
+ break;
+
+ default:
+ dst = ptr;
+ break;
+ }
for (auto *display : this->displays_) {
- display->draw_pixels_at(area->x1, area->y1, lv_area_get_width(area), lv_area_get_height(area), ptr,
- display::COLOR_ORDER_RGB, LV_BITNESS, LV_COLOR_16_SWAP);
+ ESP_LOGV(TAG, "draw buffer x1=%d, y1=%d, width=%d, height=%d", x1, y1, width, height);
+ display->draw_pixels_at(x1, y1, width, height, (const uint8_t *) dst, display::COLOR_ORDER_RGB, LV_BITNESS,
+ LV_COLOR_16_SWAP);
}
}
void LvglComponent::flush_cb_(lv_disp_drv_t *disp_drv, const lv_area_t *area, lv_color_t *color_p) {
if (!this->paused_) {
auto now = millis();
- this->draw_buffer_(area, (const uint8_t *) color_p);
- ESP_LOGV(TAG, "flush_cb, area=%d/%d, %d/%d took %dms", area->x1, area->y1, lv_area_get_width(area),
- lv_area_get_height(area), (int) (millis() - now));
+ this->draw_buffer_(area, color_p);
+ ESP_LOGVV(TAG, "flush_cb, area=%d/%d, %d/%d took %dms", area->x1, area->y1, lv_area_get_width(area),
+ lv_area_get_height(area), (int) (millis() - now));
}
lv_disp_flush_ready(disp_drv);
}
@@ -160,6 +210,13 @@ IdleTrigger::IdleTrigger(LvglComponent *parent, TemplatableValue timeo
});
}
+PauseTrigger::PauseTrigger(LvglComponent *parent, TemplatableValue paused) : paused_(std::move(paused)) {
+ parent->add_on_pause_callback([this](bool pausing) {
+ if (this->paused_.value() == pausing)
+ this->trigger();
+ });
+}
+
#ifdef USE_LVGL_TOUCHSCREEN
LVTouchListener::LVTouchListener(uint16_t long_press_time, uint16_t long_press_repeat_time) {
lv_indev_drv_init(&this->drv_);
@@ -203,6 +260,39 @@ LVEncoderListener::LVEncoderListener(lv_indev_type_t type, uint16_t lpt, uint16_
}
#endif // USE_LVGL_KEY_LISTENER
+#if defined(USE_LVGL_DROPDOWN) || defined(LV_USE_ROLLER)
+std::string LvSelectable::get_selected_text() {
+ auto selected = this->get_selected_index();
+ if (selected >= this->options_.size())
+ return "";
+ return this->options_[selected];
+}
+
+static std::string join_string(std::vector options) {
+ return std::accumulate(
+ options.begin(), options.end(), std::string(),
+ [](const std::string &a, const std::string &b) -> std::string { return a + (a.length() > 0 ? "\n" : "") + b; });
+}
+
+void LvSelectable::set_selected_text(const std::string &text, lv_anim_enable_t anim) {
+ auto index = std::find(this->options_.begin(), this->options_.end(), text);
+ if (index != this->options_.end()) {
+ this->set_selected_index(index - this->options_.begin(), anim);
+ lv_event_send(this->obj, lv_api_event, nullptr);
+ }
+}
+
+void LvSelectable::set_options(std::vector options) {
+ auto index = this->get_selected_index();
+ if (index >= options.size())
+ index = options.size() - 1;
+ this->options_ = std::move(options);
+ this->set_option_string(join_string(this->options_).c_str());
+ lv_event_send(this->obj, LV_EVENT_REFRESH, nullptr);
+ this->set_selected_index(index, LV_ANIM_OFF);
+}
+#endif // USE_LVGL_DROPDOWN || LV_USE_ROLLER
+
#ifdef USE_LVGL_BUTTONMATRIX
void LvButtonMatrixType::set_obj(lv_obj_t *lv_obj) {
LvCompound::set_obj(lv_obj);
@@ -261,45 +351,75 @@ void LvKeyboardType::set_obj(lv_obj_t *lv_obj) {
#endif // USE_LVGL_KEYBOARD
void LvglComponent::write_random_() {
- // length of 2 lines in 32 bit units
- // we write 2 lines for the benefit of displays that won't write one line at a time.
- size_t line_len = this->disp_drv_.hor_res * LV_COLOR_DEPTH / 8 / 4 * 2;
- for (size_t i = 0; i != line_len; i++) {
- ((uint32_t *) (this->draw_buf_.buf1))[i] = random_uint32();
+ int iterations = 6 - lv_disp_get_inactive_time(this->disp_) / 60000;
+ if (iterations <= 0)
+ iterations = 1;
+ while (iterations-- != 0) {
+ auto col = random_uint32() % this->disp_drv_.hor_res;
+ col = col / this->draw_rounding * this->draw_rounding;
+ auto row = random_uint32() % this->disp_drv_.ver_res;
+ row = row / this->draw_rounding * this->draw_rounding;
+ auto size = (random_uint32() % 32) / this->draw_rounding * this->draw_rounding - 1;
+ lv_area_t area;
+ area.x1 = col;
+ area.y1 = row;
+ area.x2 = col + size;
+ area.y2 = row + size;
+ if (area.x2 >= this->disp_drv_.hor_res)
+ area.x2 = this->disp_drv_.hor_res - 1;
+ if (area.y2 >= this->disp_drv_.ver_res)
+ area.y2 = this->disp_drv_.ver_res - 1;
+
+ size_t line_len = lv_area_get_width(&area) * lv_area_get_height(&area) / 2;
+ for (size_t i = 0; i != line_len; i++) {
+ ((uint32_t *) (this->draw_buf_.buf1))[i] = random_uint32();
+ }
+ this->draw_buffer_(&area, (lv_color_t *) this->draw_buf_.buf1);
}
- lv_area_t area;
- area.x1 = 0;
- area.x2 = this->disp_drv_.hor_res - 1;
- if (this->snow_line_ == this->disp_drv_.ver_res / 2) {
- area.y1 = static_cast(random_uint32() % (this->disp_drv_.ver_res / 2) * 2);
- } else {
- area.y1 = this->snow_line_++ * 2;
- }
- // write 2 lines
- area.y2 = area.y1 + 1;
- this->draw_buffer_(&area, (const uint8_t *) this->draw_buf_.buf1);
}
-void LvglComponent::setup() {
- ESP_LOGCONFIG(TAG, "LVGL Setup starts");
-#if LV_USE_LOG
- lv_log_register_print_cb(log_cb);
-#endif
+/**
+ * @class LvglComponent
+ * @brief Component for rendering LVGL.
+ *
+ * This component renders LVGL widgets on a display. Some initialisation must be done in the constructor
+ * since LVGL needs to be initialised before any widgets can be created.
+ *
+ * @param displays a list of displays to render onto. All displays must have the same
+ * resolution.
+ * @param buffer_frac the fraction of the display resolution to use for the LVGL
+ * draw buffer. A higher value will make animations smoother but
+ * also increase memory usage.
+ * @param full_refresh if true, the display will be fully refreshed on every frame.
+ * If false, only changed areas will be updated.
+ * @param draw_rounding the rounding to use when drawing. A value of 1 will draw
+ * without any rounding, a value of 2 will round to the nearest
+ * multiple of 2, and so on.
+ * @param resume_on_input if true, this component will resume rendering when the user
+ * presses a key or clicks on the screen.
+ */
+LvglComponent::LvglComponent(std::vector displays, float buffer_frac, bool full_refresh,
+ int draw_rounding, bool resume_on_input)
+ : draw_rounding(draw_rounding),
+ displays_(std::move(displays)),
+ buffer_frac_(buffer_frac),
+ full_refresh_(full_refresh),
+ resume_on_input_(resume_on_input) {
lv_init();
lv_update_event = static_cast(lv_event_register_id());
lv_api_event = static_cast(lv_event_register_id());
auto *display = this->displays_[0];
size_t buffer_pixels = display->get_width() * display->get_height() / this->buffer_frac_;
auto buf_bytes = buffer_pixels * LV_COLOR_DEPTH / 8;
- auto *buf = lv_custom_mem_alloc(buf_bytes);
- if (buf == nullptr) {
-#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_ERROR
- ESP_LOGE(TAG, "Malloc failed to allocate %zu bytes", buf_bytes);
-#endif
- this->mark_failed();
- this->status_set_error("Memory allocation failure");
- return;
+ this->rotation = display->get_rotation();
+ if (this->rotation != display::DISPLAY_ROTATION_0_DEGREES) {
+ this->rotate_buf_ = static_cast(lv_custom_mem_alloc(buf_bytes)); // NOLINT
+ if (this->rotate_buf_ == nullptr)
+ return;
}
+ auto *buf = lv_custom_mem_alloc(buf_bytes); // NOLINT
+ if (buf == nullptr)
+ return;
lv_disp_draw_buf_init(&this->draw_buf_, buf, nullptr, buffer_pixels);
lv_disp_drv_init(&this->disp_drv_);
this->disp_drv_.draw_buf = &this->draw_buf_;
@@ -307,33 +427,36 @@ void LvglComponent::setup() {
this->disp_drv_.full_refresh = this->full_refresh_;
this->disp_drv_.flush_cb = static_flush_cb;
this->disp_drv_.rounder_cb = rounder_cb;
- switch (display->get_rotation()) {
- case display::DISPLAY_ROTATION_0_DEGREES:
- break;
- case display::DISPLAY_ROTATION_90_DEGREES:
- this->disp_drv_.sw_rotate = true;
- this->disp_drv_.rotated = LV_DISP_ROT_90;
- break;
- case display::DISPLAY_ROTATION_180_DEGREES:
- this->disp_drv_.sw_rotate = true;
- this->disp_drv_.rotated = LV_DISP_ROT_180;
- break;
- case display::DISPLAY_ROTATION_270_DEGREES:
- this->disp_drv_.sw_rotate = true;
- this->disp_drv_.rotated = LV_DISP_ROT_270;
- break;
- }
- display->set_rotation(display::DISPLAY_ROTATION_0_DEGREES);
this->disp_drv_.hor_res = (lv_coord_t) display->get_width();
this->disp_drv_.ver_res = (lv_coord_t) display->get_height();
- ESP_LOGV(TAG, "sw_rotate = %d, rotated=%d", this->disp_drv_.sw_rotate, this->disp_drv_.rotated);
this->disp_ = lv_disp_drv_register(&this->disp_drv_);
- for (const auto &v : this->init_lambdas_)
- v(this);
+}
+
+void LvglComponent::setup() {
+ if (this->draw_buf_.buf1 == nullptr) {
+ this->mark_failed();
+ this->status_set_error("Memory allocation failure");
+ return;
+ }
+ ESP_LOGCONFIG(TAG, "LVGL Setup starts");
+#if LV_USE_LOG
+ lv_log_register_print_cb([](const char *buf) {
+ auto next = strchr(buf, ')');
+ if (next != nullptr)
+ buf = next + 1;
+ while (isspace(*buf))
+ buf++;
+ esp_log_printf_(LVGL_LOG_LEVEL, TAG, 0, "%.*s", (int) strlen(buf) - 1, buf);
+ });
+#endif
+ // Rotation will be handled by our drawing function, so reset the display rotation.
+ for (auto *display : this->displays_)
+ display->set_rotation(display::DISPLAY_ROTATION_0_DEGREES);
this->show_page(0, LV_SCR_LOAD_ANIM_NONE, 0);
lv_disp_trig_activity(this->disp_);
ESP_LOGCONFIG(TAG, "LVGL Setup complete");
}
+
void LvglComponent::update() {
// update indicators
if (this->paused_) {
@@ -348,13 +471,6 @@ void LvglComponent::loop() {
}
lv_timer_handler_run_in_period(5);
}
-bool lv_is_pre_initialise() {
- if (!lv_is_initialized()) {
- ESP_LOGE(TAG, "LVGL call before component is initialised");
- return true;
- }
- return false;
-}
#ifdef USE_LVGL_ANIMIMG
void lv_animimg_stop(lv_obj_t *obj) {
diff --git a/esphome/components/lvgl/lvgl_esphome.h b/esphome/components/lvgl/lvgl_esphome.h
index 0c3738bd1f..f357c4950c 100644
--- a/esphome/components/lvgl/lvgl_esphome.h
+++ b/esphome/components/lvgl/lvgl_esphome.h
@@ -4,6 +4,9 @@
#ifdef USE_BINARY_SENSOR
#include "esphome/components/binary_sensor/binary_sensor.h"
#endif // USE_BINARY_SENSOR
+#ifdef USE_LVGL_IMAGE
+#include "esphome/components/image/image.h"
+#endif // USE_LVGL_IMAGE
#ifdef USE_LVGL_ROTARY_ENCODER
#include "esphome/components/rotary_encoder/rotary_encoder.h"
#endif // USE_LVGL_ROTARY_ENCODER
@@ -18,11 +21,9 @@
#include "esphome/core/component.h"
#include "esphome/core/log.h"
#include
-#include
#include