Merge branch 'dev' into dev

This commit is contained in:
CptSkippy 2024-11-15 11:44:57 -08:00 committed by GitHub
commit 44398d7dc3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
203 changed files with 12405 additions and 1471 deletions

View file

@ -75,6 +75,9 @@ target/
# pyenv # pyenv
.python-version .python-version
# asdf
.tool-versions
# celery beat schedule file # celery beat schedule file
celerybeat-schedule celerybeat-schedule

View file

@ -219,7 +219,7 @@ jobs:
. venv/bin/activate . venv/bin/activate
pytest -vv --cov-report=xml --tb=native tests pytest -vv --cov-report=xml --tb=native tests
- name: Upload coverage to Codecov - name: Upload coverage to Codecov
uses: codecov/codecov-action@v4 uses: codecov/codecov-action@v5
with: with:
token: ${{ secrets.CODECOV_TOKEN }} token: ${{ secrets.CODECOV_TOKEN }}

View file

@ -65,7 +65,7 @@ jobs:
pip3 install build pip3 install build
python3 -m build python3 -m build
- name: Publish - name: Publish
uses: pypa/gh-action-pypi-publish@v1.10.3 uses: pypa/gh-action-pypi-publish@v1.12.2
deploy-docker: deploy-docker:
name: Build ESPHome ${{ matrix.platform }} name: Build ESPHome ${{ matrix.platform }}

3
.gitignore vendored
View file

@ -75,6 +75,9 @@ cov.xml
# pyenv # pyenv
.python-version .python-version
# asdf
.tool-versions
# Environments # Environments
.env .env
.venv .venv

View file

@ -85,6 +85,7 @@ esphome/components/bmp581/* @kahrendt
esphome/components/bp1658cj/* @Cossid esphome/components/bp1658cj/* @Cossid
esphome/components/bp5758d/* @Cossid esphome/components/bp5758d/* @Cossid
esphome/components/button/* @esphome/core esphome/components/button/* @esphome/core
esphome/components/bytebuffer/* @clydebarrow
esphome/components/canbus/* @danielschramm @mvturnho esphome/components/canbus/* @danielschramm @mvturnho
esphome/components/cap1188/* @mreditor97 esphome/components/cap1188/* @mreditor97
esphome/components/captive_portal/* @OttoWinter esphome/components/captive_portal/* @OttoWinter
@ -130,6 +131,7 @@ esphome/components/ens160_base/* @latonita @vincentscode
esphome/components/ens160_i2c/* @latonita esphome/components/ens160_i2c/* @latonita
esphome/components/ens160_spi/* @latonita esphome/components/ens160_spi/* @latonita
esphome/components/ens210/* @itn3rd77 esphome/components/ens210/* @itn3rd77
esphome/components/es8311/* @kahrendt @kroimon
esphome/components/esp32/* @esphome/core esphome/components/esp32/* @esphome/core
esphome/components/esp32_ble/* @Rapsssito @jesserockz esphome/components/esp32_ble/* @Rapsssito @jesserockz
esphome/components/esp32_ble_client/* @jesserockz esphome/components/esp32_ble_client/* @jesserockz

View file

@ -32,33 +32,14 @@ RUN \
python3-setuptools=66.1.1-1 \ python3-setuptools=66.1.1-1 \
python3-venv=3.11.2-1+b1 \ python3-venv=3.11.2-1+b1 \
python3-wheel=0.38.4-2 \ python3-wheel=0.38.4-2 \
iputils-ping=3:20221126-1 \ iputils-ping=3:20221126-1+deb12u1 \
git=1:2.39.5-0+deb12u1 \ git=1:2.39.5-0+deb12u1 \
curl=7.88.1-10+deb12u7 \ curl=7.88.1-10+deb12u8 \
openssh-client=1:9.2p1-2+deb12u3 \ openssh-client=1:9.2p1-2+deb12u3 \
python3-cffi=1.15.1-5 \ python3-cffi=1.15.1-5 \
libcairo2=1.16.0-7 \ libcairo2=1.16.0-7 \
libmagic1=1:5.44-3 \ libmagic1=1:5.44-3 \
patch=2.7.6-7 \ patch=2.7.6-7 \
&& ( \
( \
[ "$TARGETARCH$TARGETVARIANT" = "armv7" ] && \
apt-get install -y --no-install-recommends \
build-essential=12.9 \
python3-dev=3.11.2-1+b1 \
zlib1g-dev=1:1.2.13.dfsg-1 \
libjpeg-dev=1:2.1.5-2 \
libfreetype-dev=2.12.1+dfsg-5+deb12u3 \
libssl-dev=3.0.14-1~deb12u2 \
libffi-dev=3.4.4-1 \
libopenjp2-7=2.5.0-2 \
libtiff6=4.5.0-6+deb12u1 \
cargo=0.66.0+ds1-1 \
pkg-config=1.8.1-1 \
gcc-arm-linux-gnueabihf=4:12.2.0-3 \
) \
|| [ "$TARGETARCH$TARGETVARIANT" != "armv7" ] \
) \
&& rm -rf \ && rm -rf \
/tmp/* \ /tmp/* \
/var/{cache,log}/* \ /var/{cache,log}/* \
@ -97,15 +78,48 @@ RUN \
# tmpfs is for https://github.com/rust-lang/cargo/issues/8719 # tmpfs is for https://github.com/rust-lang/cargo/issues/8719
COPY requirements.txt requirements_optional.txt / COPY requirements.txt requirements_optional.txt /
RUN --mount=type=tmpfs,target=/root/.cargo if [ "$TARGETARCH$TARGETVARIANT" = "armv7" ]; then \ RUN --mount=type=tmpfs,target=/root/.cargo <<END-OF-RUN
curl -L https://www.piwheels.org/cp311/cryptography-43.0.0-cp37-abi3-linux_armv7l.whl -o /tmp/cryptography-43.0.0-cp37-abi3-linux_armv7l.whl \ # Fail on any non-zero status
&& pip3 install --break-system-packages --no-cache-dir /tmp/cryptography-43.0.0-cp37-abi3-linux_armv7l.whl \ set -e
&& rm /tmp/cryptography-43.0.0-cp37-abi3-linux_armv7l.whl \
&& export PIP_EXTRA_INDEX_URL="https://www.piwheels.org/simple"; \ if [ "$TARGETARCH$TARGETVARIANT" = "armv7" ]
fi; \ then
CARGO_REGISTRIES_CRATES_IO_PROTOCOL=sparse CARGO_HOME=/root/.cargo \ curl -L https://www.piwheels.org/cp311/cryptography-43.0.0-cp37-abi3-linux_armv7l.whl -o /tmp/cryptography-43.0.0-cp37-abi3-linux_armv7l.whl
pip3 install \ pip3 install --break-system-packages --no-cache-dir /tmp/cryptography-43.0.0-cp37-abi3-linux_armv7l.whl
--break-system-packages --no-cache-dir -r /requirements.txt -r /requirements_optional.txt rm /tmp/cryptography-43.0.0-cp37-abi3-linux_armv7l.whl
export PIP_EXTRA_INDEX_URL="https://www.piwheels.org/simple";
fi
# install build tools in case wheels are not available
BUILD_DEPS="
build-essential=12.9
python3-dev=3.11.2-1+b1
zlib1g-dev=1:1.2.13.dfsg-1
libjpeg-dev=1:2.1.5-2
libfreetype-dev=2.12.1+dfsg-5+deb12u3
libssl-dev=3.0.15-1~deb12u1
libffi-dev=3.4.4-1
libopenjp2-7=2.5.0-2
libtiff6=4.5.0-6+deb12u1
cargo=0.66.0+ds1-1
pkg-config=1.8.1-1
"
if [ "$TARGETARCH$TARGETVARIANT" = "arm64" ] || [ "$TARGETARCH$TARGETVARIANT" = "armv7" ]
then
apt-get update
apt-get install -y --no-install-recommends $BUILD_DEPS
fi
CARGO_REGISTRIES_CRATES_IO_PROTOCOL=sparse CARGO_HOME=/root/.cargo
pip3 install --break-system-packages --no-cache-dir -r /requirements.txt -r /requirements_optional.txt
if [ "$TARGETARCH$TARGETVARIANT" = "arm64" ] || [ "$TARGETARCH$TARGETVARIANT" = "armv7" ]
then
apt-get remove -y --purge --auto-remove $BUILD_DEPS
rm -rf /tmp/* /var/{cache,log}/* /var/lib/apt/lists/*
fi
END-OF-RUN
COPY script/platformio_install_deps.py platformio.ini / COPY script/platformio_install_deps.py platformio.ini /
RUN /platformio_install_deps.py /platformio.ini --libraries RUN /platformio_install_deps.py /platformio.ini --libraries

View file

@ -20,6 +20,8 @@ from esphome.const import (
CONF_DEASSERT_RTS_DTR, CONF_DEASSERT_RTS_DTR,
CONF_DISABLED, CONF_DISABLED,
CONF_ESPHOME, CONF_ESPHOME,
CONF_LEVEL,
CONF_LOG_TOPIC,
CONF_LOGGER, CONF_LOGGER,
CONF_MDNS, CONF_MDNS,
CONF_MQTT, CONF_MQTT,
@ -30,6 +32,7 @@ from esphome.const import (
CONF_PLATFORMIO_OPTIONS, CONF_PLATFORMIO_OPTIONS,
CONF_PORT, CONF_PORT,
CONF_SUBSTITUTIONS, CONF_SUBSTITUTIONS,
CONF_TOPIC,
PLATFORM_BK72XX, PLATFORM_BK72XX,
PLATFORM_ESP32, PLATFORM_ESP32,
PLATFORM_ESP8266, PLATFORM_ESP8266,
@ -38,7 +41,7 @@ from esphome.const import (
SECRETS_FILES, SECRETS_FILES,
) )
from esphome.core import CORE, EsphomeError, coroutine from esphome.core import CORE, EsphomeError, coroutine
from esphome.helpers import indent, is_ip_address, get_bool_env from esphome.helpers import get_bool_env, indent, is_ip_address
from esphome.log import Fore, color, setup_log from esphome.log import Fore, color, setup_log
from esphome.util import ( from esphome.util import (
get_serial_ports, get_serial_ports,
@ -95,8 +98,12 @@ def choose_upload_log_host(
options.append((f"Over The Air ({CORE.address})", CORE.address)) options.append((f"Over The Air ({CORE.address})", CORE.address))
if default == "OTA": if default == "OTA":
return CORE.address return CORE.address
if show_mqtt and CONF_MQTT in CORE.config: if (
options.append((f"MQTT ({CORE.config['mqtt'][CONF_BROKER]})", "MQTT")) show_mqtt
and (mqtt_config := CORE.config.get(CONF_MQTT))
and mqtt_logging_enabled(mqtt_config)
):
options.append((f"MQTT ({mqtt_config[CONF_BROKER]})", "MQTT"))
if default == "OTA": if default == "OTA":
return "MQTT" return "MQTT"
if default is not None: if default is not None:
@ -106,6 +113,17 @@ def choose_upload_log_host(
return choose_prompt(options, purpose=purpose) return choose_prompt(options, purpose=purpose)
def mqtt_logging_enabled(mqtt_config):
log_topic = mqtt_config[CONF_LOG_TOPIC]
if log_topic is None:
return False
if CONF_TOPIC not in log_topic:
return False
if log_topic.get(CONF_LEVEL, None) == "NONE":
return False
return True
def get_port_type(port): def get_port_type(port):
if port.startswith("/") or port.startswith("COM"): if port.startswith("/") or port.startswith("COM"):
return "SERIAL" return "SERIAL"
@ -378,7 +396,7 @@ def show_logs(config, args, port):
port = mqtt.get_esphome_device_ip( port = mqtt.get_esphome_device_ip(
config, args.username, args.password, args.client_id config, args.username, args.password, args.client_id
) )[0]
from esphome.components.api.client import run_logs from esphome.components.api.client import run_logs

View file

@ -204,11 +204,11 @@ void BME68xBSEC2Component::update_subscription_() {
} }
void BME68xBSEC2Component::run_() { void BME68xBSEC2Component::run_() {
this->op_mode_ = this->bsec_settings_.op_mode;
int64_t curr_time_ns = this->get_time_ns_(); int64_t curr_time_ns = this->get_time_ns_();
if (curr_time_ns < this->next_call_ns_) { if (curr_time_ns < this->bsec_settings_.next_call) {
return; return;
} }
this->op_mode_ = this->bsec_settings_.op_mode;
uint8_t status; uint8_t status;
ESP_LOGV(TAG, "Performing sensor run"); ESP_LOGV(TAG, "Performing sensor run");
@ -219,9 +219,28 @@ void BME68xBSEC2Component::run_() {
ESP_LOGW(TAG, "Failed to fetch sensor control settings (BSEC2 error code %d)", this->bsec_status_); ESP_LOGW(TAG, "Failed to fetch sensor control settings (BSEC2 error code %d)", this->bsec_status_);
return; return;
} }
this->next_call_ns_ = this->bsec_settings_.next_call;
if (this->bsec_settings_.trigger_measurement) { switch (this->bsec_settings_.op_mode) {
case BME68X_FORCED_MODE:
bme68x_get_conf(&bme68x_conf, &this->bme68x_);
bme68x_conf.os_hum = this->bsec_settings_.humidity_oversampling;
bme68x_conf.os_temp = this->bsec_settings_.temperature_oversampling;
bme68x_conf.os_pres = this->bsec_settings_.pressure_oversampling;
bme68x_set_conf(&bme68x_conf, &this->bme68x_);
this->bme68x_heatr_conf_.enable = BME68X_ENABLE;
this->bme68x_heatr_conf_.heatr_temp = this->bsec_settings_.heater_temperature;
this->bme68x_heatr_conf_.heatr_dur = this->bsec_settings_.heater_duration;
// status = bme68x_set_op_mode(this->bsec_settings_.op_mode, &this->bme68x_);
status = bme68x_set_heatr_conf(BME68X_FORCED_MODE, &this->bme68x_heatr_conf_, &this->bme68x_);
status = bme68x_set_op_mode(BME68X_FORCED_MODE, &this->bme68x_);
this->op_mode_ = BME68X_FORCED_MODE;
ESP_LOGV(TAG, "Using forced mode");
break;
case BME68X_PARALLEL_MODE:
if (this->op_mode_ != this->bsec_settings_.op_mode) {
bme68x_get_conf(&bme68x_conf, &this->bme68x_); bme68x_get_conf(&bme68x_conf, &this->bme68x_);
bme68x_conf.os_hum = this->bsec_settings_.humidity_oversampling; bme68x_conf.os_hum = this->bsec_settings_.humidity_oversampling;
@ -229,22 +248,6 @@ void BME68xBSEC2Component::run_() {
bme68x_conf.os_pres = this->bsec_settings_.pressure_oversampling; bme68x_conf.os_pres = this->bsec_settings_.pressure_oversampling;
bme68x_set_conf(&bme68x_conf, &this->bme68x_); bme68x_set_conf(&bme68x_conf, &this->bme68x_);
switch (this->bsec_settings_.op_mode) {
case BME68X_FORCED_MODE:
this->bme68x_heatr_conf_.enable = BME68X_ENABLE;
this->bme68x_heatr_conf_.heatr_temp = this->bsec_settings_.heater_temperature;
this->bme68x_heatr_conf_.heatr_dur = this->bsec_settings_.heater_duration;
status = bme68x_set_op_mode(this->bsec_settings_.op_mode, &this->bme68x_);
status = bme68x_set_heatr_conf(BME68X_FORCED_MODE, &this->bme68x_heatr_conf_, &this->bme68x_);
status = bme68x_set_op_mode(BME68X_FORCED_MODE, &this->bme68x_);
this->op_mode_ = BME68X_FORCED_MODE;
this->sleep_mode_ = false;
ESP_LOGV(TAG, "Using forced mode");
break;
case BME68X_PARALLEL_MODE:
if (this->op_mode_ != this->bsec_settings_.op_mode) {
this->bme68x_heatr_conf_.enable = BME68X_ENABLE; this->bme68x_heatr_conf_.enable = BME68X_ENABLE;
this->bme68x_heatr_conf_.heatr_temp_prof = this->bsec_settings_.heater_temperature_profile; this->bme68x_heatr_conf_.heatr_temp_prof = this->bsec_settings_.heater_temperature_profile;
this->bme68x_heatr_conf_.heatr_dur_prof = this->bsec_settings_.heater_duration_profile; this->bme68x_heatr_conf_.heatr_dur_prof = this->bsec_settings_.heater_duration_profile;
@ -257,19 +260,19 @@ void BME68xBSEC2Component::run_() {
status = bme68x_set_op_mode(BME68X_PARALLEL_MODE, &this->bme68x_); status = bme68x_set_op_mode(BME68X_PARALLEL_MODE, &this->bme68x_);
this->op_mode_ = BME68X_PARALLEL_MODE; this->op_mode_ = BME68X_PARALLEL_MODE;
this->sleep_mode_ = false;
ESP_LOGV(TAG, "Using parallel mode"); ESP_LOGV(TAG, "Using parallel mode");
} }
break; break;
case BME68X_SLEEP_MODE: case BME68X_SLEEP_MODE:
if (!this->sleep_mode_) { if (this->op_mode_ != this->bsec_settings_.op_mode) {
bme68x_set_op_mode(BME68X_SLEEP_MODE, &this->bme68x_); bme68x_set_op_mode(BME68X_SLEEP_MODE, &this->bme68x_);
this->sleep_mode_ = true; this->op_mode_ = BME68X_SLEEP_MODE;
ESP_LOGV(TAG, "Using sleep mode"); ESP_LOGV(TAG, "Using sleep mode");
} }
break; break;
} }
if (this->bsec_settings_.trigger_measurement && this->bsec_settings_.op_mode != BME68X_SLEEP_MODE) {
uint32_t meas_dur = 0; uint32_t meas_dur = 0;
meas_dur = bme68x_get_meas_dur(this->op_mode_, &bme68x_conf, &this->bme68x_); meas_dur = bme68x_get_meas_dur(this->op_mode_, &bme68x_conf, &this->bme68x_);
ESP_LOGV(TAG, "Queueing read in %uus", meas_dur); ESP_LOGV(TAG, "Queueing read in %uus", meas_dur);

View file

@ -113,13 +113,11 @@ class BME68xBSEC2Component : public Component {
struct bme68x_heatr_conf bme68x_heatr_conf_; struct bme68x_heatr_conf bme68x_heatr_conf_;
uint8_t op_mode_; // operating mode of sensor uint8_t op_mode_; // operating mode of sensor
bool sleep_mode_;
bsec_library_return_t bsec_status_{BSEC_OK}; bsec_library_return_t bsec_status_{BSEC_OK};
int8_t bme68x_status_{BME68X_OK}; int8_t bme68x_status_{BME68X_OK};
int64_t last_time_ms_{0}; int64_t last_time_ms_{0};
uint32_t millis_overflow_counter_{0}; uint32_t millis_overflow_counter_{0};
int64_t next_call_ns_{0};
std::queue<std::function<void()>> queue_; std::queue<std::function<void()>> queue_;

View file

@ -0,0 +1,5 @@
CODEOWNERS = ["@clydebarrow"]
# Allows bytebuffer to be configured in yaml, to allow use of the C++ api.
CONFIG_SCHEMA = {}

View file

@ -0,0 +1,421 @@
#pragma once
#include <utility>
#include <vector>
#include <cinttypes>
#include <cstddef>
#include "esphome/core/helpers.h"
namespace esphome {
namespace bytebuffer {
enum Endian { LITTLE, BIG };
/**
* A class modelled on the Java ByteBuffer class. It wraps a vector of bytes and permits putting and getting
* items of various sizes, with an automatically incremented position.
*
* There are three variables maintained pointing into the buffer:
*
* capacity: the maximum amount of data that can be stored - set on construction and cannot be changed
* limit: the limit of the data currently available to get or put
* position: the current insert or extract position
*
* 0 <= position <= limit <= capacity
*
* In addition a mark can be set to the current position with mark(). A subsequent call to reset() will restore
* the position to the mark.
*
* The buffer can be marked to be little-endian (default) or big-endian. All subsequent operations will use that order.
*
* The flip() operation will reset the position to 0 and limit to the current position. This is useful for reading
* data from a buffer after it has been written.
*
* The code is defined here in the header file rather than in a .cpp file, so that it does not get compiled if not used.
* The templated functions ensure that only those typed functions actually used are compiled. The functions
* are implicitly inline-able which will aid performance.
*/
class ByteBuffer {
public:
// Default constructor (compatibility with TEMPLATABLE_VALUE)
// Creates a zero-length ByteBuffer which is little use to anybody.
ByteBuffer() : ByteBuffer(std::vector<uint8_t>()) {}
/**
* Create a new Bytebuffer with the given capacity
*/
ByteBuffer(size_t capacity, Endian endianness = LITTLE)
: data_(std::vector<uint8_t>(capacity)), endianness_(endianness), limit_(capacity){};
// templated functions to implement putting and getting data of various types. There are two flavours of all
// functions - one that uses the position as the offset, and updates the position accordingly, and one that
// takes an explicit offset and does not update the position.
// Separate temnplates are provided for types that fit into 32 bits and those that are bigger. These delegate
// the actual put/get to common code based around those sizes.
// This reduces the code size and execution time for smaller types. A similar structure for e.g. 16 bits is unlikely
// to provide any further benefit given that all target platforms are native 32 bit.
template<typename T>
T get(typename std::enable_if<std::is_integral<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) <= sizeof(uint32_t)), T>::type * = 0) {
// integral types that fit into 32 bit
return static_cast<T>(this->get_uint32_(sizeof(T)));
}
template<typename T>
T get(size_t offset, typename std::enable_if<std::is_integral<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) <= sizeof(uint32_t)), T>::type * = 0) {
return static_cast<T>(this->get_uint32_(offset, sizeof(T)));
}
template<typename T>
void put(const T &value, typename std::enable_if<std::is_integral<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) <= sizeof(uint32_t)), T>::type * = 0) {
this->put_uint32_(static_cast<uint32_t>(value), sizeof(T));
}
template<typename T>
void put(const T &value, size_t offset, typename std::enable_if<std::is_integral<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) <= sizeof(uint32_t)), T>::type * = 0) {
this->put_uint32_(static_cast<uint32_t>(value), offset, sizeof(T));
}
// integral types that do not fit into 32 bit (basically only 64 bit types)
template<typename T>
T get(typename std::enable_if<std::is_integral<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) == sizeof(uint64_t)), T>::type * = 0) {
return static_cast<T>(this->get_uint64_(sizeof(T)));
}
template<typename T>
T get(size_t offset, typename std::enable_if<std::is_integral<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) == sizeof(uint64_t)), T>::type * = 0) {
return static_cast<T>(this->get_uint64_(offset, sizeof(T)));
}
template<typename T>
void put(const T &value, typename std::enable_if<std::is_integral<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) == sizeof(uint64_t)), T>::type * = 0) {
this->put_uint64_(value, sizeof(T));
}
template<typename T>
void put(const T &value, size_t offset, typename std::enable_if<std::is_integral<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) == sizeof(uint64_t)), T>::type * = 0) {
this->put_uint64_(static_cast<uint64_t>(value), offset, sizeof(T));
}
// floating point types. Caters for 32 and 64 bit floating point.
template<typename T>
T get(typename std::enable_if<std::is_floating_point<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) == sizeof(uint32_t)), T>::type * = 0) {
return bit_cast<T>(this->get_uint32_(sizeof(T)));
}
template<typename T>
T get(typename std::enable_if<std::is_floating_point<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) == sizeof(uint64_t)), T>::type * = 0) {
return bit_cast<T>(this->get_uint64_(sizeof(T)));
}
template<typename T>
T get(size_t offset, typename std::enable_if<std::is_floating_point<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) == sizeof(uint32_t)), T>::type * = 0) {
return bit_cast<T>(this->get_uint32_(offset, sizeof(T)));
}
template<typename T>
T get(size_t offset, typename std::enable_if<std::is_floating_point<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) == sizeof(uint64_t)), T>::type * = 0) {
return bit_cast<T>(this->get_uint64_(offset, sizeof(T)));
}
template<typename T>
void put(const T &value, typename std::enable_if<std::is_floating_point<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) <= sizeof(uint32_t)), T>::type * = 0) {
this->put_uint32_(bit_cast<uint32_t>(value), sizeof(T));
}
template<typename T>
void put(const T &value, typename std::enable_if<std::is_floating_point<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) == sizeof(uint64_t)), T>::type * = 0) {
this->put_uint64_(bit_cast<uint64_t>(value), sizeof(T));
}
template<typename T>
void put(const T &value, size_t offset, typename std::enable_if<std::is_floating_point<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) <= sizeof(uint32_t)), T>::type * = 0) {
this->put_uint32_(bit_cast<uint32_t>(value), offset, sizeof(T));
}
template<typename T>
void put(const T &value, size_t offset, typename std::enable_if<std::is_floating_point<T>::value, T>::type * = 0,
typename std::enable_if<(sizeof(T) == sizeof(uint64_t)), T>::type * = 0) {
this->put_uint64_(bit_cast<uint64_t>(value), offset, sizeof(T));
}
template<typename T> static ByteBuffer wrap(T value, Endian endianness = LITTLE) {
ByteBuffer buffer = ByteBuffer(sizeof(T), endianness);
buffer.put(value);
buffer.flip();
return buffer;
}
static ByteBuffer wrap(std::vector<uint8_t> const &data, Endian endianness = LITTLE) {
ByteBuffer buffer = {data};
buffer.endianness_ = endianness;
return buffer;
}
static ByteBuffer wrap(const uint8_t *ptr, size_t len, Endian endianness = LITTLE) {
return wrap(std::vector<uint8_t>(ptr, ptr + len), endianness);
}
// convenience functions with explicit types named..
void put_float(float value) { this->put(value); }
void put_double(double value) { this->put(value); }
uint8_t get_uint8() { return this->data_[this->position_++]; }
// Get a 16 bit unsigned value, increment by 2
uint16_t get_uint16() { return this->get<uint16_t>(); }
// Get a 24 bit unsigned value, increment by 3
uint32_t get_uint24() { return this->get_uint32_(3); };
// Get a 32 bit unsigned value, increment by 4
uint32_t get_uint32() { return this->get<uint32_t>(); };
// Get a 64 bit unsigned value, increment by 8
uint64_t get_uint64() { return this->get<uint64_t>(); };
// Signed versions of the get functions
uint8_t get_int8() { return static_cast<int8_t>(this->get_uint8()); };
int16_t get_int16() { return this->get<uint16_t>(); }
int32_t get_int32() { return this->get<int32_t>(); }
int64_t get_int64() { return this->get<int64_t>(); }
// Get a float value, increment by 4
float get_float() { return this->get<float>(); }
// Get a double value, increment by 8
double get_double() { return this->get<double>(); }
// Get a bool value, increment by 1
bool get_bool() { return static_cast<bool>(this->get_uint8()); }
uint32_t get_int24(size_t offset) {
auto value = this->get_uint24(offset);
uint32_t mask = (~static_cast<uint32_t>(0)) << 23;
if ((value & mask) != 0)
value |= mask;
return value;
}
uint32_t get_int24() {
auto value = this->get_uint24();
uint32_t mask = (~static_cast<uint32_t>(0)) << 23;
if ((value & mask) != 0)
value |= mask;
return value;
}
std::vector<uint8_t> get_vector(size_t length, size_t offset) {
auto start = this->data_.begin() + offset;
return {start, start + length};
}
std::vector<uint8_t> get_vector(size_t length) {
auto result = this->get_vector(length, this->position_);
this->position_ += length;
return result;
}
// Convenience named functions
void put_uint8(uint8_t value) { this->data_[this->position_++] = value; }
void put_uint16(uint16_t value) { this->put(value); }
void put_uint24(uint32_t value) { this->put_uint32_(value, 3); }
void put_uint32(uint32_t value) { this->put(value); }
void put_uint64(uint64_t value) { this->put(value); }
// Signed versions of the put functions
void put_int8(int8_t value) { this->put_uint8(static_cast<uint8_t>(value)); }
void put_int16(int16_t value) { this->put(value); }
void put_int24(int32_t value) { this->put_uint32_(value, 3); }
void put_int32(int32_t value) { this->put(value); }
void put_int64(int64_t value) { this->put(value); }
// Extra put functions
void put_bool(bool value) { this->put_uint8(value); }
// versions of the above with an offset, these do not update the position
uint64_t get_uint64(size_t offset) { return this->get<uint64_t>(offset); }
uint32_t get_uint24(size_t offset) { return this->get_uint32_(offset, 3); };
double get_double(size_t offset) { return get<double>(offset); }
// Get one byte from the buffer, increment position by 1
uint8_t get_uint8(size_t offset) { return this->data_[offset]; }
// Get a 16 bit unsigned value, increment by 2
uint16_t get_uint16(size_t offset) { return get<uint16_t>(offset); }
// Get a 24 bit unsigned value, increment by 3
uint32_t get_uint32(size_t offset) { return this->get<uint32_t>(offset); };
// Get a 64 bit unsigned value, increment by 8
uint8_t get_int8(size_t offset) { return get<int8_t>(offset); }
int16_t get_int16(size_t offset) { return get<int16_t>(offset); }
int32_t get_int32(size_t offset) { return get<int32_t>(offset); }
int64_t get_int64(size_t offset) { return get<int64_t>(offset); }
// Get a float value, increment by 4
float get_float(size_t offset) { return get<float>(offset); }
// Get a double value, increment by 8
// Get a bool value, increment by 1
bool get_bool(size_t offset) { return this->get_uint8(offset); }
void put_uint8(uint8_t value, size_t offset) { this->data_[offset] = value; }
void put_uint16(uint16_t value, size_t offset) { this->put(value, offset); }
void put_uint24(uint32_t value, size_t offset) { this->put(value, offset); }
void put_uint32(uint32_t value, size_t offset) { this->put(value, offset); }
void put_uint64(uint64_t value, size_t offset) { this->put(value, offset); }
// Signed versions of the put functions
void put_int8(int8_t value, size_t offset) { this->put_uint8(static_cast<uint8_t>(value), offset); }
void put_int16(int16_t value, size_t offset) { this->put(value, offset); }
void put_int24(int32_t value, size_t offset) { this->put_uint32_(value, offset, 3); }
void put_int32(int32_t value, size_t offset) { this->put(value, offset); }
void put_int64(int64_t value, size_t offset) { this->put(value, offset); }
// Extra put functions
void put_float(float value, size_t offset) { this->put(value, offset); }
void put_double(double value, size_t offset) { this->put(value, offset); }
void put_bool(bool value, size_t offset) { this->put_uint8(value, offset); }
void put(const std::vector<uint8_t> &value, size_t offset) {
std::copy(value.begin(), value.end(), this->data_.begin() + offset);
}
void put_vector(const std::vector<uint8_t> &value, size_t offset) { this->put(value, offset); }
void put(const std::vector<uint8_t> &value) {
this->put_vector(value, this->position_);
this->position_ += value.size();
}
void put_vector(const std::vector<uint8_t> &value) { this->put(value); }
// Getters
inline size_t get_capacity() const { return this->data_.size(); }
inline size_t get_position() const { return this->position_; }
inline size_t get_limit() const { return this->limit_; }
inline size_t get_remaining() const { return this->get_limit() - this->get_position(); }
inline Endian get_endianness() const { return this->endianness_; }
inline void mark() { this->mark_ = this->position_; }
inline void big_endian() { this->endianness_ = BIG; }
inline void little_endian() { this->endianness_ = LITTLE; }
// retrieve a pointer to the underlying data.
std::vector<uint8_t> get_data() { return this->data_; };
void get_bytes(void *dest, size_t length) {
std::copy(this->data_.begin() + this->position_, this->data_.begin() + this->position_ + length, (uint8_t *) dest);
this->position_ += length;
}
void get_bytes(void *dest, size_t length, size_t offset) {
std::copy(this->data_.begin() + offset, this->data_.begin() + offset + length, (uint8_t *) dest);
}
void rewind() { this->position_ = 0; }
void reset() { this->position_ = this->mark_; }
void set_limit(size_t limit) { this->limit_ = limit; }
void set_position(size_t position) { this->position_ = position; }
void clear() {
this->limit_ = this->get_capacity();
this->position_ = 0;
}
void flip() {
this->limit_ = this->position_;
this->position_ = 0;
}
protected:
uint64_t get_uint64_(size_t offset, size_t length) const {
uint64_t value = 0;
if (this->endianness_ == LITTLE) {
offset += length;
while (length-- != 0) {
value <<= 8;
value |= this->data_[--offset];
}
} else {
while (length-- != 0) {
value <<= 8;
value |= this->data_[offset++];
}
}
return value;
}
uint64_t get_uint64_(size_t length) {
auto result = this->get_uint64_(this->position_, length);
this->position_ += length;
return result;
}
uint32_t get_uint32_(size_t offset, size_t length) const {
uint32_t value = 0;
if (this->endianness_ == LITTLE) {
offset += length;
while (length-- != 0) {
value <<= 8;
value |= this->data_[--offset];
}
} else {
while (length-- != 0) {
value <<= 8;
value |= this->data_[offset++];
}
}
return value;
}
uint32_t get_uint32_(size_t length) {
auto result = this->get_uint32_(this->position_, length);
this->position_ += length;
return result;
}
/// Putters
void put_uint64_(uint64_t value, size_t length) {
this->put_uint64_(value, this->position_, length);
this->position_ += length;
}
void put_uint32_(uint32_t value, size_t length) {
this->put_uint32_(value, this->position_, length);
this->position_ += length;
}
void put_uint64_(uint64_t value, size_t offset, size_t length) {
if (this->endianness_ == LITTLE) {
while (length-- != 0) {
this->data_[offset++] = static_cast<uint8_t>(value);
value >>= 8;
}
} else {
offset += length;
while (length-- != 0) {
this->data_[--offset] = static_cast<uint8_t>(value);
value >>= 8;
}
}
}
void put_uint32_(uint32_t value, size_t offset, size_t length) {
if (this->endianness_ == LITTLE) {
while (length-- != 0) {
this->data_[offset++] = static_cast<uint8_t>(value);
value >>= 8;
}
} else {
offset += length;
while (length-- != 0) {
this->data_[--offset] = static_cast<uint8_t>(value);
value >>= 8;
}
}
}
ByteBuffer(std::vector<uint8_t> const &data) : data_(data), limit_(data.size()) {}
std::vector<uint8_t> data_;
Endian endianness_{LITTLE};
size_t position_{0};
size_t mark_{0};
size_t limit_{0};
};
} // namespace bytebuffer
} // namespace esphome

View file

@ -119,10 +119,21 @@ visual_temperature = cv.float_with_unit(
) )
def single_visual_temperature(value): VISUAL_TEMPERATURE_STEP_SCHEMA = cv.Schema(
if isinstance(value, dict): {
return value cv.Required(CONF_TARGET_TEMPERATURE): visual_temperature,
cv.Required(CONF_CURRENT_TEMPERATURE): visual_temperature,
}
)
def visual_temperature_step(value):
# Allow defining target/current temperature steps separately
if isinstance(value, dict):
return VISUAL_TEMPERATURE_STEP_SCHEMA(value)
# Otherwise, use the single value for both properties
value = visual_temperature(value) value = visual_temperature(value)
return VISUAL_TEMPERATURE_STEP_SCHEMA( return VISUAL_TEMPERATURE_STEP_SCHEMA(
{ {
@ -141,16 +152,6 @@ ControlTrigger = climate_ns.class_(
"ControlTrigger", automation.Trigger.template(ClimateCall.operator("ref")) "ControlTrigger", automation.Trigger.template(ClimateCall.operator("ref"))
) )
VISUAL_TEMPERATURE_STEP_SCHEMA = cv.Any(
single_visual_temperature,
cv.Schema(
{
cv.Required(CONF_TARGET_TEMPERATURE): visual_temperature,
cv.Required(CONF_CURRENT_TEMPERATURE): visual_temperature,
}
),
)
CLIMATE_SCHEMA = ( CLIMATE_SCHEMA = (
cv.ENTITY_BASE_SCHEMA.extend(web_server.WEBSERVER_SORTING_SCHEMA) cv.ENTITY_BASE_SCHEMA.extend(web_server.WEBSERVER_SORTING_SCHEMA)
.extend(cv.MQTT_COMMAND_COMPONENT_SCHEMA) .extend(cv.MQTT_COMMAND_COMPONENT_SCHEMA)
@ -162,7 +163,7 @@ CLIMATE_SCHEMA = (
{ {
cv.Optional(CONF_MIN_TEMPERATURE): cv.temperature, cv.Optional(CONF_MIN_TEMPERATURE): cv.temperature,
cv.Optional(CONF_MAX_TEMPERATURE): cv.temperature, cv.Optional(CONF_MAX_TEMPERATURE): cv.temperature,
cv.Optional(CONF_TEMPERATURE_STEP): VISUAL_TEMPERATURE_STEP_SCHEMA, cv.Optional(CONF_TEMPERATURE_STEP): visual_temperature_step,
cv.Optional(CONF_MIN_HUMIDITY): cv.percentage_int, cv.Optional(CONF_MIN_HUMIDITY): cv.percentage_int,
cv.Optional(CONF_MAX_HUMIDITY): cv.percentage_int, cv.Optional(CONF_MAX_HUMIDITY): cv.percentage_int,
} }

View file

@ -70,8 +70,6 @@ def _validate_time_present(config):
_DATETIME_SCHEMA = cv.ENTITY_BASE_SCHEMA.extend( _DATETIME_SCHEMA = cv.ENTITY_BASE_SCHEMA.extend(
web_server.WEBSERVER_SORTING_SCHEMA,
cv.MQTT_COMMAND_COMPONENT_SCHEMA,
cv.Schema( cv.Schema(
{ {
cv.Optional(CONF_ON_VALUE): automation.validate_automation( cv.Optional(CONF_ON_VALUE): automation.validate_automation(
@ -81,7 +79,9 @@ _DATETIME_SCHEMA = cv.ENTITY_BASE_SCHEMA.extend(
), ),
cv.Optional(CONF_TIME_ID): cv.use_id(time.RealTimeClock), cv.Optional(CONF_TIME_ID): cv.use_id(time.RealTimeClock),
} }
), )
.extend(web_server.WEBSERVER_SORTING_SCHEMA)
.extend(cv.MQTT_COMMAND_COMPONENT_SCHEMA)
).add_extra(_validate_time_present) ).add_extra(_validate_time_present)

View file

@ -6,7 +6,104 @@ namespace dfplayer {
static const char *const TAG = "dfplayer"; static const char *const TAG = "dfplayer";
void DFPlayer::next() {
this->ack_set_is_playing_ = true;
ESP_LOGD(TAG, "Playing next track");
this->send_cmd_(0x01);
}
void DFPlayer::previous() {
this->ack_set_is_playing_ = true;
ESP_LOGD(TAG, "Playing previous track");
this->send_cmd_(0x02);
}
void DFPlayer::play_mp3(uint16_t file) {
this->ack_set_is_playing_ = true;
ESP_LOGD(TAG, "Playing file %d in mp3 folder", file);
this->send_cmd_(0x12, file);
}
void DFPlayer::play_file(uint16_t file) {
this->ack_set_is_playing_ = true;
ESP_LOGD(TAG, "Playing file %d", file);
this->send_cmd_(0x03, file);
}
void DFPlayer::play_file_loop(uint16_t file) {
this->ack_set_is_playing_ = true;
ESP_LOGD(TAG, "Playing file %d in loop", file);
this->send_cmd_(0x08, file);
}
void DFPlayer::play_folder_loop(uint16_t folder) {
this->ack_set_is_playing_ = true;
ESP_LOGD(TAG, "Playing folder %d in loop", folder);
this->send_cmd_(0x17, folder);
}
void DFPlayer::volume_up() {
ESP_LOGD(TAG, "Increasing volume");
this->send_cmd_(0x04);
}
void DFPlayer::volume_down() {
ESP_LOGD(TAG, "Decreasing volume");
this->send_cmd_(0x05);
}
void DFPlayer::set_device(Device device) {
ESP_LOGD(TAG, "Setting device to %d", device);
this->send_cmd_(0x09, device);
}
void DFPlayer::set_volume(uint8_t volume) {
ESP_LOGD(TAG, "Setting volume to %d", volume);
this->send_cmd_(0x06, volume);
}
void DFPlayer::set_eq(EqPreset preset) {
ESP_LOGD(TAG, "Setting EQ to %d", preset);
this->send_cmd_(0x07, preset);
}
void DFPlayer::sleep() {
this->ack_reset_is_playing_ = true;
ESP_LOGD(TAG, "Putting DFPlayer to sleep");
this->send_cmd_(0x0A);
}
void DFPlayer::reset() {
this->ack_reset_is_playing_ = true;
ESP_LOGD(TAG, "Resetting DFPlayer");
this->send_cmd_(0x0C);
}
void DFPlayer::start() {
this->ack_set_is_playing_ = true;
ESP_LOGD(TAG, "Starting playback");
this->send_cmd_(0x0D);
}
void DFPlayer::pause() {
this->ack_reset_is_playing_ = true;
ESP_LOGD(TAG, "Pausing playback");
this->send_cmd_(0x0E);
}
void DFPlayer::stop() {
this->ack_reset_is_playing_ = true;
ESP_LOGD(TAG, "Stopping playback");
this->send_cmd_(0x16);
}
void DFPlayer::random() {
this->ack_set_is_playing_ = true;
ESP_LOGD(TAG, "Playing random file");
this->send_cmd_(0x18);
}
void DFPlayer::play_folder(uint16_t folder, uint16_t file) { void DFPlayer::play_folder(uint16_t folder, uint16_t file) {
ESP_LOGD(TAG, "Playing file %d in folder %d", file, folder);
if (folder < 100 && file < 256) { if (folder < 100 && file < 256) {
this->ack_set_is_playing_ = true; this->ack_set_is_playing_ = true;
this->send_cmd_(0x0F, (uint8_t) folder, (uint8_t) file); this->send_cmd_(0x0F, (uint8_t) folder, (uint8_t) file);
@ -29,7 +126,7 @@ void DFPlayer::send_cmd_(uint8_t cmd, uint16_t argument) {
this->sent_cmd_ = cmd; this->sent_cmd_ = cmd;
ESP_LOGD(TAG, "Send Command %#02x arg %#04x", cmd, argument); ESP_LOGV(TAG, "Send Command %#02x arg %#04x", cmd, argument);
this->write_array(buffer, 10); this->write_array(buffer, 10);
} }
@ -101,9 +198,37 @@ void DFPlayer::loop() {
ESP_LOGV(TAG, "Nack"); ESP_LOGV(TAG, "Nack");
this->ack_set_is_playing_ = false; this->ack_set_is_playing_ = false;
this->ack_reset_is_playing_ = false; this->ack_reset_is_playing_ = false;
if (argument == 6) { switch (argument) {
ESP_LOGV(TAG, "File not found"); case 0x01:
ESP_LOGE(TAG, "Module is busy or uninitialized");
break;
case 0x02:
ESP_LOGE(TAG, "Module is in sleep mode");
break;
case 0x03:
ESP_LOGE(TAG, "Serial receive error");
break;
case 0x04:
ESP_LOGE(TAG, "Checksum incorrect");
break;
case 0x05:
ESP_LOGE(TAG, "Specified track is out of current track scope");
this->is_playing_ = false; this->is_playing_ = false;
break;
case 0x06:
ESP_LOGE(TAG, "Specified track is not found");
this->is_playing_ = false;
break;
case 0x07:
ESP_LOGE(TAG, "Insertion error (an inserting operation only can be done when a track is being played)");
break;
case 0x08:
ESP_LOGE(TAG, "SD card reading failed (SD card pulled out or damaged)");
break;
case 0x09:
ESP_LOGE(TAG, "Entered into sleep mode");
this->is_playing_ = false;
break;
} }
break; break;
case 0x41: case 0x41:
@ -113,12 +238,13 @@ void DFPlayer::loop() {
this->ack_set_is_playing_ = false; this->ack_set_is_playing_ = false;
this->ack_reset_is_playing_ = false; this->ack_reset_is_playing_ = false;
break; break;
case 0x3D: // Playback finished case 0x3D:
ESP_LOGV(TAG, "Playback finished");
this->is_playing_ = false; this->is_playing_ = false;
this->on_finished_playback_callback_.call(); this->on_finished_playback_callback_.call();
break; break;
default: default:
ESP_LOGD(TAG, "Command %#02x arg %#04x", cmd, argument); ESP_LOGV(TAG, "Received unknown cmd %#02x arg %#04x", cmd, argument);
} }
this->sent_cmd_ = 0; this->sent_cmd_ = 0;
this->read_pos_ = 0; this->read_pos_ = 0;

View file

@ -23,64 +23,30 @@ enum Device {
TF_CARD = 2, TF_CARD = 2,
}; };
// See the datasheet here:
// https://github.com/DFRobot/DFRobotDFPlayerMini/blob/master/doc/FN-M16P%2BEmbedded%2BMP3%2BAudio%2BModule%2BDatasheet.pdf
class DFPlayer : public uart::UARTDevice, public Component { class DFPlayer : public uart::UARTDevice, public Component {
public: public:
void loop() override; void loop() override;
void next() { void next();
this->ack_set_is_playing_ = true; void previous();
this->send_cmd_(0x01); void play_mp3(uint16_t file);
} void play_file(uint16_t file);
void previous() { void play_file_loop(uint16_t file);
this->ack_set_is_playing_ = true;
this->send_cmd_(0x02);
}
void play_mp3(uint16_t file) {
this->ack_set_is_playing_ = true;
this->send_cmd_(0x12, file);
}
void play_file(uint16_t file) {
this->ack_set_is_playing_ = true;
this->send_cmd_(0x03, file);
}
void play_file_loop(uint16_t file) {
this->ack_set_is_playing_ = true;
this->send_cmd_(0x08, file);
}
void play_folder(uint16_t folder, uint16_t file); void play_folder(uint16_t folder, uint16_t file);
void play_folder_loop(uint16_t folder) { void play_folder_loop(uint16_t folder);
this->ack_set_is_playing_ = true; void volume_up();
this->send_cmd_(0x17, folder); void volume_down();
} void set_device(Device device);
void volume_up() { this->send_cmd_(0x04); } void set_volume(uint8_t volume);
void volume_down() { this->send_cmd_(0x05); } void set_eq(EqPreset preset);
void set_device(Device device) { this->send_cmd_(0x09, device); } void sleep();
void set_volume(uint8_t volume) { this->send_cmd_(0x06, volume); } void reset();
void set_eq(EqPreset preset) { this->send_cmd_(0x07, preset); } void start();
void sleep() { void pause();
this->ack_reset_is_playing_ = true; void stop();
this->send_cmd_(0x0A); void random();
}
void reset() {
this->ack_reset_is_playing_ = true;
this->send_cmd_(0x0C);
}
void start() {
this->ack_set_is_playing_ = true;
this->send_cmd_(0x0D);
}
void pause() {
this->ack_reset_is_playing_ = true;
this->send_cmd_(0x0E);
}
void stop() {
this->ack_reset_is_playing_ = true;
this->send_cmd_(0x16);
}
void random() {
this->ack_set_is_playing_ = true;
this->send_cmd_(0x18);
}
bool is_playing() { return is_playing_; } bool is_playing() { return is_playing_; }
void dump_config() override; void dump_config() override;

View file

View file

@ -0,0 +1,70 @@
import esphome.codegen as cg
from esphome.components import i2c
from esphome.components.audio_dac import AudioDac
import esphome.config_validation as cv
from esphome.const import CONF_BITS_PER_SAMPLE, CONF_ID, CONF_SAMPLE_RATE
CODEOWNERS = ["@kroimon", "@kahrendt"]
DEPENDENCIES = ["i2c"]
es8311_ns = cg.esphome_ns.namespace("es8311")
ES8311 = es8311_ns.class_("ES8311", AudioDac, cg.Component, i2c.I2CDevice)
CONF_MIC_GAIN = "mic_gain"
CONF_USE_MCLK = "use_mclk"
CONF_USE_MICROPHONE = "use_microphone"
es8311_resolution = es8311_ns.enum("ES8311Resolution")
ES8311_BITS_PER_SAMPLE_ENUM = {
16: es8311_resolution.ES8311_RESOLUTION_16,
24: es8311_resolution.ES8311_RESOLUTION_24,
32: es8311_resolution.ES8311_RESOLUTION_32,
}
es8311_mic_gain = es8311_ns.enum("ES8311MicGain")
ES8311_MIC_GAIN_ENUM = {
"MIN": es8311_mic_gain.ES8311_MIC_GAIN_MIN,
"0DB": es8311_mic_gain.ES8311_MIC_GAIN_0DB,
"6DB": es8311_mic_gain.ES8311_MIC_GAIN_6DB,
"12DB": es8311_mic_gain.ES8311_MIC_GAIN_12DB,
"18DB": es8311_mic_gain.ES8311_MIC_GAIN_18DB,
"24DB": es8311_mic_gain.ES8311_MIC_GAIN_24DB,
"30DB": es8311_mic_gain.ES8311_MIC_GAIN_30DB,
"36DB": es8311_mic_gain.ES8311_MIC_GAIN_36DB,
"42DB": es8311_mic_gain.ES8311_MIC_GAIN_42DB,
"MAX": es8311_mic_gain.ES8311_MIC_GAIN_MAX,
}
_validate_bits = cv.float_with_unit("bits", "bit")
CONFIG_SCHEMA = (
cv.Schema(
{
cv.GenerateID(): cv.declare_id(ES8311),
cv.Optional(CONF_BITS_PER_SAMPLE, default="16bit"): cv.All(
_validate_bits, cv.enum(ES8311_BITS_PER_SAMPLE_ENUM)
),
cv.Optional(CONF_MIC_GAIN, default="42DB"): cv.enum(
ES8311_MIC_GAIN_ENUM, upper=True
),
cv.Optional(CONF_SAMPLE_RATE, default=16000): cv.int_range(min=1),
cv.Optional(CONF_USE_MCLK, default=True): cv.boolean,
cv.Optional(CONF_USE_MICROPHONE, default=False): cv.boolean,
}
)
.extend(cv.COMPONENT_SCHEMA)
.extend(i2c.i2c_device_schema(0x18))
)
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)
cg.add(var.set_bits_per_sample(config[CONF_BITS_PER_SAMPLE]))
cg.add(var.set_mic_gain(config[CONF_MIC_GAIN]))
cg.add(var.set_sample_frequency(config[CONF_SAMPLE_RATE]))
cg.add(var.set_use_mclk(config[CONF_USE_MCLK]))
cg.add(var.set_use_mic(config[CONF_USE_MICROPHONE]))

View file

@ -0,0 +1,227 @@
#include "es8311.h"
#include "es8311_const.h"
#include "esphome/core/hal.h"
#include "esphome/core/log.h"
#include <cinttypes>
namespace esphome {
namespace es8311 {
static const char *const TAG = "es8311";
// Mark the component as failed; use only in setup
#define ES8311_ERROR_FAILED(func) \
if (!(func)) { \
this->mark_failed(); \
return; \
}
// Return false; use outside of setup
#define ES8311_ERROR_CHECK(func) \
if (!(func)) { \
return false; \
}
void ES8311::setup() {
ESP_LOGCONFIG(TAG, "Setting up ES8311...");
// Reset
ES8311_ERROR_FAILED(this->write_byte(ES8311_REG00_RESET, 0x1F));
ES8311_ERROR_FAILED(this->write_byte(ES8311_REG00_RESET, 0x00));
ES8311_ERROR_FAILED(this->configure_clock_());
ES8311_ERROR_FAILED(this->configure_format_());
ES8311_ERROR_FAILED(this->configure_mic_());
// Set initial volume
this->set_volume(0.75); // 0.75 = 0xBF = 0dB
// Power up analog circuitry
ES8311_ERROR_FAILED(this->write_byte(ES8311_REG0D_SYSTEM, 0x01));
// Enable analog PGA, enable ADC modulator
ES8311_ERROR_FAILED(this->write_byte(ES8311_REG0E_SYSTEM, 0x02));
// Power up DAC
ES8311_ERROR_FAILED(this->write_byte(ES8311_REG12_SYSTEM, 0x00));
// Enable output to HP drive
ES8311_ERROR_FAILED(this->write_byte(ES8311_REG13_SYSTEM, 0x10));
// ADC Equalizer bypass, cancel DC offset in digital domain
ES8311_ERROR_FAILED(this->write_byte(ES8311_REG1C_ADC, 0x6A));
// Bypass DAC equalizer
ES8311_ERROR_FAILED(this->write_byte(ES8311_REG37_DAC, 0x08));
// Power On
ES8311_ERROR_FAILED(this->write_byte(ES8311_REG00_RESET, 0x80));
}
void ES8311::dump_config() {
ESP_LOGCONFIG(TAG, "ES8311 Audio Codec:");
ESP_LOGCONFIG(TAG, " Use MCLK: %s", YESNO(this->use_mclk_));
ESP_LOGCONFIG(TAG, " Use Microphone: %s", YESNO(this->use_mic_));
ESP_LOGCONFIG(TAG, " DAC Bits per Sample: %" PRIu8, this->resolution_out_);
ESP_LOGCONFIG(TAG, " Sample Rate: %" PRIu32, this->sample_frequency_);
if (this->is_failed()) {
ESP_LOGCONFIG(TAG, " Failed to initialize!");
return;
}
}
bool ES8311::set_volume(float volume) {
volume = clamp(volume, 0.0f, 1.0f);
uint8_t reg32 = remap<uint8_t, float>(volume, 0.0f, 1.0f, 0, 255);
return this->write_byte(ES8311_REG32_DAC, reg32);
}
float ES8311::volume() {
uint8_t reg32;
this->read_byte(ES8311_REG32_DAC, &reg32);
return remap<float, uint8_t>(reg32, 0, 255, 0.0f, 1.0f);
}
uint8_t ES8311::calculate_resolution_value(ES8311Resolution resolution) {
switch (resolution) {
case ES8311_RESOLUTION_16:
return (3 << 2);
case ES8311_RESOLUTION_18:
return (2 << 2);
case ES8311_RESOLUTION_20:
return (1 << 2);
case ES8311_RESOLUTION_24:
return (0 << 2);
case ES8311_RESOLUTION_32:
return (4 << 2);
default:
return 0;
}
}
const ES8311Coefficient *ES8311::get_coefficient(uint32_t mclk, uint32_t rate) {
for (const auto &coefficient : ES8311_COEFFICIENTS) {
if (coefficient.mclk == mclk && coefficient.rate == rate)
return &coefficient;
}
return nullptr;
}
bool ES8311::configure_clock_() {
// Register 0x01: select clock source for internal MCLK and determine its frequency
uint8_t reg01 = 0x3F; // Enable all clocks
uint32_t mclk_frequency = this->sample_frequency_ * this->mclk_multiple_;
if (!this->use_mclk_) {
reg01 |= BIT(7); // Use SCLK
mclk_frequency = this->sample_frequency_ * (int) this->resolution_out_ * 2;
}
if (this->mclk_inverted_) {
reg01 |= BIT(6); // Invert MCLK pin
}
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG01_CLK_MANAGER, reg01));
// Get clock coefficients from coefficient table
auto *coefficient = get_coefficient(mclk_frequency, this->sample_frequency_);
if (coefficient == nullptr) {
ESP_LOGE(TAG, "Unable to configure sample rate %" PRIu32 "Hz with %" PRIu32 "Hz MCLK", this->sample_frequency_,
mclk_frequency);
return false;
}
// Register 0x02
uint8_t reg02;
ES8311_ERROR_CHECK(this->read_byte(ES8311_REG02_CLK_MANAGER, &reg02));
reg02 &= 0x07;
reg02 |= (coefficient->pre_div - 1) << 5;
reg02 |= coefficient->pre_mult << 3;
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG02_CLK_MANAGER, reg02));
// Register 0x03
const uint8_t reg03 = (coefficient->fs_mode << 6) | coefficient->adc_osr;
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG03_CLK_MANAGER, reg03));
// Register 0x04
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG04_CLK_MANAGER, coefficient->dac_osr));
// Register 0x05
const uint8_t reg05 = ((coefficient->adc_div - 1) << 4) | (coefficient->dac_div - 1);
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG05_CLK_MANAGER, reg05));
// Register 0x06
uint8_t reg06;
ES8311_ERROR_CHECK(this->read_byte(ES8311_REG06_CLK_MANAGER, &reg06));
if (this->sclk_inverted_) {
reg06 |= BIT(5);
} else {
reg06 &= ~BIT(5);
}
reg06 &= 0xE0;
if (coefficient->bclk_div < 19) {
reg06 |= (coefficient->bclk_div - 1) << 0;
} else {
reg06 |= (coefficient->bclk_div) << 0;
}
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG06_CLK_MANAGER, reg06));
// Register 0x07
uint8_t reg07;
ES8311_ERROR_CHECK(this->read_byte(ES8311_REG07_CLK_MANAGER, &reg07));
reg07 &= 0xC0;
reg07 |= coefficient->lrck_h << 0;
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG07_CLK_MANAGER, reg07));
// Register 0x08
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG08_CLK_MANAGER, coefficient->lrck_l));
// Successfully configured the clock
return true;
}
bool ES8311::configure_format_() {
// Configure I2S mode and format
uint8_t reg00;
ES8311_ERROR_CHECK(this->read_byte(ES8311_REG00_RESET, &reg00));
reg00 &= 0xBF;
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG00_RESET, reg00));
// Configure SDP in resolution
uint8_t reg09 = calculate_resolution_value(this->resolution_in_);
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG09_SDPIN, reg09));
// Configure SDP out resolution
uint8_t reg0a = calculate_resolution_value(this->resolution_out_);
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG0A_SDPOUT, reg0a));
// Successfully configured the format
return true;
}
bool ES8311::configure_mic_() {
uint8_t reg14 = 0x1A; // Enable analog MIC and max PGA gain
if (this->use_mic_) {
reg14 |= BIT(6); // Enable PDM digital microphone
}
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG14_SYSTEM, reg14));
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG16_ADC, this->mic_gain_)); // ADC gain scale up
ES8311_ERROR_CHECK(this->write_byte(ES8311_REG17_ADC, 0xC8)); // Set ADC gain
// Successfully configured the microphones
return true;
}
bool ES8311::set_mute_state_(bool mute_state) {
uint8_t reg31;
this->is_muted_ = mute_state;
if (!this->read_byte(ES8311_REG31_DAC, &reg31)) {
return false;
}
if (mute_state) {
reg31 |= BIT(6) | BIT(5);
} else {
reg31 &= ~(BIT(6) | BIT(5));
}
return this->write_byte(ES8311_REG31_DAC, reg31);
}
} // namespace es8311
} // namespace esphome

View file

@ -0,0 +1,135 @@
#pragma once
#include "esphome/components/audio_dac/audio_dac.h"
#include "esphome/components/i2c/i2c.h"
#include "esphome/core/component.h"
namespace esphome {
namespace es8311 {
enum ES8311MicGain {
ES8311_MIC_GAIN_MIN = -1,
ES8311_MIC_GAIN_0DB,
ES8311_MIC_GAIN_6DB,
ES8311_MIC_GAIN_12DB,
ES8311_MIC_GAIN_18DB,
ES8311_MIC_GAIN_24DB,
ES8311_MIC_GAIN_30DB,
ES8311_MIC_GAIN_36DB,
ES8311_MIC_GAIN_42DB,
ES8311_MIC_GAIN_MAX
};
enum ES8311Resolution : uint8_t {
ES8311_RESOLUTION_16 = 16,
ES8311_RESOLUTION_18 = 18,
ES8311_RESOLUTION_20 = 20,
ES8311_RESOLUTION_24 = 24,
ES8311_RESOLUTION_32 = 32
};
struct ES8311Coefficient {
uint32_t mclk; // mclk frequency
uint32_t rate; // sample rate
uint8_t pre_div; // the pre divider with range from 1 to 8
uint8_t pre_mult; // the pre multiplier with x1, x2, x4 and x8 selection
uint8_t adc_div; // adcclk divider
uint8_t dac_div; // dacclk divider
uint8_t fs_mode; // single speed (0) or double speed (1)
uint8_t lrck_h; // adc lrck divider and dac lrck divider
uint8_t lrck_l; //
uint8_t bclk_div; // sclk divider
uint8_t adc_osr; // adc osr
uint8_t dac_osr; // dac osr
};
class ES8311 : public audio_dac::AudioDac, public Component, public i2c::I2CDevice {
public:
/////////////////////////
// Component overrides //
/////////////////////////
void setup() override;
float get_setup_priority() const override { return setup_priority::DATA; }
void dump_config() override;
////////////////////////
// AudioDac overrides //
////////////////////////
/// @brief Writes the volume out to the DAC
/// @param volume floating point between 0.0 and 1.0
/// @return True if successful and false otherwise
bool set_volume(float volume) override;
/// @brief Gets the current volume out from the DAC
/// @return floating point between 0.0 and 1.0
float volume() override;
/// @brief Disables mute for audio out
/// @return True if successful and false otherwise
bool set_mute_off() override { return this->set_mute_state_(false); }
/// @brief Enables mute for audio out
/// @return True if successful and false otherwise
bool set_mute_on() override { return this->set_mute_state_(true); }
bool is_muted() override { return this->is_muted_; }
//////////////////////////////////
// ES8311 configuration setters //
//////////////////////////////////
void set_use_mclk(bool use_mclk) { this->use_mclk_ = use_mclk; }
void set_bits_per_sample(ES8311Resolution resolution) {
this->resolution_in_ = resolution;
this->resolution_out_ = resolution;
}
void set_sample_frequency(uint32_t sample_frequency) { this->sample_frequency_ = sample_frequency; }
void set_use_mic(bool use_mic) { this->use_mic_ = use_mic; }
void set_mic_gain(ES8311MicGain mic_gain) { this->mic_gain_ = mic_gain; }
protected:
/// @brief Computes the register value for the configured resolution (bits per sample)
/// @param resolution bits per sample enum for both audio in and audio out
/// @return register value
static uint8_t calculate_resolution_value(ES8311Resolution resolution);
/// @brief Retrieves the appropriate registers values for the configured mclk and rate
/// @param mclk mlck frequency in Hz
/// @param rate sample rate frequency in Hz
/// @return ES8311Coeffecient containing appropriate register values to configure the ES8311 or nullptr if impossible
static const ES8311Coefficient *get_coefficient(uint32_t mclk, uint32_t rate);
/// @brief Configures the ES8311 registers for the chosen sample rate
/// @return True if successful and false otherwise
bool configure_clock_();
/// @brief Configures the ES8311 registers for the chosen bits per sample
/// @return True if successful and false otherwise
bool configure_format_();
/// @brief Configures the ES8311 microphone registers
/// @return True if successful and false otherwise
bool configure_mic_();
/// @brief Mutes or unmute the DAC audio out
/// @param mute_state True to mute, false to unmute
/// @return
bool set_mute_state_(bool mute_state);
bool use_mic_;
ES8311MicGain mic_gain_;
bool use_mclk_; // true = use dedicated MCLK pin, false = use SCLK
bool sclk_inverted_{false}; // SCLK is inverted
bool mclk_inverted_{false}; // MCLK is inverted (ignored if use_mclk_ == false)
uint32_t mclk_multiple_{256}; // MCLK frequency is sample rate * mclk_multiple_ (ignored if use_mclk_ == false)
uint32_t sample_frequency_; // in Hz
ES8311Resolution resolution_in_;
ES8311Resolution resolution_out_;
};
} // namespace es8311
} // namespace esphome

View file

@ -0,0 +1,195 @@
#pragma once
#include "es8311.h"
namespace esphome {
namespace es8311 {
// ES8311 register addresses
static const uint8_t ES8311_REG00_RESET = 0x00; // Reset
static const uint8_t ES8311_REG01_CLK_MANAGER = 0x01; // Clock Manager: select clk src for mclk, enable clock for codec
static const uint8_t ES8311_REG02_CLK_MANAGER = 0x02; // Clock Manager: clk divider and clk multiplier
static const uint8_t ES8311_REG03_CLK_MANAGER = 0x03; // Clock Manager: adc fsmode and osr
static const uint8_t ES8311_REG04_CLK_MANAGER = 0x04; // Clock Manager: dac osr
static const uint8_t ES8311_REG05_CLK_MANAGER = 0x05; // Clock Manager: clk divider for adc and dac
static const uint8_t ES8311_REG06_CLK_MANAGER = 0x06; // Clock Manager: bclk inverter BIT(5) and divider
static const uint8_t ES8311_REG07_CLK_MANAGER = 0x07; // Clock Manager: tri-state, lrck divider
static const uint8_t ES8311_REG08_CLK_MANAGER = 0x08; // Clock Manager: lrck divider
static const uint8_t ES8311_REG09_SDPIN = 0x09; // Serial Digital Port: DAC
static const uint8_t ES8311_REG0A_SDPOUT = 0x0A; // Serial Digital Port: ADC
static const uint8_t ES8311_REG0B_SYSTEM = 0x0B; // System
static const uint8_t ES8311_REG0C_SYSTEM = 0x0C; // System
static const uint8_t ES8311_REG0D_SYSTEM = 0x0D; // System: power up/down
static const uint8_t ES8311_REG0E_SYSTEM = 0x0E; // System: power up/down
static const uint8_t ES8311_REG0F_SYSTEM = 0x0F; // System: low power
static const uint8_t ES8311_REG10_SYSTEM = 0x10; // System
static const uint8_t ES8311_REG11_SYSTEM = 0x11; // System
static const uint8_t ES8311_REG12_SYSTEM = 0x12; // System: Enable DAC
static const uint8_t ES8311_REG13_SYSTEM = 0x13; // System
static const uint8_t ES8311_REG14_SYSTEM = 0x14; // System: select DMIC, select analog pga gain
static const uint8_t ES8311_REG15_ADC = 0x15; // ADC: adc ramp rate, dmic sense
static const uint8_t ES8311_REG16_ADC = 0x16; // ADC
static const uint8_t ES8311_REG17_ADC = 0x17; // ADC: volume
static const uint8_t ES8311_REG18_ADC = 0x18; // ADC: alc enable and winsize
static const uint8_t ES8311_REG19_ADC = 0x19; // ADC: alc maxlevel
static const uint8_t ES8311_REG1A_ADC = 0x1A; // ADC: alc automute
static const uint8_t ES8311_REG1B_ADC = 0x1B; // ADC: alc automute, adc hpf s1
static const uint8_t ES8311_REG1C_ADC = 0x1C; // ADC: equalizer, hpf s2
static const uint8_t ES8311_REG1D_ADCEQ = 0x1D; // ADCEQ: equalizer B0
static const uint8_t ES8311_REG1E_ADCEQ = 0x1E; // ADCEQ: equalizer B0
static const uint8_t ES8311_REG1F_ADCEQ = 0x1F; // ADCEQ: equalizer B0
static const uint8_t ES8311_REG20_ADCEQ = 0x20; // ADCEQ: equalizer B0
static const uint8_t ES8311_REG21_ADCEQ = 0x21; // ADCEQ: equalizer A1
static const uint8_t ES8311_REG22_ADCEQ = 0x22; // ADCEQ: equalizer A1
static const uint8_t ES8311_REG23_ADCEQ = 0x23; // ADCEQ: equalizer A1
static const uint8_t ES8311_REG24_ADCEQ = 0x24; // ADCEQ: equalizer A1
static const uint8_t ES8311_REG25_ADCEQ = 0x25; // ADCEQ: equalizer A2
static const uint8_t ES8311_REG26_ADCEQ = 0x26; // ADCEQ: equalizer A2
static const uint8_t ES8311_REG27_ADCEQ = 0x27; // ADCEQ: equalizer A2
static const uint8_t ES8311_REG28_ADCEQ = 0x28; // ADCEQ: equalizer A2
static const uint8_t ES8311_REG29_ADCEQ = 0x29; // ADCEQ: equalizer B1
static const uint8_t ES8311_REG2A_ADCEQ = 0x2A; // ADCEQ: equalizer B1
static const uint8_t ES8311_REG2B_ADCEQ = 0x2B; // ADCEQ: equalizer B1
static const uint8_t ES8311_REG2C_ADCEQ = 0x2C; // ADCEQ: equalizer B1
static const uint8_t ES8311_REG2D_ADCEQ = 0x2D; // ADCEQ: equalizer B2
static const uint8_t ES8311_REG2E_ADCEQ = 0x2E; // ADCEQ: equalizer B2
static const uint8_t ES8311_REG2F_ADCEQ = 0x2F; // ADCEQ: equalizer B2
static const uint8_t ES8311_REG30_ADCEQ = 0x30; // ADCEQ: equalizer B2
static const uint8_t ES8311_REG31_DAC = 0x31; // DAC: mute
static const uint8_t ES8311_REG32_DAC = 0x32; // DAC: volume
static const uint8_t ES8311_REG33_DAC = 0x33; // DAC: offset
static const uint8_t ES8311_REG34_DAC = 0x34; // DAC: drc enable, drc winsize
static const uint8_t ES8311_REG35_DAC = 0x35; // DAC: drc maxlevel, minilevel
static const uint8_t ES8311_REG36_DAC = 0x36; // DAC
static const uint8_t ES8311_REG37_DAC = 0x37; // DAC: ramprate
static const uint8_t ES8311_REG38_DACEQ = 0x38; // DACEQ: equalizer B0
static const uint8_t ES8311_REG39_DACEQ = 0x39; // DACEQ: equalizer B0
static const uint8_t ES8311_REG3A_DACEQ = 0x3A; // DACEQ: equalizer B0
static const uint8_t ES8311_REG3B_DACEQ = 0x3B; // DACEQ: equalizer B0
static const uint8_t ES8311_REG3C_DACEQ = 0x3C; // DACEQ: equalizer B1
static const uint8_t ES8311_REG3D_DACEQ = 0x3D; // DACEQ: equalizer B1
static const uint8_t ES8311_REG3E_DACEQ = 0x3E; // DACEQ: equalizer B1
static const uint8_t ES8311_REG3F_DACEQ = 0x3F; // DACEQ: equalizer B1
static const uint8_t ES8311_REG40_DACEQ = 0x40; // DACEQ: equalizer A1
static const uint8_t ES8311_REG41_DACEQ = 0x41; // DACEQ: equalizer A1
static const uint8_t ES8311_REG42_DACEQ = 0x42; // DACEQ: equalizer A1
static const uint8_t ES8311_REG43_DACEQ = 0x43; // DACEQ: equalizer A1
static const uint8_t ES8311_REG44_GPIO = 0x44; // GPIO: dac2adc for test
static const uint8_t ES8311_REG45_GP = 0x45; // GPIO: GP control
static const uint8_t ES8311_REGFA_I2C = 0xFA; // I2C: reset registers
static const uint8_t ES8311_REGFC_FLAG = 0xFC; // Flag
static const uint8_t ES8311_REGFD_CHD1 = 0xFD; // Chip: ID1
static const uint8_t ES8311_REGFE_CHD2 = 0xFE; // Chip: ID2
static const uint8_t ES8311_REGFF_CHVER = 0xFF; // Chip: Version
// ES8311 clock divider coefficients
static const ES8311Coefficient ES8311_COEFFICIENTS[] = {
// clang-format off
// mclk, rate, pre_ pre_ adc_ dac_ fs_ lrck lrck bclk_ adc_ dac_
// div, mult, div, div, mode, _h, _l, div, osr, osr
// 8k
{12288000, 8000, 0x06, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{18432000, 8000, 0x03, 0x02, 0x03, 0x03, 0x00, 0x05, 0xff, 0x18, 0x10, 0x20},
{16384000, 8000, 0x08, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 8192000, 8000, 0x04, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 6144000, 8000, 0x03, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 4096000, 8000, 0x02, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 3072000, 8000, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 2048000, 8000, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 1536000, 8000, 0x03, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 1024000, 8000, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
// 11.025k
{11289600, 11025, 0x04, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 5644800, 11025, 0x02, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 2822400, 11025, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 1411200, 11025, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
// 12k
{12288000, 12000, 0x04, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 6144000, 12000, 0x02, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 3072000, 12000, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 1536000, 12000, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
// 16k
{12288000, 16000, 0x03, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{18432000, 16000, 0x03, 0x02, 0x03, 0x03, 0x00, 0x02, 0xff, 0x0c, 0x10, 0x20},
{16384000, 16000, 0x04, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 8192000, 16000, 0x02, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 6144000, 16000, 0x03, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 4096000, 16000, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 3072000, 16000, 0x03, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 2048000, 16000, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 1536000, 16000, 0x03, 0x08, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
{ 1024000, 16000, 0x01, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x20},
// 22.05k
{11289600, 22050, 0x02, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 5644800, 22050, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 2822400, 22050, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 1411200, 22050, 0x01, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
// 24k
{12288000, 24000, 0x02, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{18432000, 24000, 0x03, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 6144000, 24000, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 3072000, 24000, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 1536000, 24000, 0x01, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
// 32k
{12288000, 32000, 0x03, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{18432000, 32000, 0x03, 0x04, 0x03, 0x03, 0x00, 0x02, 0xff, 0x0c, 0x10, 0x10},
{16384000, 32000, 0x02, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 8192000, 32000, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 6144000, 32000, 0x03, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 4096000, 32000, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 3072000, 32000, 0x03, 0x08, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 2048000, 32000, 0x01, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 1536000, 32000, 0x03, 0x08, 0x01, 0x01, 0x01, 0x00, 0x7f, 0x02, 0x10, 0x10},
{ 1024000, 32000, 0x01, 0x08, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
// 44.1k
{11289600, 44100, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 5644800, 44100, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 2822400, 44100, 0x01, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 1411200, 44100, 0x01, 0x08, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
// 48k
{12288000, 48000, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{18432000, 48000, 0x03, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 6144000, 48000, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 3072000, 48000, 0x01, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 1536000, 48000, 0x01, 0x08, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
// 64k
{12288000, 64000, 0x03, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{18432000, 64000, 0x03, 0x04, 0x03, 0x03, 0x01, 0x01, 0x7f, 0x06, 0x10, 0x10},
{16384000, 64000, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 8192000, 64000, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 6144000, 64000, 0x01, 0x04, 0x03, 0x03, 0x01, 0x01, 0x7f, 0x06, 0x10, 0x10},
{ 4096000, 64000, 0x01, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 3072000, 64000, 0x01, 0x08, 0x03, 0x03, 0x01, 0x01, 0x7f, 0x06, 0x10, 0x10},
{ 2048000, 64000, 0x01, 0x08, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 1536000, 64000, 0x01, 0x08, 0x01, 0x01, 0x01, 0x00, 0xbf, 0x03, 0x18, 0x18},
{ 1024000, 64000, 0x01, 0x08, 0x01, 0x01, 0x01, 0x00, 0x7f, 0x02, 0x10, 0x10},
// 88.2k
{11289600, 88200, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 5644800, 88200, 0x01, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 2822400, 88200, 0x01, 0x08, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 1411200, 88200, 0x01, 0x08, 0x01, 0x01, 0x01, 0x00, 0x7f, 0x02, 0x10, 0x10},
// 96k
{12288000, 96000, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{18432000, 96000, 0x03, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 6144000, 96000, 0x01, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 3072000, 96000, 0x01, 0x08, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
{ 1536000, 96000, 0x01, 0x08, 0x01, 0x01, 0x01, 0x00, 0x7f, 0x02, 0x10, 0x10},
// clang-format on
};
} // namespace es8311
} // namespace esphome

View file

@ -67,8 +67,10 @@ def _translate_pin(value):
"This variable only supports pin numbers, not full pin schemas " "This variable only supports pin numbers, not full pin schemas "
"(with inverted and mode)." "(with inverted and mode)."
) )
if isinstance(value, int): if isinstance(value, int) and not isinstance(value, bool):
return value return value
if not isinstance(value, str):
raise cv.Invalid(f"Invalid pin number: {value}")
try: try:
return int(value) return int(value)
except ValueError: except ValueError:

View file

@ -35,7 +35,7 @@ class BLEClientBase : public espbt::ESPBTClient, public Component {
void gap_event_handler(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) override; void gap_event_handler(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) override;
void connect() override; void connect() override;
esp_err_t pair(); esp_err_t pair();
void disconnect(); void disconnect() override;
void release_services(); void release_services();
bool connected() { return this->state_ == espbt::ClientState::ESTABLISHED; } bool connected() { return this->state_ == espbt::ClientState::ESTABLISHED; }

View file

@ -65,6 +65,9 @@ void ESP32BLETracker::setup() {
[this](ota::OTAState state, float progress, uint8_t error, ota::OTAComponent *comp) { [this](ota::OTAState state, float progress, uint8_t error, ota::OTAComponent *comp) {
if (state == ota::OTA_STARTED) { if (state == ota::OTA_STARTED) {
this->stop_scan(); this->stop_scan();
for (auto *client : this->clients_) {
client->disconnect();
}
} }
}); });
#endif #endif

View file

@ -11,9 +11,9 @@
#ifdef USE_ESP32 #ifdef USE_ESP32
#include <esp_bt_defs.h>
#include <esp_gap_ble_api.h> #include <esp_gap_ble_api.h>
#include <esp_gattc_api.h> #include <esp_gattc_api.h>
#include <esp_bt_defs.h>
#include <freertos/FreeRTOS.h> #include <freertos/FreeRTOS.h>
#include <freertos/semphr.h> #include <freertos/semphr.h>
@ -172,6 +172,7 @@ class ESPBTClient : public ESPBTDeviceListener {
esp_ble_gattc_cb_param_t *param) = 0; esp_ble_gattc_cb_param_t *param) = 0;
virtual void gap_event_handler(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) = 0; virtual void gap_event_handler(esp_gap_ble_cb_event_t event, esp_ble_gap_cb_param_t *param) = 0;
virtual void connect() = 0; virtual void connect() = 0;
virtual void disconnect() = 0;
virtual void set_state(ClientState st) { this->state_ = st; } virtual void set_state(ClientState st) { this->state_ = st; }
ClientState state() const { return state_; } ClientState state() const { return state_; }
int app_id; int app_id;

View file

@ -1,6 +1,9 @@
import logging
from dataclasses import dataclass from dataclasses import dataclass
import logging
from esphome import pins
import esphome.codegen as cg
import esphome.config_validation as cv
from esphome.const import ( from esphome.const import (
CONF_ANALOG, CONF_ANALOG,
CONF_ID, CONF_ID,
@ -14,10 +17,7 @@ from esphome.const import (
CONF_PULLUP, CONF_PULLUP,
PLATFORM_ESP8266, PLATFORM_ESP8266,
) )
from esphome import pins
from esphome.core import CORE, coroutine_with_priority from esphome.core import CORE, coroutine_with_priority
import esphome.config_validation as cv
import esphome.codegen as cg
from . import boards from . import boards
from .const import KEY_BOARD, KEY_ESP8266, KEY_PIN_INITIAL_STATES, esp8266_ns from .const import KEY_BOARD, KEY_ESP8266, KEY_PIN_INITIAL_STATES, esp8266_ns
@ -48,8 +48,10 @@ def _translate_pin(value):
"This variable only supports pin numbers, not full pin schemas " "This variable only supports pin numbers, not full pin schemas "
"(with inverted and mode)." "(with inverted and mode)."
) )
if isinstance(value, int): if isinstance(value, int) and not isinstance(value, bool):
return value return value
if not isinstance(value, str):
raise cv.Invalid(f"Invalid pin number: {value}")
try: try:
return int(value) return int(value)
except ValueError: except ValueError:

View file

@ -1,3 +1,4 @@
import logging
from esphome import pins from esphome import pins
import esphome.codegen as cg import esphome.codegen as cg
from esphome.components.esp32 import add_idf_sdkconfig_option, get_esp32_variant from esphome.components.esp32 import add_idf_sdkconfig_option, get_esp32_variant
@ -23,6 +24,7 @@ from esphome.const import (
CONF_MISO_PIN, CONF_MISO_PIN,
CONF_MOSI_PIN, CONF_MOSI_PIN,
CONF_PAGE_ID, CONF_PAGE_ID,
CONF_POLLING_INTERVAL,
CONF_RESET_PIN, CONF_RESET_PIN,
CONF_SPI, CONF_SPI,
CONF_STATIC_IP, CONF_STATIC_IP,
@ -30,13 +32,16 @@ from esphome.const import (
CONF_TYPE, CONF_TYPE,
CONF_USE_ADDRESS, CONF_USE_ADDRESS,
CONF_VALUE, CONF_VALUE,
KEY_CORE,
KEY_FRAMEWORK_VERSION,
) )
from esphome.core import CORE, coroutine_with_priority from esphome.core import CORE, TimePeriodMilliseconds, coroutine_with_priority
import esphome.final_validate as fv import esphome.final_validate as fv
CONFLICTS_WITH = ["wifi"] CONFLICTS_WITH = ["wifi"]
DEPENDENCIES = ["esp32"] DEPENDENCIES = ["esp32"]
AUTO_LOAD = ["network"] AUTO_LOAD = ["network"]
LOGGER = logging.getLogger(__name__)
ethernet_ns = cg.esphome_ns.namespace("ethernet") ethernet_ns = cg.esphome_ns.namespace("ethernet")
PHYRegister = ethernet_ns.struct("PHYRegister") PHYRegister = ethernet_ns.struct("PHYRegister")
@ -63,6 +68,7 @@ ETHERNET_TYPES = {
} }
SPI_ETHERNET_TYPES = ["W5500"] SPI_ETHERNET_TYPES = ["W5500"]
SPI_ETHERNET_DEFAULT_POLLING_INTERVAL = TimePeriodMilliseconds(milliseconds=10)
emac_rmii_clock_mode_t = cg.global_ns.enum("emac_rmii_clock_mode_t") emac_rmii_clock_mode_t = cg.global_ns.enum("emac_rmii_clock_mode_t")
emac_rmii_clock_gpio_t = cg.global_ns.enum("emac_rmii_clock_gpio_t") emac_rmii_clock_gpio_t = cg.global_ns.enum("emac_rmii_clock_gpio_t")
@ -100,6 +106,24 @@ EthernetComponent = ethernet_ns.class_("EthernetComponent", cg.Component)
ManualIP = ethernet_ns.struct("ManualIP") ManualIP = ethernet_ns.struct("ManualIP")
def _is_framework_spi_polling_mode_supported():
# SPI Ethernet without IRQ feature is added in
# esp-idf >= (5.3+ ,5.2.1+, 5.1.4) and arduino-esp32 >= 3.0.0
framework_version = CORE.data[KEY_CORE][KEY_FRAMEWORK_VERSION]
if CORE.using_esp_idf:
if framework_version >= cv.Version(5, 3, 0):
return True
if cv.Version(5, 3, 0) > framework_version >= cv.Version(5, 2, 1):
return True
if cv.Version(5, 2, 0) > framework_version >= cv.Version(5, 1, 4):
return True
return False
if CORE.using_arduino:
return framework_version >= cv.Version(3, 0, 0)
# fail safe: Unknown framework
return False
def _validate(config): def _validate(config):
if CONF_USE_ADDRESS not in config: if CONF_USE_ADDRESS not in config:
if CONF_MANUAL_IP in config: if CONF_MANUAL_IP in config:
@ -107,6 +131,27 @@ def _validate(config):
else: else:
use_address = CORE.name + config[CONF_DOMAIN] use_address = CORE.name + config[CONF_DOMAIN]
config[CONF_USE_ADDRESS] = use_address config[CONF_USE_ADDRESS] = use_address
if config[CONF_TYPE] in SPI_ETHERNET_TYPES:
if _is_framework_spi_polling_mode_supported():
if CONF_POLLING_INTERVAL in config and CONF_INTERRUPT_PIN in config:
raise cv.Invalid(
f"Cannot specify more than one of {CONF_INTERRUPT_PIN}, {CONF_POLLING_INTERVAL}"
)
if CONF_POLLING_INTERVAL not in config and CONF_INTERRUPT_PIN not in config:
config[CONF_POLLING_INTERVAL] = SPI_ETHERNET_DEFAULT_POLLING_INTERVAL
else:
if CONF_POLLING_INTERVAL in config:
raise cv.Invalid(
"In this version of the framework "
f"({CORE.target_framework} {CORE.data[KEY_CORE][KEY_FRAMEWORK_VERSION]}), "
f"'{CONF_POLLING_INTERVAL}' is not supported."
)
if CONF_INTERRUPT_PIN not in config:
raise cv.Invalid(
"In this version of the framework "
f"({CORE.target_framework} {CORE.data[KEY_CORE][KEY_FRAMEWORK_VERSION]}), "
f"'{CONF_INTERRUPT_PIN}' is a required option for [ethernet]."
)
return config return config
@ -157,6 +202,11 @@ SPI_SCHEMA = BASE_SCHEMA.extend(
cv.Optional(CONF_CLOCK_SPEED, default="26.67MHz"): cv.All( cv.Optional(CONF_CLOCK_SPEED, default="26.67MHz"): cv.All(
cv.frequency, cv.int_range(int(8e6), int(80e6)) cv.frequency, cv.int_range(int(8e6), int(80e6))
), ),
# Set default value (SPI_ETHERNET_DEFAULT_POLLING_INTERVAL) at _validate()
cv.Optional(CONF_POLLING_INTERVAL): cv.All(
cv.positive_time_period_milliseconds,
cv.Range(min=TimePeriodMilliseconds(milliseconds=1)),
),
} }
), ),
) )
@ -234,6 +284,10 @@ async def to_code(config):
cg.add(var.set_cs_pin(config[CONF_CS_PIN])) cg.add(var.set_cs_pin(config[CONF_CS_PIN]))
if CONF_INTERRUPT_PIN in config: if CONF_INTERRUPT_PIN in config:
cg.add(var.set_interrupt_pin(config[CONF_INTERRUPT_PIN])) cg.add(var.set_interrupt_pin(config[CONF_INTERRUPT_PIN]))
else:
cg.add(var.set_polling_interval(config[CONF_POLLING_INTERVAL]))
if _is_framework_spi_polling_mode_supported():
cg.add_define("USE_ETHERNET_SPI_POLLING_SUPPORT")
if CONF_RESET_PIN in config: if CONF_RESET_PIN in config:
cg.add(var.set_reset_pin(config[CONF_RESET_PIN])) cg.add(var.set_reset_pin(config[CONF_RESET_PIN]))
cg.add(var.set_clock_speed(config[CONF_CLOCK_SPEED])) cg.add(var.set_clock_speed(config[CONF_CLOCK_SPEED]))

View file

@ -116,6 +116,9 @@ void EthernetComponent::setup() {
eth_w5500_config_t w5500_config = ETH_W5500_DEFAULT_CONFIG(spi_handle); eth_w5500_config_t w5500_config = ETH_W5500_DEFAULT_CONFIG(spi_handle);
#endif #endif
w5500_config.int_gpio_num = this->interrupt_pin_; w5500_config.int_gpio_num = this->interrupt_pin_;
#ifdef USE_ETHERNET_SPI_POLLING_SUPPORT
w5500_config.poll_period_ms = this->polling_interval_;
#endif
phy_config.phy_addr = this->phy_addr_spi_; phy_config.phy_addr = this->phy_addr_spi_;
phy_config.reset_gpio_num = this->reset_pin_; phy_config.reset_gpio_num = this->reset_pin_;
@ -327,7 +330,14 @@ void EthernetComponent::dump_config() {
ESP_LOGCONFIG(TAG, " MISO Pin: %u", this->miso_pin_); ESP_LOGCONFIG(TAG, " MISO Pin: %u", this->miso_pin_);
ESP_LOGCONFIG(TAG, " MOSI Pin: %u", this->mosi_pin_); ESP_LOGCONFIG(TAG, " MOSI Pin: %u", this->mosi_pin_);
ESP_LOGCONFIG(TAG, " CS Pin: %u", this->cs_pin_); ESP_LOGCONFIG(TAG, " CS Pin: %u", this->cs_pin_);
ESP_LOGCONFIG(TAG, " IRQ Pin: %u", this->interrupt_pin_); #ifdef USE_ETHERNET_SPI_POLLING_SUPPORT
if (this->polling_interval_ != 0) {
ESP_LOGCONFIG(TAG, " Polling Interval: %lu ms", this->polling_interval_);
} else
#endif
{
ESP_LOGCONFIG(TAG, " IRQ Pin: %d", this->interrupt_pin_);
}
ESP_LOGCONFIG(TAG, " Reset Pin: %d", this->reset_pin_); ESP_LOGCONFIG(TAG, " Reset Pin: %d", this->reset_pin_);
ESP_LOGCONFIG(TAG, " Clock Speed: %d MHz", this->clock_speed_ / 1000000); ESP_LOGCONFIG(TAG, " Clock Speed: %d MHz", this->clock_speed_ / 1000000);
#else #else
@ -536,6 +546,9 @@ void EthernetComponent::set_cs_pin(uint8_t cs_pin) { this->cs_pin_ = cs_pin; }
void EthernetComponent::set_interrupt_pin(uint8_t interrupt_pin) { this->interrupt_pin_ = interrupt_pin; } void EthernetComponent::set_interrupt_pin(uint8_t interrupt_pin) { this->interrupt_pin_ = interrupt_pin; }
void EthernetComponent::set_reset_pin(uint8_t reset_pin) { this->reset_pin_ = reset_pin; } void EthernetComponent::set_reset_pin(uint8_t reset_pin) { this->reset_pin_ = reset_pin; }
void EthernetComponent::set_clock_speed(int clock_speed) { this->clock_speed_ = clock_speed; } void EthernetComponent::set_clock_speed(int clock_speed) { this->clock_speed_ = clock_speed; }
#ifdef USE_ETHERNET_SPI_POLLING_SUPPORT
void EthernetComponent::set_polling_interval(uint32_t polling_interval) { this->polling_interval_ = polling_interval; }
#endif
#else #else
void EthernetComponent::set_phy_addr(uint8_t phy_addr) { this->phy_addr_ = phy_addr; } void EthernetComponent::set_phy_addr(uint8_t phy_addr) { this->phy_addr_ = phy_addr; }
void EthernetComponent::set_power_pin(int power_pin) { this->power_pin_ = power_pin; } void EthernetComponent::set_power_pin(int power_pin) { this->power_pin_ = power_pin; }

View file

@ -67,6 +67,9 @@ class EthernetComponent : public Component {
void set_interrupt_pin(uint8_t interrupt_pin); void set_interrupt_pin(uint8_t interrupt_pin);
void set_reset_pin(uint8_t reset_pin); void set_reset_pin(uint8_t reset_pin);
void set_clock_speed(int clock_speed); void set_clock_speed(int clock_speed);
#ifdef USE_ETHERNET_SPI_POLLING_SUPPORT
void set_polling_interval(uint32_t polling_interval);
#endif
#else #else
void set_phy_addr(uint8_t phy_addr); void set_phy_addr(uint8_t phy_addr);
void set_power_pin(int power_pin); void set_power_pin(int power_pin);
@ -108,10 +111,13 @@ class EthernetComponent : public Component {
uint8_t miso_pin_; uint8_t miso_pin_;
uint8_t mosi_pin_; uint8_t mosi_pin_;
uint8_t cs_pin_; uint8_t cs_pin_;
uint8_t interrupt_pin_; int interrupt_pin_{-1};
int reset_pin_{-1}; int reset_pin_{-1};
int phy_addr_spi_{-1}; int phy_addr_spi_{-1};
int clock_speed_; int clock_speed_;
#ifdef USE_ETHERNET_SPI_POLLING_SUPPORT
uint32_t polling_interval_{0};
#endif
#else #else
uint8_t phy_addr_{0}; uint8_t phy_addr_{0};
int power_pin_{-1}; int power_pin_{-1};

View file

@ -1,3 +1,4 @@
from collections.abc import Iterable
import functools import functools
import hashlib import hashlib
import logging import logging
@ -5,6 +6,8 @@ import os
from pathlib import Path from pathlib import Path
import re import re
import freetype
import glyphsets
from packaging import version from packaging import version
import requests import requests
@ -43,6 +46,18 @@ GlyphData = font_ns.struct("GlyphData")
CONF_BPP = "bpp" CONF_BPP = "bpp"
CONF_EXTRAS = "extras" CONF_EXTRAS = "extras"
CONF_FONTS = "fonts" CONF_FONTS = "fonts"
CONF_GLYPHSETS = "glyphsets"
CONF_IGNORE_MISSING_GLYPHS = "ignore_missing_glyphs"
# Cache loaded freetype fonts
class FontCache(dict):
def __missing__(self, key):
res = self[key] = freetype.Face(key)
return res
FONT_CACHE = FontCache()
def glyph_comparator(x, y): def glyph_comparator(x, y):
@ -59,36 +74,106 @@ def glyph_comparator(x, y):
return -1 return -1
if len(x_) > len(y_): if len(x_) > len(y_):
return 1 return 1
raise cv.Invalid(f"Found duplicate glyph {x}") return 0
def validate_glyphs(value): def flatten(lists) -> list:
if isinstance(value, list): """
value = cv.Schema([cv.string])(value) Given a list of lists, flatten it to a single list of all elements of all lists.
value = cv.Schema([cv.string])(list(value)) This wraps itertools.chain.from_iterable to make it more readable, and return a list
rather than a single use iterable.
"""
from itertools import chain
value.sort(key=functools.cmp_to_key(glyph_comparator)) return list(chain.from_iterable(lists))
return value
font_map = {} def check_missing_glyphs(file, codepoints: Iterable, warning: bool = False):
"""
Check that the given font file actually contains the requested glyphs
:param file: A Truetype font file
:param codepoints: A list of codepoints to check
:param warning: If true, log a warning instead of raising an exception
"""
font = FONT_CACHE[file]
def merge_glyphs(config): missing = [chr(x) for x in codepoints if font.get_char_index(x) == 0]
glyphs = [] if missing:
glyphs.extend(config[CONF_GLYPHS]) # Only list up to 10 missing glyphs
font_list = [(EFont(config[CONF_FILE], config[CONF_SIZE], config[CONF_GLYPHS]))] missing.sort(key=functools.cmp_to_key(glyph_comparator))
if extras := config.get(CONF_EXTRAS): count = len(missing)
extra_fonts = list( missing = missing[:10]
map( missing_str = "\n ".join(
lambda x: EFont(x[CONF_FILE], config[CONF_SIZE], x[CONF_GLYPHS]), extras f"{x} ({x.encode('unicode_escape')})" for x in missing
) )
if count > 10:
missing_str += f"\n and {count - 10} more."
message = f"Font {Path(file).name} is missing {count} glyph{'s' if count != 1 else ''}:\n {missing_str}"
if warning:
_LOGGER.warning(message)
else:
raise cv.Invalid(message)
def validate_glyphs(config):
"""
Check for duplicate codepoints, then check that all requested codepoints actually
have glyphs defined in the appropriate font file.
"""
# Collect all glyph codepoints and flatten to a list of chars
glyphspoints = flatten(
[x[CONF_GLYPHS] for x in config[CONF_EXTRAS]] + config[CONF_GLYPHS]
) )
font_list.extend(extra_fonts) # Convert a list of strings to a list of chars (one char strings)
for extra in extras: glyphspoints = flatten([list(x) for x in glyphspoints])
glyphs.extend(extra[CONF_GLYPHS]) if len(set(glyphspoints)) != len(glyphspoints):
validate_glyphs(glyphs) duplicates = {x for x in glyphspoints if glyphspoints.count(x) > 1}
font_map[config[CONF_ID]] = font_list dup_str = ", ".join(f"{x} ({x.encode('unicode_escape')})" for x in duplicates)
raise cv.Invalid(
f"Found duplicate glyph{'s' if len(duplicates) != 1 else ''}: {dup_str}"
)
# convert to codepoints
glyphspoints = {ord(x) for x in glyphspoints}
fileconf = config[CONF_FILE]
setpoints = set(
flatten([glyphsets.unicodes_per_glyphset(x) for x in config[CONF_GLYPHSETS]])
)
# Make setpoints and glyphspoints disjoint
setpoints.difference_update(glyphspoints)
if fileconf[CONF_TYPE] == TYPE_LOCAL_BITMAP:
# Pillow only allows 256 glyphs per bitmap font. Not sure if that is a Pillow limitation
# or a file format limitation
if any(x >= 256 for x in setpoints.copy().union(glyphspoints)):
raise cv.Invalid("Codepoints in bitmap fonts must be in the range 0-255")
else:
# for TT fonts, check that glyphs are actually present
# Check extras against their own font, exclude from parent font codepoints
for extra in config[CONF_EXTRAS]:
points = {ord(x) for x in flatten(extra[CONF_GLYPHS])}
glyphspoints.difference_update(points)
setpoints.difference_update(points)
check_missing_glyphs(extra[CONF_FILE][CONF_PATH], points)
# A named glyph that can't be provided is an error
check_missing_glyphs(fileconf[CONF_PATH], glyphspoints)
# A missing glyph from a set is a warning.
if not config[CONF_IGNORE_MISSING_GLYPHS]:
check_missing_glyphs(fileconf[CONF_PATH], setpoints, warning=True)
# Populate the default after the above checks so that use of the default doesn't trigger errors
if not config[CONF_GLYPHS] and not config[CONF_GLYPHSETS]:
if fileconf[CONF_TYPE] == TYPE_LOCAL_BITMAP:
config[CONF_GLYPHS] = [DEFAULT_GLYPHS]
else:
# set a default glyphset, intersected with what the font actually offers
font = FONT_CACHE[fileconf[CONF_PATH]]
config[CONF_GLYPHS] = [
chr(x)
for x in glyphsets.unicodes_per_glyphset(DEFAULT_GLYPHSET)
if font.get_char_index(x) != 0
]
return config return config
@ -120,7 +205,7 @@ def validate_truetype_file(value):
) )
if not any(map(value.lower().endswith, FONT_EXTENSIONS)): if not any(map(value.lower().endswith, FONT_EXTENSIONS)):
raise cv.Invalid(f"Only {FONT_EXTENSIONS} files are supported.") raise cv.Invalid(f"Only {FONT_EXTENSIONS} files are supported.")
return cv.file_(value) return CORE.relative_config_path(cv.file_(value))
TYPE_LOCAL = "local" TYPE_LOCAL = "local"
@ -139,6 +224,10 @@ LOCAL_BITMAP_SCHEMA = cv.Schema(
} }
) )
FULLPATH_SCHEMA = cv.maybe_simple_value(
{cv.Required(CONF_PATH): cv.string}, key=CONF_PATH
)
CONF_ITALIC = "italic" CONF_ITALIC = "italic"
FONT_WEIGHTS = { FONT_WEIGHTS = {
"thin": 100, "thin": 100,
@ -167,13 +256,13 @@ def _compute_local_font_path(value: dict) -> Path:
return base_dir / key return base_dir / key
def get_font_path(value, type) -> Path: def get_font_path(value, font_type) -> Path:
if type == TYPE_GFONTS: if font_type == TYPE_GFONTS:
name = f"{value[CONF_FAMILY]}@{value[CONF_WEIGHT]}@{value[CONF_ITALIC]}@v1" name = f"{value[CONF_FAMILY]}@{value[CONF_WEIGHT]}@{value[CONF_ITALIC]}@v1"
return external_files.compute_local_file_dir(DOMAIN) / f"{name}.ttf" return external_files.compute_local_file_dir(DOMAIN) / f"{name}.ttf"
if type == TYPE_WEB: if font_type == TYPE_WEB:
return _compute_local_font_path(value) / "font.ttf" return _compute_local_font_path(value) / "font.ttf"
return None assert False
def download_gfont(value): def download_gfont(value):
@ -203,7 +292,7 @@ def download_gfont(value):
_LOGGER.debug("download_gfont: ttf_url=%s", ttf_url) _LOGGER.debug("download_gfont: ttf_url=%s", ttf_url)
external_files.download_content(ttf_url, path) external_files.download_content(ttf_url, path)
return value return FULLPATH_SCHEMA(path)
def download_web_font(value): def download_web_font(value):
@ -212,7 +301,7 @@ def download_web_font(value):
external_files.download_content(url, path) external_files.download_content(url, path)
_LOGGER.debug("download_web_font: path=%s", path) _LOGGER.debug("download_web_font: path=%s", path)
return value return FULLPATH_SCHEMA(path)
EXTERNAL_FONT_SCHEMA = cv.Schema( EXTERNAL_FONT_SCHEMA = cv.Schema(
@ -225,7 +314,6 @@ EXTERNAL_FONT_SCHEMA = cv.Schema(
} }
) )
GFONTS_SCHEMA = cv.All( GFONTS_SCHEMA = cv.All(
EXTERNAL_FONT_SCHEMA.extend( EXTERNAL_FONT_SCHEMA.extend(
{ {
@ -259,10 +347,10 @@ def validate_file_shorthand(value):
} }
if weight is not None: if weight is not None:
data[CONF_WEIGHT] = weight[1:] data[CONF_WEIGHT] = weight[1:]
return FILE_SCHEMA(data) return font_file_schema(data)
if value.startswith("http://") or value.startswith("https://"): if value.startswith("http://") or value.startswith("https://"):
return FILE_SCHEMA( return font_file_schema(
{ {
CONF_TYPE: TYPE_WEB, CONF_TYPE: TYPE_WEB,
CONF_URL: value, CONF_URL: value,
@ -270,14 +358,15 @@ def validate_file_shorthand(value):
) )
if value.endswith(".pcf") or value.endswith(".bdf"): if value.endswith(".pcf") or value.endswith(".bdf"):
return FILE_SCHEMA( value = convert_bitmap_to_pillow_font(
{ CORE.relative_config_path(cv.file_(value))
)
return {
CONF_TYPE: TYPE_LOCAL_BITMAP, CONF_TYPE: TYPE_LOCAL_BITMAP,
CONF_PATH: value, CONF_PATH: value,
} }
)
return FILE_SCHEMA( return font_file_schema(
{ {
CONF_TYPE: TYPE_LOCAL, CONF_TYPE: TYPE_LOCAL,
CONF_PATH: value, CONF_PATH: value,
@ -295,31 +384,35 @@ TYPED_FILE_SCHEMA = cv.typed_schema(
) )
def _file_schema(value): def font_file_schema(value):
if isinstance(value, str): if isinstance(value, str):
return validate_file_shorthand(value) return validate_file_shorthand(value)
return TYPED_FILE_SCHEMA(value) return TYPED_FILE_SCHEMA(value)
FILE_SCHEMA = cv.All(_file_schema) # Default if no glyphs or glyphsets are provided
DEFAULT_GLYPHSET = "GF_Latin_Kernel"
# default for bitmap fonts
DEFAULT_GLYPHS = ' !"%()+=,-.:/?0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz<C2><B0>'
DEFAULT_GLYPHS = (
' !"%()+=,-.:/?0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz°'
)
CONF_RAW_GLYPH_ID = "raw_glyph_id" CONF_RAW_GLYPH_ID = "raw_glyph_id"
FONT_SCHEMA = cv.Schema( FONT_SCHEMA = cv.Schema(
{ {
cv.Required(CONF_ID): cv.declare_id(Font), cv.Required(CONF_ID): cv.declare_id(Font),
cv.Required(CONF_FILE): FILE_SCHEMA, cv.Required(CONF_FILE): font_file_schema,
cv.Optional(CONF_GLYPHS, default=DEFAULT_GLYPHS): validate_glyphs, cv.Optional(CONF_GLYPHS, default=[]): cv.ensure_list(cv.string_strict),
cv.Optional(CONF_GLYPHSETS, default=[]): cv.ensure_list(
cv.one_of(*glyphsets.defined_glyphsets())
),
cv.Optional(CONF_IGNORE_MISSING_GLYPHS, default=False): cv.boolean,
cv.Optional(CONF_SIZE, default=20): cv.int_range(min=1), cv.Optional(CONF_SIZE, default=20): cv.int_range(min=1),
cv.Optional(CONF_BPP, default=1): cv.one_of(1, 2, 4, 8), cv.Optional(CONF_BPP, default=1): cv.one_of(1, 2, 4, 8),
cv.Optional(CONF_EXTRAS): cv.ensure_list( cv.Optional(CONF_EXTRAS, default=[]): cv.ensure_list(
cv.Schema( cv.Schema(
{ {
cv.Required(CONF_FILE): FILE_SCHEMA, cv.Required(CONF_FILE): font_file_schema,
cv.Required(CONF_GLYPHS): validate_glyphs, cv.Required(CONF_GLYPHS): cv.ensure_list(cv.string_strict),
} }
) )
), ),
@ -328,7 +421,7 @@ FONT_SCHEMA = cv.Schema(
}, },
) )
CONFIG_SCHEMA = cv.All(validate_pillow_installed, FONT_SCHEMA, merge_glyphs) CONFIG_SCHEMA = cv.All(validate_pillow_installed, FONT_SCHEMA, validate_glyphs)
# PIL doesn't provide a consistent interface for both TrueType and bitmap # PIL doesn't provide a consistent interface for both TrueType and bitmap
@ -344,7 +437,7 @@ class TrueTypeFontWrapper:
return offset_x, offset_y return offset_x, offset_y
def getmask(self, glyph, **kwargs): def getmask(self, glyph, **kwargs):
return self.font.getmask(glyph, **kwargs) return self.font.getmask(str(glyph), **kwargs)
def getmetrics(self, glyphs): def getmetrics(self, glyphs):
return self.font.getmetrics() return self.font.getmetrics()
@ -359,7 +452,7 @@ class BitmapFontWrapper:
return 0, 0 return 0, 0
def getmask(self, glyph, **kwargs): def getmask(self, glyph, **kwargs):
return self.font.getmask(glyph, **kwargs) return self.font.getmask(str(glyph), **kwargs)
def getmetrics(self, glyphs): def getmetrics(self, glyphs):
max_height = 0 max_height = 0
@ -367,28 +460,20 @@ class BitmapFontWrapper:
mask = self.getmask(glyph, mode="1") mask = self.getmask(glyph, mode="1")
_, height = mask.size _, height = mask.size
max_height = max(max_height, height) max_height = max(max_height, height)
return (max_height, 0) return max_height, 0
class EFont: class EFont:
def __init__(self, file, size, glyphs): def __init__(self, file, size, codepoints):
self.glyphs = glyphs self.codepoints = codepoints
path = file[CONF_PATH]
self.name = Path(path).name
ftype = file[CONF_TYPE] ftype = file[CONF_TYPE]
if ftype == TYPE_LOCAL_BITMAP: if ftype == TYPE_LOCAL_BITMAP:
font = load_bitmap_font(CORE.relative_config_path(file[CONF_PATH])) self.font = load_bitmap_font(path)
elif ftype == TYPE_LOCAL:
path = CORE.relative_config_path(file[CONF_PATH])
font = load_ttf_font(path, size)
elif ftype in (TYPE_GFONTS, TYPE_WEB):
path = get_font_path(file, ftype)
font = load_ttf_font(path, size)
else: else:
raise cv.Invalid(f"Could not load font: unknown type: {ftype}") self.font = load_ttf_font(path, size)
self.font = font self.ascent, self.descent = self.font.getmetrics(codepoints)
self.ascent, self.descent = font.getmetrics(glyphs)
def has_glyph(self, glyph):
return glyph in self.glyphs
def convert_bitmap_to_pillow_font(filepath): def convert_bitmap_to_pillow_font(filepath):
@ -400,6 +485,7 @@ def convert_bitmap_to_pillow_font(filepath):
copy_file_if_changed(filepath, local_bitmap_font_file) copy_file_if_changed(filepath, local_bitmap_font_file)
local_pil_font_file = local_bitmap_font_file.with_suffix(".pil")
with open(local_bitmap_font_file, "rb") as fp: with open(local_bitmap_font_file, "rb") as fp:
try: try:
try: try:
@ -409,28 +495,22 @@ def convert_bitmap_to_pillow_font(filepath):
p = BdfFontFile.BdfFontFile(fp) p = BdfFontFile.BdfFontFile(fp)
# Convert to pillow-formatted fonts, which have a .pil and .pbm extension. # Convert to pillow-formatted fonts, which have a .pil and .pbm extension.
p.save(local_bitmap_font_file) p.save(local_pil_font_file)
except (SyntaxError, OSError) as err: except (SyntaxError, OSError) as err:
raise core.EsphomeError( raise core.EsphomeError(
f"Failed to parse as bitmap font: '{filepath}': {err}" f"Failed to parse as bitmap font: '{filepath}': {err}"
) )
local_pil_font_file = os.path.splitext(local_bitmap_font_file)[0] + ".pil" return str(local_pil_font_file)
return cv.file_(local_pil_font_file)
def load_bitmap_font(filepath): def load_bitmap_font(filepath):
from PIL import ImageFont from PIL import ImageFont
# Convert bpf and pcf files to pillow fonts, first.
pil_font_path = convert_bitmap_to_pillow_font(filepath)
try: try:
font = ImageFont.load(str(pil_font_path)) font = ImageFont.load(str(filepath))
except Exception as e: except Exception as e:
raise core.EsphomeError( raise core.EsphomeError(f"Failed to load bitmap font file: {filepath}: {e}")
f"Failed to load bitmap font file: {pil_font_path} : {e}"
)
return BitmapFontWrapper(font) return BitmapFontWrapper(font)
@ -441,7 +521,7 @@ def load_ttf_font(path, size):
try: try:
font = ImageFont.truetype(str(path), size) font = ImageFont.truetype(str(path), size)
except Exception as e: except Exception as e:
raise core.EsphomeError(f"Could not load truetype file {path}: {e}") raise core.EsphomeError(f"Could not load TrueType file {path}: {e}")
return TrueTypeFontWrapper(font) return TrueTypeFontWrapper(font)
@ -456,14 +536,35 @@ class GlyphInfo:
async def to_code(config): async def to_code(config):
glyph_to_font_map = {} """
font_list = font_map[config[CONF_ID]] Collect all glyph codepoints, construct a map from a codepoint to a font file.
glyphs = [] Codepoints are either explicit (glyphs key in top level or extras) or part of a glyphset.
for font in font_list: Codepoints listed in extras use the extra font and override codepoints from glyphsets.
glyphs.extend(font.glyphs) Achieve this by processing the base codepoints first, then the extras
for glyph in font.glyphs: """
glyph_to_font_map[glyph] = font
glyphs.sort(key=functools.cmp_to_key(glyph_comparator)) # get the codepoints from glyphsets and flatten to a set of chrs.
point_set: set[str] = {
chr(x)
for x in flatten(
[glyphsets.unicodes_per_glyphset(x) for x in config[CONF_GLYPHSETS]]
)
}
# get the codepoints from the glyphs key, flatten to a list of chrs and combine with the points from glyphsets
point_set.update(flatten(config[CONF_GLYPHS]))
size = config[CONF_SIZE]
# Create the codepoint to font file map
base_font = EFont(config[CONF_FILE], size, point_set)
point_font_map: dict[str, EFont] = {c: base_font for c in point_set}
# process extras, updating the map and extending the codepoint list
for extra in config[CONF_EXTRAS]:
extra_points = flatten(extra[CONF_GLYPHS])
point_set.update(extra_points)
extra_font = EFont(extra[CONF_FILE], size, extra_points)
point_font_map.update({c: extra_font for c in extra_points})
codepoints = list(point_set)
codepoints.sort(key=functools.cmp_to_key(glyph_comparator))
glyph_args = {} glyph_args = {}
data = [] data = []
bpp = config[CONF_BPP] bpp = config[CONF_BPP]
@ -473,10 +574,11 @@ async def to_code(config):
else: else:
mode = "L" mode = "L"
scale = 256 // (1 << bpp) scale = 256 // (1 << bpp)
for glyph in glyphs: # create the data array for all glyphs
font = glyph_to_font_map[glyph].font for codepoint in codepoints:
mask = font.getmask(glyph, mode=mode) font = point_font_map[codepoint]
offset_x, offset_y = font.getoffset(glyph) mask = font.font.getmask(codepoint, mode=mode)
offset_x, offset_y = font.font.getoffset(codepoint)
width, height = mask.size width, height = mask.size
glyph_data = [0] * ((height * width * bpp + 7) // 8) glyph_data = [0] * ((height * width * bpp + 7) // 8)
pos = 0 pos = 0
@ -487,31 +589,34 @@ async def to_code(config):
if pixel & (1 << (bpp - bit_num - 1)): if pixel & (1 << (bpp - bit_num - 1)):
glyph_data[pos // 8] |= 0x80 >> (pos % 8) glyph_data[pos // 8] |= 0x80 >> (pos % 8)
pos += 1 pos += 1
glyph_args[glyph] = GlyphInfo(len(data), offset_x, offset_y, width, height) glyph_args[codepoint] = GlyphInfo(len(data), offset_x, offset_y, width, height)
data += glyph_data data += glyph_data
rhs = [HexInt(x) for x in data] rhs = [HexInt(x) for x in data]
prog_arr = cg.progmem_array(config[CONF_RAW_DATA_ID], rhs) prog_arr = cg.progmem_array(config[CONF_RAW_DATA_ID], rhs)
# Create the glyph table that points to data in the above array.
glyph_initializer = [] glyph_initializer = []
for glyph in glyphs: for codepoint in codepoints:
glyph_initializer.append( glyph_initializer.append(
cg.StructInitializer( cg.StructInitializer(
GlyphData, GlyphData,
( (
"a_char", "a_char",
cg.RawExpression(f"(const uint8_t *){cpp_string_escape(glyph)}"), cg.RawExpression(
f"(const uint8_t *){cpp_string_escape(codepoint)}"
),
), ),
( (
"data", "data",
cg.RawExpression( cg.RawExpression(
f"{str(prog_arr)} + {str(glyph_args[glyph].data_len)}" f"{str(prog_arr)} + {str(glyph_args[codepoint].data_len)}"
), ),
), ),
("offset_x", glyph_args[glyph].offset_x), ("offset_x", glyph_args[codepoint].offset_x),
("offset_y", glyph_args[glyph].offset_y), ("offset_y", glyph_args[codepoint].offset_y),
("width", glyph_args[glyph].width), ("width", glyph_args[codepoint].width),
("height", glyph_args[glyph].height), ("height", glyph_args[codepoint].height),
) )
) )
@ -521,7 +626,7 @@ async def to_code(config):
config[CONF_ID], config[CONF_ID],
glyphs, glyphs,
len(glyph_initializer), len(glyph_initializer),
font_list[0].ascent, base_font.ascent,
font_list[0].ascent + font_list[0].descent, base_font.ascent + base_font.descent,
bpp, bpp,
) )

View file

@ -16,7 +16,7 @@ CONFIG_SCHEMA = output.FLOAT_OUTPUT_SCHEMA.extend(
{ {
cv.GenerateID(): cv.declare_id(GP8403Output), cv.GenerateID(): cv.declare_id(GP8403Output),
cv.GenerateID(CONF_GP8403_ID): cv.use_id(GP8403), cv.GenerateID(CONF_GP8403_ID): cv.use_id(GP8403),
cv.Required(CONF_CHANNEL): cv.one_of(0, 1), cv.Required(CONF_CHANNEL): cv.int_range(min=0, max=1),
} }
).extend(cv.COMPONENT_SCHEMA) ).extend(cv.COMPONENT_SCHEMA)

View file

@ -1,5 +1,8 @@
import logging import logging
from esphome import pins
import esphome.codegen as cg
import esphome.config_validation as cv
from esphome.const import ( from esphome.const import (
CONF_ID, CONF_ID,
CONF_INPUT, CONF_INPUT,
@ -11,9 +14,6 @@ from esphome.const import (
CONF_PULLDOWN, CONF_PULLDOWN,
CONF_PULLUP, CONF_PULLUP,
) )
from esphome import pins
import esphome.config_validation as cv
import esphome.codegen as cg
from .const import host_ns from .const import host_ns
@ -28,8 +28,10 @@ def _translate_pin(value):
"This variable only supports pin numbers, not full pin schemas " "This variable only supports pin numbers, not full pin schemas "
"(with inverted and mode)." "(with inverted and mode)."
) )
if isinstance(value, int): if isinstance(value, int) and not isinstance(value, bool):
return value return value
if not isinstance(value, str):
raise cv.Invalid(f"Invalid pin number: {value}")
try: try:
return int(value) return int(value)
except ValueError: except ValueError:

View file

@ -6,6 +6,7 @@ from esphome.const import (
CONF_ESP8266_DISABLE_SSL_SUPPORT, CONF_ESP8266_DISABLE_SSL_SUPPORT,
CONF_ID, CONF_ID,
CONF_METHOD, CONF_METHOD,
CONF_ON_ERROR,
CONF_TIMEOUT, CONF_TIMEOUT,
CONF_TRIGGER_ID, CONF_TRIGGER_ID,
CONF_URL, CONF_URL,
@ -185,6 +186,13 @@ HTTP_REQUEST_ACTION_SCHEMA = cv.Schema(
cv.Optional(CONF_ON_RESPONSE): automation.validate_automation( cv.Optional(CONF_ON_RESPONSE): automation.validate_automation(
{cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(HttpRequestResponseTrigger)} {cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(HttpRequestResponseTrigger)}
), ),
cv.Optional(CONF_ON_ERROR): automation.validate_automation(
{
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(
automation.Trigger.template()
)
}
),
cv.Optional(CONF_MAX_RESPONSE_BUFFER_SIZE, default="1kB"): cv.validate_bytes, cv.Optional(CONF_MAX_RESPONSE_BUFFER_SIZE, default="1kB"): cv.validate_bytes,
} }
) )
@ -272,5 +280,9 @@ async def http_request_action_to_code(config, action_id, template_arg, args):
], ],
conf, conf,
) )
for conf in config.get(CONF_ON_ERROR, []):
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID])
cg.add(var.register_error_trigger(trigger))
await automation.build_automation(trigger, [], conf)
return var return var

View file

@ -22,6 +22,63 @@ struct Header {
const char *value; const char *value;
}; };
// Some common HTTP status codes
enum HttpStatus {
HTTP_STATUS_OK = 200,
HTTP_STATUS_NO_CONTENT = 204,
HTTP_STATUS_PARTIAL_CONTENT = 206,
/* 3xx - Redirection */
HTTP_STATUS_MULTIPLE_CHOICES = 300,
HTTP_STATUS_MOVED_PERMANENTLY = 301,
HTTP_STATUS_FOUND = 302,
HTTP_STATUS_SEE_OTHER = 303,
HTTP_STATUS_NOT_MODIFIED = 304,
HTTP_STATUS_TEMPORARY_REDIRECT = 307,
HTTP_STATUS_PERMANENT_REDIRECT = 308,
/* 4XX - CLIENT ERROR */
HTTP_STATUS_BAD_REQUEST = 400,
HTTP_STATUS_UNAUTHORIZED = 401,
HTTP_STATUS_FORBIDDEN = 403,
HTTP_STATUS_NOT_FOUND = 404,
HTTP_STATUS_METHOD_NOT_ALLOWED = 405,
HTTP_STATUS_NOT_ACCEPTABLE = 406,
HTTP_STATUS_LENGTH_REQUIRED = 411,
/* 5xx - Server Error */
HTTP_STATUS_INTERNAL_ERROR = 500
};
/**
* @brief Returns true if the HTTP status code is a redirect.
*
* @param status the HTTP status code to check
* @return true if the status code is a redirect, false otherwise
*/
inline bool is_redirect(int const status) {
switch (status) {
case HTTP_STATUS_MOVED_PERMANENTLY:
case HTTP_STATUS_FOUND:
case HTTP_STATUS_SEE_OTHER:
case HTTP_STATUS_TEMPORARY_REDIRECT:
case HTTP_STATUS_PERMANENT_REDIRECT:
return true;
default:
return false;
}
}
/**
* @brief Checks if the given HTTP status code indicates a successful request.
*
* A successful request is one where the status code is in the range 200-299
*
* @param status the HTTP status code to check
* @return true if the status code indicates a successful request, false otherwise
*/
inline bool is_success(int const status) { return status >= HTTP_STATUS_OK && status < HTTP_STATUS_MULTIPLE_CHOICES; }
class HttpRequestComponent; class HttpRequestComponent;
class HttpContainer : public Parented<HttpRequestComponent> { class HttpContainer : public Parented<HttpRequestComponent> {
@ -78,8 +135,8 @@ class HttpRequestComponent : public Component {
protected: protected:
const char *useragent_{nullptr}; const char *useragent_{nullptr};
bool follow_redirects_; bool follow_redirects_{};
uint16_t redirect_limit_; uint16_t redirect_limit_{};
uint16_t timeout_{4500}; uint16_t timeout_{4500};
uint32_t watchdog_timeout_{0}; uint32_t watchdog_timeout_{0};
}; };
@ -100,6 +157,8 @@ template<typename... Ts> class HttpRequestSendAction : public Action<Ts...> {
void register_response_trigger(HttpRequestResponseTrigger *trigger) { this->response_triggers_.push_back(trigger); } void register_response_trigger(HttpRequestResponseTrigger *trigger) { this->response_triggers_.push_back(trigger); }
void register_error_trigger(Trigger<> *trigger) { this->error_triggers_.push_back(trigger); }
void set_max_response_buffer_size(size_t max_response_buffer_size) { void set_max_response_buffer_size(size_t max_response_buffer_size) {
this->max_response_buffer_size_ = max_response_buffer_size; this->max_response_buffer_size_ = max_response_buffer_size;
} }
@ -129,6 +188,8 @@ template<typename... Ts> class HttpRequestSendAction : public Action<Ts...> {
auto container = this->parent_->start(this->url_.value(x...), this->method_.value(x...), body, headers); auto container = this->parent_->start(this->url_.value(x...), this->method_.value(x...), body, headers);
if (container == nullptr) { if (container == nullptr) {
for (auto *trigger : this->error_triggers_)
trigger->trigger(x...);
return; return;
} }
@ -180,7 +241,8 @@ template<typename... Ts> class HttpRequestSendAction : public Action<Ts...> {
std::map<const char *, TemplatableValue<const char *, Ts...>> headers_{}; std::map<const char *, TemplatableValue<const char *, Ts...>> headers_{};
std::map<const char *, TemplatableValue<std::string, Ts...>> json_{}; std::map<const char *, TemplatableValue<std::string, Ts...>> json_{};
std::function<void(Ts..., JsonObject)> json_func_{nullptr}; std::function<void(Ts..., JsonObject)> json_func_{nullptr};
std::vector<HttpRequestResponseTrigger *> response_triggers_; std::vector<HttpRequestResponseTrigger *> response_triggers_{};
std::vector<Trigger<> *> error_triggers_{};
size_t max_response_buffer_size_{SIZE_MAX}; size_t max_response_buffer_size_{SIZE_MAX};
}; };

View file

@ -113,11 +113,10 @@ std::shared_ptr<HttpContainer> HttpRequestArduino::start(std::string url, std::s
return nullptr; return nullptr;
} }
if (container->status_code < 200 || container->status_code >= 300) { if (!is_success(container->status_code)) {
ESP_LOGE(TAG, "HTTP Request failed; URL: %s; Code: %d", url.c_str(), container->status_code); ESP_LOGE(TAG, "HTTP Request failed; URL: %s; Code: %d", url.c_str(), container->status_code);
this->status_momentary_error("failed", 1000); this->status_momentary_error("failed", 1000);
container->end(); // Still return the container, so it can be used to get the status code and error message
return nullptr;
} }
int content_length = container->client_.getSize(); int content_length = container->client_.getSize();

View file

@ -6,7 +6,6 @@
#include "esphome/components/watchdog/watchdog.h" #include "esphome/components/watchdog/watchdog.h"
#include "esphome/core/application.h" #include "esphome/core/application.h"
#include "esphome/core/defines.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
#if CONFIG_MBEDTLS_CERTIFICATE_BUNDLE #if CONFIG_MBEDTLS_CERTIFICATE_BUNDLE
@ -118,20 +117,14 @@ std::shared_ptr<HttpContainer> HttpRequestIDF::start(std::string url, std::strin
return nullptr; return nullptr;
} }
auto is_ok = [](int code) { return code >= HttpStatus_Ok && code < HttpStatus_MultipleChoices; };
container->content_length = esp_http_client_fetch_headers(client); container->content_length = esp_http_client_fetch_headers(client);
container->status_code = esp_http_client_get_status_code(client); container->status_code = esp_http_client_get_status_code(client);
if (is_ok(container->status_code)) { if (is_success(container->status_code)) {
container->duration_ms = millis() - start; container->duration_ms = millis() - start;
return container; return container;
} }
if (this->follow_redirects_) { if (this->follow_redirects_) {
auto is_redirect = [](int code) {
return code == HttpStatus_MovedPermanently || code == HttpStatus_Found || code == HttpStatus_SeeOther ||
code == HttpStatus_TemporaryRedirect || code == HttpStatus_PermanentRedirect;
};
auto num_redirects = this->redirect_limit_; auto num_redirects = this->redirect_limit_;
while (is_redirect(container->status_code) && num_redirects > 0) { while (is_redirect(container->status_code) && num_redirects > 0) {
err = esp_http_client_set_redirection(client); err = esp_http_client_set_redirection(client);
@ -142,9 +135,9 @@ std::shared_ptr<HttpContainer> HttpRequestIDF::start(std::string url, std::strin
return nullptr; return nullptr;
} }
#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE #if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
char url[256]{}; char redirect_url[256]{};
if (esp_http_client_get_url(client, url, sizeof(url) - 1) == ESP_OK) { if (esp_http_client_get_url(client, redirect_url, sizeof(redirect_url) - 1) == ESP_OK) {
ESP_LOGV(TAG, "redirecting to url: %s", url); ESP_LOGV(TAG, "redirecting to url: %s", redirect_url);
} }
#endif #endif
err = esp_http_client_open(client, 0); err = esp_http_client_open(client, 0);
@ -157,7 +150,7 @@ std::shared_ptr<HttpContainer> HttpRequestIDF::start(std::string url, std::strin
container->content_length = esp_http_client_fetch_headers(client); container->content_length = esp_http_client_fetch_headers(client);
container->status_code = esp_http_client_get_status_code(client); container->status_code = esp_http_client_get_status_code(client);
if (is_ok(container->status_code)) { if (is_success(container->status_code)) {
container->duration_ms = millis() - start; container->duration_ms = millis() - start;
return container; return container;
} }
@ -172,8 +165,7 @@ std::shared_ptr<HttpContainer> HttpRequestIDF::start(std::string url, std::strin
ESP_LOGE(TAG, "HTTP Request failed; URL: %s; Code: %d", url.c_str(), container->status_code); ESP_LOGE(TAG, "HTTP Request failed; URL: %s; Code: %d", url.c_str(), container->status_code);
this->status_momentary_error("failed", 1000); this->status_momentary_error("failed", 1000);
esp_http_client_cleanup(client); return container;
return nullptr;
} }
int HttpContainerIDF::read(uint8_t *buf, size_t max_len) { int HttpContainerIDF::read(uint8_t *buf, size_t max_len) {

View file

@ -106,7 +106,7 @@ uint8_t OtaHttpRequestComponent::do_ota_() {
auto container = this->parent_->get(url_with_auth); auto container = this->parent_->get(url_with_auth);
if (container == nullptr) { if (container == nullptr || container->status_code != HTTP_STATUS_OK) {
return OTA_CONNECTION_ERROR; return OTA_CONNECTION_ERROR;
} }

View file

@ -31,7 +31,7 @@ void HttpRequestUpdate::setup() {
void HttpRequestUpdate::update() { void HttpRequestUpdate::update() {
auto container = this->request_parent_->get(this->source_url_); auto container = this->request_parent_->get(this->source_url_);
if (container == nullptr) { if (container == nullptr || container->status_code != HTTP_STATUS_OK) {
std::string msg = str_sprintf("Failed to fetch manifest from %s", this->source_url_.c_str()); std::string msg = str_sprintf("Failed to fetch manifest from %s", this->source_url_.c_str());
this->status_set_error(msg.c_str()); this->status_set_error(msg.c_str());
return; return;

View file

@ -8,7 +8,7 @@ from esphome.components.esp32.const import (
VARIANT_ESP32S3, VARIANT_ESP32S3,
) )
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome.const import CONF_CHANNEL, CONF_ID, CONF_SAMPLE_RATE from esphome.const import CONF_BITS_PER_SAMPLE, CONF_CHANNEL, CONF_ID, CONF_SAMPLE_RATE
from esphome.cpp_generator import MockObjClass from esphome.cpp_generator import MockObjClass
import esphome.final_validate as fv import esphome.final_validate as fv
@ -25,13 +25,11 @@ CONF_I2S_LRCLK_PIN = "i2s_lrclk_pin"
CONF_I2S_AUDIO = "i2s_audio" CONF_I2S_AUDIO = "i2s_audio"
CONF_I2S_AUDIO_ID = "i2s_audio_id" CONF_I2S_AUDIO_ID = "i2s_audio_id"
CONF_BITS_PER_SAMPLE = "bits_per_sample"
CONF_I2S_MODE = "i2s_mode" CONF_I2S_MODE = "i2s_mode"
CONF_PRIMARY = "primary" CONF_PRIMARY = "primary"
CONF_SECONDARY = "secondary" CONF_SECONDARY = "secondary"
CONF_USE_APLL = "use_apll" CONF_USE_APLL = "use_apll"
CONF_BITS_PER_SAMPLE = "bits_per_sample"
CONF_BITS_PER_CHANNEL = "bits_per_channel" CONF_BITS_PER_CHANNEL = "bits_per_channel"
CONF_MONO = "mono" CONF_MONO = "mono"
CONF_LEFT = "left" CONF_LEFT = "left"

View file

@ -24,9 +24,10 @@ I2SAudioSpeaker = i2s_audio_ns.class_(
"I2SAudioSpeaker", cg.Component, speaker.Speaker, I2SAudioOut "I2SAudioSpeaker", cg.Component, speaker.Speaker, I2SAudioOut
) )
CONF_BUFFER_DURATION = "buffer_duration"
CONF_DAC_TYPE = "dac_type" CONF_DAC_TYPE = "dac_type"
CONF_I2S_COMM_FMT = "i2s_comm_fmt" CONF_I2S_COMM_FMT = "i2s_comm_fmt"
CONF_NEVER = "never"
i2s_dac_mode_t = cg.global_ns.enum("i2s_dac_mode_t") i2s_dac_mode_t = cg.global_ns.enum("i2s_dac_mode_t")
INTERNAL_DAC_OPTIONS = { INTERNAL_DAC_OPTIONS = {
@ -73,8 +74,12 @@ BASE_SCHEMA = (
.extend( .extend(
{ {
cv.Optional( cv.Optional(
CONF_TIMEOUT, default="500ms" CONF_BUFFER_DURATION, default="500ms"
): cv.positive_time_period_milliseconds, ): cv.positive_time_period_milliseconds,
cv.Optional(CONF_TIMEOUT, default="500ms"): cv.Any(
cv.positive_time_period_milliseconds,
cv.one_of(CONF_NEVER, lower=True),
),
} }
) )
.extend(cv.COMPONENT_SCHEMA) .extend(cv.COMPONENT_SCHEMA)
@ -116,4 +121,6 @@ async def to_code(config):
else: else:
cg.add(var.set_dout_pin(config[CONF_I2S_DOUT_PIN])) cg.add(var.set_dout_pin(config[CONF_I2S_DOUT_PIN]))
cg.add(var.set_i2s_comm_fmt(config[CONF_I2S_COMM_FMT])) cg.add(var.set_i2s_comm_fmt(config[CONF_I2S_COMM_FMT]))
if config[CONF_TIMEOUT] != CONF_NEVER:
cg.add(var.set_timeout(config[CONF_TIMEOUT])) cg.add(var.set_timeout(config[CONF_TIMEOUT]))
cg.add(var.set_buffer_duration(config[CONF_BUFFER_DURATION]))

View file

@ -13,21 +13,22 @@
namespace esphome { namespace esphome {
namespace i2s_audio { namespace i2s_audio {
static const size_t DMA_BUFFER_SIZE = 512; static const uint8_t DMA_BUFFER_DURATION_MS = 15;
static const size_t DMA_BUFFERS_COUNT = 4; 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 = DMA_BUFFER_DURATION_MS * DMA_BUFFERS_COUNT / 2;
static const size_t TASK_DELAY_MS = 10;
static const size_t TASK_STACK_SIZE = 4096; static const size_t TASK_STACK_SIZE = 4096;
static const ssize_t TASK_PRIORITY = 23; static const ssize_t TASK_PRIORITY = 23;
static const size_t I2S_EVENT_QUEUE_COUNT = DMA_BUFFERS_COUNT + 1;
static const char *const TAG = "i2s_audio.speaker"; static const char *const TAG = "i2s_audio.speaker";
enum SpeakerEventGroupBits : uint32_t { enum SpeakerEventGroupBits : uint32_t {
COMMAND_START = (1 << 0), // Starts the main task purpose COMMAND_START = (1 << 0), // starts the speaker task
COMMAND_STOP = (1 << 1), // stops the main task COMMAND_STOP = (1 << 1), // stops the speaker task
COMMAND_STOP_GRACEFULLY = (1 << 2), // Stops the task once all data has been written COMMAND_STOP_GRACEFULLY = (1 << 2), // Stops the speaker 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_STARTING = (1 << 10),
STATE_RUNNING = (1 << 11), STATE_RUNNING = (1 << 11),
STATE_STOPPING = (1 << 12), STATE_STOPPING = (1 << 12),
@ -91,9 +92,7 @@ static const std::vector<int16_t> Q15_VOLUME_SCALING_FACTORS = {
void I2SAudioSpeaker::setup() { void I2SAudioSpeaker::setup() {
ESP_LOGCONFIG(TAG, "Setting up I2S Audio Speaker..."); ESP_LOGCONFIG(TAG, "Setting up I2S Audio Speaker...");
if (this->event_group_ == nullptr) {
this->event_group_ = xEventGroupCreate(); this->event_group_ = xEventGroupCreate();
}
if (this->event_group_ == nullptr) { if (this->event_group_ == nullptr) {
ESP_LOGE(TAG, "Failed to create event group"); ESP_LOGE(TAG, "Failed to create event group");
@ -199,23 +198,17 @@ size_t I2SAudioSpeaker::play(const uint8_t *data, size_t length, TickType_t tick
this->start(); this->start();
} }
// Wait for the ring buffer to be available size_t bytes_written = 0;
uint32_t event_bits = if ((this->state_ == speaker::STATE_RUNNING) && (this->audio_ring_buffer_.use_count() == 1)) {
xEventGroupWaitBits(this->event_group_, SpeakerEventGroupBits::MESSAGE_RING_BUFFER_AVAILABLE_TO_WRITE, pdFALSE, // Only one owner of the ring buffer (the speaker task), so the ring buffer is allocated and no other components are
pdFALSE, pdMS_TO_TICKS(TASK_DELAY_MS)); // attempting to write to it.
if (event_bits & SpeakerEventGroupBits::MESSAGE_RING_BUFFER_AVAILABLE_TO_WRITE) { // Temporarily share ownership of the ring buffer so it won't be deallocated while writing
// Ring buffer is available to write std::shared_ptr<RingBuffer> temp_ring_buffer = this->audio_ring_buffer_;
bytes_written = temp_ring_buffer->write_without_replacement((void *) data, length, ticks_to_wait);
// 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; return bytes_written;
} }
bool I2SAudioSpeaker::has_buffered_data() const { bool I2SAudioSpeaker::has_buffered_data() const {
@ -246,10 +239,12 @@ void I2SAudioSpeaker::speaker_task(void *params) {
const ssize_t bytes_per_sample = audio_stream_info.get_bytes_per_sample(); const ssize_t bytes_per_sample = audio_stream_info.get_bytes_per_sample();
const uint8_t number_of_channels = audio_stream_info.channels; 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; const size_t dma_buffers_size = DMA_BUFFERS_COUNT * DMA_BUFFER_DURATION_MS * this_speaker->sample_rate_ / 1000 *
bytes_per_sample * number_of_channels;
const size_t ring_buffer_size =
this_speaker->buffer_duration_ms_ * this_speaker->sample_rate_ / 1000 * bytes_per_sample * number_of_channels;
if (this_speaker->send_esp_err_to_event_group_( if (this_speaker->send_esp_err_to_event_group_(this_speaker->allocate_buffers_(dma_buffers_size, ring_buffer_size))) {
this_speaker->allocate_buffers_(dma_buffers_size, RING_BUFFER_SAMPLES * bytes_per_sample))) {
// Failed to allocate buffers // Failed to allocate buffers
xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::ERR_ESP_NO_MEM); xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::ERR_ESP_NO_MEM);
this_speaker->delete_task_(dma_buffers_size); this_speaker->delete_task_(dma_buffers_size);
@ -258,9 +253,6 @@ void I2SAudioSpeaker::speaker_task(void *params) {
if (this_speaker->send_esp_err_to_event_group_(this_speaker->start_i2s_driver_())) { if (this_speaker->send_esp_err_to_event_group_(this_speaker->start_i2s_driver_())) {
// Failed to start I2S driver // Failed to start I2S driver
this_speaker->delete_task_(dma_buffers_size); 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))) { if (!this_speaker->send_esp_err_to_event_group_(this_speaker->reconfigure_i2s_stream_info_(audio_stream_info))) {
@ -270,8 +262,10 @@ void I2SAudioSpeaker::speaker_task(void *params) {
bool stop_gracefully = false; bool stop_gracefully = false;
uint32_t last_data_received_time = millis(); uint32_t last_data_received_time = millis();
bool tx_dma_underflow = false;
while ((millis() - last_data_received_time) <= this_speaker->timeout_) { while (!this_speaker->timeout_.has_value() ||
(millis() - last_data_received_time) <= this_speaker->timeout_.value()) {
event_group_bits = xEventGroupGetBits(this_speaker->event_group_); event_group_bits = xEventGroupGetBits(this_speaker->event_group_);
if (event_group_bits & SpeakerEventGroupBits::COMMAND_STOP) { if (event_group_bits & SpeakerEventGroupBits::COMMAND_STOP) {
@ -281,12 +275,18 @@ void I2SAudioSpeaker::speaker_task(void *params) {
stop_gracefully = true; stop_gracefully = true;
} }
i2s_event_t i2s_event;
while (xQueueReceive(this_speaker->i2s_event_queue_, &i2s_event, 0)) {
if (i2s_event.type == I2S_EVENT_TX_Q_OVF) {
tx_dma_underflow = true;
}
}
size_t bytes_to_read = dma_buffers_size; 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, size_t bytes_read = this_speaker->audio_ring_buffer_->read((void *) this_speaker->data_buffer_, bytes_to_read,
pdMS_TO_TICKS(TASK_DELAY_MS)); pdMS_TO_TICKS(TASK_DELAY_MS));
if (bytes_read > 0) { if (bytes_read > 0) {
last_data_received_time = millis();
size_t bytes_written = 0; size_t bytes_written = 0;
if ((audio_stream_info.bits_per_sample == 16) && (this_speaker->q15_volume_factor_ < INT16_MAX)) { if ((audio_stream_info.bits_per_sample == 16) && (this_speaker->q15_volume_factor_ < INT16_MAX)) {
@ -307,15 +307,13 @@ void I2SAudioSpeaker::speaker_task(void *params) {
if (bytes_written != bytes_read) { if (bytes_written != bytes_read) {
xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::ERR_ESP_INVALID_SIZE); xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::ERR_ESP_INVALID_SIZE);
} }
tx_dma_underflow = false;
last_data_received_time = millis();
} else { } else {
// No data received // No data received
if (stop_gracefully && tx_dma_underflow) {
if (stop_gracefully) {
break; break;
} }
i2s_zero_dma_buffer(this_speaker->parent_->get_port());
} }
} }
} else { } else {
@ -326,7 +324,6 @@ void I2SAudioSpeaker::speaker_task(void *params) {
xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::STATE_STOPPING); xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::STATE_STOPPING);
i2s_stop(this_speaker->parent_->get_port());
i2s_driver_uninstall(this_speaker->parent_->get_port()); i2s_driver_uninstall(this_speaker->parent_->get_port());
this_speaker->parent_->unlock(); this_speaker->parent_->unlock();
@ -334,7 +331,7 @@ void I2SAudioSpeaker::speaker_task(void *params) {
} }
void I2SAudioSpeaker::start() { void I2SAudioSpeaker::start() {
if (this->is_failed() || this->status_has_error()) if (!this->is_ready() || this->is_failed() || this->status_has_error())
return; return;
if ((this->state_ == speaker::STATE_STARTING) || (this->state_ == speaker::STATE_RUNNING)) if ((this->state_ == speaker::STATE_STARTING) || (this->state_ == speaker::STATE_RUNNING))
return; return;
@ -402,8 +399,8 @@ esp_err_t I2SAudioSpeaker::allocate_buffers_(size_t data_buffer_size, size_t rin
return ESP_ERR_NO_MEM; return ESP_ERR_NO_MEM;
} }
if (this->audio_ring_buffer_ == nullptr) { if (this->audio_ring_buffer_.use_count() == 0) {
// Allocate ring buffer // Allocate ring buffer. Uses a shared_ptr to ensure it isn't improperly deallocated.
this->audio_ring_buffer_ = RingBuffer::create(ring_buffer_size); this->audio_ring_buffer_ = RingBuffer::create(ring_buffer_size);
} }
@ -419,6 +416,8 @@ esp_err_t I2SAudioSpeaker::start_i2s_driver_() {
return ESP_ERR_INVALID_STATE; return ESP_ERR_INVALID_STATE;
} }
int dma_buffer_length = DMA_BUFFER_DURATION_MS * this->sample_rate_ / 1000;
i2s_driver_config_t config = { i2s_driver_config_t config = {
.mode = (i2s_mode_t) (this->i2s_mode_ | I2S_MODE_TX), .mode = (i2s_mode_t) (this->i2s_mode_ | I2S_MODE_TX),
.sample_rate = this->sample_rate_, .sample_rate = this->sample_rate_,
@ -427,7 +426,7 @@ esp_err_t I2SAudioSpeaker::start_i2s_driver_() {
.communication_format = this->i2s_comm_fmt_, .communication_format = this->i2s_comm_fmt_,
.intr_alloc_flags = ESP_INTR_FLAG_LEVEL1, .intr_alloc_flags = ESP_INTR_FLAG_LEVEL1,
.dma_buf_count = DMA_BUFFERS_COUNT, .dma_buf_count = DMA_BUFFERS_COUNT,
.dma_buf_len = DMA_BUFFER_SIZE, .dma_buf_len = dma_buffer_length,
.use_apll = this->use_apll_, .use_apll = this->use_apll_,
.tx_desc_auto_clear = true, .tx_desc_auto_clear = true,
.fixed_mclk = I2S_PIN_NO_CHANGE, .fixed_mclk = I2S_PIN_NO_CHANGE,
@ -448,7 +447,8 @@ esp_err_t I2SAudioSpeaker::start_i2s_driver_() {
} }
#endif #endif
esp_err_t err = i2s_driver_install(this->parent_->get_port(), &config, 0, nullptr); esp_err_t err =
i2s_driver_install(this->parent_->get_port(), &config, I2S_EVENT_QUEUE_COUNT, &this->i2s_event_queue_);
if (err != ESP_OK) { if (err != ESP_OK) {
// Failed to install the driver, so unlock the I2S port // Failed to install the driver, so unlock the I2S port
this->parent_->unlock(); this->parent_->unlock();
@ -502,16 +502,7 @@ esp_err_t I2SAudioSpeaker::reconfigure_i2s_stream_info_(audio::AudioStreamInfo &
} }
void I2SAudioSpeaker::delete_task_(size_t buffer_size) { void I2SAudioSpeaker::delete_task_(size_t buffer_size) {
if (this->audio_ring_buffer_ != nullptr) { this->audio_ring_buffer_.reset(); // Releases onwership of the shared_ptr
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) { if (this->data_buffer_ != nullptr) {
ExternalRAMAllocator<uint8_t> allocator(ExternalRAMAllocator<uint8_t>::ALLOW_FAILURE); ExternalRAMAllocator<uint8_t> allocator(ExternalRAMAllocator<uint8_t>::ALLOW_FAILURE);

View file

@ -7,6 +7,7 @@
#include <driver/i2s.h> #include <driver/i2s.h>
#include <freertos/event_groups.h> #include <freertos/event_groups.h>
#include <freertos/queue.h>
#include <freertos/FreeRTOS.h> #include <freertos/FreeRTOS.h>
#include "esphome/components/audio/audio.h" #include "esphome/components/audio/audio.h"
@ -22,11 +23,12 @@ namespace i2s_audio {
class I2SAudioSpeaker : public I2SAudioOut, public speaker::Speaker, public Component { class I2SAudioSpeaker : public I2SAudioOut, public speaker::Speaker, public Component {
public: public:
float get_setup_priority() const override { return esphome::setup_priority::LATE; } float get_setup_priority() const override { return esphome::setup_priority::PROCESSOR; }
void setup() override; void setup() override;
void loop() override; void loop() override;
void set_buffer_duration(uint32_t buffer_duration_ms) { this->buffer_duration_ms_ = buffer_duration_ms; }
void set_timeout(uint32_t ms) { this->timeout_ = ms; } void set_timeout(uint32_t ms) { this->timeout_ = ms; }
void set_dout_pin(uint8_t pin) { this->dout_pin_ = pin; } void set_dout_pin(uint8_t pin) { this->dout_pin_ = pin; }
#if SOC_I2S_SUPPORTS_DAC #if SOC_I2S_SUPPORTS_DAC
@ -117,10 +119,14 @@ class I2SAudioSpeaker : public I2SAudioOut, public speaker::Speaker, public Comp
TaskHandle_t speaker_task_handle_{nullptr}; TaskHandle_t speaker_task_handle_{nullptr};
EventGroupHandle_t event_group_{nullptr}; EventGroupHandle_t event_group_{nullptr};
uint8_t *data_buffer_; QueueHandle_t i2s_event_queue_;
std::unique_ptr<RingBuffer> audio_ring_buffer_;
uint32_t timeout_; uint8_t *data_buffer_;
std::shared_ptr<RingBuffer> audio_ring_buffer_;
uint32_t buffer_duration_ms_;
optional<uint32_t> timeout_;
uint8_t dout_pin_; uint8_t dout_pin_;
bool task_created_{false}; bool task_created_{false};

View file

@ -196,6 +196,10 @@ CONFIG_SCHEMA = cv.All(
_validate, _validate,
) )
FINAL_VALIDATE_SCHEMA = spi.final_validate_device_schema(
"ili9xxx", require_miso=False, require_mosi=True
)
async def to_code(config): async def to_code(config):
rhs = MODELS[config[CONF_MODEL]].new() rhs = MODELS[config[CONF_MODEL]].new()

View file

@ -8,8 +8,13 @@ extern "C" {
uint8_t temprature_sens_read(); uint8_t temprature_sens_read();
} }
#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32C6) || \ #elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32C6) || \
defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3) defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3) || defined(USE_ESP32_VARIANT_ESP32H2) || \
defined(USE_ESP32_VARIANT_ESP32C2)
#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 0, 0)
#include "driver/temp_sensor.h" #include "driver/temp_sensor.h"
#else
#include "driver/temperature_sensor.h"
#endif // ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 0, 0)
#endif // USE_ESP32_VARIANT #endif // USE_ESP32_VARIANT
#endif // USE_ESP32 #endif // USE_ESP32
#ifdef USE_RP2040 #ifdef USE_RP2040
@ -25,6 +30,13 @@ namespace esphome {
namespace internal_temperature { namespace internal_temperature {
static const char *const TAG = "internal_temperature"; static const char *const TAG = "internal_temperature";
#ifdef USE_ESP32
#if (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)) && \
(defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32C6) || defined(USE_ESP32_VARIANT_ESP32S2) || \
defined(USE_ESP32_VARIANT_ESP32S3) || defined(USE_ESP32_VARIANT_ESP32H2) || defined(USE_ESP32_VARIANT_ESP32C2))
static temperature_sensor_handle_t tsensNew = NULL;
#endif // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0) && USE_ESP32_VARIANT
#endif // USE_ESP32
void InternalTemperatureSensor::update() { void InternalTemperatureSensor::update() {
float temperature = NAN; float temperature = NAN;
@ -36,7 +48,9 @@ void InternalTemperatureSensor::update() {
temperature = (raw - 32) / 1.8f; temperature = (raw - 32) / 1.8f;
success = (raw != 128); success = (raw != 128);
#elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32C6) || \ #elif defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32C6) || \
defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3) defined(USE_ESP32_VARIANT_ESP32S2) || defined(USE_ESP32_VARIANT_ESP32S3) || defined(USE_ESP32_VARIANT_ESP32H2) || \
defined(USE_ESP32_VARIANT_ESP32C2)
#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 0, 0)
temp_sensor_config_t tsens = TSENS_CONFIG_DEFAULT(); temp_sensor_config_t tsens = TSENS_CONFIG_DEFAULT();
temp_sensor_set_config(tsens); temp_sensor_set_config(tsens);
temp_sensor_start(); temp_sensor_start();
@ -47,6 +61,13 @@ void InternalTemperatureSensor::update() {
esp_err_t result = temp_sensor_read_celsius(&temperature); esp_err_t result = temp_sensor_read_celsius(&temperature);
temp_sensor_stop(); temp_sensor_stop();
success = (result == ESP_OK); success = (result == ESP_OK);
#else
esp_err_t result = temperature_sensor_get_celsius(tsensNew, &temperature);
success = (result == ESP_OK);
if (!success) {
ESP_LOGE(TAG, "Failed to get temperature: %d", result);
}
#endif // ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 0, 0)
#endif // USE_ESP32_VARIANT #endif // USE_ESP32_VARIANT
#endif // USE_ESP32 #endif // USE_ESP32
#ifdef USE_RP2040 #ifdef USE_RP2040
@ -75,6 +96,32 @@ void InternalTemperatureSensor::update() {
} }
} }
void InternalTemperatureSensor::setup() {
#ifdef USE_ESP32
#if (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)) && \
(defined(USE_ESP32_VARIANT_ESP32C3) || defined(USE_ESP32_VARIANT_ESP32C6) || defined(USE_ESP32_VARIANT_ESP32S2) || \
defined(USE_ESP32_VARIANT_ESP32S3) || defined(USE_ESP32_VARIANT_ESP32H2) || defined(USE_ESP32_VARIANT_ESP32C2))
ESP_LOGCONFIG(TAG, "Setting up temperature sensor...");
temperature_sensor_config_t tsens_config = TEMPERATURE_SENSOR_CONFIG_DEFAULT(-10, 80);
esp_err_t result = temperature_sensor_install(&tsens_config, &tsensNew);
if (result != ESP_OK) {
ESP_LOGE(TAG, "Failed to install temperature sensor: %d", result);
this->mark_failed();
return;
}
result = temperature_sensor_enable(tsensNew);
if (result != ESP_OK) {
ESP_LOGE(TAG, "Failed to enable temperature sensor: %d", result);
this->mark_failed();
return;
}
#endif // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0) && USE_ESP32_VARIANT
#endif // USE_ESP32
}
void InternalTemperatureSensor::dump_config() { LOG_SENSOR("", "Internal Temperature Sensor", this); } void InternalTemperatureSensor::dump_config() { LOG_SENSOR("", "Internal Temperature Sensor", this); }
} // namespace internal_temperature } // namespace internal_temperature

View file

@ -8,6 +8,7 @@ namespace internal_temperature {
class InternalTemperatureSensor : public sensor::Sensor, public PollingComponent { class InternalTemperatureSensor : public sensor::Sensor, public PollingComponent {
public: public:
void setup() override;
void dump_config() override; void dump_config() override;
void update() override; void update() override;

View file

@ -180,7 +180,7 @@ void LD2420Component::apply_config_action() {
} }
void LD2420Component::factory_reset_action() { void LD2420Component::factory_reset_action() {
ESP_LOGCONFIG(TAG, "Setiing factory defaults..."); ESP_LOGCONFIG(TAG, "Setting factory defaults...");
if (this->set_config_mode(true) == LD2420_ERROR_TIMEOUT) { if (this->set_config_mode(true) == LD2420_ERROR_TIMEOUT) {
ESP_LOGE(TAG, "LD2420 module has failed to respond, check baud rate and serial connections."); ESP_LOGE(TAG, "LD2420 module has failed to respond, check baud rate and serial connections.");
this->mark_failed(); this->mark_failed();

View file

@ -1,8 +1,8 @@
import logging import logging
from esphome import pins
import esphome.codegen as cg import esphome.codegen as cg
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome import pins
from esphome.const import ( from esphome.const import (
CONF_ANALOG, CONF_ANALOG,
CONF_ID, CONF_ID,
@ -103,8 +103,10 @@ def _translate_pin(value):
"This variable only supports pin numbers, not full pin schemas " "This variable only supports pin numbers, not full pin schemas "
"(with inverted and mode)." "(with inverted and mode)."
) )
if isinstance(value, int): if isinstance(value, int) and not isinstance(value, bool):
return value return value
if not isinstance(value, str):
raise cv.Invalid(f"Invalid pin number: {value}")
try: try:
return int(value) return int(value)
except ValueError: except ValueError:

View file

@ -7,6 +7,7 @@ import esphome.config_validation as cv
from esphome.const import ( from esphome.const import (
CONF_AUTO_CLEAR_ENABLED, CONF_AUTO_CLEAR_ENABLED,
CONF_BUFFER_SIZE, CONF_BUFFER_SIZE,
CONF_GROUP,
CONF_ID, CONF_ID,
CONF_LAMBDA, CONF_LAMBDA,
CONF_ON_IDLE, CONF_ON_IDLE,
@ -23,11 +24,17 @@ from esphome.helpers import write_file_if_changed
from . import defines as df, helpers, lv_validation as lvalid from . import defines as df, helpers, lv_validation as lvalid
from .automation import disp_update, focused_widgets, update_to_code from .automation import disp_update, focused_widgets, update_to_code
from .defines import add_define from .defines import add_define
from .encoders import ENCODERS_CONFIG, encoders_to_code, initial_focus_to_code from .encoders import (
ENCODERS_CONFIG,
encoders_to_code,
get_default_group,
initial_focus_to_code,
)
from .gradient import GRADIENT_SCHEMA, gradients_to_code from .gradient import GRADIENT_SCHEMA, gradients_to_code
from .hello_world import get_hello_world from .hello_world import get_hello_world
from .keypads import KEYPADS_CONFIG, keypads_to_code
from .lv_validation import lv_bool, lv_images_used from .lv_validation import lv_bool, lv_images_used
from .lvcode import LvContext, LvglComponent from .lvcode import LvContext, LvglComponent, lvgl_static
from .schemas import ( from .schemas import (
DISP_BG_SCHEMA, DISP_BG_SCHEMA,
FLEX_OBJ_SCHEMA, FLEX_OBJ_SCHEMA,
@ -71,6 +78,7 @@ from .widgets.meter import meter_spec
from .widgets.msgbox import MSGBOX_SCHEMA, msgboxes_to_code from .widgets.msgbox import MSGBOX_SCHEMA, msgboxes_to_code
from .widgets.obj import obj_spec from .widgets.obj import obj_spec
from .widgets.page import add_pages, generate_page_triggers, page_spec from .widgets.page import add_pages, generate_page_triggers, page_spec
from .widgets.qrcode import qr_code_spec
from .widgets.roller import roller_spec from .widgets.roller import roller_spec
from .widgets.slider import slider_spec from .widgets.slider import slider_spec
from .widgets.spinbox import spinbox_spec from .widgets.spinbox import spinbox_spec
@ -109,6 +117,7 @@ for w_type in (
spinbox_spec, spinbox_spec,
keyboard_spec, keyboard_spec,
tileview_spec, tileview_spec,
qr_code_spec,
): ):
WIDGET_TYPES[w_type.name] = w_type WIDGET_TYPES[w_type.name] = w_type
@ -150,16 +159,48 @@ def generate_lv_conf_h():
return LV_CONF_H_FORMAT.format("\n".join(definitions)) return LV_CONF_H_FORMAT.format("\n".join(definitions))
def final_validation(config): def multi_conf_validate(configs: list[dict]):
displays = [config[df.CONF_DISPLAYS] for config in configs]
# flatten the display list
display_list = [disp for disps in displays for disp in disps]
if len(display_list) != len(set(display_list)):
raise cv.Invalid("A display ID may be used in only one LVGL instance")
for config in configs:
for item in (df.CONF_ENCODERS, df.CONF_KEYPADS):
for enc in config.get(item, ()):
if CONF_GROUP not in enc:
raise cv.Invalid(
f"'{item}' must have an explicit group set when using multiple LVGL instances"
)
base_config = configs[0]
for config in configs[1:]:
for item in (
df.CONF_LOG_LEVEL,
df.CONF_COLOR_DEPTH,
df.CONF_BYTE_ORDER,
df.CONF_TRANSPARENCY_KEY,
):
if base_config[item] != config[item]:
raise cv.Invalid(
f"Config item '{item}' must be the same for all LVGL instances"
)
def final_validation(configs):
if len(configs) != 1:
multi_conf_validate(configs)
global_config = full_config.get()
for config in configs:
if pages := config.get(CONF_PAGES): if pages := config.get(CONF_PAGES):
if all(p[df.CONF_SKIP] for p in pages): if all(p[df.CONF_SKIP] for p in pages):
raise cv.Invalid("At least one page must not be skipped") raise cv.Invalid("At least one page must not be skipped")
global_config = full_config.get()
for display_id in config[df.CONF_DISPLAYS]: for display_id in config[df.CONF_DISPLAYS]:
path = global_config.get_path_for_id(display_id)[:-1] path = global_config.get_path_for_id(display_id)[:-1]
display = global_config.get_config_for_path(path) display = global_config.get_config_for_path(path)
if CONF_LAMBDA in display: if CONF_LAMBDA in display:
raise cv.Invalid("Using lambda: in display config not compatible with LVGL") raise cv.Invalid(
"Using lambda: in display config not compatible with LVGL"
)
if display[CONF_AUTO_CLEAR_ENABLED]: if display[CONF_AUTO_CLEAR_ENABLED]:
raise cv.Invalid( raise cv.Invalid(
"Using auto_clear_enabled: true in display config not compatible with LVGL" "Using auto_clear_enabled: true in display config not compatible with LVGL"
@ -177,14 +218,19 @@ def final_validation(config):
for w in focused_widgets: for w in focused_widgets:
path = global_config.get_path_for_id(w) path = global_config.get_path_for_id(w)
widget_conf = global_config.get_config_for_path(path[:-1]) widget_conf = global_config.get_config_for_path(path[:-1])
if df.CONF_ADJUSTABLE in widget_conf and not widget_conf[df.CONF_ADJUSTABLE]: if (
df.CONF_ADJUSTABLE in widget_conf
and not widget_conf[df.CONF_ADJUSTABLE]
):
raise cv.Invalid( raise cv.Invalid(
"A non adjustable arc may not be focused", "A non adjustable arc may not be focused",
path, path,
) )
async def to_code(config): async def to_code(configs):
config_0 = configs[0]
# Global configuration
cg.add_library("lvgl/lvgl", "8.4.0") cg.add_library("lvgl/lvgl", "8.4.0")
cg.add_define("USE_LVGL") cg.add_define("USE_LVGL")
# suppress default enabling of extra widgets # suppress default enabling of extra widgets
@ -201,53 +247,33 @@ async def to_code(config):
add_define("LV_MEM_CUSTOM_INCLUDE", '"esphome/components/lvgl/lvgl_hal.h"') add_define("LV_MEM_CUSTOM_INCLUDE", '"esphome/components/lvgl/lvgl_hal.h"')
add_define( add_define(
"LV_LOG_LEVEL", f"LV_LOG_LEVEL_{df.LV_LOG_LEVELS[config[df.CONF_LOG_LEVEL]]}" "LV_LOG_LEVEL",
f"LV_LOG_LEVEL_{df.LV_LOG_LEVELS[config_0[df.CONF_LOG_LEVEL]]}",
) )
cg.add_define( cg.add_define(
"LVGL_LOG_LEVEL", "LVGL_LOG_LEVEL",
cg.RawExpression(f"ESPHOME_LOG_LEVEL_{config[df.CONF_LOG_LEVEL]}"), cg.RawExpression(f"ESPHOME_LOG_LEVEL_{config_0[df.CONF_LOG_LEVEL]}"),
) )
add_define("LV_COLOR_DEPTH", config[df.CONF_COLOR_DEPTH]) add_define("LV_COLOR_DEPTH", config_0[df.CONF_COLOR_DEPTH])
for font in helpers.lv_fonts_used: for font in helpers.lv_fonts_used:
add_define(f"LV_FONT_{font.upper()}") add_define(f"LV_FONT_{font.upper()}")
if config[df.CONF_COLOR_DEPTH] == 16: if config_0[df.CONF_COLOR_DEPTH] == 16:
add_define( add_define(
"LV_COLOR_16_SWAP", "LV_COLOR_16_SWAP",
"1" if config[df.CONF_BYTE_ORDER] == "big_endian" else "0", "1" if config_0[df.CONF_BYTE_ORDER] == "big_endian" else "0",
) )
add_define( add_define(
"LV_COLOR_CHROMA_KEY", "LV_COLOR_CHROMA_KEY",
await lvalid.lv_color.process(config[df.CONF_TRANSPARENCY_KEY]), await lvalid.lv_color.process(config_0[df.CONF_TRANSPARENCY_KEY]),
) )
cg.add_build_flag("-Isrc") cg.add_build_flag("-Isrc")
cg.add_global(lvgl_ns.using) cg.add_global(lvgl_ns.using)
frac = config[CONF_BUFFER_SIZE]
if frac >= 0.75:
frac = 1
elif frac >= 0.375:
frac = 2
elif frac > 0.19:
frac = 4
else:
frac = 8
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: for font in helpers.esphome_fonts_used:
await cg.get_variable(font) await cg.get_variable(font)
cg.new_Pvariable(ID(f"{font}_engine", True, type=FontEngine), MockObj(font)) cg.new_Pvariable(ID(f"{font}_engine", True, type=FontEngine), MockObj(font))
default_font = config[df.CONF_DEFAULT_FONT] default_font = config_0[df.CONF_DEFAULT_FONT]
if not lvalid.is_lv_font(default_font): if not lvalid.is_lv_font(default_font):
add_define( add_define(
"LV_FONT_CUSTOM_DECLARE", f"LV_FONT_DECLARE(*{df.DEFAULT_ESPHOME_FONT})" "LV_FONT_CUSTOM_DECLARE", f"LV_FONT_DECLARE(*{df.DEFAULT_ESPHOME_FONT})"
@ -263,11 +289,38 @@ async def to_code(config):
add_define("LV_FONT_DEFAULT", df.DEFAULT_ESPHOME_FONT) add_define("LV_FONT_DEFAULT", df.DEFAULT_ESPHOME_FONT)
else: else:
add_define("LV_FONT_DEFAULT", await lvalid.lv_font.process(default_font)) add_define("LV_FONT_DEFAULT", await lvalid.lv_font.process(default_font))
cg.add(lvgl_static.esphome_lvgl_init())
default_group = get_default_group(config_0)
for config in configs:
frac = config[CONF_BUFFER_SIZE]
if frac >= 0.75:
frac = 1
elif frac >= 0.375:
frac = 2
elif frac > 0.19:
frac = 4
else:
frac = 8
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)
lv_scr_act = get_scr_act(lv_component) lv_scr_act = get_scr_act(lv_component)
async with LvContext(lv_component): async with LvContext():
await touchscreens_to_code(lv_component, config) await touchscreens_to_code(lv_component, config)
await encoders_to_code(lv_component, config) await encoders_to_code(lv_component, config, default_group)
await keypads_to_code(lv_component, config, default_group)
await theme_to_code(config) await theme_to_code(config)
await styles_to_code(config) await styles_to_code(config)
await gradients_to_code(config) await gradients_to_code(config)
@ -279,16 +332,22 @@ async def to_code(config):
await disp_update(lv_component.get_disp(), 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. # Set this directly since we are limited in how many methods can be added to the Widget class.
Widget.widgets_completed = True Widget.widgets_completed = True
async with LvContext(lv_component): async with LvContext():
await generate_triggers(lv_component) await generate_triggers()
await generate_page_triggers(lv_component, config) for config in configs:
lv_component = await cg.get_variable(config[CONF_ID])
await generate_page_triggers(config)
await initial_focus_to_code(config) await initial_focus_to_code(config)
for conf in config.get(CONF_ON_IDLE, ()): for conf in config.get(CONF_ON_IDLE, ()):
templ = await cg.templatable(conf[CONF_TIMEOUT], [], cg.uint32) templ = await cg.templatable(conf[CONF_TIMEOUT], [], cg.uint32)
idle_trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], lv_component, templ) idle_trigger = cg.new_Pvariable(
conf[CONF_TRIGGER_ID], lv_component, templ
)
await build_automation(idle_trigger, [], conf) await build_automation(idle_trigger, [], conf)
for conf in config.get(df.CONF_ON_PAUSE, ()): for conf in config.get(df.CONF_ON_PAUSE, ()):
pause_trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], lv_component, True) pause_trigger = cg.new_Pvariable(
conf[CONF_TRIGGER_ID], lv_component, True
)
await build_automation(pause_trigger, [], conf) await build_automation(pause_trigger, [], conf)
for conf in config.get(df.CONF_ON_RESUME, ()): for conf in config.get(df.CONF_ON_RESUME, ()):
resume_trigger = cg.new_Pvariable( resume_trigger = cg.new_Pvariable(
@ -296,6 +355,7 @@ async def to_code(config):
) )
await build_automation(resume_trigger, [], conf) await build_automation(resume_trigger, [], conf)
# This must be done after all widgets are created
for comp in helpers.lvgl_components_required: for comp in helpers.lvgl_components_required:
cg.add_define(f"USE_LVGL_{comp.upper()}") cg.add_define(f"USE_LVGL_{comp.upper()}")
if "transform_angle" in styles_used: if "transform_angle" in styles_used:
@ -310,7 +370,10 @@ async def to_code(config):
def display_schema(config): def display_schema(config):
value = cv.ensure_list(cv.use_id(Display))(config) value = cv.ensure_list(cv.use_id(Display))(config)
return value or [cv.use_id(Display)(config)] value = value or [cv.use_id(Display)(config)]
if len(set(value)) != len(value):
raise cv.Invalid("Display IDs must be unique")
return value
def add_hello_world(config): def add_hello_world(config):
@ -322,7 +385,7 @@ def add_hello_world(config):
FINAL_VALIDATE_SCHEMA = final_validation FINAL_VALIDATE_SCHEMA = final_validation
CONFIG_SCHEMA = ( LVGL_SCHEMA = (
cv.polling_component_schema("1s") cv.polling_component_schema("1s")
.extend(obj_schema(obj_spec)) .extend(obj_schema(obj_spec))
.extend( .extend(
@ -384,6 +447,7 @@ CONFIG_SCHEMA = (
cv.Optional(df.CONF_GRADIENTS): GRADIENT_SCHEMA, cv.Optional(df.CONF_GRADIENTS): GRADIENT_SCHEMA,
cv.Optional(df.CONF_TOUCHSCREENS, default=None): touchscreen_schema, cv.Optional(df.CONF_TOUCHSCREENS, default=None): touchscreen_schema,
cv.Optional(df.CONF_ENCODERS, default=None): ENCODERS_CONFIG, cv.Optional(df.CONF_ENCODERS, default=None): ENCODERS_CONFIG,
cv.Optional(df.CONF_KEYPADS, default=None): KEYPADS_CONFIG,
cv.GenerateID(df.CONF_DEFAULT_GROUP): cv.declare_id(lv_group_t), cv.GenerateID(df.CONF_DEFAULT_GROUP): cv.declare_id(lv_group_t),
cv.Optional(df.CONF_RESUME_ON_INPUT, default=True): cv.boolean, cv.Optional(df.CONF_RESUME_ON_INPUT, default=True): cv.boolean,
} }
@ -391,3 +455,16 @@ CONFIG_SCHEMA = (
.extend(DISP_BG_SCHEMA) .extend(DISP_BG_SCHEMA)
.add_extra(add_hello_world) .add_extra(add_hello_world)
) )
def lvgl_config_schema(config):
"""
Can't use cv.ensure_list here because it converts an empty config to an empty list,
rather than a default config.
"""
if not config or isinstance(config, dict):
return [LVGL_SCHEMA(config)]
return cv.Schema([LVGL_SCHEMA])(config)
CONFIG_SCHEMA = lvgl_config_schema

View file

@ -1,5 +1,4 @@
from collections.abc import Awaitable from typing import Any, Callable
from typing import Callable
from esphome import automation from esphome import automation
import esphome.codegen as cg import esphome.codegen as cg
@ -23,7 +22,6 @@ from .lvcode import (
UPDATE_EVENT, UPDATE_EVENT,
LambdaContext, LambdaContext,
LocalVariable, LocalVariable,
LvglComponent,
ReturnStatement, ReturnStatement,
add_line_marks, add_line_marks,
lv, lv,
@ -58,7 +56,7 @@ focused_widgets = set()
async def action_to_code( async def action_to_code(
widgets: list[Widget], widgets: list[Widget],
action: Callable[[Widget], Awaitable[None]], action: Callable[[Widget], Any],
action_id, action_id,
template_arg, template_arg,
args, args,
@ -137,20 +135,18 @@ async def disp_update(disp, config: dict):
cv.maybe_simple_value( cv.maybe_simple_value(
{ {
cv.Required(CONF_ID): cv.use_id(lv_obj_t), cv.Required(CONF_ID): cv.use_id(lv_obj_t),
cv.GenerateID(CONF_LVGL_ID): cv.use_id(LvglComponent),
}, },
key=CONF_ID, key=CONF_ID,
), ),
cv.Schema( LVGL_SCHEMA,
{
cv.GenerateID(CONF_LVGL_ID): cv.use_id(LvglComponent),
}
),
), ),
) )
async def obj_invalidate_to_code(config, action_id, template_arg, args): async def obj_invalidate_to_code(config, action_id, template_arg, args):
if CONF_LVGL_ID in config:
lv_comp = await cg.get_variable(config[CONF_LVGL_ID]) lv_comp = await cg.get_variable(config[CONF_LVGL_ID])
widgets = await get_widgets(config) or [get_scr_act(lv_comp)] widgets = [get_scr_act(lv_comp)]
else:
widgets = await get_widgets(config)
async def do_invalidate(widget: Widget): async def do_invalidate(widget: Widget):
lv_obj.invalidate(widget.obj) lv_obj.invalidate(widget.obj)
@ -161,14 +157,12 @@ async def obj_invalidate_to_code(config, action_id, template_arg, args):
@automation.register_action( @automation.register_action(
"lvgl.update", "lvgl.update",
LvglAction, LvglAction,
DISP_BG_SCHEMA.extend( DISP_BG_SCHEMA.extend(LVGL_SCHEMA).add_extra(
{ cv.has_at_least_one_key(CONF_DISP_BG_COLOR, CONF_DISP_BG_IMAGE)
cv.GenerateID(): cv.use_id(LvglComponent), ),
}
).add_extra(cv.has_at_least_one_key(CONF_DISP_BG_COLOR, CONF_DISP_BG_IMAGE)),
) )
async def lvgl_update_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) widgets = await get_widgets(config, CONF_LVGL_ID)
w = widgets[0] w = widgets[0]
disp = literal(f"{w.obj}->get_disp()") disp = literal(f"{w.obj}->get_disp()")
async with LambdaContext(LVGL_COMP_ARG, where=action_id) as context: async with LambdaContext(LVGL_COMP_ARG, where=action_id) as context:
@ -181,32 +175,33 @@ async def lvgl_update_to_code(config, action_id, template_arg, args):
@automation.register_action( @automation.register_action(
"lvgl.pause", "lvgl.pause",
LvglAction, LvglAction,
LVGL_SCHEMA.extend(
{ {
cv.GenerateID(): cv.use_id(LvglComponent),
cv.Optional(CONF_SHOW_SNOW, default=False): lv_bool, cv.Optional(CONF_SHOW_SNOW, default=False): lv_bool,
}, }
),
) )
async def pause_action_to_code(config, action_id, template_arg, args): async def pause_action_to_code(config, action_id, template_arg, args):
lv_comp = await cg.get_variable(config[CONF_LVGL_ID])
async with LambdaContext(LVGL_COMP_ARG) as context: async with LambdaContext(LVGL_COMP_ARG) as context:
add_line_marks(where=action_id) add_line_marks(where=action_id)
lv_add(lvgl_comp.set_paused(True, config[CONF_SHOW_SNOW])) lv_add(lvgl_comp.set_paused(True, config[CONF_SHOW_SNOW]))
var = cg.new_Pvariable(action_id, template_arg, await context.get_lambda()) var = cg.new_Pvariable(action_id, template_arg, await context.get_lambda())
await cg.register_parented(var, config[CONF_ID]) await cg.register_parented(var, lv_comp)
return var return var
@automation.register_action( @automation.register_action(
"lvgl.resume", "lvgl.resume",
LvglAction, LvglAction,
{ LVGL_SCHEMA,
cv.GenerateID(): cv.use_id(LvglComponent),
},
) )
async def resume_action_to_code(config, action_id, template_arg, args): async def resume_action_to_code(config, action_id, template_arg, args):
lv_comp = await cg.get_variable(config[CONF_LVGL_ID])
async with LambdaContext(LVGL_COMP_ARG, where=action_id) as context: async with LambdaContext(LVGL_COMP_ARG, where=action_id) as context:
lv_add(lvgl_comp.set_paused(False, False)) lv_add(lvgl_comp.set_paused(False, False))
var = cg.new_Pvariable(action_id, template_arg, await context.get_lambda()) var = cg.new_Pvariable(action_id, template_arg, await context.get_lambda())
await cg.register_parented(var, config[CONF_ID]) await cg.register_parented(var, lv_comp)
return var return var
@ -265,14 +260,15 @@ def focused_id(value):
ObjUpdateAction, ObjUpdateAction,
cv.Any( cv.Any(
cv.maybe_simple_value( cv.maybe_simple_value(
LVGL_SCHEMA.extend(
{ {
cv.Optional(CONF_GROUP): cv.use_id(lv_group_t), cv.Optional(CONF_GROUP): cv.use_id(lv_group_t),
cv.Required(CONF_ACTION): cv.one_of( cv.Required(CONF_ACTION): cv.one_of(
"MARK", "RESTORE", "NEXT", "PREVIOUS", upper=True "MARK", "RESTORE", "NEXT", "PREVIOUS", upper=True
), ),
cv.GenerateID(CONF_LVGL_ID): cv.use_id(LvglComponent),
cv.Optional(CONF_FREEZE, default=False): cv.boolean, cv.Optional(CONF_FREEZE, default=False): cv.boolean,
}, }
),
key=CONF_ACTION, key=CONF_ACTION,
), ),
cv.maybe_simple_value( cv.maybe_simple_value(

View file

@ -1,4 +1,3 @@
import esphome.codegen as cg
from esphome.components.binary_sensor import ( from esphome.components.binary_sensor import (
BinarySensor, BinarySensor,
binary_sensor_schema, binary_sensor_schema,
@ -6,36 +5,30 @@ from esphome.components.binary_sensor import (
) )
import esphome.config_validation as cv import esphome.config_validation as cv
from ..defines import CONF_LVGL_ID, CONF_WIDGET from ..defines import CONF_WIDGET
from ..lvcode import EVENT_ARG, LambdaContext, LvContext from ..lvcode import EVENT_ARG, LambdaContext, LvContext, lvgl_static
from ..schemas import LVGL_SCHEMA
from ..types import LV_EVENT, lv_pseudo_button_t from ..types import LV_EVENT, lv_pseudo_button_t
from ..widgets import Widget, get_widgets, wait_for_widgets from ..widgets import Widget, get_widgets, wait_for_widgets
CONFIG_SCHEMA = ( CONFIG_SCHEMA = binary_sensor_schema(BinarySensor).extend(
binary_sensor_schema(BinarySensor)
.extend(LVGL_SCHEMA)
.extend(
{ {
cv.Required(CONF_WIDGET): cv.use_id(lv_pseudo_button_t), cv.Required(CONF_WIDGET): cv.use_id(lv_pseudo_button_t),
} }
)
) )
async def to_code(config): async def to_code(config):
sensor = await new_binary_sensor(config) sensor = await new_binary_sensor(config)
paren = await cg.get_variable(config[CONF_LVGL_ID])
widget = await get_widgets(config, CONF_WIDGET) widget = await get_widgets(config, CONF_WIDGET)
widget = widget[0] widget = widget[0]
assert isinstance(widget, Widget) assert isinstance(widget, Widget)
await wait_for_widgets() await wait_for_widgets()
async with LambdaContext(EVENT_ARG) as pressed_ctx: async with LambdaContext(EVENT_ARG) as pressed_ctx:
pressed_ctx.add(sensor.publish_state(widget.is_pressed())) pressed_ctx.add(sensor.publish_state(widget.is_pressed()))
async with LvContext(paren) as ctx: async with LvContext() as ctx:
ctx.add(sensor.publish_initial_state(widget.is_pressed())) ctx.add(sensor.publish_initial_state(widget.is_pressed()))
ctx.add( ctx.add(
paren.add_event_cb( lvgl_static.add_event_cb(
widget.obj, widget.obj,
await pressed_ctx.get_lambda(), await pressed_ctx.get_lambda(),
LV_EVENT.PRESSING, LV_EVENT.PRESSING,

View file

@ -438,6 +438,7 @@ CONF_HEADER_MODE = "header_mode"
CONF_HOME = "home" CONF_HOME = "home"
CONF_INITIAL_FOCUS = "initial_focus" CONF_INITIAL_FOCUS = "initial_focus"
CONF_KEY_CODE = "key_code" CONF_KEY_CODE = "key_code"
CONF_KEYPADS = "keypads"
CONF_LAYOUT = "layout" CONF_LAYOUT = "layout"
CONF_LEFT_BUTTON = "left_button" CONF_LEFT_BUTTON = "left_button"
CONF_LINE_WIDTH = "line_width" CONF_LINE_WIDTH = "line_width"

View file

@ -17,7 +17,7 @@ from .defines import (
from .helpers import lvgl_components_required, requires_component from .helpers import lvgl_components_required, requires_component
from .lvcode import lv, lv_add, lv_assign, lv_expr, lv_Pvariable from .lvcode import lv, lv_add, lv_assign, lv_expr, lv_Pvariable
from .schemas import ENCODER_SCHEMA from .schemas import ENCODER_SCHEMA
from .types import lv_group_t, lv_indev_type_t from .types import lv_group_t, lv_indev_type_t, lv_key_t
ENCODERS_CONFIG = cv.ensure_list( ENCODERS_CONFIG = cv.ensure_list(
ENCODER_SCHEMA.extend( ENCODER_SCHEMA.extend(
@ -39,10 +39,13 @@ ENCODERS_CONFIG = cv.ensure_list(
) )
async def encoders_to_code(var, config): def get_default_group(config):
default_group = lv_Pvariable(lv_group_t, config[CONF_DEFAULT_GROUP]) default_group = cg.Pvariable(config[CONF_DEFAULT_GROUP], lv_expr.group_create())
lv_assign(default_group, lv_expr.group_create()) cg.add(lv.group_set_default(default_group))
lv.group_set_default(default_group) return default_group
async def encoders_to_code(var, config, default_group):
for enc_conf in config[CONF_ENCODERS]: for enc_conf in config[CONF_ENCODERS]:
lvgl_components_required.add("KEY_LISTENER") lvgl_components_required.add("KEY_LISTENER")
lpt = enc_conf[CONF_LONG_PRESS_TIME].total_milliseconds lpt = enc_conf[CONF_LONG_PRESS_TIME].total_milliseconds
@ -54,14 +57,14 @@ async def encoders_to_code(var, config):
if sensor_config := enc_conf.get(CONF_SENSOR): if sensor_config := enc_conf.get(CONF_SENSOR):
if isinstance(sensor_config, dict): if isinstance(sensor_config, dict):
b_sensor = await cg.get_variable(sensor_config[CONF_LEFT_BUTTON]) b_sensor = await cg.get_variable(sensor_config[CONF_LEFT_BUTTON])
cg.add(listener.set_left_button(b_sensor)) cg.add(listener.add_button(b_sensor, lv_key_t.LV_KEY_LEFT))
b_sensor = await cg.get_variable(sensor_config[CONF_RIGHT_BUTTON]) b_sensor = await cg.get_variable(sensor_config[CONF_RIGHT_BUTTON])
cg.add(listener.set_right_button(b_sensor)) cg.add(listener.add_button(b_sensor, lv_key_t.LV_KEY_RIGHT))
else: else:
sensor_config = await cg.get_variable(sensor_config) sensor_config = await cg.get_variable(sensor_config)
lv_add(listener.set_sensor(sensor_config)) lv_add(listener.set_sensor(sensor_config))
b_sensor = await cg.get_variable(enc_conf[CONF_ENTER_BUTTON]) b_sensor = await cg.get_variable(enc_conf[CONF_ENTER_BUTTON])
cg.add(listener.set_enter_button(b_sensor)) cg.add(listener.add_button(b_sensor, lv_key_t.LV_KEY_ENTER))
if group := enc_conf.get(CONF_GROUP): if group := enc_conf.get(CONF_GROUP):
group = lv_Pvariable(lv_group_t, group) group = lv_Pvariable(lv_group_t, group)
lv_assign(group, lv_expr.group_create()) lv_assign(group, lv_expr.group_create())

View file

@ -0,0 +1,77 @@
import esphome.codegen as cg
from esphome.components.binary_sensor import BinarySensor
import esphome.config_validation as cv
from esphome.const import CONF_GROUP, CONF_ID
from .defines import (
CONF_ENCODERS,
CONF_INITIAL_FOCUS,
CONF_KEYPADS,
CONF_LONG_PRESS_REPEAT_TIME,
CONF_LONG_PRESS_TIME,
literal,
)
from .helpers import lvgl_components_required
from .lvcode import lv, lv_assign, lv_expr, lv_Pvariable
from .schemas import ENCODER_SCHEMA
from .types import lv_group_t, lv_indev_type_t
KEYPAD_KEYS = (
"up",
"down",
"right",
"left",
"esc",
"del",
"backspace",
"enter",
"next",
"prev",
"home",
"end",
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"#",
"*",
)
KEYPADS_CONFIG = cv.ensure_list(
ENCODER_SCHEMA.extend(
{cv.Optional(key): cv.use_id(BinarySensor) for key in KEYPAD_KEYS}
)
)
async def keypads_to_code(var, config, default_group):
for enc_conf in config[CONF_KEYPADS]:
lvgl_components_required.add("KEY_LISTENER")
lpt = enc_conf[CONF_LONG_PRESS_TIME].total_milliseconds
lprt = enc_conf[CONF_LONG_PRESS_REPEAT_TIME].total_milliseconds
listener = cg.new_Pvariable(
enc_conf[CONF_ID], lv_indev_type_t.LV_INDEV_TYPE_KEYPAD, lpt, lprt
)
await cg.register_parented(listener, var)
for key in [x for x in enc_conf if x in KEYPAD_KEYS]:
b_sensor = await cg.get_variable(enc_conf[key])
cg.add(listener.add_button(b_sensor, literal(f"LV_KEY_{key.upper()}")))
if group := enc_conf.get(CONF_GROUP):
group = lv_Pvariable(lv_group_t, group)
lv_assign(group, lv_expr.group_create())
else:
group = default_group
lv.indev_set_group(lv_expr.indev_drv_register(listener.get_drv()), group)
async def initial_focus_to_code(config):
for enc_conf in config[CONF_ENCODERS]:
if default_focus := enc_conf.get(CONF_INITIAL_FOCUS):
obj = await cg.get_variable(default_focus)
lv.group_focus_obj(obj)

View file

@ -4,9 +4,8 @@ from esphome.components.light import LightOutput
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome.const import CONF_GAMMA_CORRECT, CONF_OUTPUT_ID from esphome.const import CONF_GAMMA_CORRECT, CONF_OUTPUT_ID
from ..defines import CONF_LVGL_ID, CONF_WIDGET from ..defines import CONF_WIDGET
from ..lvcode import LvContext from ..lvcode import LvContext
from ..schemas import LVGL_SCHEMA
from ..types import LvType, lvgl_ns from ..types import LvType, lvgl_ns
from ..widgets import get_widgets, wait_for_widgets from ..widgets import get_widgets, wait_for_widgets
@ -18,16 +17,15 @@ CONFIG_SCHEMA = light.RGB_LIGHT_SCHEMA.extend(
cv.Required(CONF_WIDGET): 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), cv.GenerateID(CONF_OUTPUT_ID): cv.declare_id(LVLight),
} }
).extend(LVGL_SCHEMA) )
async def to_code(config): async def to_code(config):
var = cg.new_Pvariable(config[CONF_OUTPUT_ID]) var = cg.new_Pvariable(config[CONF_OUTPUT_ID])
await light.register_light(var, config) await light.register_light(var, config)
paren = await cg.get_variable(config[CONF_LVGL_ID])
widget = await get_widgets(config, CONF_WIDGET) widget = await get_widgets(config, CONF_WIDGET)
widget = widget[0] widget = widget[0]
await wait_for_widgets() await wait_for_widgets()
async with LvContext(paren) as ctx: async with LvContext() as ctx:
ctx.add(var.set_obj(widget.obj)) ctx.add(var.set_obj(widget.obj))

View file

@ -178,10 +178,9 @@ class LvContext(LambdaContext):
added_lambda_count = 0 added_lambda_count = 0
def __init__(self, lv_component, args=None): def __init__(self, args=None):
self.args = args or LVGL_COMP_ARG self.args = args or LVGL_COMP_ARG
super().__init__(parameters=self.args) super().__init__(parameters=self.args)
self.lv_component = lv_component
async def __aexit__(self, exc_type, exc_val, exc_tb): async def __aexit__(self, exc_type, exc_val, exc_tb):
await super().__aexit__(exc_type, exc_val, exc_tb) await super().__aexit__(exc_type, exc_val, exc_tb)
@ -298,6 +297,7 @@ lv_expr = LvExpr("lv_")
lv_obj = MockLv("lv_obj_") lv_obj = MockLv("lv_obj_")
# Operations on the LVGL component # Operations on the LVGL component
lvgl_comp = MockObj(LVGL_COMP, "->") lvgl_comp = MockObj(LVGL_COMP, "->")
lvgl_static = MockObj("LvglComponent", "::")
# equivalent to cg.add() for the current code context # equivalent to cg.add() for the current code context

View file

@ -98,19 +98,24 @@ void LvglComponent::set_paused(bool paused, bool show_snow) {
this->pause_callbacks_.call(paused); this->pause_callbacks_.call(paused);
} }
void LvglComponent::esphome_lvgl_init() {
lv_init();
lv_update_event = static_cast<lv_event_code_t>(lv_event_register_id());
lv_api_event = static_cast<lv_event_code_t>(lv_event_register_id());
}
void LvglComponent::add_event_cb(lv_obj_t *obj, event_callback_t callback, lv_event_code_t event) { 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); lv_obj_add_event_cb(obj, callback, event, nullptr);
} }
void LvglComponent::add_event_cb(lv_obj_t *obj, event_callback_t callback, lv_event_code_t event1, void LvglComponent::add_event_cb(lv_obj_t *obj, event_callback_t callback, lv_event_code_t event1,
lv_event_code_t event2) { lv_event_code_t event2) {
this->add_event_cb(obj, callback, event1); add_event_cb(obj, callback, event1);
this->add_event_cb(obj, callback, event2); add_event_cb(obj, callback, event2);
} }
void LvglComponent::add_event_cb(lv_obj_t *obj, event_callback_t callback, lv_event_code_t event1, void LvglComponent::add_event_cb(lv_obj_t *obj, event_callback_t callback, lv_event_code_t event1,
lv_event_code_t event2, lv_event_code_t event3) { lv_event_code_t event2, lv_event_code_t event3) {
this->add_event_cb(obj, callback, event1); add_event_cb(obj, callback, event1);
this->add_event_cb(obj, callback, event2); add_event_cb(obj, callback, event2);
this->add_event_cb(obj, callback, event3); add_event_cb(obj, callback, event3);
} }
void LvglComponent::add_page(LvPageType *page) { void LvglComponent::add_page(LvPageType *page) {
this->pages_.push_back(page); this->pages_.push_back(page);
@ -218,8 +223,10 @@ PauseTrigger::PauseTrigger(LvglComponent *parent, TemplatableValue<bool> paused)
} }
#ifdef USE_LVGL_TOUCHSCREEN #ifdef USE_LVGL_TOUCHSCREEN
LVTouchListener::LVTouchListener(uint16_t long_press_time, uint16_t long_press_repeat_time) { LVTouchListener::LVTouchListener(uint16_t long_press_time, uint16_t long_press_repeat_time, LvglComponent *parent) {
this->set_parent(parent);
lv_indev_drv_init(&this->drv_); lv_indev_drv_init(&this->drv_);
this->drv_.disp = parent->get_disp();
this->drv_.long_press_repeat_time = long_press_repeat_time; this->drv_.long_press_repeat_time = long_press_repeat_time;
this->drv_.long_press_time = long_press_time; this->drv_.long_press_time = long_press_time;
this->drv_.type = LV_INDEV_TYPE_POINTER; this->drv_.type = LV_INDEV_TYPE_POINTER;
@ -235,6 +242,7 @@ LVTouchListener::LVTouchListener(uint16_t long_press_time, uint16_t long_press_r
} }
}; };
} }
void LVTouchListener::update(const touchscreen::TouchPoints_t &tpoints) { void LVTouchListener::update(const touchscreen::TouchPoints_t &tpoints) {
this->touch_pressed_ = !this->parent_->is_paused() && !tpoints.empty(); this->touch_pressed_ = !this->parent_->is_paused() && !tpoints.empty();
if (this->touch_pressed_) if (this->touch_pressed_)
@ -405,9 +413,6 @@ LvglComponent::LvglComponent(std::vector<display::Display *> displays, float buf
buffer_frac_(buffer_frac), buffer_frac_(buffer_frac),
full_refresh_(full_refresh), full_refresh_(full_refresh),
resume_on_input_(resume_on_input) { resume_on_input_(resume_on_input) {
lv_init();
lv_update_event = static_cast<lv_event_code_t>(lv_event_register_id());
lv_api_event = static_cast<lv_event_code_t>(lv_event_register_id());
auto *display = this->displays_[0]; auto *display = this->displays_[0];
size_t buffer_pixels = display->get_width() * display->get_height() / this->buffer_frac_; size_t buffer_pixels = display->get_width() * display->get_height() / this->buffer_frac_;
auto buf_bytes = buffer_pixels * LV_COLOR_DEPTH / 8; auto buf_bytes = buffer_pixels * LV_COLOR_DEPTH / 8;

View file

@ -146,9 +146,13 @@ class LvglComponent : public PollingComponent {
} }
} }
void add_event_cb(lv_obj_t *obj, event_callback_t callback, lv_event_code_t event); /**
void add_event_cb(lv_obj_t *obj, event_callback_t callback, lv_event_code_t event1, lv_event_code_t event2); * Initialize the LVGL library and register custom events.
void add_event_cb(lv_obj_t *obj, event_callback_t callback, lv_event_code_t event1, lv_event_code_t event2, */
static void esphome_lvgl_init();
static void add_event_cb(lv_obj_t *obj, event_callback_t callback, lv_event_code_t event);
static void add_event_cb(lv_obj_t *obj, event_callback_t callback, lv_event_code_t event1, lv_event_code_t event2);
static void add_event_cb(lv_obj_t *obj, event_callback_t callback, lv_event_code_t event1, lv_event_code_t event2,
lv_event_code_t event3); lv_event_code_t event3);
void add_page(LvPageType *page); void add_page(LvPageType *page);
void show_page(size_t index, lv_scr_load_anim_t anim, uint32_t time); void show_page(size_t index, lv_scr_load_anim_t anim, uint32_t time);
@ -231,7 +235,7 @@ template<typename... Ts> class LvglCondition : public Condition<Ts...>, public P
#ifdef USE_LVGL_TOUCHSCREEN #ifdef USE_LVGL_TOUCHSCREEN
class LVTouchListener : public touchscreen::TouchListener, public Parented<LvglComponent> { class LVTouchListener : public touchscreen::TouchListener, public Parented<LvglComponent> {
public: public:
LVTouchListener(uint16_t long_press_time, uint16_t long_press_repeat_time); LVTouchListener(uint16_t long_press_time, uint16_t long_press_repeat_time, LvglComponent *parent);
void update(const touchscreen::TouchPoints_t &tpoints) override; void update(const touchscreen::TouchPoints_t &tpoints) override;
void release() override { void release() override {
touch_pressed_ = false; touch_pressed_ = false;
@ -252,15 +256,8 @@ class LVEncoderListener : public Parented<LvglComponent> {
LVEncoderListener(lv_indev_type_t type, uint16_t lpt, uint16_t lprt); LVEncoderListener(lv_indev_type_t type, uint16_t lpt, uint16_t lprt);
#ifdef USE_BINARY_SENSOR #ifdef USE_BINARY_SENSOR
void set_left_button(binary_sensor::BinarySensor *left_button) { void add_button(binary_sensor::BinarySensor *button, lv_key_t key) {
left_button->add_on_state_callback([this](bool state) { this->event(LV_KEY_LEFT, state); }); button->add_on_state_callback([this, key](bool state) { this->event(key, state); });
}
void set_right_button(binary_sensor::BinarySensor *right_button) {
right_button->add_on_state_callback([this](bool state) { this->event(LV_KEY_RIGHT, state); });
}
void set_enter_button(binary_sensor::BinarySensor *enter_button) {
enter_button->add_on_state_callback([this](bool state) { this->event(LV_KEY_ENTER, state); });
} }
#endif #endif

View file

@ -3,7 +3,7 @@ from esphome.components import number
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome.cpp_generator import MockObj from esphome.cpp_generator import MockObj
from ..defines import CONF_ANIMATED, CONF_LVGL_ID, CONF_UPDATE_ON_RELEASE, CONF_WIDGET from ..defines import CONF_ANIMATED, CONF_UPDATE_ON_RELEASE, CONF_WIDGET
from ..lv_validation import animated from ..lv_validation import animated
from ..lvcode import ( from ..lvcode import (
API_EVENT, API_EVENT,
@ -13,28 +13,23 @@ from ..lvcode import (
LvContext, LvContext,
lv, lv,
lv_add, lv_add,
lvgl_static,
) )
from ..schemas import LVGL_SCHEMA
from ..types import LV_EVENT, LvNumber, lvgl_ns from ..types import LV_EVENT, LvNumber, lvgl_ns
from ..widgets import get_widgets, wait_for_widgets from ..widgets import get_widgets, wait_for_widgets
LVGLNumber = lvgl_ns.class_("LVGLNumber", number.Number) LVGLNumber = lvgl_ns.class_("LVGLNumber", number.Number)
CONFIG_SCHEMA = ( CONFIG_SCHEMA = number.number_schema(LVGLNumber).extend(
number.number_schema(LVGLNumber)
.extend(LVGL_SCHEMA)
.extend(
{ {
cv.Required(CONF_WIDGET): cv.use_id(LvNumber), cv.Required(CONF_WIDGET): cv.use_id(LvNumber),
cv.Optional(CONF_ANIMATED, default=True): animated, cv.Optional(CONF_ANIMATED, default=True): animated,
cv.Optional(CONF_UPDATE_ON_RELEASE, default=False): cv.boolean, cv.Optional(CONF_UPDATE_ON_RELEASE, default=False): cv.boolean,
} }
)
) )
async def to_code(config): async def to_code(config):
paren = await cg.get_variable(config[CONF_LVGL_ID])
widget = await get_widgets(config, CONF_WIDGET) widget = await get_widgets(config, CONF_WIDGET)
widget = widget[0] widget = widget[0]
var = await number.new_number( var = await number.new_number(
@ -58,10 +53,10 @@ async def to_code(config):
if not config[CONF_UPDATE_ON_RELEASE] if not config[CONF_UPDATE_ON_RELEASE]
else LV_EVENT.RELEASED else LV_EVENT.RELEASED
) )
async with LvContext(paren): async with LvContext():
lv_add(var.set_control_lambda(await control.get_lambda())) lv_add(var.set_control_lambda(await control.get_lambda()))
lv_add( lv_add(
paren.add_event_cb( lvgl_static.add_event_cb(
widget.obj, await event.get_lambda(), UPDATE_EVENT, event_code widget.obj, await event.get_lambda(), UPDATE_EVENT, event_code
) )
) )

View file

@ -391,7 +391,9 @@ def container_validator(schema, widget_type: WidgetType):
add_lv_use(ltype) add_lv_use(ltype)
if value == SCHEMA_EXTRACT: if value == SCHEMA_EXTRACT:
return result return result
result = result.extend(LAYOUT_SCHEMAS[ltype.lower()]) result = result.extend(
LAYOUT_SCHEMAS.get(ltype.lower(), LAYOUT_SCHEMAS[df.TYPE_NONE])
)
return result(value) return result(value)
return validator return validator

View file

@ -1,25 +1,19 @@
import esphome.codegen as cg
from esphome.components import select from esphome.components import select
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome.const import CONF_OPTIONS from esphome.const import CONF_OPTIONS
from ..defines import CONF_ANIMATED, CONF_LVGL_ID, CONF_WIDGET, literal from ..defines import CONF_ANIMATED, CONF_WIDGET, literal
from ..lvcode import LvContext from ..lvcode import LvContext
from ..schemas import LVGL_SCHEMA
from ..types import LvSelect, lvgl_ns from ..types import LvSelect, lvgl_ns
from ..widgets import get_widgets, wait_for_widgets from ..widgets import get_widgets, wait_for_widgets
LVGLSelect = lvgl_ns.class_("LVGLSelect", select.Select) LVGLSelect = lvgl_ns.class_("LVGLSelect", select.Select)
CONFIG_SCHEMA = ( CONFIG_SCHEMA = select.select_schema(LVGLSelect).extend(
select.select_schema(LVGLSelect)
.extend(LVGL_SCHEMA)
.extend(
{ {
cv.Required(CONF_WIDGET): cv.use_id(LvSelect), cv.Required(CONF_WIDGET): cv.use_id(LvSelect),
cv.Optional(CONF_ANIMATED, default=False): cv.boolean, cv.Optional(CONF_ANIMATED, default=False): cv.boolean,
} }
)
) )
@ -28,9 +22,8 @@ async def to_code(config):
widget = widget[0] widget = widget[0]
options = widget.config.get(CONF_OPTIONS, []) options = widget.config.get(CONF_OPTIONS, [])
selector = await select.new_select(config, options=options) selector = await select.new_select(config, options=options)
paren = await cg.get_variable(config[CONF_LVGL_ID])
await wait_for_widgets() await wait_for_widgets()
async with LvContext(paren) as ctx: async with LvContext() as ctx:
ctx.add( ctx.add(
selector.set_widget( selector.set_widget(
widget.var, widget.var,

View file

@ -1,8 +1,7 @@
import esphome.codegen as cg
from esphome.components.sensor import Sensor, new_sensor, sensor_schema from esphome.components.sensor import Sensor, new_sensor, sensor_schema
import esphome.config_validation as cv import esphome.config_validation as cv
from ..defines import CONF_LVGL_ID, CONF_WIDGET from ..defines import CONF_WIDGET
from ..lvcode import ( from ..lvcode import (
API_EVENT, API_EVENT,
EVENT_ARG, EVENT_ARG,
@ -11,34 +10,29 @@ from ..lvcode import (
LambdaContext, LambdaContext,
LvContext, LvContext,
lv_add, lv_add,
lvgl_static,
) )
from ..schemas import LVGL_SCHEMA
from ..types import LV_EVENT, LvNumber from ..types import LV_EVENT, LvNumber
from ..widgets import Widget, get_widgets, wait_for_widgets from ..widgets import Widget, get_widgets, wait_for_widgets
CONFIG_SCHEMA = ( CONFIG_SCHEMA = sensor_schema(Sensor).extend(
sensor_schema(Sensor)
.extend(LVGL_SCHEMA)
.extend(
{ {
cv.Required(CONF_WIDGET): cv.use_id(LvNumber), cv.Required(CONF_WIDGET): cv.use_id(LvNumber),
} }
)
) )
async def to_code(config): async def to_code(config):
sensor = await new_sensor(config) sensor = await new_sensor(config)
paren = await cg.get_variable(config[CONF_LVGL_ID])
widget = await get_widgets(config, CONF_WIDGET) widget = await get_widgets(config, CONF_WIDGET)
widget = widget[0] widget = widget[0]
assert isinstance(widget, Widget) assert isinstance(widget, Widget)
await wait_for_widgets() await wait_for_widgets()
async with LambdaContext(EVENT_ARG) as lamb: async with LambdaContext(EVENT_ARG) as lamb:
lv_add(sensor.publish_state(widget.get_value())) lv_add(sensor.publish_state(widget.get_value()))
async with LvContext(paren, LVGL_COMP_ARG): async with LvContext(LVGL_COMP_ARG):
lv_add( lv_add(
paren.add_event_cb( lvgl_static.add_event_cb(
widget.obj, widget.obj,
await lamb.get_lambda(), await lamb.get_lambda(),
LV_EVENT.VALUE_CHANGED, LV_EVENT.VALUE_CHANGED,

View file

@ -3,7 +3,7 @@ from esphome.components.switch import Switch, new_switch, switch_schema
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome.cpp_generator import MockObj from esphome.cpp_generator import MockObj
from ..defines import CONF_LVGL_ID, CONF_WIDGET, literal from ..defines import CONF_WIDGET, literal
from ..lvcode import ( from ..lvcode import (
API_EVENT, API_EVENT,
EVENT_ARG, EVENT_ARG,
@ -13,26 +13,21 @@ from ..lvcode import (
LvContext, LvContext,
lv, lv,
lv_add, lv_add,
lvgl_static,
) )
from ..schemas import LVGL_SCHEMA
from ..types import LV_EVENT, LV_STATE, lv_pseudo_button_t, lvgl_ns from ..types import LV_EVENT, LV_STATE, lv_pseudo_button_t, lvgl_ns
from ..widgets import get_widgets, wait_for_widgets from ..widgets import get_widgets, wait_for_widgets
LVGLSwitch = lvgl_ns.class_("LVGLSwitch", Switch) LVGLSwitch = lvgl_ns.class_("LVGLSwitch", Switch)
CONFIG_SCHEMA = ( CONFIG_SCHEMA = switch_schema(LVGLSwitch).extend(
switch_schema(LVGLSwitch)
.extend(LVGL_SCHEMA)
.extend(
{ {
cv.Required(CONF_WIDGET): cv.use_id(lv_pseudo_button_t), cv.Required(CONF_WIDGET): cv.use_id(lv_pseudo_button_t),
} }
)
) )
async def to_code(config): async def to_code(config):
switch = await new_switch(config) switch = await new_switch(config)
paren = await cg.get_variable(config[CONF_LVGL_ID])
widget = await get_widgets(config, CONF_WIDGET) widget = await get_widgets(config, CONF_WIDGET)
widget = widget[0] widget = widget[0]
await wait_for_widgets() await wait_for_widgets()
@ -45,10 +40,10 @@ async def to_code(config):
widget.clear_state(LV_STATE.CHECKED) widget.clear_state(LV_STATE.CHECKED)
lv.event_send(widget.obj, API_EVENT, cg.nullptr) lv.event_send(widget.obj, API_EVENT, cg.nullptr)
control.add(switch.publish_state(literal("v"))) control.add(switch.publish_state(literal("v")))
async with LvContext(paren) as ctx: async with LvContext() as ctx:
lv_add(switch.set_control_lambda(await control.get_lambda())) lv_add(switch.set_control_lambda(await control.get_lambda()))
ctx.add( ctx.add(
paren.add_event_cb( lvgl_static.add_event_cb(
widget.obj, widget.obj,
await checked_ctx.get_lambda(), await checked_ctx.get_lambda(),
LV_EVENT.VALUE_CHANGED, LV_EVENT.VALUE_CHANGED,

View file

@ -3,7 +3,7 @@ from esphome.components import text
from esphome.components.text import new_text from esphome.components.text import new_text
import esphome.config_validation as cv import esphome.config_validation as cv
from ..defines import CONF_LVGL_ID, CONF_WIDGET from ..defines import CONF_WIDGET
from ..lvcode import ( from ..lvcode import (
API_EVENT, API_EVENT,
EVENT_ARG, EVENT_ARG,
@ -12,14 +12,14 @@ from ..lvcode import (
LvContext, LvContext,
lv, lv,
lv_add, lv_add,
lvgl_static,
) )
from ..schemas import LVGL_SCHEMA
from ..types import LV_EVENT, LvText, lvgl_ns from ..types import LV_EVENT, LvText, lvgl_ns
from ..widgets import get_widgets, wait_for_widgets from ..widgets import get_widgets, wait_for_widgets
LVGLText = lvgl_ns.class_("LVGLText", text.Text) LVGLText = lvgl_ns.class_("LVGLText", text.Text)
CONFIG_SCHEMA = text.TEXT_SCHEMA.extend(LVGL_SCHEMA).extend( CONFIG_SCHEMA = text.TEXT_SCHEMA.extend(
{ {
cv.GenerateID(): cv.declare_id(LVGLText), cv.GenerateID(): cv.declare_id(LVGLText),
cv.Required(CONF_WIDGET): cv.use_id(LvText), cv.Required(CONF_WIDGET): cv.use_id(LvText),
@ -29,7 +29,6 @@ CONFIG_SCHEMA = text.TEXT_SCHEMA.extend(LVGL_SCHEMA).extend(
async def to_code(config): async def to_code(config):
textvar = await new_text(config) textvar = await new_text(config)
paren = await cg.get_variable(config[CONF_LVGL_ID])
widget = await get_widgets(config, CONF_WIDGET) widget = await get_widgets(config, CONF_WIDGET)
widget = widget[0] widget = widget[0]
await wait_for_widgets() await wait_for_widgets()
@ -39,10 +38,10 @@ async def to_code(config):
control.add(textvar.publish_state(widget.get_value())) control.add(textvar.publish_state(widget.get_value()))
async with LambdaContext(EVENT_ARG) as lamb: async with LambdaContext(EVENT_ARG) as lamb:
lv_add(textvar.publish_state(widget.get_value())) lv_add(textvar.publish_state(widget.get_value()))
async with LvContext(paren): async with LvContext():
lv_add(textvar.set_control_lambda(await control.get_lambda())) lv_add(textvar.set_control_lambda(await control.get_lambda()))
lv_add( lv_add(
paren.add_event_cb( lvgl_static.add_event_cb(
widget.obj, widget.obj,
await lamb.get_lambda(), await lamb.get_lambda(),
LV_EVENT.VALUE_CHANGED, LV_EVENT.VALUE_CHANGED,

View file

@ -1,4 +1,3 @@
import esphome.codegen as cg
from esphome.components.text_sensor import ( from esphome.components.text_sensor import (
TextSensor, TextSensor,
new_text_sensor, new_text_sensor,
@ -6,34 +5,35 @@ from esphome.components.text_sensor import (
) )
import esphome.config_validation as cv import esphome.config_validation as cv
from ..defines import CONF_LVGL_ID, CONF_WIDGET from ..defines import CONF_WIDGET
from ..lvcode import API_EVENT, EVENT_ARG, UPDATE_EVENT, LambdaContext, LvContext from ..lvcode import (
from ..schemas import LVGL_SCHEMA API_EVENT,
EVENT_ARG,
UPDATE_EVENT,
LambdaContext,
LvContext,
lvgl_static,
)
from ..types import LV_EVENT, LvText from ..types import LV_EVENT, LvText
from ..widgets import get_widgets, wait_for_widgets from ..widgets import get_widgets, wait_for_widgets
CONFIG_SCHEMA = ( CONFIG_SCHEMA = text_sensor_schema(TextSensor).extend(
text_sensor_schema(TextSensor)
.extend(LVGL_SCHEMA)
.extend(
{ {
cv.Required(CONF_WIDGET): cv.use_id(LvText), cv.Required(CONF_WIDGET): cv.use_id(LvText),
} }
)
) )
async def to_code(config): async def to_code(config):
sensor = await new_text_sensor(config) sensor = await new_text_sensor(config)
paren = await cg.get_variable(config[CONF_LVGL_ID])
widget = await get_widgets(config, CONF_WIDGET) widget = await get_widgets(config, CONF_WIDGET)
widget = widget[0] widget = widget[0]
await wait_for_widgets() await wait_for_widgets()
async with LambdaContext(EVENT_ARG) as pressed_ctx: async with LambdaContext(EVENT_ARG) as pressed_ctx:
pressed_ctx.add(sensor.publish_state(widget.get_value())) pressed_ctx.add(sensor.publish_state(widget.get_value()))
async with LvContext(paren) as ctx: async with LvContext() as ctx:
ctx.add( ctx.add(
paren.add_event_cb( lvgl_static.add_event_cb(
widget.obj, widget.obj,
await pressed_ctx.get_lambda(), await pressed_ctx.get_lambda(),
LV_EVENT.VALUE_CHANGED, LV_EVENT.VALUE_CHANGED,

View file

@ -33,13 +33,12 @@ def touchscreen_schema(config):
return [TOUCHSCREENS_CONFIG(config)] return [TOUCHSCREENS_CONFIG(config)]
async def touchscreens_to_code(var, config): async def touchscreens_to_code(lv_component, config):
for tconf in config[CONF_TOUCHSCREENS]: for tconf in config[CONF_TOUCHSCREENS]:
lvgl_components_required.add(CONF_TOUCHSCREEN) lvgl_components_required.add(CONF_TOUCHSCREEN)
touchscreen = await cg.get_variable(tconf[CONF_TOUCHSCREEN_ID]) touchscreen = await cg.get_variable(tconf[CONF_TOUCHSCREEN_ID])
lpt = tconf[CONF_LONG_PRESS_TIME].total_milliseconds lpt = tconf[CONF_LONG_PRESS_TIME].total_milliseconds
lprt = tconf[CONF_LONG_PRESS_REPEAT_TIME].total_milliseconds lprt = tconf[CONF_LONG_PRESS_REPEAT_TIME].total_milliseconds
listener = cg.new_Pvariable(tconf[CONF_ID], lpt, lprt) listener = cg.new_Pvariable(tconf[CONF_ID], lpt, lprt, lv_component)
await cg.register_parented(listener, var)
lv.indev_drv_register(listener.get_drv()) lv.indev_drv_register(listener.get_drv())
cg.add(touchscreen.register_listener(listener)) cg.add(touchscreen.register_listener(listener))

View file

@ -20,17 +20,16 @@ from .lvcode import (
lv, lv,
lv_add, lv_add,
lv_event_t_ptr, lv_event_t_ptr,
lvgl_static,
) )
from .types import LV_EVENT from .types import LV_EVENT
from .widgets import widget_map from .widgets import widget_map
async def generate_triggers(lv_component): async def generate_triggers():
""" """
Generate LVGL triggers for all defined widgets Generate LVGL triggers for all defined widgets
Must be done after all widgets completed Must be done after all widgets completed
:param lv_component: The parent component
:return:
""" """
for w in widget_map.values(): for w in widget_map.values():
@ -43,11 +42,10 @@ async def generate_triggers(lv_component):
conf = conf[0] conf = conf[0]
w.add_flag("LV_OBJ_FLAG_CLICKABLE") w.add_flag("LV_OBJ_FLAG_CLICKABLE")
event = literal("LV_EVENT_" + LV_EVENT_MAP[event[3:].upper()]) event = literal("LV_EVENT_" + LV_EVENT_MAP[event[3:].upper()])
await add_trigger(conf, lv_component, w, event) await add_trigger(conf, w, event)
for conf in w.config.get(CONF_ON_VALUE, ()): for conf in w.config.get(CONF_ON_VALUE, ()):
await add_trigger( await add_trigger(
conf, conf,
lv_component,
w, w,
LV_EVENT.VALUE_CHANGED, LV_EVENT.VALUE_CHANGED,
API_EVENT, API_EVENT,
@ -63,7 +61,7 @@ async def generate_triggers(lv_component):
lv.obj_align_to(w.obj, target, align, x, y) lv.obj_align_to(w.obj, target, align, x, y)
async def add_trigger(conf, lv_component, w, *events): async def add_trigger(conf, w, *events):
tid = conf[CONF_TRIGGER_ID] tid = conf[CONF_TRIGGER_ID]
trigger = cg.new_Pvariable(tid) trigger = cg.new_Pvariable(tid)
args = w.get_args() + [(lv_event_t_ptr, "event")] args = w.get_args() + [(lv_event_t_ptr, "event")]
@ -72,4 +70,4 @@ async def add_trigger(conf, lv_component, w, *events):
async with LambdaContext(EVENT_ARG, where=tid) as context: async with LambdaContext(EVENT_ARG, where=tid) as context:
with LvConditional(w.is_selected()): with LvConditional(w.is_selected()):
lv_add(trigger.trigger(*value, literal("event"))) lv_add(trigger.trigger(*value, literal("event")))
lv_add(lv_component.add_event_cb(w.obj, await context.get_lambda(), *events)) lv_add(lvgl_static.add_event_cb(w.obj, await context.get_lambda(), *events))

View file

@ -40,6 +40,7 @@ void_ptr = cg.void.operator("ptr")
lv_coord_t = cg.global_ns.namespace("lv_coord_t") lv_coord_t = cg.global_ns.namespace("lv_coord_t")
lv_event_code_t = cg.global_ns.enum("lv_event_code_t") lv_event_code_t = cg.global_ns.enum("lv_event_code_t")
lv_indev_type_t = cg.global_ns.enum("lv_indev_type_t") lv_indev_type_t = cg.global_ns.enum("lv_indev_type_t")
lv_key_t = cg.global_ns.enum("lv_key_t")
FontEngine = lvgl_ns.class_("FontEngine") FontEngine = lvgl_ns.class_("FontEngine")
IdleTrigger = lvgl_ns.class_("IdleTrigger", automation.Trigger.template()) IdleTrigger = lvgl_ns.class_("IdleTrigger", automation.Trigger.template())
PauseTrigger = lvgl_ns.class_("PauseTrigger", automation.Trigger.template()) PauseTrigger = lvgl_ns.class_("PauseTrigger", automation.Trigger.template())

View file

@ -60,9 +60,10 @@ class AnimimgType(WidgetType):
lvgl_components_required.add(CONF_IMAGE) lvgl_components_required.add(CONF_IMAGE)
lvgl_components_required.add(CONF_ANIMIMG) lvgl_components_required.add(CONF_ANIMIMG)
if CONF_SRC in config: if CONF_SRC in config:
for x in config[CONF_SRC]: srcs = [
await cg.get_variable(x) await lv_image.process(await cg.get_variable(x))
srcs = [await lv_image.process(x) for x in config[CONF_SRC]] for x in config[CONF_SRC]
]
src_id = cg.static_const_array(config[CONF_SRC_LIST_ID], srcs) src_id = cg.static_const_array(config[CONF_SRC_LIST_ID], srcs)
count = len(config[CONF_SRC]) count = len(config[CONF_SRC])
lv.animimg_set_src(w.obj, src_id, count) lv.animimg_set_src(w.obj, src_id, count)

View file

@ -1,3 +1,4 @@
import esphome.codegen as cg
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome.const import CONF_ANGLE, CONF_MODE from esphome.const import CONF_ANGLE, CONF_MODE
@ -64,6 +65,7 @@ class ImgType(WidgetType):
async def to_code(self, w: Widget, config): async def to_code(self, w: Widget, config):
if src := config.get(CONF_SRC): if src := config.get(CONF_SRC):
src = await cg.get_variable(src)
lv.img_set_src(w.obj, await lv_image.process(src)) lv.img_set_src(w.obj, await lv_image.process(src))
if (cf_angle := config.get(CONF_ANGLE)) is not None: if (cf_angle := config.get(CONF_ANGLE)) is not None:
pivot_x = config[CONF_PIVOT_X] pivot_x = config[CONF_PIVOT_X]

View file

@ -20,6 +20,7 @@ from ..lvcode import (
add_line_marks, add_line_marks,
lv_add, lv_add,
lvgl_comp, lvgl_comp,
lvgl_static,
) )
from ..schemas import LVGL_SCHEMA from ..schemas import LVGL_SCHEMA
from ..types import LvglAction, lv_page_t from ..types import LvglAction, lv_page_t
@ -139,7 +140,7 @@ async def add_pages(lv_component, config):
await add_widgets(page, pconf) await add_widgets(page, pconf)
async def generate_page_triggers(lv_component, config): async def generate_page_triggers(config):
for pconf in config.get(CONF_PAGES, ()): for pconf in config.get(CONF_PAGES, ()):
page = (await get_widgets(pconf))[0] page = (await get_widgets(pconf))[0]
for ev in (CONF_ON_LOAD, CONF_ON_UNLOAD): for ev in (CONF_ON_LOAD, CONF_ON_UNLOAD):
@ -149,7 +150,7 @@ async def generate_page_triggers(lv_component, config):
async with LambdaContext(EVENT_ARG, where=id) as context: async with LambdaContext(EVENT_ARG, where=id) as context:
lv_add(trigger.trigger()) lv_add(trigger.trigger())
lv_add( lv_add(
lv_component.add_event_cb( lvgl_static.add_event_cb(
page.obj, page.obj,
await context.get_lambda(), await context.get_lambda(),
literal(f"LV_EVENT_SCREEN_{ev[3:].upper()}_START"), literal(f"LV_EVENT_SCREEN_{ev[3:].upper()}_START"),

View file

@ -0,0 +1,54 @@
import esphome.codegen as cg
import esphome.config_validation as cv
from esphome.const import CONF_SIZE, CONF_TEXT
from esphome.cpp_generator import MockObjClass
from ..defines import CONF_MAIN, literal
from ..lv_validation import color, color_retmapper, lv_text
from ..lvcode import LocalVariable, lv, lv_expr
from ..schemas import TEXT_SCHEMA
from ..types import WidgetType, lv_obj_t
from . import Widget
CONF_QRCODE = "qrcode"
CONF_DARK_COLOR = "dark_color"
CONF_LIGHT_COLOR = "light_color"
QRCODE_SCHEMA = TEXT_SCHEMA.extend(
{
cv.Optional(CONF_DARK_COLOR, default="black"): color,
cv.Optional(CONF_LIGHT_COLOR, default="white"): color,
cv.Required(CONF_SIZE): cv.int_,
}
)
class QrCodeType(WidgetType):
def __init__(self):
super().__init__(
CONF_QRCODE,
lv_obj_t,
(CONF_MAIN,),
QRCODE_SCHEMA,
modify_schema=TEXT_SCHEMA,
)
def get_uses(self):
return ("canvas", "img")
def obj_creator(self, parent: MockObjClass, config: dict):
dark_color = color_retmapper(config[CONF_DARK_COLOR])
light_color = color_retmapper(config[CONF_LIGHT_COLOR])
size = config[CONF_SIZE]
return lv_expr.call("qrcode_create", parent, size, dark_color, light_color)
async def to_code(self, w: Widget, config):
if (value := config.get(CONF_TEXT)) is not None:
value = await lv_text.process(value)
with LocalVariable(
"qr_text", cg.const_char_ptr, value, modifier=""
) as str_obj:
lv.qrcode_update(w.obj, str_obj, literal(f"strlen({str_obj})"))
qr_code_spec = QrCodeType()

View file

@ -3,6 +3,8 @@
#include "esphome/core/log.h" #include "esphome/core/log.h"
#include "air_conditioner.h" #include "air_conditioner.h"
#include "ac_adapter.h" #include "ac_adapter.h"
#include <cmath>
#include <cstdint>
namespace esphome { namespace esphome {
namespace midea { namespace midea {
@ -121,7 +123,21 @@ void AirConditioner::dump_config() {
void AirConditioner::do_follow_me(float temperature, bool beeper) { void AirConditioner::do_follow_me(float temperature, bool beeper) {
#ifdef USE_REMOTE_TRANSMITTER #ifdef USE_REMOTE_TRANSMITTER
IrFollowMeData data(static_cast<uint8_t>(lroundf(temperature)), beeper); // Check if temperature is finite (not NaN or infinite)
if (!std::isfinite(temperature)) {
ESP_LOGW(Constants::TAG, "Follow me action requires a finite temperature, got: %f", temperature);
return;
}
// Round and convert temperature to long, then clamp and convert it to uint8_t
uint8_t temp_uint8 =
static_cast<uint8_t>(std::max(0L, std::min(static_cast<long>(UINT8_MAX), std::lroundf(temperature))));
ESP_LOGD(Constants::TAG, "Follow me action called with temperature: %f °C, rounded to: %u °C", temperature,
temp_uint8);
// Create and transmit the data
IrFollowMeData data(temp_uint8, beeper);
this->transmitter_.transmit(data); this->transmitter_.transmit(data);
#else #else
ESP_LOGW(Constants::TAG, "Action needs remote_transmitter component"); ESP_LOGW(Constants::TAG, "Action needs remote_transmitter component");

View file

@ -15,31 +15,41 @@ void Modbus::setup() {
void Modbus::loop() { void Modbus::loop() {
const uint32_t now = millis(); const uint32_t now = millis();
if (now - this->last_modbus_byte_ > 50) {
this->rx_buffer_.clear();
this->last_modbus_byte_ = now;
}
// stop blocking new send commands after send_wait_time_ ms regardless if a response has been received since then
if (now - this->last_send_ > send_wait_time_) {
waiting_for_response = 0;
}
while (this->available()) { while (this->available()) {
uint8_t byte; uint8_t byte;
this->read_byte(&byte); this->read_byte(&byte);
if (this->parse_modbus_byte_(byte)) { if (this->parse_modbus_byte_(byte)) {
this->last_modbus_byte_ = now; this->last_modbus_byte_ = now;
} else { } else {
size_t at = this->rx_buffer_.size();
if (at > 0) {
ESP_LOGV(TAG, "Clearing buffer of %d bytes - parse failed", at);
this->rx_buffer_.clear(); this->rx_buffer_.clear();
} }
} }
}
if (now - this->last_modbus_byte_ > 50) {
size_t at = this->rx_buffer_.size();
if (at > 0) {
ESP_LOGV(TAG, "Clearing buffer of %d bytes - timeout", at);
this->rx_buffer_.clear();
}
// stop blocking new send commands after sent_wait_time_ ms after response received
if (now - this->last_send_ > send_wait_time_) {
if (waiting_for_response > 0)
ESP_LOGV(TAG, "Stop waiting for response from %d", waiting_for_response);
waiting_for_response = 0;
}
}
} }
bool Modbus::parse_modbus_byte_(uint8_t byte) { bool Modbus::parse_modbus_byte_(uint8_t byte) {
size_t at = this->rx_buffer_.size(); size_t at = this->rx_buffer_.size();
this->rx_buffer_.push_back(byte); this->rx_buffer_.push_back(byte);
const uint8_t *raw = &this->rx_buffer_[0]; const uint8_t *raw = &this->rx_buffer_[0];
ESP_LOGV(TAG, "Modbus received Byte %d (0X%x)", byte, byte); ESP_LOGVV(TAG, "Modbus received Byte %d (0X%x)", byte, byte);
// Byte 0: modbus address (match all) // Byte 0: modbus address (match all)
if (at == 0) if (at == 0)
return true; return true;
@ -144,8 +154,10 @@ bool Modbus::parse_modbus_byte_(uint8_t byte) {
ESP_LOGW(TAG, "Got Modbus frame from unknown address 0x%02X! ", address); ESP_LOGW(TAG, "Got Modbus frame from unknown address 0x%02X! ", address);
} }
// return false to reset buffer // reset buffer
return false; ESP_LOGV(TAG, "Clearing buffer of %d bytes - parse succeeded", at);
this->rx_buffer_.clear();
return true;
} }
void Modbus::dump_config() { void Modbus::dump_config() {

View file

@ -25,6 +25,8 @@ from .const import (
CONF_MODBUS_CONTROLLER_ID, CONF_MODBUS_CONTROLLER_ID,
CONF_OFFLINE_SKIP_UPDATES, CONF_OFFLINE_SKIP_UPDATES,
CONF_ON_COMMAND_SENT, CONF_ON_COMMAND_SENT,
CONF_ON_ONLINE,
CONF_ON_OFFLINE,
CONF_REGISTER_COUNT, CONF_REGISTER_COUNT,
CONF_REGISTER_TYPE, CONF_REGISTER_TYPE,
CONF_RESPONSE_SIZE, CONF_RESPONSE_SIZE,
@ -114,6 +116,14 @@ ModbusCommandSentTrigger = modbus_controller_ns.class_(
"ModbusCommandSentTrigger", automation.Trigger.template(cg.int_, cg.int_) "ModbusCommandSentTrigger", automation.Trigger.template(cg.int_, cg.int_)
) )
ModbusOnlineTrigger = modbus_controller_ns.class_(
"ModbusOnlineTrigger", automation.Trigger.template(cg.int_, cg.int_)
)
ModbusOfflineTrigger = modbus_controller_ns.class_(
"ModbusOfflineTrigger", automation.Trigger.template(cg.int_, cg.int_)
)
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
ModbusServerRegisterSchema = cv.Schema( ModbusServerRegisterSchema = cv.Schema(
@ -146,6 +156,16 @@ CONFIG_SCHEMA = cv.All(
), ),
} }
), ),
cv.Optional(CONF_ON_ONLINE): automation.validate_automation(
{
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(ModbusOnlineTrigger),
}
),
cv.Optional(CONF_ON_OFFLINE): automation.validate_automation(
{
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(ModbusOnlineTrigger),
}
),
} }
) )
.extend(cv.polling_component_schema("60s")) .extend(cv.polling_component_schema("60s"))
@ -284,7 +304,17 @@ async def to_code(config):
for conf in config.get(CONF_ON_COMMAND_SENT, []): for conf in config.get(CONF_ON_COMMAND_SENT, []):
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var) trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
await automation.build_automation( await automation.build_automation(
trigger, [(int, "function_code"), (int, "address")], conf trigger, [(cg.int_, "function_code"), (cg.int_, "address")], conf
)
for conf in config.get(CONF_ON_ONLINE, []):
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
await automation.build_automation(
trigger, [(cg.int_, "function_code"), (cg.int_, "address")], conf
)
for conf in config.get(CONF_ON_OFFLINE, []):
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
await automation.build_automation(
trigger, [(cg.int_, "function_code"), (cg.int_, "address")], conf
) )

View file

@ -15,5 +15,21 @@ class ModbusCommandSentTrigger : public Trigger<int, int> {
} }
}; };
class ModbusOnlineTrigger : public Trigger<int, int> {
public:
ModbusOnlineTrigger(ModbusController *a_modbuscontroller) {
a_modbuscontroller->add_on_online_callback(
[this](int function_code, int address) { this->trigger(function_code, address); });
}
};
class ModbusOfflineTrigger : public Trigger<int, int> {
public:
ModbusOfflineTrigger(ModbusController *a_modbuscontroller) {
a_modbuscontroller->add_on_offline_callback(
[this](int function_code, int address) { this->trigger(function_code, address); });
}
};
} // namespace modbus_controller } // namespace modbus_controller
} // namespace esphome } // namespace esphome

View file

@ -9,6 +9,8 @@ CONF_MAX_CMD_RETRIES = "max_cmd_retries"
CONF_MODBUS_CONTROLLER_ID = "modbus_controller_id" CONF_MODBUS_CONTROLLER_ID = "modbus_controller_id"
CONF_MODBUS_FUNCTIONCODE = "modbus_functioncode" CONF_MODBUS_FUNCTIONCODE = "modbus_functioncode"
CONF_ON_COMMAND_SENT = "on_command_sent" CONF_ON_COMMAND_SENT = "on_command_sent"
CONF_ON_ONLINE = "on_online"
CONF_ON_OFFLINE = "on_offline"
CONF_RAW_ENCODE = "raw_encode" CONF_RAW_ENCODE = "raw_encode"
CONF_REGISTER_COUNT = "register_count" CONF_REGISTER_COUNT = "register_count"
CONF_REGISTER_TYPE = "register_type" CONF_REGISTER_TYPE = "register_type"

View file

@ -32,8 +32,10 @@ bool ModbusController::send_next_command_() {
r.skip_updates_counter = this->offline_skip_updates_; r.skip_updates_counter = this->offline_skip_updates_;
} }
} }
}
this->module_offline_ = true; this->module_offline_ = true;
this->offline_callback_.call((int) command->function_code, command->register_address);
}
ESP_LOGD(TAG, "Modbus command to device=%d register=0x%02X no response received - removed from send queue", ESP_LOGD(TAG, "Modbus command to device=%d register=0x%02X no response received - removed from send queue",
this->address_, command->register_address); this->address_, command->register_address);
this->command_queue_.pop_front(); this->command_queue_.pop_front();
@ -68,8 +70,10 @@ void ModbusController::on_modbus_data(const std::vector<uint8_t> &data) {
r.skip_updates_counter = 0; r.skip_updates_counter = 0;
} }
} }
} // Restore module online state
this->module_offline_ = false; this->module_offline_ = false;
this->online_callback_.call((int) current_command->function_code, current_command->register_address);
}
// Move the commandItem to the response queue // Move the commandItem to the response queue
current_command->payload = data; current_command->payload = data;
@ -670,5 +674,13 @@ void ModbusController::add_on_command_sent_callback(std::function<void(int, int)
this->command_sent_callback_.add(std::move(callback)); this->command_sent_callback_.add(std::move(callback));
} }
void ModbusController::add_on_online_callback(std::function<void(int, int)> &&callback) {
this->online_callback_.add(std::move(callback));
}
void ModbusController::add_on_offline_callback(std::function<void(int, int)> &&callback) {
this->offline_callback_.add(std::move(callback));
}
} // namespace modbus_controller } // namespace modbus_controller
} // namespace esphome } // namespace esphome

View file

@ -468,6 +468,10 @@ class ModbusController : public PollingComponent, public modbus::ModbusDevice {
bool get_module_offline() { return module_offline_; } bool get_module_offline() { return module_offline_; }
/// Set callback for commands /// Set callback for commands
void add_on_command_sent_callback(std::function<void(int, int)> &&callback); void add_on_command_sent_callback(std::function<void(int, int)> &&callback);
/// Set callback for online changes
void add_on_online_callback(std::function<void(int, int)> &&callback);
/// Set callback for offline changes
void add_on_offline_callback(std::function<void(int, int)> &&callback);
/// called by esphome generated code to set the max_cmd_retries. /// called by esphome generated code to set the max_cmd_retries.
void set_max_cmd_retries(uint8_t max_cmd_retries) { this->max_cmd_retries_ = max_cmd_retries; } void set_max_cmd_retries(uint8_t max_cmd_retries) { this->max_cmd_retries_ = max_cmd_retries; }
/// get how many times a command will be (re)sent if no response is received /// get how many times a command will be (re)sent if no response is received
@ -508,7 +512,12 @@ class ModbusController : public PollingComponent, public modbus::ModbusDevice {
uint16_t offline_skip_updates_; uint16_t offline_skip_updates_;
/// How many times we will retry a command if we get no response /// How many times we will retry a command if we get no response
uint8_t max_cmd_retries_{4}; uint8_t max_cmd_retries_{4};
/// Command sent callback
CallbackManager<void(int, int)> command_sent_callback_{}; CallbackManager<void(int, int)> command_sent_callback_{};
/// Server online callback
CallbackManager<void(int, int)> online_callback_{};
/// Server offline callback
CallbackManager<void(int, int)> offline_callback_{};
}; };
/** Convert vector<uint8_t> response payload to float. /** Convert vector<uint8_t> response payload to float.

View file

@ -17,6 +17,8 @@ void MopekaProCheck::dump_config() {
LOG_SENSOR(" ", "Temperature", this->temperature_); LOG_SENSOR(" ", "Temperature", this->temperature_);
LOG_SENSOR(" ", "Battery Level", this->battery_level_); LOG_SENSOR(" ", "Battery Level", this->battery_level_);
LOG_SENSOR(" ", "Reading Distance", this->distance_); LOG_SENSOR(" ", "Reading Distance", this->distance_);
LOG_SENSOR(" ", "Read Quality", this->read_quality_);
LOG_SENSOR(" ", "Ignored Reads", this->ignored_reads_);
} }
/** /**
@ -66,20 +68,34 @@ bool MopekaProCheck::parse_device(const esp32_ble_tracker::ESPBTDevice &device)
this->battery_level_->publish_state(level); this->battery_level_->publish_state(level);
} }
// Get the quality value
SensorReadQuality quality_value = this->parse_read_quality_(manu_data.data);
if (this->read_quality_ != nullptr) {
this->read_quality_->publish_state(static_cast<int>(quality_value));
}
// Determine if we have a good enough quality of read to report level and distance
// sensors. This sensor is reported regardless of distance or level sensors being enabled
if (quality_value < this->min_signal_quality_) {
ESP_LOGW(TAG, "Read Quality too low to report distance or level");
this->ignored_read_count_++;
} else {
// reset to zero since read quality was sufficient
this->ignored_read_count_ = 0;
}
// Report number of contiguous ignored reads if sensor defined
if (this->ignored_reads_ != nullptr) {
this->ignored_reads_->publish_state(this->ignored_read_count_);
}
// Get distance and level if either are sensors // Get distance and level if either are sensors
if ((this->distance_ != nullptr) || (this->level_ != nullptr)) { if ((this->distance_ != nullptr) || (this->level_ != nullptr)) {
uint32_t distance_value = this->parse_distance_(manu_data.data); uint32_t distance_value = this->parse_distance_(manu_data.data);
SensorReadQuality quality_value = this->parse_read_quality_(manu_data.data);
ESP_LOGD(TAG, "Distance Sensor: Quality (0x%X) Distance (%" PRId32 "mm)", quality_value, distance_value); ESP_LOGD(TAG, "Distance Sensor: Quality (0x%X) Distance (%" PRId32 "mm)", quality_value, distance_value);
if (quality_value < QUALITY_HIGH) {
ESP_LOGW(TAG, "Poor read quality.");
}
if (quality_value < QUALITY_MED) {
// if really bad reading set to 0
ESP_LOGW(TAG, "Setting distance to 0");
distance_value = 0;
}
// only update distance and level sensors if read quality was sufficient. This can be determined by
// if the ignored_read_count is zero.
if (this->ignored_read_count_ == 0) {
// update distance sensor // update distance sensor
if (this->distance_ != nullptr) { if (this->distance_ != nullptr) {
this->distance_->publish_state(distance_value); this->distance_->publish_state(distance_value);
@ -96,6 +112,7 @@ bool MopekaProCheck::parse_device(const esp32_ble_tracker::ESPBTDevice &device)
this->level_->publish_state(tank_level); this->level_->publish_state(tank_level);
} }
} }
}
// Get temperature of sensor // Get temperature of sensor
if (this->temperature_ != nullptr) { if (this->temperature_ != nullptr) {
@ -131,6 +148,8 @@ uint32_t MopekaProCheck::parse_distance_(const std::vector<uint8_t> &message) {
uint8_t MopekaProCheck::parse_temperature_(const std::vector<uint8_t> &message) { return (message[2] & 0x7F) - 40; } uint8_t MopekaProCheck::parse_temperature_(const std::vector<uint8_t> &message) { return (message[2] & 0x7F) - 40; }
SensorReadQuality MopekaProCheck::parse_read_quality_(const std::vector<uint8_t> &message) { SensorReadQuality MopekaProCheck::parse_read_quality_(const std::vector<uint8_t> &message) {
// Since a 8 bit value is being shifted and truncated to 2 bits all possible values are defined as enumeration
// value and the static cast is safe.
return static_cast<SensorReadQuality>(message[4] >> 6); return static_cast<SensorReadQuality>(message[4] >> 6);
} }

View file

@ -24,9 +24,9 @@ enum SensorType {
}; };
// Sensor read quality. If sensor is poorly placed or tank level // Sensor read quality. If sensor is poorly placed or tank level
// gets too low the read quality will show and the distanace // gets too low the read quality will show and the distance
// measurement may be inaccurate. // measurement may be inaccurate.
enum SensorReadQuality { QUALITY_HIGH = 0x3, QUALITY_MED = 0x2, QUALITY_LOW = 0x1, QUALITY_NONE = 0x0 }; enum SensorReadQuality { QUALITY_HIGH = 0x3, QUALITY_MED = 0x2, QUALITY_LOW = 0x1, QUALITY_ZERO = 0x0 };
class MopekaProCheck : public Component, public esp32_ble_tracker::ESPBTDeviceListener { class MopekaProCheck : public Component, public esp32_ble_tracker::ESPBTDeviceListener {
public: public:
@ -35,11 +35,14 @@ class MopekaProCheck : public Component, public esp32_ble_tracker::ESPBTDeviceLi
bool parse_device(const esp32_ble_tracker::ESPBTDevice &device) override; bool parse_device(const esp32_ble_tracker::ESPBTDevice &device) override;
void dump_config() override; void dump_config() override;
float get_setup_priority() const override { return setup_priority::DATA; } float get_setup_priority() const override { return setup_priority::DATA; }
void set_min_signal_quality(SensorReadQuality min) { this->min_signal_quality_ = min; };
void set_level(sensor::Sensor *level) { level_ = level; }; void set_level(sensor::Sensor *level) { level_ = level; };
void set_temperature(sensor::Sensor *temperature) { temperature_ = temperature; }; void set_temperature(sensor::Sensor *temperature) { temperature_ = temperature; };
void set_battery_level(sensor::Sensor *bat) { battery_level_ = bat; }; void set_battery_level(sensor::Sensor *bat) { battery_level_ = bat; };
void set_distance(sensor::Sensor *distance) { distance_ = distance; }; void set_distance(sensor::Sensor *distance) { distance_ = distance; };
void set_signal_quality(sensor::Sensor *rq) { read_quality_ = rq; };
void set_ignored_reads(sensor::Sensor *ir) { ignored_reads_ = ir; };
void set_tank_full(float full) { full_mm_ = full; }; void set_tank_full(float full) { full_mm_ = full; };
void set_tank_empty(float empty) { empty_mm_ = empty; }; void set_tank_empty(float empty) { empty_mm_ = empty; };
@ -49,9 +52,13 @@ class MopekaProCheck : public Component, public esp32_ble_tracker::ESPBTDeviceLi
sensor::Sensor *temperature_{nullptr}; sensor::Sensor *temperature_{nullptr};
sensor::Sensor *distance_{nullptr}; sensor::Sensor *distance_{nullptr};
sensor::Sensor *battery_level_{nullptr}; sensor::Sensor *battery_level_{nullptr};
sensor::Sensor *read_quality_{nullptr};
sensor::Sensor *ignored_reads_{nullptr};
uint32_t full_mm_; uint32_t full_mm_;
uint32_t empty_mm_; uint32_t empty_mm_;
uint32_t ignored_read_count_ = 0;
SensorReadQuality min_signal_quality_ = QUALITY_MED;
uint8_t parse_battery_level_(const std::vector<uint8_t> &message); uint8_t parse_battery_level_(const std::vector<uint8_t> &message);
uint32_t parse_distance_(const std::vector<uint8_t> &message); uint32_t parse_distance_(const std::vector<uint8_t> &message);

View file

@ -5,9 +5,12 @@ from esphome.const import (
CONF_DISTANCE, CONF_DISTANCE,
CONF_MAC_ADDRESS, CONF_MAC_ADDRESS,
CONF_ID, CONF_ID,
ICON_COUNTER,
ICON_THERMOMETER, ICON_THERMOMETER,
ICON_RULER, ICON_RULER,
ICON_SIGNAL,
UNIT_PERCENT, UNIT_PERCENT,
UNIT_EMPTY,
CONF_LEVEL, CONF_LEVEL,
CONF_TEMPERATURE, CONF_TEMPERATURE,
DEVICE_CLASS_TEMPERATURE, DEVICE_CLASS_TEMPERATURE,
@ -16,11 +19,15 @@ from esphome.const import (
STATE_CLASS_MEASUREMENT, STATE_CLASS_MEASUREMENT,
CONF_BATTERY_LEVEL, CONF_BATTERY_LEVEL,
DEVICE_CLASS_BATTERY, DEVICE_CLASS_BATTERY,
ENTITY_CATEGORY_DIAGNOSTIC,
) )
CONF_TANK_TYPE = "tank_type" CONF_TANK_TYPE = "tank_type"
CONF_CUSTOM_DISTANCE_FULL = "custom_distance_full" CONF_CUSTOM_DISTANCE_FULL = "custom_distance_full"
CONF_CUSTOM_DISTANCE_EMPTY = "custom_distance_empty" CONF_CUSTOM_DISTANCE_EMPTY = "custom_distance_empty"
CONF_SIGNAL_QUALITY = "signal_quality"
CONF_MINIMUM_SIGNAL_QUALITY = "minimum_signal_quality"
CONF_IGNORED_READS = "ignored_reads"
ICON_PROPANE_TANK = "mdi:propane-tank" ICON_PROPANE_TANK = "mdi:propane-tank"
@ -56,6 +63,14 @@ MopekaProCheck = mopeka_pro_check_ns.class_(
"MopekaProCheck", esp32_ble_tracker.ESPBTDeviceListener, cg.Component "MopekaProCheck", esp32_ble_tracker.ESPBTDeviceListener, cg.Component
) )
SensorReadQuality = mopeka_pro_check_ns.enum("SensorReadQuality")
SIGNAL_QUALITIES = {
"ZERO": SensorReadQuality.QUALITY_ZERO,
"LOW": SensorReadQuality.QUALITY_LOW,
"MEDIUM": SensorReadQuality.QUALITY_MED,
"HIGH": SensorReadQuality.QUALITY_HIGH,
}
CONFIG_SCHEMA = ( CONFIG_SCHEMA = (
cv.Schema( cv.Schema(
{ {
@ -89,6 +104,21 @@ CONFIG_SCHEMA = (
device_class=DEVICE_CLASS_BATTERY, device_class=DEVICE_CLASS_BATTERY,
state_class=STATE_CLASS_MEASUREMENT, state_class=STATE_CLASS_MEASUREMENT,
), ),
cv.Optional(CONF_SIGNAL_QUALITY): sensor.sensor_schema(
unit_of_measurement=UNIT_EMPTY,
icon=ICON_SIGNAL,
accuracy_decimals=0,
state_class=STATE_CLASS_MEASUREMENT,
),
cv.Optional(CONF_IGNORED_READS): sensor.sensor_schema(
unit_of_measurement=UNIT_EMPTY,
icon=ICON_COUNTER,
accuracy_decimals=0,
entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
),
cv.Optional(CONF_MINIMUM_SIGNAL_QUALITY, default="MEDIUM"): cv.enum(
SIGNAL_QUALITIES, upper=True
),
} }
) )
.extend(esp32_ble_tracker.ESP_BLE_DEVICE_SCHEMA) .extend(esp32_ble_tracker.ESP_BLE_DEVICE_SCHEMA)
@ -119,6 +149,11 @@ async def to_code(config):
cg.add(var.set_tank_empty(CONF_SUPPORTED_TANKS_MAP[t][0])) cg.add(var.set_tank_empty(CONF_SUPPORTED_TANKS_MAP[t][0]))
cg.add(var.set_tank_full(CONF_SUPPORTED_TANKS_MAP[t][1])) cg.add(var.set_tank_full(CONF_SUPPORTED_TANKS_MAP[t][1]))
if (
minimum_signal_quality := config.get(CONF_MINIMUM_SIGNAL_QUALITY, None)
) is not None:
cg.add(var.set_min_signal_quality(minimum_signal_quality))
if CONF_TEMPERATURE in config: if CONF_TEMPERATURE in config:
sens = await sensor.new_sensor(config[CONF_TEMPERATURE]) sens = await sensor.new_sensor(config[CONF_TEMPERATURE])
cg.add(var.set_temperature(sens)) cg.add(var.set_temperature(sens))
@ -131,3 +166,9 @@ async def to_code(config):
if CONF_BATTERY_LEVEL in config: if CONF_BATTERY_LEVEL in config:
sens = await sensor.new_sensor(config[CONF_BATTERY_LEVEL]) sens = await sensor.new_sensor(config[CONF_BATTERY_LEVEL])
cg.add(var.set_battery_level(sens)) cg.add(var.set_battery_level(sens))
if CONF_SIGNAL_QUALITY in config:
sens = await sensor.new_sensor(config[CONF_SIGNAL_QUALITY])
cg.add(var.set_signal_quality(sens))
if CONF_IGNORED_READS in config:
sens = await sensor.new_sensor(config[CONF_IGNORED_READS])
cg.add(var.set_ignored_reads(sens))

View file

@ -22,6 +22,7 @@ from esphome.const import (
CONF_DISCOVERY_PREFIX, CONF_DISCOVERY_PREFIX,
CONF_DISCOVERY_RETAIN, CONF_DISCOVERY_RETAIN,
CONF_DISCOVERY_UNIQUE_ID_GENERATOR, CONF_DISCOVERY_UNIQUE_ID_GENERATOR,
CONF_ENABLE_ON_BOOT,
CONF_ID, CONF_ID,
CONF_KEEPALIVE, CONF_KEEPALIVE,
CONF_LEVEL, CONF_LEVEL,
@ -99,6 +100,8 @@ MQTTMessage = mqtt_ns.struct("MQTTMessage")
MQTTClientComponent = mqtt_ns.class_("MQTTClientComponent", cg.Component) MQTTClientComponent = mqtt_ns.class_("MQTTClientComponent", cg.Component)
MQTTPublishAction = mqtt_ns.class_("MQTTPublishAction", automation.Action) MQTTPublishAction = mqtt_ns.class_("MQTTPublishAction", automation.Action)
MQTTPublishJsonAction = mqtt_ns.class_("MQTTPublishJsonAction", automation.Action) MQTTPublishJsonAction = mqtt_ns.class_("MQTTPublishJsonAction", automation.Action)
MQTTEnableAction = mqtt_ns.class_("MQTTEnableAction", automation.Action)
MQTTDisableAction = mqtt_ns.class_("MQTTDisableAction", automation.Action)
MQTTMessageTrigger = mqtt_ns.class_( MQTTMessageTrigger = mqtt_ns.class_(
"MQTTMessageTrigger", automation.Trigger.template(cg.std_string), cg.Component "MQTTMessageTrigger", automation.Trigger.template(cg.std_string), cg.Component
) )
@ -208,6 +211,7 @@ CONFIG_SCHEMA = cv.All(
{ {
cv.GenerateID(): cv.declare_id(MQTTClientComponent), cv.GenerateID(): cv.declare_id(MQTTClientComponent),
cv.Required(CONF_BROKER): cv.string_strict, cv.Required(CONF_BROKER): cv.string_strict,
cv.Optional(CONF_ENABLE_ON_BOOT, default=True): cv.boolean,
cv.Optional(CONF_PORT, default=1883): cv.port, cv.Optional(CONF_PORT, default=1883): cv.port,
cv.Optional(CONF_USERNAME, default=""): cv.string, cv.Optional(CONF_USERNAME, default=""): cv.string,
cv.Optional(CONF_PASSWORD, default=""): cv.string, cv.Optional(CONF_PASSWORD, default=""): cv.string,
@ -325,6 +329,7 @@ async def to_code(config):
cg.add_global(mqtt_ns.using) cg.add_global(mqtt_ns.using)
cg.add(var.set_broker_address(config[CONF_BROKER])) cg.add(var.set_broker_address(config[CONF_BROKER]))
cg.add(var.set_enable_on_boot(config[CONF_ENABLE_ON_BOOT]))
cg.add(var.set_broker_port(config[CONF_PORT])) cg.add(var.set_broker_port(config[CONF_PORT]))
cg.add(var.set_username(config[CONF_USERNAME])) cg.add(var.set_username(config[CONF_USERNAME]))
cg.add(var.set_password(config[CONF_PASSWORD])) cg.add(var.set_password(config[CONF_PASSWORD]))
@ -555,3 +560,31 @@ async def register_mqtt_component(var, config):
async def mqtt_connected_to_code(config, condition_id, template_arg, args): async def mqtt_connected_to_code(config, condition_id, template_arg, args):
paren = await cg.get_variable(config[CONF_ID]) paren = await cg.get_variable(config[CONF_ID])
return cg.new_Pvariable(condition_id, template_arg, paren) return cg.new_Pvariable(condition_id, template_arg, paren)
@automation.register_action(
"mqtt.enable",
MQTTEnableAction,
cv.Schema(
{
cv.GenerateID(): cv.use_id(MQTTClientComponent),
}
),
)
async def mqtt_enable_to_code(config, action_id, template_arg, args):
paren = await cg.get_variable(config[CONF_ID])
return cg.new_Pvariable(action_id, template_arg, paren)
@automation.register_action(
"mqtt.disable",
MQTTDisableAction,
cv.Schema(
{
cv.GenerateID(): cv.use_id(MQTTClientComponent),
}
),
)
async def mqtt_disable_to_code(config, action_id, template_arg, args):
paren = await cg.get_variable(config[CONF_ID])
return cg.new_Pvariable(action_id, template_arg, paren)

View file

@ -50,6 +50,8 @@ void MQTTClientComponent::setup() {
} }
}); });
this->mqtt_backend_.set_on_disconnect([this](MQTTClientDisconnectReason reason) { this->mqtt_backend_.set_on_disconnect([this](MQTTClientDisconnectReason reason) {
if (this->state_ == MQTT_CLIENT_DISABLED)
return;
this->state_ = MQTT_CLIENT_DISCONNECTED; this->state_ = MQTT_CLIENT_DISCONNECTED;
this->disconnect_reason_ = reason; this->disconnect_reason_ = reason;
}); });
@ -77,8 +79,9 @@ void MQTTClientComponent::setup() {
topic, [this](const std::string &topic, const std::string &payload) { this->send_device_info_(); }, 2); topic, [this](const std::string &topic, const std::string &payload) { this->send_device_info_(); }, 2);
} }
this->last_connected_ = millis(); if (this->enable_on_boot_) {
this->start_dnslookup_(); this->enable();
}
} }
void MQTTClientComponent::send_device_info_() { void MQTTClientComponent::send_device_info_() {
@ -163,7 +166,9 @@ void MQTTClientComponent::dump_config() {
ESP_LOGCONFIG(TAG, " Availability: '%s'", this->availability_.topic.c_str()); ESP_LOGCONFIG(TAG, " Availability: '%s'", this->availability_.topic.c_str());
} }
} }
bool MQTTClientComponent::can_proceed() { return network::is_disabled() || this->is_connected(); } bool MQTTClientComponent::can_proceed() {
return network::is_disabled() || this->state_ == MQTT_CLIENT_DISABLED || this->is_connected();
}
void MQTTClientComponent::start_dnslookup_() { void MQTTClientComponent::start_dnslookup_() {
for (auto &subscription : this->subscriptions_) { for (auto &subscription : this->subscriptions_) {
@ -339,6 +344,8 @@ void MQTTClientComponent::loop() {
const uint32_t now = millis(); const uint32_t now = millis();
switch (this->state_) { switch (this->state_) {
case MQTT_CLIENT_DISABLED:
return; // Return to avoid a reboot when disabled
case MQTT_CLIENT_DISCONNECTED: case MQTT_CLIENT_DISCONNECTED:
if (now - this->connect_begin_ > 5000) { if (now - this->connect_begin_ > 5000) {
this->start_dnslookup_(); this->start_dnslookup_();
@ -501,6 +508,23 @@ bool MQTTClientComponent::publish_json(const std::string &topic, const json::jso
return this->publish(topic, message, qos, retain); return this->publish(topic, message, qos, retain);
} }
void MQTTClientComponent::enable() {
if (this->state_ != MQTT_CLIENT_DISABLED)
return;
ESP_LOGD(TAG, "Enabling MQTT...");
this->state_ = MQTT_CLIENT_DISCONNECTED;
this->last_connected_ = millis();
this->start_dnslookup_();
}
void MQTTClientComponent::disable() {
if (this->state_ == MQTT_CLIENT_DISABLED)
return;
ESP_LOGD(TAG, "Disabling MQTT...");
this->state_ = MQTT_CLIENT_DISABLED;
this->on_shutdown();
}
/** Check if the message topic matches the given subscription topic /** Check if the message topic matches the given subscription topic
* *
* INFO: MQTT spec mandates that topics must not be empty and must be valid NULL-terminated UTF-8 strings. * INFO: MQTT spec mandates that topics must not be empty and must be valid NULL-terminated UTF-8 strings.

View file

@ -87,7 +87,8 @@ struct MQTTDiscoveryInfo {
}; };
enum MQTTClientState { enum MQTTClientState {
MQTT_CLIENT_DISCONNECTED = 0, MQTT_CLIENT_DISABLED = 0,
MQTT_CLIENT_DISCONNECTED,
MQTT_CLIENT_RESOLVING_ADDRESS, MQTT_CLIENT_RESOLVING_ADDRESS,
MQTT_CLIENT_CONNECTING, MQTT_CLIENT_CONNECTING,
MQTT_CLIENT_CONNECTED, MQTT_CLIENT_CONNECTED,
@ -247,6 +248,9 @@ class MQTTClientComponent : public Component {
void register_mqtt_component(MQTTComponent *component); void register_mqtt_component(MQTTComponent *component);
bool is_connected(); bool is_connected();
void set_enable_on_boot(bool enable_on_boot) { this->enable_on_boot_ = enable_on_boot; }
void enable();
void disable();
void on_shutdown() override; void on_shutdown() override;
@ -314,10 +318,11 @@ class MQTTClientComponent : public Component {
MQTTBackendLibreTiny mqtt_backend_; MQTTBackendLibreTiny mqtt_backend_;
#endif #endif
MQTTClientState state_{MQTT_CLIENT_DISCONNECTED}; MQTTClientState state_{MQTT_CLIENT_DISABLED};
network::IPAddress ip_; network::IPAddress ip_;
bool dns_resolved_{false}; bool dns_resolved_{false};
bool dns_resolve_error_{false}; bool dns_resolve_error_{false};
bool enable_on_boot_{true};
std::vector<MQTTComponent *> children_; std::vector<MQTTComponent *> children_;
uint32_t reboot_timeout_{300000}; uint32_t reboot_timeout_{300000};
uint32_t connect_begin_; uint32_t connect_begin_;
@ -414,6 +419,26 @@ template<typename... Ts> class MQTTConnectedCondition : public Condition<Ts...>
MQTTClientComponent *parent_; MQTTClientComponent *parent_;
}; };
template<typename... Ts> class MQTTEnableAction : public Action<Ts...> {
public:
MQTTEnableAction(MQTTClientComponent *parent) : parent_(parent) {}
void play(Ts... x) override { this->parent_->enable(); }
protected:
MQTTClientComponent *parent_;
};
template<typename... Ts> class MQTTDisableAction : public Action<Ts...> {
public:
MQTTDisableAction(MQTTClientComponent *parent) : parent_(parent) {}
void play(Ts... x) override { this->parent_->disable(); }
protected:
MQTTClientComponent *parent_;
};
} // namespace mqtt } // namespace mqtt
} // namespace esphome } // namespace esphome

View file

@ -71,8 +71,10 @@ void MQTTClimateComponent::send_discovery(JsonObject root, mqtt::SendDiscoveryCo
root[MQTT_MIN_TEMP] = traits.get_visual_min_temperature(); root[MQTT_MIN_TEMP] = traits.get_visual_min_temperature();
// max_temp // max_temp
root[MQTT_MAX_TEMP] = traits.get_visual_max_temperature(); root[MQTT_MAX_TEMP] = traits.get_visual_max_temperature();
// temp_step // target_temp_step
root["temp_step"] = traits.get_visual_target_temperature_step(); root[MQTT_TARGET_TEMPERATURE_STEP] = traits.get_visual_target_temperature_step();
// current_temp_step
root[MQTT_CURRENT_TEMPERATURE_STEP] = traits.get_visual_current_temperature_step();
// temperature units are always coerced to Celsius internally // temperature units are always coerced to Celsius internally
root[MQTT_TEMPERATURE_UNIT] = "C"; root[MQTT_TEMPERATURE_UNIT] = "C";

View file

@ -51,6 +51,7 @@ constexpr const char *const MQTT_COMMAND_TOPIC = "cmd_t";
constexpr const char *const MQTT_CONFIGURATION_URL = "cu"; constexpr const char *const MQTT_CONFIGURATION_URL = "cu";
constexpr const char *const MQTT_CURRENT_HUMIDITY_TEMPLATE = "curr_hum_tpl"; constexpr const char *const MQTT_CURRENT_HUMIDITY_TEMPLATE = "curr_hum_tpl";
constexpr const char *const MQTT_CURRENT_HUMIDITY_TOPIC = "curr_hum_t"; constexpr const char *const MQTT_CURRENT_HUMIDITY_TOPIC = "curr_hum_t";
constexpr const char *const MQTT_CURRENT_TEMPERATURE_STEP = "precision";
constexpr const char *const MQTT_CURRENT_TEMPERATURE_TEMPLATE = "curr_temp_tpl"; constexpr const char *const MQTT_CURRENT_TEMPERATURE_TEMPLATE = "curr_temp_tpl";
constexpr const char *const MQTT_CURRENT_TEMPERATURE_TOPIC = "curr_temp_t"; constexpr const char *const MQTT_CURRENT_TEMPERATURE_TOPIC = "curr_temp_t";
constexpr const char *const MQTT_DEVICE = "dev"; constexpr const char *const MQTT_DEVICE = "dev";
@ -232,6 +233,7 @@ constexpr const char *const MQTT_TARGET_HUMIDITY_COMMAND_TEMPLATE = "hum_cmd_tpl
constexpr const char *const MQTT_TARGET_HUMIDITY_COMMAND_TOPIC = "hum_cmd_t"; constexpr const char *const MQTT_TARGET_HUMIDITY_COMMAND_TOPIC = "hum_cmd_t";
constexpr const char *const MQTT_TARGET_HUMIDITY_STATE_TEMPLATE = "hum_state_tpl"; constexpr const char *const MQTT_TARGET_HUMIDITY_STATE_TEMPLATE = "hum_state_tpl";
constexpr const char *const MQTT_TARGET_HUMIDITY_STATE_TOPIC = "hum_stat_t"; constexpr const char *const MQTT_TARGET_HUMIDITY_STATE_TOPIC = "hum_stat_t";
constexpr const char *const MQTT_TARGET_TEMPERATURE_STEP = "temp_step";
constexpr const char *const MQTT_TEMPERATURE_COMMAND_TEMPLATE = "temp_cmd_tpl"; constexpr const char *const MQTT_TEMPERATURE_COMMAND_TEMPLATE = "temp_cmd_tpl";
constexpr const char *const MQTT_TEMPERATURE_COMMAND_TOPIC = "temp_cmd_t"; constexpr const char *const MQTT_TEMPERATURE_COMMAND_TOPIC = "temp_cmd_t";
constexpr const char *const MQTT_TEMPERATURE_HIGH_COMMAND_TEMPLATE = "temp_hi_cmd_tpl"; constexpr const char *const MQTT_TEMPERATURE_HIGH_COMMAND_TEMPLATE = "temp_hi_cmd_tpl";
@ -313,6 +315,7 @@ constexpr const char *const MQTT_COMMAND_TOPIC = "command_topic";
constexpr const char *const MQTT_CONFIGURATION_URL = "configuration_url"; constexpr const char *const MQTT_CONFIGURATION_URL = "configuration_url";
constexpr const char *const MQTT_CURRENT_HUMIDITY_TEMPLATE = "current_humidity_template"; constexpr const char *const MQTT_CURRENT_HUMIDITY_TEMPLATE = "current_humidity_template";
constexpr const char *const MQTT_CURRENT_HUMIDITY_TOPIC = "current_humidity_topic"; constexpr const char *const MQTT_CURRENT_HUMIDITY_TOPIC = "current_humidity_topic";
constexpr const char *const MQTT_CURRENT_TEMPERATURE_STEP = "precision";
constexpr const char *const MQTT_CURRENT_TEMPERATURE_TEMPLATE = "current_temperature_template"; constexpr const char *const MQTT_CURRENT_TEMPERATURE_TEMPLATE = "current_temperature_template";
constexpr const char *const MQTT_CURRENT_TEMPERATURE_TOPIC = "current_temperature_topic"; constexpr const char *const MQTT_CURRENT_TEMPERATURE_TOPIC = "current_temperature_topic";
constexpr const char *const MQTT_DEVICE = "device"; constexpr const char *const MQTT_DEVICE = "device";
@ -494,6 +497,7 @@ constexpr const char *const MQTT_TARGET_HUMIDITY_COMMAND_TEMPLATE = "target_humi
constexpr const char *const MQTT_TARGET_HUMIDITY_COMMAND_TOPIC = "target_humidity_command_topic"; constexpr const char *const MQTT_TARGET_HUMIDITY_COMMAND_TOPIC = "target_humidity_command_topic";
constexpr const char *const MQTT_TARGET_HUMIDITY_STATE_TEMPLATE = "target_humidity_state_template"; constexpr const char *const MQTT_TARGET_HUMIDITY_STATE_TEMPLATE = "target_humidity_state_template";
constexpr const char *const MQTT_TARGET_HUMIDITY_STATE_TOPIC = "target_humidity_state_topic"; constexpr const char *const MQTT_TARGET_HUMIDITY_STATE_TOPIC = "target_humidity_state_topic";
constexpr const char *const MQTT_TARGET_TEMPERATURE_STEP = "temp_step";
constexpr const char *const MQTT_TEMPERATURE_COMMAND_TEMPLATE = "temperature_command_template"; constexpr const char *const MQTT_TEMPERATURE_COMMAND_TEMPLATE = "temperature_command_template";
constexpr const char *const MQTT_TEMPERATURE_COMMAND_TOPIC = "temperature_command_topic"; constexpr const char *const MQTT_TEMPERATURE_COMMAND_TOPIC = "temperature_command_topic";
constexpr const char *const MQTT_TEMPERATURE_HIGH_COMMAND_TEMPLATE = "temperature_high_command_template"; constexpr const char *const MQTT_TEMPERATURE_HIGH_COMMAND_TEMPLATE = "temperature_high_command_template";

View file

@ -3,8 +3,9 @@ from typing import Any
import esphome.codegen as cg import esphome.codegen as cg
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome import pins from esphome import pins
from esphome.components import sensor
from esphome.const import CONF_ID, PLATFORM_ESP32, PLATFORM_ESP8266 from esphome.const import CONF_ID, PLATFORM_ESP32, PLATFORM_ESP8266
from . import generate from . import const, schema, validate, generate
CODEOWNERS = ["@olegtarasov"] CODEOWNERS = ["@olegtarasov"]
MULTI_CONF = True MULTI_CONF = True
@ -19,6 +20,7 @@ CONF_CH2_ACTIVE = "ch2_active"
CONF_SUMMER_MODE_ACTIVE = "summer_mode_active" CONF_SUMMER_MODE_ACTIVE = "summer_mode_active"
CONF_DHW_BLOCK = "dhw_block" CONF_DHW_BLOCK = "dhw_block"
CONF_SYNC_MODE = "sync_mode" CONF_SYNC_MODE = "sync_mode"
CONF_OPENTHERM_VERSION = "opentherm_version"
CONFIG_SCHEMA = cv.All( CONFIG_SCHEMA = cv.All(
cv.Schema( cv.Schema(
@ -34,8 +36,15 @@ CONFIG_SCHEMA = cv.All(
cv.Optional(CONF_SUMMER_MODE_ACTIVE, False): cv.boolean, cv.Optional(CONF_SUMMER_MODE_ACTIVE, False): cv.boolean,
cv.Optional(CONF_DHW_BLOCK, False): cv.boolean, cv.Optional(CONF_DHW_BLOCK, False): cv.boolean,
cv.Optional(CONF_SYNC_MODE, False): cv.boolean, cv.Optional(CONF_SYNC_MODE, False): cv.boolean,
cv.Optional(CONF_OPENTHERM_VERSION): cv.positive_float,
} }
).extend(cv.COMPONENT_SCHEMA), )
.extend(
validate.create_entities_schema(
schema.INPUTS, (lambda _: cv.use_id(sensor.Sensor))
)
)
.extend(cv.COMPONENT_SCHEMA),
cv.only_on([PLATFORM_ESP32, PLATFORM_ESP8266]), cv.only_on([PLATFORM_ESP32, PLATFORM_ESP8266]),
) )
@ -52,8 +61,23 @@ async def to_code(config: dict[str, Any]) -> None:
cg.add(var.set_out_pin(out_pin)) cg.add(var.set_out_pin(out_pin))
non_sensors = {CONF_ID, CONF_IN_PIN, CONF_OUT_PIN} non_sensors = {CONF_ID, CONF_IN_PIN, CONF_OUT_PIN}
input_sensors = []
for key, value in config.items(): for key, value in config.items():
if key in non_sensors: if key in non_sensors:
continue continue
if key in schema.INPUTS:
input_sensor = await cg.get_variable(value)
cg.add(
getattr(var, f"set_{key}_{const.INPUT_SENSOR.lower()}")(input_sensor)
)
input_sensors.append(key)
else:
cg.add(getattr(var, f"set_{key}")(value)) cg.add(getattr(var, f"set_{key}")(value))
if len(input_sensors) > 0:
generate.define_has_component(const.INPUT_SENSOR, input_sensors)
generate.define_message_handler(
const.INPUT_SENSOR, input_sensors, schema.INPUTS
)
generate.define_readers(const.INPUT_SENSOR, input_sensors)
generate.add_messages(var, input_sensors, schema.INPUTS)

View file

@ -0,0 +1,33 @@
from typing import Any
import esphome.config_validation as cv
from esphome.components import binary_sensor
from .. import const, schema, validate, generate
DEPENDENCIES = [const.OPENTHERM]
COMPONENT_TYPE = const.BINARY_SENSOR
def get_entity_validation_schema(entity: schema.BinarySensorSchema) -> cv.Schema:
return binary_sensor.binary_sensor_schema(
device_class=(
entity.device_class
or binary_sensor._UNDEF # pylint: disable=protected-access
),
icon=(entity.icon or binary_sensor._UNDEF), # pylint: disable=protected-access
)
CONFIG_SCHEMA = validate.create_component_schema(
schema.BINARY_SENSORS, get_entity_validation_schema
)
async def to_code(config: dict[str, Any]) -> None:
await generate.component_to_code(
COMPONENT_TYPE,
schema.BINARY_SENSORS,
binary_sensor.BinarySensor,
generate.create_only_conf(binary_sensor.new_binary_sensor),
config,
)

View file

@ -1,5 +1,11 @@
OPENTHERM = "opentherm" OPENTHERM = "opentherm"
CONF_OPENTHERM_ID = "opentherm_id" CONF_OPENTHERM_ID = "opentherm_id"
CONF_DATA_TYPE = "data_type"
SENSOR = "sensor" SENSOR = "sensor"
BINARY_SENSOR = "binary_sensor"
SWITCH = "switch"
NUMBER = "number"
OUTPUT = "output"
INPUT_SENSOR = "input_sensor"

View file

@ -130,6 +130,8 @@ async def component_to_code(
id = conf[CONF_ID] id = conf[CONF_ID]
if id and id.type == type: if id and id.type == type:
entity = await create(conf, key, hub) entity = await create(conf, key, hub)
if const.CONF_DATA_TYPE in conf:
schemas[key].message_data = conf[const.CONF_DATA_TYPE]
cg.add(getattr(hub, f"set_{key}_{component_type.lower()}")(entity)) cg.add(getattr(hub, f"set_{key}_{component_type.lower()}")(entity))
keys.append(key) keys.append(key)

View file

@ -29,6 +29,8 @@ uint8_t parse_u8_hb(OpenthermData &data) { return data.valueHB; }
int8_t parse_s8_lb(OpenthermData &data) { return (int8_t) data.valueLB; } int8_t parse_s8_lb(OpenthermData &data) { return (int8_t) data.valueLB; }
int8_t parse_s8_hb(OpenthermData &data) { return (int8_t) data.valueHB; } int8_t parse_s8_hb(OpenthermData &data) { return (int8_t) data.valueHB; }
uint16_t parse_u16(OpenthermData &data) { return data.u16(); } uint16_t parse_u16(OpenthermData &data) { return data.u16(); }
uint16_t parse_u8_lb_60(OpenthermData &data) { return data.valueLB * 60; }
uint16_t parse_u8_hb_60(OpenthermData &data) { return data.valueHB * 60; }
int16_t parse_s16(OpenthermData &data) { return data.s16(); } int16_t parse_s16(OpenthermData &data) { return data.s16(); }
float parse_f88(OpenthermData &data) { return data.f88(); } float parse_f88(OpenthermData &data) { return data.f88(); }
@ -87,13 +89,40 @@ OpenthermData OpenthermHub::build_request_(MessageId request_id) const {
return data; return data;
} }
// Another special case is OpenTherm version number which is configured at hub level as a constant
if (request_id == MessageId::OT_VERSION_CONTROLLER) {
data.type = MessageType::WRITE_DATA;
data.id = MessageId::OT_VERSION_CONTROLLER;
data.f88(this->opentherm_version_);
return data;
}
// Disable incomplete switch statement warnings, because the cases in each // Disable incomplete switch statement warnings, because the cases in each
// switch are generated based on the configured sensors and inputs. // switch are generated based on the configured sensors and inputs.
#pragma GCC diagnostic push #pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wswitch" #pragma GCC diagnostic ignored "-Wswitch"
switch (request_id) { OPENTHERM_SENSOR_MESSAGE_HANDLERS(OPENTHERM_MESSAGE_READ_MESSAGE, OPENTHERM_IGNORE, , , ) } // Next, we start with the write requests from switches and other inputs,
// because we would want to write that data if it is available, rather than
// request a read for that type (in the case that both read and write are
// supported).
switch (request_id) {
OPENTHERM_SWITCH_MESSAGE_HANDLERS(OPENTHERM_MESSAGE_WRITE_MESSAGE, OPENTHERM_MESSAGE_WRITE_ENTITY, ,
OPENTHERM_MESSAGE_WRITE_POSTSCRIPT, )
OPENTHERM_NUMBER_MESSAGE_HANDLERS(OPENTHERM_MESSAGE_WRITE_MESSAGE, OPENTHERM_MESSAGE_WRITE_ENTITY, ,
OPENTHERM_MESSAGE_WRITE_POSTSCRIPT, )
OPENTHERM_OUTPUT_MESSAGE_HANDLERS(OPENTHERM_MESSAGE_WRITE_MESSAGE, OPENTHERM_MESSAGE_WRITE_ENTITY, ,
OPENTHERM_MESSAGE_WRITE_POSTSCRIPT, )
OPENTHERM_INPUT_SENSOR_MESSAGE_HANDLERS(OPENTHERM_MESSAGE_WRITE_MESSAGE, OPENTHERM_MESSAGE_WRITE_ENTITY, ,
OPENTHERM_MESSAGE_WRITE_POSTSCRIPT, )
}
// Finally, handle the simple read requests, which only change with the message id.
switch (request_id) { OPENTHERM_SENSOR_MESSAGE_HANDLERS(OPENTHERM_MESSAGE_READ_MESSAGE, OPENTHERM_IGNORE, , , ) }
switch (request_id) {
OPENTHERM_BINARY_SENSOR_MESSAGE_HANDLERS(OPENTHERM_MESSAGE_READ_MESSAGE, OPENTHERM_IGNORE, , , )
}
#pragma GCC diagnostic pop #pragma GCC diagnostic pop
// And if we get here, a message was requested which somehow wasn't handled. // And if we get here, a message was requested which somehow wasn't handled.
@ -115,6 +144,10 @@ void OpenthermHub::process_response(OpenthermData &data) {
OPENTHERM_SENSOR_MESSAGE_HANDLERS(OPENTHERM_MESSAGE_RESPONSE_MESSAGE, OPENTHERM_MESSAGE_RESPONSE_ENTITY, , OPENTHERM_SENSOR_MESSAGE_HANDLERS(OPENTHERM_MESSAGE_RESPONSE_MESSAGE, OPENTHERM_MESSAGE_RESPONSE_ENTITY, ,
OPENTHERM_MESSAGE_RESPONSE_POSTSCRIPT, ) OPENTHERM_MESSAGE_RESPONSE_POSTSCRIPT, )
} }
switch (data.id) {
OPENTHERM_BINARY_SENSOR_MESSAGE_HANDLERS(OPENTHERM_MESSAGE_RESPONSE_MESSAGE, OPENTHERM_MESSAGE_RESPONSE_ENTITY, ,
OPENTHERM_MESSAGE_RESPONSE_POSTSCRIPT, )
}
} }
void OpenthermHub::setup() { void OpenthermHub::setup() {
@ -131,6 +164,13 @@ void OpenthermHub::setup() {
// good practice anyway. // good practice anyway.
this->add_repeating_message(MessageId::STATUS); this->add_repeating_message(MessageId::STATUS);
// Also ensure that we start communication with the STATUS message
this->initial_messages_.insert(this->initial_messages_.begin(), MessageId::STATUS);
if (this->opentherm_version_ > 0.0f) {
this->initial_messages_.insert(this->initial_messages_.begin(), MessageId::OT_VERSION_CONTROLLER);
}
this->current_message_iterator_ = this->initial_messages_.begin(); this->current_message_iterator_ = this->initial_messages_.begin();
} }
@ -331,11 +371,11 @@ void OpenthermHub::dump_config() {
ESP_LOGCONFIG(TAG, " Numbers: %s", SHOW(OPENTHERM_NUMBER_LIST(ID, ))); ESP_LOGCONFIG(TAG, " Numbers: %s", SHOW(OPENTHERM_NUMBER_LIST(ID, )));
ESP_LOGCONFIG(TAG, " Initial requests:"); ESP_LOGCONFIG(TAG, " Initial requests:");
for (auto type : this->initial_messages_) { for (auto type : this->initial_messages_) {
ESP_LOGCONFIG(TAG, " - %d", type); ESP_LOGCONFIG(TAG, " - %d (%s)", type, this->opentherm_->message_id_to_str((type)));
} }
ESP_LOGCONFIG(TAG, " Repeating requests:"); ESP_LOGCONFIG(TAG, " Repeating requests:");
for (auto type : this->repeating_messages_) { for (auto type : this->repeating_messages_) {
ESP_LOGCONFIG(TAG, " - %d", type); ESP_LOGCONFIG(TAG, " - %d (%s)", type, this->opentherm_->message_id_to_str((type)));
} }
} }

View file

@ -4,6 +4,7 @@
#include "esphome/core/hal.h" #include "esphome/core/hal.h"
#include "esphome/core/component.h" #include "esphome/core/component.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
#include <vector>
#include "opentherm.h" #include "opentherm.h"
@ -11,6 +12,22 @@
#include "esphome/components/sensor/sensor.h" #include "esphome/components/sensor/sensor.h"
#endif #endif
#ifdef OPENTHERM_USE_BINARY_SENSOR
#include "esphome/components/binary_sensor/binary_sensor.h"
#endif
#ifdef OPENTHERM_USE_SWITCH
#include "esphome/components/opentherm/switch/switch.h"
#endif
#ifdef OPENTHERM_USE_OUTPUT
#include "esphome/components/opentherm/output/output.h"
#endif
#ifdef OPENTHERM_USE_NUMBER
#include "esphome/components/opentherm/number/number.h"
#endif
#include <memory> #include <memory>
#include <unordered_map> #include <unordered_map>
#include <unordered_set> #include <unordered_set>
@ -31,15 +48,25 @@ class OpenthermHub : public Component {
OPENTHERM_SENSOR_LIST(OPENTHERM_DECLARE_SENSOR, ) OPENTHERM_SENSOR_LIST(OPENTHERM_DECLARE_SENSOR, )
OPENTHERM_BINARY_SENSOR_LIST(OPENTHERM_DECLARE_BINARY_SENSOR, )
OPENTHERM_SWITCH_LIST(OPENTHERM_DECLARE_SWITCH, )
OPENTHERM_NUMBER_LIST(OPENTHERM_DECLARE_NUMBER, )
OPENTHERM_OUTPUT_LIST(OPENTHERM_DECLARE_OUTPUT, )
OPENTHERM_INPUT_SENSOR_LIST(OPENTHERM_DECLARE_INPUT_SENSOR, )
// The set of initial messages to send on starting communication with the boiler // The set of initial messages to send on starting communication with the boiler
std::unordered_set<MessageId> initial_messages_; std::vector<MessageId> initial_messages_;
// and the repeating messages which are sent repeatedly to update various sensors // and the repeating messages which are sent repeatedly to update various sensors
// and boiler parameters (like the setpoint). // and boiler parameters (like the setpoint).
std::unordered_set<MessageId> repeating_messages_; std::vector<MessageId> repeating_messages_;
// Indicates if we are still working on the initial requests or not // Indicates if we are still working on the initial requests or not
bool sending_initial_ = true; bool sending_initial_ = true;
// Index for the current request in one of the _requests sets. // Index for the current request in one of the _requests sets.
std::unordered_set<MessageId>::const_iterator current_message_iterator_; std::vector<MessageId>::const_iterator current_message_iterator_;
uint32_t last_conversation_start_ = 0; uint32_t last_conversation_start_ = 0;
uint32_t last_conversation_end_ = 0; uint32_t last_conversation_end_ = 0;
@ -51,6 +78,8 @@ class OpenthermHub : public Component {
// Very likely to happen while using Dallas temperature sensors. // Very likely to happen while using Dallas temperature sensors.
bool sync_mode_ = false; bool sync_mode_ = false;
float opentherm_version_ = 0.0f;
// Create OpenTherm messages based on the message id // Create OpenTherm messages based on the message id
OpenthermData build_request_(MessageId request_id) const; OpenthermData build_request_(MessageId request_id) const;
void handle_protocol_write_error_(); void handle_protocol_write_error_();
@ -88,13 +117,23 @@ class OpenthermHub : public Component {
OPENTHERM_SENSOR_LIST(OPENTHERM_SET_SENSOR, ) OPENTHERM_SENSOR_LIST(OPENTHERM_SET_SENSOR, )
// Add a request to the set of initial requests OPENTHERM_BINARY_SENSOR_LIST(OPENTHERM_SET_BINARY_SENSOR, )
void add_initial_message(MessageId message_id) { this->initial_messages_.insert(message_id); }
OPENTHERM_SWITCH_LIST(OPENTHERM_SET_SWITCH, )
OPENTHERM_NUMBER_LIST(OPENTHERM_SET_NUMBER, )
OPENTHERM_OUTPUT_LIST(OPENTHERM_SET_OUTPUT, )
OPENTHERM_INPUT_SENSOR_LIST(OPENTHERM_SET_INPUT_SENSOR, )
// Add a request to the vector of initial requests
void add_initial_message(MessageId message_id) { this->initial_messages_.push_back(message_id); }
// Add a request to the set of repeating requests. Note that a large number of repeating // Add a request to the set of repeating requests. Note that a large number of repeating
// requests will slow down communication with the boiler. Each request may take up to 1 second, // requests will slow down communication with the boiler. Each request may take up to 1 second,
// so with all sensors enabled, it may take about half a minute before a change in setpoint // so with all sensors enabled, it may take about half a minute before a change in setpoint
// will be processed. // will be processed.
void add_repeating_message(MessageId message_id) { this->repeating_messages_.insert(message_id); } void add_repeating_message(MessageId message_id) { this->repeating_messages_.push_back(message_id); }
// There are seven status variables, which can either be set as a simple variable, // There are seven status variables, which can either be set as a simple variable,
// or using a switch. ch_enable and dhw_enable default to true, the others to false. // or using a switch. ch_enable and dhw_enable default to true, the others to false.
@ -110,6 +149,7 @@ class OpenthermHub : public Component {
void set_summer_mode_active(bool value) { this->summer_mode_active = value; } void set_summer_mode_active(bool value) { this->summer_mode_active = value; }
void set_dhw_block(bool value) { this->dhw_block = value; } void set_dhw_block(bool value) { this->dhw_block = value; }
void set_sync_mode(bool sync_mode) { this->sync_mode_ = sync_mode; } void set_sync_mode(bool sync_mode) { this->sync_mode_ = sync_mode; }
void set_opentherm_version(float value) { this->opentherm_version_ = value; }
float get_setup_priority() const override { return setup_priority::HARDWARE; } float get_setup_priority() const override { return setup_priority::HARDWARE; }

View file

@ -0,0 +1,18 @@
#pragma once
namespace esphome {
namespace opentherm {
class OpenthermInput {
public:
bool auto_min_value, auto_max_value;
virtual void set_min_value(float min_value) = 0;
virtual void set_max_value(float max_value) = 0;
virtual void set_auto_min_value(bool auto_min_value) { this->auto_min_value = auto_min_value; }
virtual void set_auto_max_value(bool auto_max_value) { this->auto_max_value = auto_max_value; }
};
} // namespace opentherm
} // namespace esphome

View file

@ -0,0 +1,51 @@
from typing import Any
import esphome.codegen as cg
import esphome.config_validation as cv
from . import schema, generate
CONF_min_value = "min_value"
CONF_max_value = "max_value"
CONF_auto_min_value = "auto_min_value"
CONF_auto_max_value = "auto_max_value"
CONF_step = "step"
OpenthermInput = generate.opentherm_ns.class_("OpenthermInput")
def validate_min_value_less_than_max_value(conf):
if (
CONF_min_value in conf
and CONF_max_value in conf
and conf[CONF_min_value] > conf[CONF_max_value]
):
raise cv.Invalid(f"{CONF_min_value} must be less than {CONF_max_value}")
return conf
def input_schema(entity: schema.InputSchema) -> cv.Schema:
result = cv.Schema(
{
cv.Optional(CONF_min_value, entity.range[0]): cv.float_range(
entity.range[0], entity.range[1]
),
cv.Optional(CONF_max_value, entity.range[1]): cv.float_range(
entity.range[0], entity.range[1]
),
}
)
result = result.add_extra(validate_min_value_less_than_max_value)
result = result.extend({cv.Optional(CONF_step, False): cv.float_})
if entity.auto_min_value is not None:
result = result.extend({cv.Optional(CONF_auto_min_value, False): cv.boolean})
if entity.auto_max_value is not None:
result = result.extend({cv.Optional(CONF_auto_max_value, False): cv.boolean})
return result
def generate_setters(entity: cg.MockObj, conf: dict[str, Any]) -> None:
generate.add_property_set(entity, CONF_min_value, conf)
generate.add_property_set(entity, CONF_max_value, conf)
generate.add_property_set(entity, CONF_auto_min_value, conf)
generate.add_property_set(entity, CONF_auto_max_value, conf)

View file

@ -0,0 +1,74 @@
from typing import Any
import esphome.codegen as cg
import esphome.config_validation as cv
from esphome.components import number
from esphome.const import (
CONF_ID,
CONF_UNIT_OF_MEASUREMENT,
CONF_STEP,
CONF_INITIAL_VALUE,
CONF_RESTORE_VALUE,
)
from .. import const, schema, validate, input, generate
DEPENDENCIES = [const.OPENTHERM]
COMPONENT_TYPE = const.NUMBER
OpenthermNumber = generate.opentherm_ns.class_(
"OpenthermNumber", number.Number, cg.Component, input.OpenthermInput
)
async def new_openthermnumber(config: dict[str, Any]) -> cg.Pvariable:
var = cg.new_Pvariable(config[CONF_ID])
await cg.register_component(var, config)
await number.register_number(
var,
config,
min_value=config[input.CONF_min_value],
max_value=config[input.CONF_max_value],
step=config[input.CONF_step],
)
input.generate_setters(var, config)
if CONF_INITIAL_VALUE in config:
cg.add(var.set_initial_value(config[CONF_INITIAL_VALUE]))
if CONF_RESTORE_VALUE in config:
cg.add(var.set_restore_value(config[CONF_RESTORE_VALUE]))
return var
def get_entity_validation_schema(entity: schema.InputSchema) -> cv.Schema:
return (
number.NUMBER_SCHEMA.extend(
{
cv.GenerateID(): cv.declare_id(OpenthermNumber),
cv.Optional(
CONF_UNIT_OF_MEASUREMENT, entity.unit_of_measurement
): cv.string_strict,
cv.Optional(CONF_STEP, entity.step): cv.float_,
cv.Optional(CONF_INITIAL_VALUE): cv.float_,
cv.Optional(CONF_RESTORE_VALUE): cv.boolean,
}
)
.extend(input.input_schema(entity))
.extend(cv.COMPONENT_SCHEMA)
)
CONFIG_SCHEMA = validate.create_component_schema(
schema.INPUTS, get_entity_validation_schema
)
async def to_code(config: dict[str, Any]) -> None:
keys = await generate.component_to_code(
COMPONENT_TYPE,
schema.INPUTS,
OpenthermNumber,
generate.create_only_conf(new_openthermnumber),
config,
)
generate.define_readers(COMPONENT_TYPE, keys)

View file

@ -0,0 +1,40 @@
#include "number.h"
namespace esphome {
namespace opentherm {
static const char *const TAG = "opentherm.number";
void OpenthermNumber::control(float value) {
this->publish_state(value);
if (this->restore_value_)
this->pref_.save(&value);
}
void OpenthermNumber::setup() {
float value;
if (!this->restore_value_) {
value = this->initial_value_;
} else {
this->pref_ = global_preferences->make_preference<float>(this->get_object_id_hash());
if (!this->pref_.load(&value)) {
if (!std::isnan(this->initial_value_)) {
value = this->initial_value_;
} else {
value = this->traits.get_min_value();
}
}
}
this->publish_state(value);
}
void OpenthermNumber::dump_config() {
LOG_NUMBER("", "OpenTherm Number", this);
ESP_LOGCONFIG(TAG, " Restore value: %d", this->restore_value_);
ESP_LOGCONFIG(TAG, " Initial value: %.2f", this->initial_value_);
ESP_LOGCONFIG(TAG, " Current value: %.2f", this->state);
}
} // namespace opentherm
} // namespace esphome

View file

@ -0,0 +1,31 @@
#pragma once
#include "esphome/components/number/number.h"
#include "esphome/core/preferences.h"
#include "esphome/core/log.h"
#include "esphome/components/opentherm/input.h"
namespace esphome {
namespace opentherm {
// Just a simple number, which stores the number
class OpenthermNumber : public number::Number, public Component, public OpenthermInput {
protected:
void control(float value) override;
void setup() override;
void dump_config() override;
float initial_value_{NAN};
bool restore_value_{false};
ESPPreferenceObject pref_;
public:
void set_min_value(float min_value) override { this->traits.set_min_value(min_value); }
void set_max_value(float max_value) override { this->traits.set_max_value(max_value); }
void set_initial_value(float initial_value) { initial_value_ = initial_value; }
void set_restore_value(bool restore_value) { this->restore_value_ = restore_value; }
};
} // namespace opentherm
} // namespace esphome

View file

@ -483,6 +483,8 @@ const char *OpenTherm::message_id_to_str(MessageId id) {
TO_STRING_MEMBER(EXHAUST_TEMP) TO_STRING_MEMBER(EXHAUST_TEMP)
TO_STRING_MEMBER(FAN_SPEED) TO_STRING_MEMBER(FAN_SPEED)
TO_STRING_MEMBER(FLAME_CURRENT) TO_STRING_MEMBER(FLAME_CURRENT)
TO_STRING_MEMBER(ROOM_TEMP_CH2)
TO_STRING_MEMBER(REL_HUMIDITY)
TO_STRING_MEMBER(DHW_BOUNDS) TO_STRING_MEMBER(DHW_BOUNDS)
TO_STRING_MEMBER(CH_BOUNDS) TO_STRING_MEMBER(CH_BOUNDS)
TO_STRING_MEMBER(OTC_CURVE_BOUNDS) TO_STRING_MEMBER(OTC_CURVE_BOUNDS)
@ -492,14 +494,39 @@ const char *OpenTherm::message_id_to_str(MessageId id) {
TO_STRING_MEMBER(HVAC_STATUS) TO_STRING_MEMBER(HVAC_STATUS)
TO_STRING_MEMBER(REL_VENT_SETPOINT) TO_STRING_MEMBER(REL_VENT_SETPOINT)
TO_STRING_MEMBER(DEVICE_VENT) TO_STRING_MEMBER(DEVICE_VENT)
TO_STRING_MEMBER(HVAC_VER_ID)
TO_STRING_MEMBER(REL_VENTILATION) TO_STRING_MEMBER(REL_VENTILATION)
TO_STRING_MEMBER(REL_HUMID_EXHAUST) TO_STRING_MEMBER(REL_HUMID_EXHAUST)
TO_STRING_MEMBER(EXHAUST_CO2)
TO_STRING_MEMBER(SUPPLY_INLET_TEMP) TO_STRING_MEMBER(SUPPLY_INLET_TEMP)
TO_STRING_MEMBER(SUPPLY_OUTLET_TEMP) TO_STRING_MEMBER(SUPPLY_OUTLET_TEMP)
TO_STRING_MEMBER(EXHAUST_INLET_TEMP) TO_STRING_MEMBER(EXHAUST_INLET_TEMP)
TO_STRING_MEMBER(EXHAUST_OUTLET_TEMP) TO_STRING_MEMBER(EXHAUST_OUTLET_TEMP)
TO_STRING_MEMBER(EXHAUST_FAN_SPEED)
TO_STRING_MEMBER(SUPPLY_FAN_SPEED)
TO_STRING_MEMBER(REMOTE_VENTILATION_PARAM)
TO_STRING_MEMBER(NOM_REL_VENTILATION) TO_STRING_MEMBER(NOM_REL_VENTILATION)
TO_STRING_MEMBER(HVAC_NUM_TSP)
TO_STRING_MEMBER(HVAC_IDX_TSP)
TO_STRING_MEMBER(HVAC_FHB_SIZE)
TO_STRING_MEMBER(HVAC_FHB_IDX)
TO_STRING_MEMBER(RF_SIGNAL)
TO_STRING_MEMBER(DHW_MODE)
TO_STRING_MEMBER(OVERRIDE_FUNC) TO_STRING_MEMBER(OVERRIDE_FUNC)
TO_STRING_MEMBER(SOLAR_MODE_FLAGS)
TO_STRING_MEMBER(SOLAR_ASF)
TO_STRING_MEMBER(SOLAR_VERSION_ID)
TO_STRING_MEMBER(SOLAR_PRODUCT_ID)
TO_STRING_MEMBER(SOLAR_NUM_TSP)
TO_STRING_MEMBER(SOLAR_IDX_TSP)
TO_STRING_MEMBER(SOLAR_FHB_SIZE)
TO_STRING_MEMBER(SOLAR_FHB_IDX)
TO_STRING_MEMBER(SOLAR_STARTS)
TO_STRING_MEMBER(SOLAR_HOURS)
TO_STRING_MEMBER(SOLAR_ENERGY)
TO_STRING_MEMBER(SOLAR_TOTAL_ENERGY)
TO_STRING_MEMBER(FAILED_BURNER_STARTS)
TO_STRING_MEMBER(BURNER_FLAME_LOW)
TO_STRING_MEMBER(OEM_DIAGNOSTIC) TO_STRING_MEMBER(OEM_DIAGNOSTIC)
TO_STRING_MEMBER(BURNER_STARTS) TO_STRING_MEMBER(BURNER_STARTS)
TO_STRING_MEMBER(CH_PUMP_STARTS) TO_STRING_MEMBER(CH_PUMP_STARTS)

View file

@ -99,6 +99,8 @@ enum MessageId {
EXHAUST_TEMP = 33, EXHAUST_TEMP = 33,
FAN_SPEED = 35, FAN_SPEED = 35,
FLAME_CURRENT = 36, FLAME_CURRENT = 36,
ROOM_TEMP_CH2 = 37,
REL_HUMIDITY = 38,
DHW_BOUNDS = 48, DHW_BOUNDS = 48,
CH_BOUNDS = 49, CH_BOUNDS = 49,
OTC_CURVE_BOUNDS = 50, OTC_CURVE_BOUNDS = 50,
@ -110,15 +112,46 @@ enum MessageId {
HVAC_STATUS = 70, HVAC_STATUS = 70,
REL_VENT_SETPOINT = 71, REL_VENT_SETPOINT = 71,
DEVICE_VENT = 74, DEVICE_VENT = 74,
HVAC_VER_ID = 75,
REL_VENTILATION = 77, REL_VENTILATION = 77,
REL_HUMID_EXHAUST = 78, REL_HUMID_EXHAUST = 78,
EXHAUST_CO2 = 79,
SUPPLY_INLET_TEMP = 80, SUPPLY_INLET_TEMP = 80,
SUPPLY_OUTLET_TEMP = 81, SUPPLY_OUTLET_TEMP = 81,
EXHAUST_INLET_TEMP = 82, EXHAUST_INLET_TEMP = 82,
EXHAUST_OUTLET_TEMP = 83, EXHAUST_OUTLET_TEMP = 83,
EXHAUST_FAN_SPEED = 84,
SUPPLY_FAN_SPEED = 85,
REMOTE_VENTILATION_PARAM = 86,
NOM_REL_VENTILATION = 87, NOM_REL_VENTILATION = 87,
HVAC_NUM_TSP = 88,
HVAC_IDX_TSP = 89,
HVAC_FHB_SIZE = 90,
HVAC_FHB_IDX = 91,
RF_SIGNAL = 98,
DHW_MODE = 99,
OVERRIDE_FUNC = 100, OVERRIDE_FUNC = 100,
// Solar Specific Message IDs
SOLAR_MODE_FLAGS = 101, // hb0-2 Controller storage mode
// lb0 Device fault
// lb1-3 Device mode status
// lb4-5 Device status
SOLAR_ASF = 102,
SOLAR_VERSION_ID = 103,
SOLAR_PRODUCT_ID = 104,
SOLAR_NUM_TSP = 105,
SOLAR_IDX_TSP = 106,
SOLAR_FHB_SIZE = 107,
SOLAR_FHB_IDX = 108,
SOLAR_STARTS = 109,
SOLAR_HOURS = 110,
SOLAR_ENERGY = 111,
SOLAR_TOTAL_ENERGY = 112,
FAILED_BURNER_STARTS = 113,
BURNER_FLAME_LOW = 114,
OEM_DIAGNOSTIC = 115, OEM_DIAGNOSTIC = 115,
BURNER_STARTS = 116, BURNER_STARTS = 116,
CH_PUMP_STARTS = 117, CH_PUMP_STARTS = 117,

View file

@ -13,14 +13,49 @@ namespace opentherm {
#ifndef OPENTHERM_SENSOR_LIST #ifndef OPENTHERM_SENSOR_LIST
#define OPENTHERM_SENSOR_LIST(F, sep) #define OPENTHERM_SENSOR_LIST(F, sep)
#endif #endif
#ifndef OPENTHERM_BINARY_SENSOR_LIST
#define OPENTHERM_BINARY_SENSOR_LIST(F, sep)
#endif
#ifndef OPENTHERM_SWITCH_LIST
#define OPENTHERM_SWITCH_LIST(F, sep)
#endif
#ifndef OPENTHERM_NUMBER_LIST
#define OPENTHERM_NUMBER_LIST(F, sep)
#endif
#ifndef OPENTHERM_OUTPUT_LIST
#define OPENTHERM_OUTPUT_LIST(F, sep)
#endif
#ifndef OPENTHERM_INPUT_SENSOR_LIST
#define OPENTHERM_INPUT_SENSOR_LIST(F, sep)
#endif
// Use macros to create fields for every entity specified in the ESPHome configuration // Use macros to create fields for every entity specified in the ESPHome configuration
#define OPENTHERM_DECLARE_SENSOR(entity) sensor::Sensor *entity; #define OPENTHERM_DECLARE_SENSOR(entity) sensor::Sensor *entity;
#define OPENTHERM_DECLARE_BINARY_SENSOR(entity) binary_sensor::BinarySensor *entity;
#define OPENTHERM_DECLARE_SWITCH(entity) OpenthermSwitch *entity;
#define OPENTHERM_DECLARE_NUMBER(entity) OpenthermNumber *entity;
#define OPENTHERM_DECLARE_OUTPUT(entity) OpenthermOutput *entity;
#define OPENTHERM_DECLARE_INPUT_SENSOR(entity) sensor::Sensor *entity;
// Setter macros // Setter macros
#define OPENTHERM_SET_SENSOR(entity) \ #define OPENTHERM_SET_SENSOR(entity) \
void set_##entity(sensor::Sensor *sensor) { this->entity = sensor; } void set_##entity(sensor::Sensor *sensor) { this->entity = sensor; }
#define OPENTHERM_SET_BINARY_SENSOR(entity) \
void set_##entity(binary_sensor::BinarySensor *binary_sensor) { this->entity = binary_sensor; }
#define OPENTHERM_SET_SWITCH(entity) \
void set_##entity(OpenthermSwitch *sw) { this->entity = sw; }
#define OPENTHERM_SET_NUMBER(entity) \
void set_##entity(OpenthermNumber *number) { this->entity = number; }
#define OPENTHERM_SET_OUTPUT(entity) \
void set_##entity(OpenthermOutput *output) { this->entity = output; }
#define OPENTHERM_SET_INPUT_SENSOR(entity) \
void set_##entity(sensor::Sensor *sensor) { this->entity = sensor; }
// ===== hub.cpp macros ===== // ===== hub.cpp macros =====
// *_MESSAGE_HANDLERS are generated in defines.h and look like this: // *_MESSAGE_HANDLERS are generated in defines.h and look like this:
@ -35,6 +70,31 @@ namespace opentherm {
#ifndef OPENTHERM_SENSOR_MESSAGE_HANDLERS #ifndef OPENTHERM_SENSOR_MESSAGE_HANDLERS
#define OPENTHERM_SENSOR_MESSAGE_HANDLERS(MESSAGE, ENTITY, entity_sep, postscript, msg_sep) #define OPENTHERM_SENSOR_MESSAGE_HANDLERS(MESSAGE, ENTITY, entity_sep, postscript, msg_sep)
#endif #endif
#ifndef OPENTHERM_BINARY_SENSOR_MESSAGE_HANDLERS
#define OPENTHERM_BINARY_SENSOR_MESSAGE_HANDLERS(MESSAGE, ENTITY, entity_sep, postscript, msg_sep)
#endif
#ifndef OPENTHERM_SWITCH_MESSAGE_HANDLERS
#define OPENTHERM_SWITCH_MESSAGE_HANDLERS(MESSAGE, ENTITY, entity_sep, postscript, msg_sep)
#endif
#ifndef OPENTHERM_NUMBER_MESSAGE_HANDLERS
#define OPENTHERM_NUMBER_MESSAGE_HANDLERS(MESSAGE, ENTITY, entity_sep, postscript, msg_sep)
#endif
#ifndef OPENTHERM_OUTPUT_MESSAGE_HANDLERS
#define OPENTHERM_OUTPUT_MESSAGE_HANDLERS(MESSAGE, ENTITY, entity_sep, postscript, msg_sep)
#endif
#ifndef OPENTHERM_INPUT_SENSOR_MESSAGE_HANDLERS
#define OPENTHERM_INPUT_SENSOR_MESSAGE_HANDLERS(MESSAGE, ENTITY, entity_sep, postscript, msg_sep)
#endif
// Write data request builders
#define OPENTHERM_MESSAGE_WRITE_MESSAGE(msg) \
case MessageId::msg: { \
data.type = MessageType::WRITE_DATA; \
data.id = request_id;
#define OPENTHERM_MESSAGE_WRITE_ENTITY(key, msg_data) message_data::write_##msg_data(this->key->state, data);
#define OPENTHERM_MESSAGE_WRITE_POSTSCRIPT \
return data; \
}
// Read data request builder // Read data request builder
#define OPENTHERM_MESSAGE_READ_MESSAGE(msg) \ #define OPENTHERM_MESSAGE_READ_MESSAGE(msg) \

View file

@ -0,0 +1,47 @@
from typing import Any
import esphome.codegen as cg
import esphome.config_validation as cv
from esphome.components import output
from esphome.const import CONF_ID
from .. import const, schema, validate, input, generate
DEPENDENCIES = [const.OPENTHERM]
COMPONENT_TYPE = const.OUTPUT
OpenthermOutput = generate.opentherm_ns.class_(
"OpenthermOutput", output.FloatOutput, cg.Component, input.OpenthermInput
)
async def new_openthermoutput(
config: dict[str, Any], key: str, _hub: cg.MockObj
) -> cg.Pvariable:
var = cg.new_Pvariable(config[CONF_ID])
await cg.register_component(var, config)
await output.register_output(var, config)
cg.add(getattr(var, "set_id")(cg.RawExpression(f'"{key}_{config[CONF_ID]}"')))
input.generate_setters(var, config)
return var
def get_entity_validation_schema(entity: schema.InputSchema) -> cv.Schema:
return (
output.FLOAT_OUTPUT_SCHEMA.extend(
{cv.GenerateID(): cv.declare_id(OpenthermOutput)}
)
.extend(input.input_schema(entity))
.extend(cv.COMPONENT_SCHEMA)
)
CONFIG_SCHEMA = validate.create_component_schema(
schema.INPUTS, get_entity_validation_schema
)
async def to_code(config: dict[str, Any]) -> None:
keys = await generate.component_to_code(
COMPONENT_TYPE, schema.INPUTS, OpenthermOutput, new_openthermoutput, config
)
generate.define_readers(COMPONENT_TYPE, keys)

Some files were not shown because too many files have changed in this diff Show more