mirror of
https://github.com/esphome/esphome.git
synced 2024-11-15 03:28:12 +01:00
Merge branch 'dev' into refactor_esp32camera
This commit is contained in:
commit
3a11485a4d
204 changed files with 11979 additions and 1399 deletions
|
@ -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
|
||||||
|
|
||||||
|
|
15
.github/PULL_REQUEST_TEMPLATE.md
vendored
15
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -7,11 +7,16 @@
|
||||||
- [ ] Bugfix (non-breaking change which fixes an issue)
|
- [ ] Bugfix (non-breaking change which fixes an issue)
|
||||||
- [ ] New feature (non-breaking change which adds functionality)
|
- [ ] New feature (non-breaking change which adds functionality)
|
||||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||||
|
- [ ] Code quality improvements to existing code or addition of tests
|
||||||
- [ ] Other
|
- [ ] Other
|
||||||
|
|
||||||
**Related issue or feature (if applicable):** fixes <link to issue>
|
**Related issue or feature (if applicable):**
|
||||||
|
|
||||||
**Pull request in [esphome-docs](https://github.com/esphome/esphome-docs) with documentation (if applicable):** esphome/esphome-docs#<esphome-docs PR number goes here>
|
- fixes <link to issue>
|
||||||
|
|
||||||
|
**Pull request in [esphome-docs](https://github.com/esphome/esphome-docs) with documentation (if applicable):**
|
||||||
|
|
||||||
|
- esphome/esphome-docs#<esphome-docs PR number goes here>
|
||||||
|
|
||||||
## Test Environment
|
## Test Environment
|
||||||
|
|
||||||
|
@ -23,12 +28,6 @@
|
||||||
- [ ] RTL87xx
|
- [ ] RTL87xx
|
||||||
|
|
||||||
## Example entry for `config.yaml`:
|
## Example entry for `config.yaml`:
|
||||||
<!--
|
|
||||||
Supplying a configuration snippet, makes it easier for a maintainer to test
|
|
||||||
your PR. Furthermore, for new integrations, it gives an impression of how
|
|
||||||
the configuration would look like.
|
|
||||||
Note: Remove this section if this PR does not have an example entry.
|
|
||||||
-->
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example config.yaml
|
# Example config.yaml
|
||||||
|
|
4
.github/actions/restore-python/action.yml
vendored
4
.github/actions/restore-python/action.yml
vendored
|
@ -17,12 +17,12 @@ runs:
|
||||||
steps:
|
steps:
|
||||||
- name: Set up Python ${{ inputs.python-version }}
|
- name: Set up Python ${{ inputs.python-version }}
|
||||||
id: python
|
id: python
|
||||||
uses: actions/setup-python@v5.2.0
|
uses: actions/setup-python@v5.3.0
|
||||||
with:
|
with:
|
||||||
python-version: ${{ inputs.python-version }}
|
python-version: ${{ inputs.python-version }}
|
||||||
- name: Restore Python virtual environment
|
- name: Restore Python virtual environment
|
||||||
id: cache-venv
|
id: cache-venv
|
||||||
uses: actions/cache/restore@v4.1.1
|
uses: actions/cache/restore@v4.1.2
|
||||||
with:
|
with:
|
||||||
path: venv
|
path: venv
|
||||||
# yamllint disable-line rule:line-length
|
# yamllint disable-line rule:line-length
|
||||||
|
|
2
.github/workflows/ci-api-proto.yml
vendored
2
.github/workflows/ci-api-proto.yml
vendored
|
@ -23,7 +23,7 @@ jobs:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4.1.7
|
uses: actions/checkout@v4.1.7
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v5.2.0
|
uses: actions/setup-python@v5.3.0
|
||||||
with:
|
with:
|
||||||
python-version: "3.11"
|
python-version: "3.11"
|
||||||
|
|
||||||
|
|
2
.github/workflows/ci-docker.yml
vendored
2
.github/workflows/ci-docker.yml
vendored
|
@ -42,7 +42,7 @@ jobs:
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4.1.7
|
- uses: actions/checkout@v4.1.7
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v5.2.0
|
uses: actions/setup-python@v5.3.0
|
||||||
with:
|
with:
|
||||||
python-version: "3.9"
|
python-version: "3.9"
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
|
|
8
.github/workflows/ci.yml
vendored
8
.github/workflows/ci.yml
vendored
|
@ -41,12 +41,12 @@ jobs:
|
||||||
run: echo key="${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}" >> $GITHUB_OUTPUT
|
run: echo key="${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}" >> $GITHUB_OUTPUT
|
||||||
- name: Set up Python ${{ env.DEFAULT_PYTHON }}
|
- name: Set up Python ${{ env.DEFAULT_PYTHON }}
|
||||||
id: python
|
id: python
|
||||||
uses: actions/setup-python@v5.2.0
|
uses: actions/setup-python@v5.3.0
|
||||||
with:
|
with:
|
||||||
python-version: ${{ env.DEFAULT_PYTHON }}
|
python-version: ${{ env.DEFAULT_PYTHON }}
|
||||||
- name: Restore Python virtual environment
|
- name: Restore Python virtual environment
|
||||||
id: cache-venv
|
id: cache-venv
|
||||||
uses: actions/cache@v4.1.1
|
uses: actions/cache@v4.1.2
|
||||||
with:
|
with:
|
||||||
path: venv
|
path: venv
|
||||||
# yamllint disable-line rule:line-length
|
# yamllint disable-line rule:line-length
|
||||||
|
@ -302,14 +302,14 @@ jobs:
|
||||||
|
|
||||||
- name: Cache platformio
|
- name: Cache platformio
|
||||||
if: github.ref == 'refs/heads/dev'
|
if: github.ref == 'refs/heads/dev'
|
||||||
uses: actions/cache@v4.1.1
|
uses: actions/cache@v4.1.2
|
||||||
with:
|
with:
|
||||||
path: ~/.platformio
|
path: ~/.platformio
|
||||||
key: platformio-${{ matrix.pio_cache_key }}
|
key: platformio-${{ matrix.pio_cache_key }}
|
||||||
|
|
||||||
- name: Cache platformio
|
- name: Cache platformio
|
||||||
if: github.ref != 'refs/heads/dev'
|
if: github.ref != 'refs/heads/dev'
|
||||||
uses: actions/cache/restore@v4.1.1
|
uses: actions/cache/restore@v4.1.2
|
||||||
with:
|
with:
|
||||||
path: ~/.platformio
|
path: ~/.platformio
|
||||||
key: platformio-${{ matrix.pio_cache_key }}
|
key: platformio-${{ matrix.pio_cache_key }}
|
||||||
|
|
6
.github/workflows/release.yml
vendored
6
.github/workflows/release.yml
vendored
|
@ -53,7 +53,7 @@ jobs:
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4.1.7
|
- uses: actions/checkout@v4.1.7
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v5.2.0
|
uses: actions/setup-python@v5.3.0
|
||||||
with:
|
with:
|
||||||
python-version: "3.x"
|
python-version: "3.x"
|
||||||
- name: Set up python environment
|
- name: Set up python environment
|
||||||
|
@ -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.11.0
|
||||||
|
|
||||||
deploy-docker:
|
deploy-docker:
|
||||||
name: Build ESPHome ${{ matrix.platform }}
|
name: Build ESPHome ${{ matrix.platform }}
|
||||||
|
@ -85,7 +85,7 @@ jobs:
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4.1.7
|
- uses: actions/checkout@v4.1.7
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v5.2.0
|
uses: actions/setup-python@v5.3.0
|
||||||
with:
|
with:
|
||||||
python-version: "3.9"
|
python-version: "3.9"
|
||||||
|
|
||||||
|
|
2
.github/workflows/sync-device-classes.yml
vendored
2
.github/workflows/sync-device-classes.yml
vendored
|
@ -22,7 +22,7 @@ jobs:
|
||||||
path: lib/home-assistant
|
path: lib/home-assistant
|
||||||
|
|
||||||
- name: Setup Python
|
- name: Setup Python
|
||||||
uses: actions/setup-python@v5.2.0
|
uses: actions/setup-python@v5.3.0
|
||||||
with:
|
with:
|
||||||
python-version: 3.12
|
python-version: 3.12
|
||||||
|
|
||||||
|
|
3
.gitignore
vendored
3
.gitignore
vendored
|
@ -75,6 +75,9 @@ cov.xml
|
||||||
# pyenv
|
# pyenv
|
||||||
.python-version
|
.python-version
|
||||||
|
|
||||||
|
# asdf
|
||||||
|
.tool-versions
|
||||||
|
|
||||||
# Environments
|
# Environments
|
||||||
.env
|
.env
|
||||||
.venv
|
.venv
|
||||||
|
|
|
@ -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/camera/* @DT-art1
|
esphome/components/camera/* @DT-art1
|
||||||
esphome/components/canbus/* @danielschramm @mvturnho
|
esphome/components/canbus/* @danielschramm @mvturnho
|
||||||
esphome/components/cap1188/* @mreditor97
|
esphome/components/cap1188/* @mreditor97
|
||||||
|
@ -131,6 +132,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
|
||||||
|
@ -199,10 +201,11 @@ esphome/components/htu31d/* @betterengineering
|
||||||
esphome/components/hydreon_rgxx/* @functionpointer
|
esphome/components/hydreon_rgxx/* @functionpointer
|
||||||
esphome/components/hyt271/* @Philippe12
|
esphome/components/hyt271/* @Philippe12
|
||||||
esphome/components/i2c/* @esphome/core
|
esphome/components/i2c/* @esphome/core
|
||||||
|
esphome/components/i2c_device/* @gabest11
|
||||||
esphome/components/i2s_audio/* @jesserockz
|
esphome/components/i2s_audio/* @jesserockz
|
||||||
esphome/components/i2s_audio/media_player/* @jesserockz
|
esphome/components/i2s_audio/media_player/* @jesserockz
|
||||||
esphome/components/i2s_audio/microphone/* @jesserockz
|
esphome/components/i2s_audio/microphone/* @jesserockz
|
||||||
esphome/components/i2s_audio/speaker/* @jesserockz
|
esphome/components/i2s_audio/speaker/* @jesserockz @kahrendt
|
||||||
esphome/components/iaqcore/* @yozik04
|
esphome/components/iaqcore/* @yozik04
|
||||||
esphome/components/ili9xxx/* @clydebarrow @nielsnl68
|
esphome/components/ili9xxx/* @clydebarrow @nielsnl68
|
||||||
esphome/components/improv_base/* @esphome/core
|
esphome/components/improv_base/* @esphome/core
|
||||||
|
@ -377,7 +380,7 @@ esphome/components/smt100/* @piechade
|
||||||
esphome/components/sn74hc165/* @jesserockz
|
esphome/components/sn74hc165/* @jesserockz
|
||||||
esphome/components/socket/* @esphome/core
|
esphome/components/socket/* @esphome/core
|
||||||
esphome/components/sonoff_d1/* @anatoly-savchenkov
|
esphome/components/sonoff_d1/* @anatoly-savchenkov
|
||||||
esphome/components/speaker/* @jesserockz
|
esphome/components/speaker/* @jesserockz @kahrendt
|
||||||
esphome/components/spi/* @clydebarrow @esphome/core
|
esphome/components/spi/* @clydebarrow @esphome/core
|
||||||
esphome/components/spi_device/* @clydebarrow
|
esphome/components/spi_device/* @clydebarrow
|
||||||
esphome/components/spi_led_strip/* @clydebarrow
|
esphome/components/spi_led_strip/* @clydebarrow
|
||||||
|
|
|
@ -40,25 +40,6 @@ RUN \
|
||||||
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.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
|
||||||
|
"
|
||||||
|
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
|
||||||
|
|
|
@ -271,7 +271,8 @@ async def to_code(config):
|
||||||
pos += 1
|
pos += 1
|
||||||
|
|
||||||
elif config[CONF_TYPE] in ["RGB565", "TRANSPARENT_IMAGE"]:
|
elif config[CONF_TYPE] in ["RGB565", "TRANSPARENT_IMAGE"]:
|
||||||
data = [0 for _ in range(height * width * 2 * frames)]
|
bytes_per_pixel = 3 if transparent else 2
|
||||||
|
data = [0 for _ in range(height * width * bytes_per_pixel * frames)]
|
||||||
pos = 0
|
pos = 0
|
||||||
for frameIndex in range(frames):
|
for frameIndex in range(frames):
|
||||||
image.seek(frameIndex)
|
image.seek(frameIndex)
|
||||||
|
@ -288,17 +289,13 @@ async def to_code(config):
|
||||||
G = g >> 2
|
G = g >> 2
|
||||||
B = b >> 3
|
B = b >> 3
|
||||||
rgb = (R << 11) | (G << 5) | B
|
rgb = (R << 11) | (G << 5) | B
|
||||||
|
|
||||||
if transparent:
|
|
||||||
if rgb == 0x0020:
|
|
||||||
rgb = 0
|
|
||||||
if a < 0x80:
|
|
||||||
rgb = 0x0020
|
|
||||||
|
|
||||||
data[pos] = rgb >> 8
|
data[pos] = rgb >> 8
|
||||||
pos += 1
|
pos += 1
|
||||||
data[pos] = rgb & 0xFF
|
data[pos] = rgb & 0xFF
|
||||||
pos += 1
|
pos += 1
|
||||||
|
if transparent:
|
||||||
|
data[pos] = a
|
||||||
|
pos += 1
|
||||||
|
|
||||||
elif config[CONF_TYPE] in ["BINARY", "TRANSPARENT_BINARY"]:
|
elif config[CONF_TYPE] in ["BINARY", "TRANSPARENT_BINARY"]:
|
||||||
width8 = ((width + 7) // 8) * 8
|
width8 = ((width + 7) // 8) * 8
|
||||||
|
|
|
@ -62,7 +62,7 @@ void Animation::set_frame(int frame) {
|
||||||
}
|
}
|
||||||
|
|
||||||
void Animation::update_data_start_() {
|
void Animation::update_data_start_() {
|
||||||
const uint32_t image_size = image_type_to_width_stride(this->width_, this->type_) * this->height_;
|
const uint32_t image_size = this->get_width_stride() * this->height_;
|
||||||
this->data_start_ = this->animation_data_start_ + image_size * this->current_frame_;
|
this->data_start_ = this->animation_data_start_ + image_size * this->current_frame_;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -45,7 +45,7 @@ CONFIG_SCHEMA = cv.All(
|
||||||
cv.Optional(CONF_SERVICE_UUID): esp32_ble_tracker.bt_uuid,
|
cv.Optional(CONF_SERVICE_UUID): esp32_ble_tracker.bt_uuid,
|
||||||
cv.Optional(CONF_IBEACON_MAJOR): cv.uint16_t,
|
cv.Optional(CONF_IBEACON_MAJOR): cv.uint16_t,
|
||||||
cv.Optional(CONF_IBEACON_MINOR): cv.uint16_t,
|
cv.Optional(CONF_IBEACON_MINOR): cv.uint16_t,
|
||||||
cv.Optional(CONF_IBEACON_UUID): cv.uuid,
|
cv.Optional(CONF_IBEACON_UUID): esp32_ble_tracker.bt_uuid,
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
.extend(esp32_ble_tracker.ESP_BLE_DEVICE_SCHEMA)
|
.extend(esp32_ble_tracker.ESP_BLE_DEVICE_SCHEMA)
|
||||||
|
@ -79,7 +79,7 @@ async def to_code(config):
|
||||||
cg.add(var.set_service_uuid128(uuid128))
|
cg.add(var.set_service_uuid128(uuid128))
|
||||||
|
|
||||||
if ibeacon_uuid := config.get(CONF_IBEACON_UUID):
|
if ibeacon_uuid := config.get(CONF_IBEACON_UUID):
|
||||||
ibeacon_uuid = esp32_ble_tracker.as_hex_array(str(ibeacon_uuid))
|
ibeacon_uuid = esp32_ble_tracker.as_reversed_hex_array(ibeacon_uuid)
|
||||||
cg.add(var.set_ibeacon_uuid(ibeacon_uuid))
|
cg.add(var.set_ibeacon_uuid(ibeacon_uuid))
|
||||||
|
|
||||||
if (ibeacon_major := config.get(CONF_IBEACON_MAJOR)) is not None:
|
if (ibeacon_major := config.get(CONF_IBEACON_MAJOR)) is not None:
|
||||||
|
|
5
esphome/components/bytebuffer/__init__.py
Normal file
5
esphome/components/bytebuffer/__init__.py
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
CODEOWNERS = ["@clydebarrow"]
|
||||||
|
|
||||||
|
# Allows bytebuffer to be configured in yaml, to allow use of the C++ api.
|
||||||
|
|
||||||
|
CONFIG_SCHEMA = {}
|
421
esphome/components/bytebuffer/bytebuffer.h
Normal file
421
esphome/components/bytebuffer/bytebuffer.h
Normal 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
|
|
@ -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,
|
||||||
}
|
}
|
||||||
|
|
|
@ -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)
|
||||||
|
|
||||||
|
|
||||||
|
|
0
esphome/components/es8311/__init__.py
Normal file
0
esphome/components/es8311/__init__.py
Normal file
70
esphome/components/es8311/audio_dac.py
Normal file
70
esphome/components/es8311/audio_dac.py
Normal 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]))
|
227
esphome/components/es8311/es8311.cpp
Normal file
227
esphome/components/es8311/es8311.cpp
Normal 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, ®32);
|
||||||
|
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, ®02));
|
||||||
|
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, ®06));
|
||||||
|
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, ®07));
|
||||||
|
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, ®00));
|
||||||
|
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, ®31)) {
|
||||||
|
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
|
135
esphome/components/es8311/es8311.h
Normal file
135
esphome/components/es8311/es8311.h
Normal 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
|
195
esphome/components/es8311/es8311_const.h
Normal file
195
esphome/components/es8311/es8311_const.h
Normal 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
|
|
@ -395,6 +395,13 @@ ARDUINO_FRAMEWORK_SCHEMA = cv.All(
|
||||||
cv.Optional(CONF_VERSION, default="recommended"): cv.string_strict,
|
cv.Optional(CONF_VERSION, default="recommended"): cv.string_strict,
|
||||||
cv.Optional(CONF_SOURCE): cv.string_strict,
|
cv.Optional(CONF_SOURCE): cv.string_strict,
|
||||||
cv.Optional(CONF_PLATFORM_VERSION): _parse_platform_version,
|
cv.Optional(CONF_PLATFORM_VERSION): _parse_platform_version,
|
||||||
|
cv.Optional(CONF_ADVANCED, default={}): cv.Schema(
|
||||||
|
{
|
||||||
|
cv.Optional(
|
||||||
|
CONF_IGNORE_EFUSE_CUSTOM_MAC, default=False
|
||||||
|
): cv.boolean,
|
||||||
|
}
|
||||||
|
),
|
||||||
}
|
}
|
||||||
),
|
),
|
||||||
_arduino_check_versions,
|
_arduino_check_versions,
|
||||||
|
@ -494,6 +501,9 @@ async def to_code(config):
|
||||||
conf = config[CONF_FRAMEWORK]
|
conf = config[CONF_FRAMEWORK]
|
||||||
cg.add_platformio_option("platform", conf[CONF_PLATFORM_VERSION])
|
cg.add_platformio_option("platform", conf[CONF_PLATFORM_VERSION])
|
||||||
|
|
||||||
|
if CONF_ADVANCED in conf and conf[CONF_ADVANCED][CONF_IGNORE_EFUSE_CUSTOM_MAC]:
|
||||||
|
cg.add_define("USE_ESP32_IGNORE_EFUSE_CUSTOM_MAC")
|
||||||
|
|
||||||
add_extra_script(
|
add_extra_script(
|
||||||
"post",
|
"post",
|
||||||
"post_build.py",
|
"post_build.py",
|
||||||
|
@ -540,8 +550,6 @@ async def to_code(config):
|
||||||
for name, value in conf[CONF_SDKCONFIG_OPTIONS].items():
|
for name, value in conf[CONF_SDKCONFIG_OPTIONS].items():
|
||||||
add_idf_sdkconfig_option(name, RawSdkconfigValue(value))
|
add_idf_sdkconfig_option(name, RawSdkconfigValue(value))
|
||||||
|
|
||||||
if conf[CONF_ADVANCED][CONF_IGNORE_EFUSE_CUSTOM_MAC]:
|
|
||||||
cg.add_define("USE_ESP32_IGNORE_EFUSE_CUSTOM_MAC")
|
|
||||||
if conf[CONF_ADVANCED].get(CONF_IGNORE_EFUSE_MAC_CRC):
|
if conf[CONF_ADVANCED].get(CONF_IGNORE_EFUSE_MAC_CRC):
|
||||||
add_idf_sdkconfig_option("CONFIG_ESP_MAC_IGNORE_MAC_CRC_ERROR", True)
|
add_idf_sdkconfig_option("CONFIG_ESP_MAC_IGNORE_MAC_CRC_ERROR", True)
|
||||||
if (framework_ver.major, framework_ver.minor) >= (4, 4):
|
if (framework_ver.major, framework_ver.minor) >= (4, 4):
|
||||||
|
|
|
@ -103,6 +103,173 @@ ESP32_BOARD_PINS = {
|
||||||
"LED": 13,
|
"LED": 13,
|
||||||
"LED_BUILTIN": 13,
|
"LED_BUILTIN": 13,
|
||||||
},
|
},
|
||||||
|
"adafruit_feather_esp32s3": {
|
||||||
|
"BUTTON": 0,
|
||||||
|
"A0": 18,
|
||||||
|
"A1": 17,
|
||||||
|
"A2": 16,
|
||||||
|
"A3": 15,
|
||||||
|
"A4": 14,
|
||||||
|
"A5": 8,
|
||||||
|
"SCK": 36,
|
||||||
|
"MOSI": 35,
|
||||||
|
"MISO": 37,
|
||||||
|
"RX": 38,
|
||||||
|
"TX": 39,
|
||||||
|
"SCL": 4,
|
||||||
|
"SDA": 3,
|
||||||
|
"NEOPIXEL": 33,
|
||||||
|
"PIN_NEOPIXEL": 33,
|
||||||
|
"NEOPIXEL_POWER": 21,
|
||||||
|
"I2C_POWER": 7,
|
||||||
|
"LED": 13,
|
||||||
|
"LED_BUILTIN": 13,
|
||||||
|
},
|
||||||
|
"adafruit_feather_esp32s3_nopsram": {
|
||||||
|
"BUTTON": 0,
|
||||||
|
"A0": 18,
|
||||||
|
"A1": 17,
|
||||||
|
"A2": 16,
|
||||||
|
"A3": 15,
|
||||||
|
"A4": 14,
|
||||||
|
"A5": 8,
|
||||||
|
"SCK": 36,
|
||||||
|
"MOSI": 35,
|
||||||
|
"MISO": 37,
|
||||||
|
"RX": 38,
|
||||||
|
"TX": 39,
|
||||||
|
"SCL": 4,
|
||||||
|
"SDA": 3,
|
||||||
|
"NEOPIXEL": 33,
|
||||||
|
"PIN_NEOPIXEL": 33,
|
||||||
|
"NEOPIXEL_POWER": 21,
|
||||||
|
"I2C_POWER": 7,
|
||||||
|
"LED": 13,
|
||||||
|
"LED_BUILTIN": 13,
|
||||||
|
},
|
||||||
|
"adafruit_feather_esp32s3_tft": {
|
||||||
|
"BUTTON": 0,
|
||||||
|
"A0": 18,
|
||||||
|
"A1": 17,
|
||||||
|
"A2": 16,
|
||||||
|
"A3": 15,
|
||||||
|
"A4": 14,
|
||||||
|
"A5": 8,
|
||||||
|
"SCK": 36,
|
||||||
|
"MOSI": 35,
|
||||||
|
"MISO": 37,
|
||||||
|
"RX": 2,
|
||||||
|
"TX": 1,
|
||||||
|
"SCL": 41,
|
||||||
|
"SDA": 42,
|
||||||
|
"NEOPIXEL": 33,
|
||||||
|
"PIN_NEOPIXEL": 33,
|
||||||
|
"NEOPIXEL_POWER": 34,
|
||||||
|
"TFT_I2C_POWER": 21,
|
||||||
|
"TFT_CS": 7,
|
||||||
|
"TFT_DC": 39,
|
||||||
|
"TFT_RESET": 40,
|
||||||
|
"TFT_BACKLIGHT": 45,
|
||||||
|
"LED": 13,
|
||||||
|
"LED_BUILTIN": 13,
|
||||||
|
},
|
||||||
|
"adafruit_funhouse_esp32s2": {
|
||||||
|
"BUTTON_UP": 5,
|
||||||
|
"BUTTON_DOWN": 3,
|
||||||
|
"BUTTON_SELECT": 4,
|
||||||
|
"DOTSTAR_DATA": 14,
|
||||||
|
"DOTSTAR_CLOCK": 15,
|
||||||
|
"PIR_SENSE": 16,
|
||||||
|
"A0": 17,
|
||||||
|
"A1": 2,
|
||||||
|
"A2": 1,
|
||||||
|
"CAP6": 6,
|
||||||
|
"CAP7": 7,
|
||||||
|
"CAP8": 8,
|
||||||
|
"CAP9": 9,
|
||||||
|
"CAP10": 10,
|
||||||
|
"CAP11": 11,
|
||||||
|
"CAP12": 12,
|
||||||
|
"CAP13": 13,
|
||||||
|
"SPEAKER": 42,
|
||||||
|
"LED": 37,
|
||||||
|
"LIGHT": 18,
|
||||||
|
"TFT_MOSI": 35,
|
||||||
|
"TFT_SCK": 36,
|
||||||
|
"TFT_CS": 40,
|
||||||
|
"TFT_DC": 39,
|
||||||
|
"TFT_RESET": 41,
|
||||||
|
"TFT_BACKLIGHT": 21,
|
||||||
|
"RED_LED": 31,
|
||||||
|
"BUTTON": 0,
|
||||||
|
},
|
||||||
|
"adafruit_itsybitsy_esp32": {
|
||||||
|
"A0": 25,
|
||||||
|
"A1": 26,
|
||||||
|
"A2": 4,
|
||||||
|
"A3": 38,
|
||||||
|
"A4": 37,
|
||||||
|
"A5": 36,
|
||||||
|
"SCK": 19,
|
||||||
|
"MOSI": 21,
|
||||||
|
"MISO": 22,
|
||||||
|
"SCL": 27,
|
||||||
|
"SDA": 15,
|
||||||
|
"TX": 20,
|
||||||
|
"RX": 8,
|
||||||
|
"NEOPIXEL": 0,
|
||||||
|
"PIN_NEOPIXEL": 0,
|
||||||
|
"NEOPIXEL_POWER": 2,
|
||||||
|
"BUTTON": 35,
|
||||||
|
},
|
||||||
|
"adafruit_magtag29_esp32s2": {
|
||||||
|
"A1": 18,
|
||||||
|
"BUTTON_A": 15,
|
||||||
|
"BUTTON_B": 14,
|
||||||
|
"BUTTON_C": 12,
|
||||||
|
"BUTTON_D": 11,
|
||||||
|
"SDA": 33,
|
||||||
|
"SCL": 34,
|
||||||
|
"SPEAKER": 17,
|
||||||
|
"SPEAKER_ENABLE": 16,
|
||||||
|
"VOLTAGE_MONITOR": 4,
|
||||||
|
"ACCELEROMETER_INT": 9,
|
||||||
|
"ACCELEROMETER_INTERRUPT": 9,
|
||||||
|
"LIGHT": 3,
|
||||||
|
"NEOPIXEL": 1,
|
||||||
|
"PIN_NEOPIXEL": 1,
|
||||||
|
"NEOPIXEL_POWER": 21,
|
||||||
|
"EPD_BUSY": 5,
|
||||||
|
"EPD_RESET": 6,
|
||||||
|
"EPD_DC": 7,
|
||||||
|
"EPD_CS": 8,
|
||||||
|
"EPD_MOSI": 35,
|
||||||
|
"EPD_SCK": 36,
|
||||||
|
"EPD_MISO": 37,
|
||||||
|
"BUTTON": 0,
|
||||||
|
"LED": 13,
|
||||||
|
"LED_BUILTIN": 13,
|
||||||
|
},
|
||||||
|
"adafruit_metro_esp32s2": {
|
||||||
|
"A0": 17,
|
||||||
|
"A1": 18,
|
||||||
|
"A2": 1,
|
||||||
|
"A3": 2,
|
||||||
|
"A4": 3,
|
||||||
|
"A5": 4,
|
||||||
|
"RX": 38,
|
||||||
|
"TX": 37,
|
||||||
|
"SCL": 34,
|
||||||
|
"SDA": 33,
|
||||||
|
"MISO": 37,
|
||||||
|
"SCK": 36,
|
||||||
|
"MOSI": 35,
|
||||||
|
"NEOPIXEL": 45,
|
||||||
|
"PIN_NEOPIXEL": 45,
|
||||||
|
"LED": 42,
|
||||||
|
"LED_BUILTIN": 42,
|
||||||
|
"BUTTON": 0,
|
||||||
|
},
|
||||||
"adafruit_qtpy_esp32c3": {
|
"adafruit_qtpy_esp32c3": {
|
||||||
"A0": 4,
|
"A0": 4,
|
||||||
"A1": 3,
|
"A1": 3,
|
||||||
|
@ -141,6 +308,26 @@ ESP32_BOARD_PINS = {
|
||||||
"BUTTON": 0,
|
"BUTTON": 0,
|
||||||
"SWITCH": 0,
|
"SWITCH": 0,
|
||||||
},
|
},
|
||||||
|
"adafruit_qtpy_esp32s3_nopsram": {
|
||||||
|
"A0": 18,
|
||||||
|
"A1": 17,
|
||||||
|
"A2": 9,
|
||||||
|
"A3": 8,
|
||||||
|
"SDA": 7,
|
||||||
|
"SCL": 6,
|
||||||
|
"MOSI": 35,
|
||||||
|
"MISO": 37,
|
||||||
|
"SCK": 36,
|
||||||
|
"RX": 16,
|
||||||
|
"TX": 5,
|
||||||
|
"SDA1": 41,
|
||||||
|
"SCL1": 40,
|
||||||
|
"NEOPIXEL": 39,
|
||||||
|
"PIN_NEOPIXEL": 39,
|
||||||
|
"NEOPIXEL_POWER": 38,
|
||||||
|
"BUTTON": 0,
|
||||||
|
"SWITCH": 0,
|
||||||
|
},
|
||||||
"adafruit_qtpy_esp32": {
|
"adafruit_qtpy_esp32": {
|
||||||
"A0": 26,
|
"A0": 26,
|
||||||
"A1": 25,
|
"A1": 25,
|
||||||
|
@ -1068,7 +1255,18 @@ ESP32_BOARD_PINS = {
|
||||||
"_VBAT": 35,
|
"_VBAT": 35,
|
||||||
},
|
},
|
||||||
"wemosbat": {"LED": 16},
|
"wemosbat": {"LED": 16},
|
||||||
"wesp32": {"MISO": 32, "SCL": 4, "SDA": 15},
|
"wesp32": {
|
||||||
|
"MISO": 32,
|
||||||
|
"MOSI": 23,
|
||||||
|
"SCK": 18,
|
||||||
|
"SCL": 4,
|
||||||
|
"SDA": 15,
|
||||||
|
"MISO1": 12,
|
||||||
|
"MOSI1": 13,
|
||||||
|
"SCK1": 14,
|
||||||
|
"SCL1": 5,
|
||||||
|
"SDA1": 33,
|
||||||
|
},
|
||||||
"widora-air": {
|
"widora-air": {
|
||||||
"A1": 39,
|
"A1": 39,
|
||||||
"A2": 35,
|
"A2": 35,
|
||||||
|
|
|
@ -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:
|
||||||
|
|
|
@ -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; }
|
||||||
|
|
|
@ -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;
|
||||||
|
|
|
@ -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:
|
||||||
|
|
|
@ -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]))
|
||||||
|
|
|
@ -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; }
|
||||||
|
|
|
@ -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};
|
||||||
|
|
|
@ -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,
|
||||||
)
|
)
|
||||||
|
|
|
@ -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)
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ from .const import KEY_HOST
|
||||||
from .gpio import host_pin_to_code # noqa
|
from .gpio import host_pin_to_code # noqa
|
||||||
|
|
||||||
CODEOWNERS = ["@esphome/core", "@clydebarrow"]
|
CODEOWNERS = ["@esphome/core", "@clydebarrow"]
|
||||||
AUTO_LOAD = ["network"]
|
AUTO_LOAD = ["network", "preferences"]
|
||||||
|
|
||||||
|
|
||||||
def set_core_data(config):
|
def set_core_data(config):
|
||||||
|
|
|
@ -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:
|
||||||
|
|
|
@ -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
|
||||||
|
|
|
@ -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};
|
||||||
};
|
};
|
||||||
|
|
|
@ -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();
|
||||||
|
|
|
@ -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) {
|
||||||
|
|
|
@ -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;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -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;
|
||||||
|
|
26
esphome/components/i2c_device/__init__.py
Normal file
26
esphome/components/i2c_device/__init__.py
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
import esphome.codegen as cg
|
||||||
|
import esphome.config_validation as cv
|
||||||
|
from esphome.components import i2c
|
||||||
|
from esphome.const import CONF_ID
|
||||||
|
|
||||||
|
DEPENDENCIES = ["i2c"]
|
||||||
|
CODEOWNERS = ["@gabest11"]
|
||||||
|
MULTI_CONF = True
|
||||||
|
|
||||||
|
i2c_device_ns = cg.esphome_ns.namespace("i2c_device")
|
||||||
|
|
||||||
|
I2CDeviceComponent = i2c_device_ns.class_(
|
||||||
|
"I2CDeviceComponent", cg.Component, i2c.I2CDevice
|
||||||
|
)
|
||||||
|
|
||||||
|
CONFIG_SCHEMA = cv.Schema(
|
||||||
|
{
|
||||||
|
cv.GenerateID(CONF_ID): cv.declare_id(I2CDeviceComponent),
|
||||||
|
}
|
||||||
|
).extend(i2c.i2c_device_schema(None))
|
||||||
|
|
||||||
|
|
||||||
|
async def to_code(config):
|
||||||
|
var = cg.new_Pvariable(config[CONF_ID])
|
||||||
|
await cg.register_component(var, config)
|
||||||
|
await i2c.register_i2c_device(var, config)
|
17
esphome/components/i2c_device/i2c_device.cpp
Normal file
17
esphome/components/i2c_device/i2c_device.cpp
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
#include "i2c_device.h"
|
||||||
|
#include "esphome/core/log.h"
|
||||||
|
#include "esphome/core/hal.h"
|
||||||
|
#include <cinttypes>
|
||||||
|
|
||||||
|
namespace esphome {
|
||||||
|
namespace i2c_device {
|
||||||
|
|
||||||
|
static const char *const TAG = "i2c_device";
|
||||||
|
|
||||||
|
void I2CDeviceComponent::dump_config() {
|
||||||
|
ESP_LOGCONFIG(TAG, "I2CDevice");
|
||||||
|
LOG_I2C_DEVICE(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace i2c_device
|
||||||
|
} // namespace esphome
|
18
esphome/components/i2c_device/i2c_device.h
Normal file
18
esphome/components/i2c_device/i2c_device.h
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include "esphome/core/component.h"
|
||||||
|
#include "esphome/components/i2c/i2c.h"
|
||||||
|
|
||||||
|
namespace esphome {
|
||||||
|
namespace i2c_device {
|
||||||
|
|
||||||
|
class I2CDeviceComponent : public Component, public i2c::I2CDevice {
|
||||||
|
public:
|
||||||
|
void dump_config() override;
|
||||||
|
float get_setup_priority() const override { return setup_priority::DATA; }
|
||||||
|
|
||||||
|
protected:
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace i2c_device
|
||||||
|
} // namespace esphome
|
|
@ -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"
|
||||||
|
|
|
@ -17,7 +17,7 @@ from .. import (
|
||||||
)
|
)
|
||||||
|
|
||||||
AUTO_LOAD = ["audio"]
|
AUTO_LOAD = ["audio"]
|
||||||
CODEOWNERS = ["@jesserockz"]
|
CODEOWNERS = ["@jesserockz", "@kahrendt"]
|
||||||
DEPENDENCIES = ["i2s_audio"]
|
DEPENDENCIES = ["i2s_audio"]
|
||||||
|
|
||||||
I2SAudioSpeaker = i2s_audio_ns.class_(
|
I2SAudioSpeaker = i2s_audio_ns.class_(
|
||||||
|
|
|
@ -32,6 +32,7 @@ enum SpeakerEventGroupBits : uint32_t {
|
||||||
STATE_RUNNING = (1 << 11),
|
STATE_RUNNING = (1 << 11),
|
||||||
STATE_STOPPING = (1 << 12),
|
STATE_STOPPING = (1 << 12),
|
||||||
STATE_STOPPED = (1 << 13),
|
STATE_STOPPED = (1 << 13),
|
||||||
|
ERR_INVALID_FORMAT = (1 << 14),
|
||||||
ERR_TASK_FAILED_TO_START = (1 << 15),
|
ERR_TASK_FAILED_TO_START = (1 << 15),
|
||||||
ERR_ESP_INVALID_STATE = (1 << 16),
|
ERR_ESP_INVALID_STATE = (1 << 16),
|
||||||
ERR_ESP_INVALID_ARG = (1 << 17),
|
ERR_ESP_INVALID_ARG = (1 << 17),
|
||||||
|
@ -104,16 +105,6 @@ void I2SAudioSpeaker::setup() {
|
||||||
void I2SAudioSpeaker::loop() {
|
void I2SAudioSpeaker::loop() {
|
||||||
uint32_t event_group_bits = xEventGroupGetBits(this->event_group_);
|
uint32_t event_group_bits = xEventGroupGetBits(this->event_group_);
|
||||||
|
|
||||||
if (event_group_bits & SpeakerEventGroupBits::ERR_TASK_FAILED_TO_START) {
|
|
||||||
this->status_set_error("Failed to start speaker task");
|
|
||||||
}
|
|
||||||
|
|
||||||
if (event_group_bits & SpeakerEventGroupBits::ALL_ERR_ESP_BITS) {
|
|
||||||
uint32_t error_bits = event_group_bits & SpeakerEventGroupBits::ALL_ERR_ESP_BITS;
|
|
||||||
ESP_LOGW(TAG, "Error writing to I2S: %s", esp_err_to_name(err_bit_to_esp_err(error_bits)));
|
|
||||||
this->status_set_warning();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (event_group_bits & SpeakerEventGroupBits::STATE_STARTING) {
|
if (event_group_bits & SpeakerEventGroupBits::STATE_STARTING) {
|
||||||
ESP_LOGD(TAG, "Starting Speaker");
|
ESP_LOGD(TAG, "Starting Speaker");
|
||||||
this->state_ = speaker::STATE_STARTING;
|
this->state_ = speaker::STATE_STARTING;
|
||||||
|
@ -139,12 +130,64 @@ void I2SAudioSpeaker::loop() {
|
||||||
this->speaker_task_handle_ = nullptr;
|
this->speaker_task_handle_ = nullptr;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (event_group_bits & SpeakerEventGroupBits::ERR_TASK_FAILED_TO_START) {
|
||||||
|
this->status_set_error("Failed to start speaker task");
|
||||||
|
xEventGroupClearBits(this->event_group_, SpeakerEventGroupBits::ERR_TASK_FAILED_TO_START);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event_group_bits & SpeakerEventGroupBits::ERR_INVALID_FORMAT) {
|
||||||
|
this->status_set_error("Failed to adjust I2S bus to match the incoming audio");
|
||||||
|
ESP_LOGE(TAG,
|
||||||
|
"Incompatible audio format: sample rate = %" PRIu32 ", channels = %" PRIu8 ", bits per sample = %" PRIu8,
|
||||||
|
this->audio_stream_info_.sample_rate, this->audio_stream_info_.channels,
|
||||||
|
this->audio_stream_info_.bits_per_sample);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (event_group_bits & SpeakerEventGroupBits::ALL_ERR_ESP_BITS) {
|
||||||
|
uint32_t error_bits = event_group_bits & SpeakerEventGroupBits::ALL_ERR_ESP_BITS;
|
||||||
|
ESP_LOGW(TAG, "Error writing to I2S: %s", esp_err_to_name(err_bit_to_esp_err(error_bits)));
|
||||||
|
this->status_set_warning();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
void I2SAudioSpeaker::set_volume(float volume) {
|
void I2SAudioSpeaker::set_volume(float volume) {
|
||||||
this->volume_ = volume;
|
this->volume_ = volume;
|
||||||
|
#ifdef USE_AUDIO_DAC
|
||||||
|
if (this->audio_dac_ != nullptr) {
|
||||||
|
if (volume > 0.0) {
|
||||||
|
this->audio_dac_->set_mute_off();
|
||||||
|
}
|
||||||
|
this->audio_dac_->set_volume(volume);
|
||||||
|
} else
|
||||||
|
#endif
|
||||||
|
{
|
||||||
|
// Fallback to software volume control by using a Q15 fixed point scaling factor
|
||||||
ssize_t decibel_index = remap<ssize_t, float>(volume, 0.0f, 1.0f, 0, Q15_VOLUME_SCALING_FACTORS.size() - 1);
|
ssize_t decibel_index = remap<ssize_t, float>(volume, 0.0f, 1.0f, 0, Q15_VOLUME_SCALING_FACTORS.size() - 1);
|
||||||
this->q15_volume_factor_ = Q15_VOLUME_SCALING_FACTORS[decibel_index];
|
this->q15_volume_factor_ = Q15_VOLUME_SCALING_FACTORS[decibel_index];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void I2SAudioSpeaker::set_mute_state(bool mute_state) {
|
||||||
|
this->mute_state_ = mute_state;
|
||||||
|
#ifdef USE_AUDIO_DAC
|
||||||
|
if (this->audio_dac_) {
|
||||||
|
if (mute_state) {
|
||||||
|
this->audio_dac_->set_mute_on();
|
||||||
|
} else {
|
||||||
|
this->audio_dac_->set_mute_off();
|
||||||
|
}
|
||||||
|
} else
|
||||||
|
#endif
|
||||||
|
{
|
||||||
|
if (mute_state) {
|
||||||
|
// Fallback to software volume control and scale by 0
|
||||||
|
this->q15_volume_factor_ = 0;
|
||||||
|
} else {
|
||||||
|
// Revert to previous volume when unmuting
|
||||||
|
this->set_volume(this->volume_);
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
size_t I2SAudioSpeaker::play(const uint8_t *data, size_t length, TickType_t ticks_to_wait) {
|
size_t I2SAudioSpeaker::play(const uint8_t *data, size_t length, TickType_t ticks_to_wait) {
|
||||||
|
@ -275,6 +318,9 @@ void I2SAudioSpeaker::speaker_task(void *params) {
|
||||||
i2s_zero_dma_buffer(this_speaker->parent_->get_port());
|
i2s_zero_dma_buffer(this_speaker->parent_->get_port());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
} else {
|
||||||
|
// Couldn't configure the I2S port to be compatible with the incoming audio
|
||||||
|
xEventGroupSetBits(this_speaker->event_group_, SpeakerEventGroupBits::ERR_INVALID_FORMAT);
|
||||||
}
|
}
|
||||||
i2s_zero_dma_buffer(this_speaker->parent_->get_port());
|
i2s_zero_dma_buffer(this_speaker->parent_->get_port());
|
||||||
|
|
||||||
|
@ -288,7 +334,7 @@ void I2SAudioSpeaker::speaker_task(void *params) {
|
||||||
}
|
}
|
||||||
|
|
||||||
void I2SAudioSpeaker::start() {
|
void I2SAudioSpeaker::start() {
|
||||||
if (this->is_failed())
|
if (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;
|
||||||
|
|
|
@ -49,11 +49,17 @@ class I2SAudioSpeaker : public I2SAudioOut, public speaker::Speaker, public Comp
|
||||||
|
|
||||||
bool has_buffered_data() const override;
|
bool has_buffered_data() const override;
|
||||||
|
|
||||||
/// @brief Sets the volume of the speaker. It is implemented as a software volume control.
|
/// @brief Sets the volume of the speaker. Uses the speaker's configured audio dac component. If unavailble, it is
|
||||||
/// Overrides the default setter to convert the floating point volume to a Q15 fixed-point factor.
|
/// implemented as a software volume control. Overrides the default setter to convert the floating point volume to a
|
||||||
/// @param volume
|
/// Q15 fixed-point factor.
|
||||||
|
/// @param volume between 0.0 and 1.0
|
||||||
void set_volume(float volume) override;
|
void set_volume(float volume) override;
|
||||||
float get_volume() override { return this->volume_; }
|
|
||||||
|
/// @brief Mutes or unmute the speaker. Uses the speaker's configured audio dac component. If unavailble, it is
|
||||||
|
/// implemented as a software volume control. Overrides the default setter to convert the floating point volume to a
|
||||||
|
/// Q15 fixed-point factor.
|
||||||
|
/// @param mute_state true for muting, false for unmuting
|
||||||
|
void set_mute_state(bool mute_state) override;
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
/// @brief Function for the FreeRTOS task handling audio output.
|
/// @brief Function for the FreeRTOS task handling audio output.
|
||||||
|
|
|
@ -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()
|
||||||
|
|
|
@ -361,24 +361,21 @@ async def to_code(config):
|
||||||
elif config[CONF_TYPE] in ["RGB565"]:
|
elif config[CONF_TYPE] in ["RGB565"]:
|
||||||
image = image.convert("RGBA")
|
image = image.convert("RGBA")
|
||||||
pixels = list(image.getdata())
|
pixels = list(image.getdata())
|
||||||
data = [0 for _ in range(height * width * 2)]
|
bytes_per_pixel = 3 if transparent else 2
|
||||||
|
data = [0 for _ in range(height * width * bytes_per_pixel)]
|
||||||
pos = 0
|
pos = 0
|
||||||
for r, g, b, a in pixels:
|
for r, g, b, a in pixels:
|
||||||
R = r >> 3
|
R = r >> 3
|
||||||
G = g >> 2
|
G = g >> 2
|
||||||
B = b >> 3
|
B = b >> 3
|
||||||
rgb = (R << 11) | (G << 5) | B
|
rgb = (R << 11) | (G << 5) | B
|
||||||
|
|
||||||
if transparent:
|
|
||||||
if rgb == 0x0020:
|
|
||||||
rgb = 0
|
|
||||||
if a < 0x80:
|
|
||||||
rgb = 0x0020
|
|
||||||
|
|
||||||
data[pos] = rgb >> 8
|
data[pos] = rgb >> 8
|
||||||
pos += 1
|
pos += 1
|
||||||
data[pos] = rgb & 0xFF
|
data[pos] = rgb & 0xFF
|
||||||
pos += 1
|
pos += 1
|
||||||
|
if transparent:
|
||||||
|
data[pos] = a
|
||||||
|
pos += 1
|
||||||
|
|
||||||
elif config[CONF_TYPE] in ["BINARY", "TRANSPARENT_BINARY"]:
|
elif config[CONF_TYPE] in ["BINARY", "TRANSPARENT_BINARY"]:
|
||||||
if transparent:
|
if transparent:
|
||||||
|
|
|
@ -88,7 +88,7 @@ lv_img_dsc_t *Image::get_lv_img_dsc() {
|
||||||
this->dsc_.header.reserved = 0;
|
this->dsc_.header.reserved = 0;
|
||||||
this->dsc_.header.w = this->width_;
|
this->dsc_.header.w = this->width_;
|
||||||
this->dsc_.header.h = this->height_;
|
this->dsc_.header.h = this->height_;
|
||||||
this->dsc_.data_size = image_type_to_width_stride(this->dsc_.header.w * this->dsc_.header.h, this->get_type());
|
this->dsc_.data_size = this->get_width_stride() * this->get_height();
|
||||||
switch (this->get_type()) {
|
switch (this->get_type()) {
|
||||||
case IMAGE_TYPE_BINARY:
|
case IMAGE_TYPE_BINARY:
|
||||||
this->dsc_.header.cf = LV_IMG_CF_ALPHA_1BIT;
|
this->dsc_.header.cf = LV_IMG_CF_ALPHA_1BIT;
|
||||||
|
@ -104,17 +104,17 @@ lv_img_dsc_t *Image::get_lv_img_dsc() {
|
||||||
|
|
||||||
case IMAGE_TYPE_RGB565:
|
case IMAGE_TYPE_RGB565:
|
||||||
#if LV_COLOR_DEPTH == 16
|
#if LV_COLOR_DEPTH == 16
|
||||||
this->dsc_.header.cf = this->has_transparency() ? LV_IMG_CF_TRUE_COLOR_CHROMA_KEYED : LV_IMG_CF_TRUE_COLOR;
|
this->dsc_.header.cf = this->has_transparency() ? LV_IMG_CF_TRUE_COLOR_ALPHA : LV_IMG_CF_TRUE_COLOR;
|
||||||
#else
|
#else
|
||||||
this->dsc_.header.cf = LV_IMG_CF_RGB565;
|
this->dsc_.header.cf = LV_IMG_CF_RGB565;
|
||||||
#endif
|
#endif
|
||||||
break;
|
break;
|
||||||
|
|
||||||
case image::IMAGE_TYPE_RGBA:
|
case IMAGE_TYPE_RGBA:
|
||||||
#if LV_COLOR_DEPTH == 32
|
#if LV_COLOR_DEPTH == 32
|
||||||
this->dsc_.header.cf = LV_IMG_CF_TRUE_COLOR;
|
this->dsc_.header.cf = LV_IMG_CF_TRUE_COLOR;
|
||||||
#else
|
#else
|
||||||
this->dsc_.header.cf = LV_IMG_CF_RGBA8888;
|
this->dsc_.header.cf = LV_IMG_CF_TRUE_COLOR_ALPHA;
|
||||||
#endif
|
#endif
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
@ -147,21 +147,21 @@ Color Image::get_rgb24_pixel_(int x, int y) const {
|
||||||
return color;
|
return color;
|
||||||
}
|
}
|
||||||
Color Image::get_rgb565_pixel_(int x, int y) const {
|
Color Image::get_rgb565_pixel_(int x, int y) const {
|
||||||
const uint32_t pos = (x + y * this->width_) * 2;
|
const uint8_t *pos = this->data_start_;
|
||||||
uint16_t rgb565 =
|
if (this->transparent_) {
|
||||||
progmem_read_byte(this->data_start_ + pos + 0) << 8 | progmem_read_byte(this->data_start_ + pos + 1);
|
pos += (x + y * this->width_) * 3;
|
||||||
|
} else {
|
||||||
|
pos += (x + y * this->width_) * 2;
|
||||||
|
}
|
||||||
|
uint16_t rgb565 = encode_uint16(progmem_read_byte(pos), progmem_read_byte(pos + 1));
|
||||||
auto r = (rgb565 & 0xF800) >> 11;
|
auto r = (rgb565 & 0xF800) >> 11;
|
||||||
auto g = (rgb565 & 0x07E0) >> 5;
|
auto g = (rgb565 & 0x07E0) >> 5;
|
||||||
auto b = rgb565 & 0x001F;
|
auto b = rgb565 & 0x001F;
|
||||||
Color color = Color((r << 3) | (r >> 2), (g << 2) | (g >> 4), (b << 3) | (b >> 2));
|
auto a = this->transparent_ ? progmem_read_byte(pos + 2) : 0xFF;
|
||||||
if (rgb565 == 0x0020 && transparent_) {
|
Color color = Color((r << 3) | (r >> 2), (g << 2) | (g >> 4), (b << 3) | (b >> 2), a);
|
||||||
// darkest green has been defined as transparent color for transparent RGB565 images.
|
|
||||||
color.w = 0;
|
|
||||||
} else {
|
|
||||||
color.w = 0xFF;
|
|
||||||
}
|
|
||||||
return color;
|
return color;
|
||||||
}
|
}
|
||||||
|
|
||||||
Color Image::get_grayscale_pixel_(int x, int y) const {
|
Color Image::get_grayscale_pixel_(int x, int y) const {
|
||||||
const uint32_t pos = (x + y * this->width_);
|
const uint32_t pos = (x + y * this->width_);
|
||||||
const uint8_t gray = progmem_read_byte(this->data_start_ + pos);
|
const uint8_t gray = progmem_read_byte(this->data_start_ + pos);
|
||||||
|
|
|
@ -3,12 +3,7 @@
|
||||||
#include "esphome/components/display/display.h"
|
#include "esphome/components/display/display.h"
|
||||||
|
|
||||||
#ifdef USE_LVGL
|
#ifdef USE_LVGL
|
||||||
// required for clang-tidy
|
#include "esphome/components/lvgl/lvgl_proxy.h"
|
||||||
#ifndef LV_CONF_H
|
|
||||||
#define LV_CONF_SKIP 1 // NOLINT
|
|
||||||
#endif // LV_CONF_H
|
|
||||||
|
|
||||||
#include <lvgl.h>
|
|
||||||
#endif // USE_LVGL
|
#endif // USE_LVGL
|
||||||
|
|
||||||
namespace esphome {
|
namespace esphome {
|
||||||
|
@ -22,24 +17,6 @@ enum ImageType {
|
||||||
IMAGE_TYPE_RGBA = 4,
|
IMAGE_TYPE_RGBA = 4,
|
||||||
};
|
};
|
||||||
|
|
||||||
inline int image_type_to_bpp(ImageType type) {
|
|
||||||
switch (type) {
|
|
||||||
case IMAGE_TYPE_BINARY:
|
|
||||||
return 1;
|
|
||||||
case IMAGE_TYPE_GRAYSCALE:
|
|
||||||
return 8;
|
|
||||||
case IMAGE_TYPE_RGB565:
|
|
||||||
return 16;
|
|
||||||
case IMAGE_TYPE_RGB24:
|
|
||||||
return 24;
|
|
||||||
case IMAGE_TYPE_RGBA:
|
|
||||||
return 32;
|
|
||||||
}
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
inline int image_type_to_width_stride(int width, ImageType type) { return (width * image_type_to_bpp(type) + 7u) / 8u; }
|
|
||||||
|
|
||||||
class Image : public display::BaseImage {
|
class Image : public display::BaseImage {
|
||||||
public:
|
public:
|
||||||
Image(const uint8_t *data_start, int width, int height, ImageType type);
|
Image(const uint8_t *data_start, int width, int height, ImageType type);
|
||||||
|
@ -49,6 +26,25 @@ class Image : public display::BaseImage {
|
||||||
const uint8_t *get_data_start() const { return this->data_start_; }
|
const uint8_t *get_data_start() const { return this->data_start_; }
|
||||||
ImageType get_type() const;
|
ImageType get_type() const;
|
||||||
|
|
||||||
|
int get_bpp() const {
|
||||||
|
switch (this->type_) {
|
||||||
|
case IMAGE_TYPE_BINARY:
|
||||||
|
return 1;
|
||||||
|
case IMAGE_TYPE_GRAYSCALE:
|
||||||
|
return 8;
|
||||||
|
case IMAGE_TYPE_RGB565:
|
||||||
|
return this->transparent_ ? 24 : 16;
|
||||||
|
case IMAGE_TYPE_RGB24:
|
||||||
|
return 24;
|
||||||
|
case IMAGE_TYPE_RGBA:
|
||||||
|
return 32;
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Return the stride of the image in bytes, that is, the distance in bytes
|
||||||
|
/// between two consecutive rows of pixels.
|
||||||
|
uint32_t get_width_stride() const { return (this->width_ * this->get_bpp() + 7u) / 8u; }
|
||||||
void draw(int x, int y, display::Display *display, Color color_on, Color color_off) override;
|
void draw(int x, int y, display::Display *display, Color color_on, Color color_off) override;
|
||||||
|
|
||||||
void set_transparency(bool transparent) { transparent_ = transparent; }
|
void set_transparency(bool transparent) { transparent_ = transparent; }
|
||||||
|
|
|
@ -46,7 +46,7 @@ from .const import (
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
CODEOWNERS = ["@kuba2k2"]
|
CODEOWNERS = ["@kuba2k2"]
|
||||||
AUTO_LOAD = []
|
AUTO_LOAD = ["preferences"]
|
||||||
|
|
||||||
|
|
||||||
def _detect_variant(value):
|
def _detect_variant(value):
|
||||||
|
|
|
@ -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:
|
||||||
|
|
|
@ -33,7 +33,7 @@ from .schemas import (
|
||||||
FLEX_OBJ_SCHEMA,
|
FLEX_OBJ_SCHEMA,
|
||||||
GRID_CELL_SCHEMA,
|
GRID_CELL_SCHEMA,
|
||||||
LAYOUT_SCHEMAS,
|
LAYOUT_SCHEMAS,
|
||||||
STATE_SCHEMA,
|
STYLE_SCHEMA,
|
||||||
WIDGET_TYPES,
|
WIDGET_TYPES,
|
||||||
any_widget_schema,
|
any_widget_schema,
|
||||||
container_schema,
|
container_schema,
|
||||||
|
@ -71,6 +71,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 +110,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
|
||||||
|
|
||||||
|
@ -342,7 +344,7 @@ CONFIG_SCHEMA = (
|
||||||
),
|
),
|
||||||
cv.Optional(df.CONF_STYLE_DEFINITIONS): cv.ensure_list(
|
cv.Optional(df.CONF_STYLE_DEFINITIONS): cv.ensure_list(
|
||||||
cv.Schema({cv.Required(CONF_ID): cv.declare_id(lv_style_t)})
|
cv.Schema({cv.Required(CONF_ID): cv.declare_id(lv_style_t)})
|
||||||
.extend(STATE_SCHEMA)
|
.extend(STYLE_SCHEMA)
|
||||||
.extend(
|
.extend(
|
||||||
{
|
{
|
||||||
cv.Optional(df.CONF_GRID_CELL_X_ALIGN): grid_alignments,
|
cv.Optional(df.CONF_GRID_CELL_X_ALIGN): grid_alignments,
|
||||||
|
|
|
@ -2,9 +2,9 @@ import esphome.codegen as cg
|
||||||
from esphome.components import light
|
from esphome.components import light
|
||||||
from esphome.components.light import LightOutput
|
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_LED, CONF_OUTPUT_ID
|
from esphome.const import CONF_GAMMA_CORRECT, CONF_OUTPUT_ID
|
||||||
|
|
||||||
from ..defines import CONF_LVGL_ID
|
from ..defines import CONF_LVGL_ID, CONF_WIDGET
|
||||||
from ..lvcode import LvContext
|
from ..lvcode import LvContext
|
||||||
from ..schemas import LVGL_SCHEMA
|
from ..schemas import LVGL_SCHEMA
|
||||||
from ..types import LvType, lvgl_ns
|
from ..types import LvType, lvgl_ns
|
||||||
|
@ -15,7 +15,7 @@ LVLight = lvgl_ns.class_("LVLight", LightOutput)
|
||||||
CONFIG_SCHEMA = light.RGB_LIGHT_SCHEMA.extend(
|
CONFIG_SCHEMA = light.RGB_LIGHT_SCHEMA.extend(
|
||||||
{
|
{
|
||||||
cv.Optional(CONF_GAMMA_CORRECT, default=0.0): cv.positive_float,
|
cv.Optional(CONF_GAMMA_CORRECT, default=0.0): cv.positive_float,
|
||||||
cv.Required(CONF_LED): cv.use_id(lv_led_t),
|
cv.Required(CONF_WIDGET): cv.use_id(lv_led_t),
|
||||||
cv.GenerateID(CONF_OUTPUT_ID): cv.declare_id(LVLight),
|
cv.GenerateID(CONF_OUTPUT_ID): cv.declare_id(LVLight),
|
||||||
}
|
}
|
||||||
).extend(LVGL_SCHEMA)
|
).extend(LVGL_SCHEMA)
|
||||||
|
@ -26,7 +26,7 @@ async def to_code(config):
|
||||||
await light.register_light(var, config)
|
await light.register_light(var, config)
|
||||||
|
|
||||||
paren = await cg.get_variable(config[CONF_LVGL_ID])
|
paren = await cg.get_variable(config[CONF_LVGL_ID])
|
||||||
widget = await get_widgets(config, CONF_LED)
|
widget = await get_widgets(config, CONF_WIDGET)
|
||||||
widget = widget[0]
|
widget = widget[0]
|
||||||
await wait_for_widgets()
|
await wait_for_widgets()
|
||||||
async with LvContext(paren) as ctx:
|
async with LvContext(paren) as ctx:
|
||||||
|
|
|
@ -267,6 +267,9 @@ def angle(value):
|
||||||
return int(cv.float_range(0.0, 360.0)(cv.angle(value)) * 10)
|
return int(cv.float_range(0.0, 360.0)(cv.angle(value)) * 10)
|
||||||
|
|
||||||
|
|
||||||
|
lv_angle = LValidator(angle, uint32)
|
||||||
|
|
||||||
|
|
||||||
@schema_extractor("one_of")
|
@schema_extractor("one_of")
|
||||||
def size_validator(value):
|
def size_validator(value):
|
||||||
"""A size in one axis - one of "size_content", a number (pixels) or a percentage"""
|
"""A size in one axis - one of "size_content", a number (pixels) or a percentage"""
|
||||||
|
@ -274,10 +277,8 @@ def size_validator(value):
|
||||||
return ["SIZE_CONTENT", "number of pixels", "percentage"]
|
return ["SIZE_CONTENT", "number of pixels", "percentage"]
|
||||||
if isinstance(value, str) and value.lower().endswith("px"):
|
if isinstance(value, str) and value.lower().endswith("px"):
|
||||||
value = cv.int_(value[:-2])
|
value = cv.int_(value[:-2])
|
||||||
if isinstance(value, str) and not value.endswith("%"):
|
if isinstance(value, str) and value.upper() == "SIZE_CONTENT":
|
||||||
if value.upper() == "SIZE_CONTENT":
|
|
||||||
return "LV_SIZE_CONTENT"
|
return "LV_SIZE_CONTENT"
|
||||||
raise cv.Invalid("must be 'size_content', a percentage or an integer (pixels)")
|
|
||||||
return pixels_or_percent_validator(value)
|
return pixels_or_percent_validator(value)
|
||||||
|
|
||||||
|
|
||||||
|
@ -403,6 +404,7 @@ class TextValidator(LValidator):
|
||||||
lv_text = TextValidator()
|
lv_text = TextValidator()
|
||||||
lv_float = LValidator(cv.float_, cg.float_)
|
lv_float = LValidator(cv.float_, cg.float_)
|
||||||
lv_int = LValidator(cv.int_, cg.int_)
|
lv_int = LValidator(cv.int_, cg.int_)
|
||||||
|
lv_positive_int = LValidator(cv.positive_int, cg.int_)
|
||||||
lv_brightness = LValidator(cv.percentage, cg.float_, retmapper=lambda x: int(x * 255))
|
lv_brightness = LValidator(cv.percentage, cg.float_, retmapper=lambda x: int(x * 255))
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -84,6 +84,7 @@ lv_event_code_t lv_api_event; // NOLINT
|
||||||
lv_event_code_t lv_update_event; // NOLINT
|
lv_event_code_t lv_update_event; // NOLINT
|
||||||
void LvglComponent::dump_config() {
|
void LvglComponent::dump_config() {
|
||||||
ESP_LOGCONFIG(TAG, "LVGL:");
|
ESP_LOGCONFIG(TAG, "LVGL:");
|
||||||
|
ESP_LOGCONFIG(TAG, " Display width/height: %d x %d", this->disp_drv_.hor_res, this->disp_drv_.ver_res);
|
||||||
ESP_LOGCONFIG(TAG, " Rotation: %d", this->rotation);
|
ESP_LOGCONFIG(TAG, " Rotation: %d", this->rotation);
|
||||||
ESP_LOGCONFIG(TAG, " Draw rounding: %d", (int) this->draw_rounding);
|
ESP_LOGCONFIG(TAG, " Draw rounding: %d", (int) this->draw_rounding);
|
||||||
}
|
}
|
||||||
|
@ -145,7 +146,7 @@ void LvglComponent::draw_buffer_(const lv_area_t *area, lv_color_t *ptr) {
|
||||||
lv_color_t *dst = this->rotate_buf_;
|
lv_color_t *dst = this->rotate_buf_;
|
||||||
switch (this->rotation) {
|
switch (this->rotation) {
|
||||||
case display::DISPLAY_ROTATION_90_DEGREES:
|
case display::DISPLAY_ROTATION_90_DEGREES:
|
||||||
for (lv_coord_t x = height - 1; x-- != 0;) {
|
for (lv_coord_t x = height; x-- != 0;) {
|
||||||
for (lv_coord_t y = 0; y != width; y++) {
|
for (lv_coord_t y = 0; y != width; y++) {
|
||||||
dst[y * height + x] = *ptr++;
|
dst[y * height + x] = *ptr++;
|
||||||
}
|
}
|
||||||
|
@ -426,19 +427,8 @@ LvglComponent::LvglComponent(std::vector<display::Display *> displays, float buf
|
||||||
this->disp_drv_.full_refresh = this->full_refresh_;
|
this->disp_drv_.full_refresh = this->full_refresh_;
|
||||||
this->disp_drv_.flush_cb = static_flush_cb;
|
this->disp_drv_.flush_cb = static_flush_cb;
|
||||||
this->disp_drv_.rounder_cb = rounder_cb;
|
this->disp_drv_.rounder_cb = rounder_cb;
|
||||||
// reset the display rotation since we will handle all rotations
|
|
||||||
display->set_rotation(display::DISPLAY_ROTATION_0_DEGREES);
|
|
||||||
switch (this->rotation) {
|
|
||||||
default:
|
|
||||||
this->disp_drv_.hor_res = (lv_coord_t) display->get_width();
|
this->disp_drv_.hor_res = (lv_coord_t) display->get_width();
|
||||||
this->disp_drv_.ver_res = (lv_coord_t) display->get_height();
|
this->disp_drv_.ver_res = (lv_coord_t) display->get_height();
|
||||||
break;
|
|
||||||
case display::DISPLAY_ROTATION_90_DEGREES:
|
|
||||||
case display::DISPLAY_ROTATION_270_DEGREES:
|
|
||||||
this->disp_drv_.ver_res = (lv_coord_t) display->get_width();
|
|
||||||
this->disp_drv_.hor_res = (lv_coord_t) display->get_height();
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
this->disp_ = lv_disp_drv_register(&this->disp_drv_);
|
this->disp_ = lv_disp_drv_register(&this->disp_drv_);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -459,6 +449,9 @@ void LvglComponent::setup() {
|
||||||
esp_log_printf_(LVGL_LOG_LEVEL, TAG, 0, "%.*s", (int) strlen(buf) - 1, buf);
|
esp_log_printf_(LVGL_LOG_LEVEL, TAG, 0, "%.*s", (int) strlen(buf) - 1, buf);
|
||||||
});
|
});
|
||||||
#endif
|
#endif
|
||||||
|
// Rotation will be handled by our drawing function, so reset the display rotation.
|
||||||
|
for (auto *display : this->displays_)
|
||||||
|
display->set_rotation(display::DISPLAY_ROTATION_0_DEGREES);
|
||||||
this->show_page(0, LV_SCR_LOAD_ANIM_NONE, 0);
|
this->show_page(0, LV_SCR_LOAD_ANIM_NONE, 0);
|
||||||
lv_disp_trig_activity(this->disp_);
|
lv_disp_trig_activity(this->disp_);
|
||||||
ESP_LOGCONFIG(TAG, "LVGL Setup complete");
|
ESP_LOGCONFIG(TAG, "LVGL Setup complete");
|
||||||
|
|
17
esphome/components/lvgl/lvgl_proxy.h
Normal file
17
esphome/components/lvgl/lvgl_proxy.h
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
#pragma once
|
||||||
|
/**
|
||||||
|
* This header is for use in components that might or might not use LVGL. There is a platformio bug where
|
||||||
|
the mere mention of a header file, even if ifdefed, causes the build to fail. This is a workaround, since if this
|
||||||
|
file is included in the build, LVGL is always included.
|
||||||
|
*/
|
||||||
|
#ifdef USE_LVGL
|
||||||
|
// required for clang-tidy
|
||||||
|
#ifndef LV_CONF_H
|
||||||
|
#define LV_CONF_SKIP 1 // NOLINT
|
||||||
|
#endif // LV_CONF_H
|
||||||
|
|
||||||
|
#include <lvgl.h>
|
||||||
|
namespace esphome {
|
||||||
|
namespace lvgl {} // namespace lvgl
|
||||||
|
} // namespace esphome
|
||||||
|
#endif // USE_LVGL
|
|
@ -91,7 +91,7 @@ STYLE_PROPS = {
|
||||||
"arc_opa": lvalid.opacity,
|
"arc_opa": lvalid.opacity,
|
||||||
"arc_color": lvalid.lv_color,
|
"arc_color": lvalid.lv_color,
|
||||||
"arc_rounded": lvalid.lv_bool,
|
"arc_rounded": lvalid.lv_bool,
|
||||||
"arc_width": cv.positive_int,
|
"arc_width": lvalid.lv_positive_int,
|
||||||
"anim_time": lvalid.lv_milliseconds,
|
"anim_time": lvalid.lv_milliseconds,
|
||||||
"bg_color": lvalid.lv_color,
|
"bg_color": lvalid.lv_color,
|
||||||
"bg_grad": lv_gradient,
|
"bg_grad": lv_gradient,
|
||||||
|
@ -111,7 +111,7 @@ STYLE_PROPS = {
|
||||||
"border_side": df.LvConstant(
|
"border_side": df.LvConstant(
|
||||||
"LV_BORDER_SIDE_", "NONE", "TOP", "BOTTOM", "LEFT", "RIGHT", "INTERNAL"
|
"LV_BORDER_SIDE_", "NONE", "TOP", "BOTTOM", "LEFT", "RIGHT", "INTERNAL"
|
||||||
).several_of,
|
).several_of,
|
||||||
"border_width": cv.positive_int,
|
"border_width": lvalid.lv_positive_int,
|
||||||
"clip_corner": lvalid.lv_bool,
|
"clip_corner": lvalid.lv_bool,
|
||||||
"color_filter_opa": lvalid.opacity,
|
"color_filter_opa": lvalid.opacity,
|
||||||
"height": lvalid.size,
|
"height": lvalid.size,
|
||||||
|
@ -134,11 +134,11 @@ STYLE_PROPS = {
|
||||||
"pad_right": lvalid.pixels,
|
"pad_right": lvalid.pixels,
|
||||||
"pad_top": lvalid.pixels,
|
"pad_top": lvalid.pixels,
|
||||||
"shadow_color": lvalid.lv_color,
|
"shadow_color": lvalid.lv_color,
|
||||||
"shadow_ofs_x": cv.int_,
|
"shadow_ofs_x": lvalid.lv_int,
|
||||||
"shadow_ofs_y": cv.int_,
|
"shadow_ofs_y": lvalid.lv_int,
|
||||||
"shadow_opa": lvalid.opacity,
|
"shadow_opa": lvalid.opacity,
|
||||||
"shadow_spread": cv.int_,
|
"shadow_spread": lvalid.lv_int,
|
||||||
"shadow_width": cv.positive_int,
|
"shadow_width": lvalid.lv_positive_int,
|
||||||
"text_align": df.LvConstant(
|
"text_align": df.LvConstant(
|
||||||
"LV_TEXT_ALIGN_", "LEFT", "CENTER", "RIGHT", "AUTO"
|
"LV_TEXT_ALIGN_", "LEFT", "CENTER", "RIGHT", "AUTO"
|
||||||
).one_of,
|
).one_of,
|
||||||
|
@ -150,7 +150,7 @@ STYLE_PROPS = {
|
||||||
"text_letter_space": cv.positive_int,
|
"text_letter_space": cv.positive_int,
|
||||||
"text_line_space": cv.positive_int,
|
"text_line_space": cv.positive_int,
|
||||||
"text_opa": lvalid.opacity,
|
"text_opa": lvalid.opacity,
|
||||||
"transform_angle": lvalid.angle,
|
"transform_angle": lvalid.lv_angle,
|
||||||
"transform_height": lvalid.pixels_or_percent,
|
"transform_height": lvalid.pixels_or_percent,
|
||||||
"transform_pivot_x": lvalid.pixels_or_percent,
|
"transform_pivot_x": lvalid.pixels_or_percent,
|
||||||
"transform_pivot_y": lvalid.pixels_or_percent,
|
"transform_pivot_y": lvalid.pixels_or_percent,
|
||||||
|
@ -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
|
||||||
|
|
|
@ -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)
|
||||||
|
|
|
@ -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]
|
||||||
|
|
54
esphome/components/lvgl/widgets/qrcode.py
Normal file
54
esphome/components/lvgl/widgets/qrcode.py
Normal 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()
|
|
@ -21,6 +21,7 @@ media_player_ns = cg.esphome_ns.namespace("media_player")
|
||||||
|
|
||||||
MediaPlayer = media_player_ns.class_("MediaPlayer")
|
MediaPlayer = media_player_ns.class_("MediaPlayer")
|
||||||
|
|
||||||
|
|
||||||
PlayAction = media_player_ns.class_(
|
PlayAction = media_player_ns.class_(
|
||||||
"PlayAction", automation.Action, cg.Parented.template(MediaPlayer)
|
"PlayAction", automation.Action, cg.Parented.template(MediaPlayer)
|
||||||
)
|
)
|
||||||
|
@ -60,7 +61,11 @@ AnnoucementTrigger = media_player_ns.class_(
|
||||||
"AnnouncementTrigger", automation.Trigger.template()
|
"AnnouncementTrigger", automation.Trigger.template()
|
||||||
)
|
)
|
||||||
IsIdleCondition = media_player_ns.class_("IsIdleCondition", automation.Condition)
|
IsIdleCondition = media_player_ns.class_("IsIdleCondition", automation.Condition)
|
||||||
|
IsPausedCondition = media_player_ns.class_("IsPausedCondition", automation.Condition)
|
||||||
IsPlayingCondition = media_player_ns.class_("IsPlayingCondition", automation.Condition)
|
IsPlayingCondition = media_player_ns.class_("IsPlayingCondition", automation.Condition)
|
||||||
|
IsAnnouncingCondition = media_player_ns.class_(
|
||||||
|
"IsAnnouncingCondition", automation.Condition
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
async def setup_media_player_core_(var, config):
|
async def setup_media_player_core_(var, config):
|
||||||
|
@ -159,9 +164,15 @@ async def media_player_play_media_action(config, action_id, template_arg, args):
|
||||||
@automation.register_condition(
|
@automation.register_condition(
|
||||||
"media_player.is_idle", IsIdleCondition, MEDIA_PLAYER_ACTION_SCHEMA
|
"media_player.is_idle", IsIdleCondition, MEDIA_PLAYER_ACTION_SCHEMA
|
||||||
)
|
)
|
||||||
|
@automation.register_condition(
|
||||||
|
"media_player.is_paused", IsPausedCondition, MEDIA_PLAYER_ACTION_SCHEMA
|
||||||
|
)
|
||||||
@automation.register_condition(
|
@automation.register_condition(
|
||||||
"media_player.is_playing", IsPlayingCondition, MEDIA_PLAYER_ACTION_SCHEMA
|
"media_player.is_playing", IsPlayingCondition, MEDIA_PLAYER_ACTION_SCHEMA
|
||||||
)
|
)
|
||||||
|
@automation.register_condition(
|
||||||
|
"media_player.is_announcing", IsAnnouncingCondition, MEDIA_PLAYER_ACTION_SCHEMA
|
||||||
|
)
|
||||||
async def media_player_action(config, action_id, template_arg, args):
|
async def media_player_action(config, action_id, template_arg, args):
|
||||||
var = cg.new_Pvariable(action_id, template_arg)
|
var = cg.new_Pvariable(action_id, template_arg)
|
||||||
await cg.register_parented(var, config[CONF_ID])
|
await cg.register_parented(var, config[CONF_ID])
|
||||||
|
|
|
@ -68,5 +68,15 @@ template<typename... Ts> class IsPlayingCondition : public Condition<Ts...>, pub
|
||||||
bool check(Ts... x) override { return this->parent_->state == MediaPlayerState::MEDIA_PLAYER_STATE_PLAYING; }
|
bool check(Ts... x) override { return this->parent_->state == MediaPlayerState::MEDIA_PLAYER_STATE_PLAYING; }
|
||||||
};
|
};
|
||||||
|
|
||||||
|
template<typename... Ts> class IsPausedCondition : public Condition<Ts...>, public Parented<MediaPlayer> {
|
||||||
|
public:
|
||||||
|
bool check(Ts... x) override { return this->parent_->state == MediaPlayerState::MEDIA_PLAYER_STATE_PAUSED; }
|
||||||
|
};
|
||||||
|
|
||||||
|
template<typename... Ts> class IsAnnouncingCondition : public Condition<Ts...>, public Parented<MediaPlayer> {
|
||||||
|
public:
|
||||||
|
bool check(Ts... x) override { return this->parent_->state == MediaPlayerState::MEDIA_PLAYER_STATE_ANNOUNCING; }
|
||||||
|
};
|
||||||
|
|
||||||
} // namespace media_player
|
} // namespace media_player
|
||||||
} // namespace esphome
|
} // namespace esphome
|
||||||
|
|
|
@ -37,6 +37,10 @@ const char *media_player_command_to_string(MediaPlayerCommand command) {
|
||||||
return "UNMUTE";
|
return "UNMUTE";
|
||||||
case MEDIA_PLAYER_COMMAND_TOGGLE:
|
case MEDIA_PLAYER_COMMAND_TOGGLE:
|
||||||
return "TOGGLE";
|
return "TOGGLE";
|
||||||
|
case MEDIA_PLAYER_COMMAND_VOLUME_UP:
|
||||||
|
return "VOLUME_UP";
|
||||||
|
case MEDIA_PLAYER_COMMAND_VOLUME_DOWN:
|
||||||
|
return "VOLUME_DOWN";
|
||||||
default:
|
default:
|
||||||
return "UNKNOWN";
|
return "UNKNOWN";
|
||||||
}
|
}
|
||||||
|
|
|
@ -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() {
|
||||||
|
|
|
@ -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);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -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);
|
||||||
|
|
|
@ -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))
|
||||||
|
|
|
@ -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,
|
||||||
|
@ -41,6 +42,7 @@ from esphome.const import (
|
||||||
CONF_SHUTDOWN_MESSAGE,
|
CONF_SHUTDOWN_MESSAGE,
|
||||||
CONF_SSL_FINGERPRINTS,
|
CONF_SSL_FINGERPRINTS,
|
||||||
CONF_STATE_TOPIC,
|
CONF_STATE_TOPIC,
|
||||||
|
CONF_SUBSCRIBE_QOS,
|
||||||
CONF_TOPIC,
|
CONF_TOPIC,
|
||||||
CONF_TOPIC_PREFIX,
|
CONF_TOPIC_PREFIX,
|
||||||
CONF_TRIGGER_ID,
|
CONF_TRIGGER_ID,
|
||||||
|
@ -98,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
|
||||||
)
|
)
|
||||||
|
@ -207,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,
|
||||||
|
@ -324,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]))
|
||||||
|
@ -518,6 +524,8 @@ async def register_mqtt_component(var, config):
|
||||||
cg.add(var.set_qos(config[CONF_QOS]))
|
cg.add(var.set_qos(config[CONF_QOS]))
|
||||||
if CONF_RETAIN in config:
|
if CONF_RETAIN in config:
|
||||||
cg.add(var.set_retain(config[CONF_RETAIN]))
|
cg.add(var.set_retain(config[CONF_RETAIN]))
|
||||||
|
if CONF_SUBSCRIBE_QOS in config:
|
||||||
|
cg.add(var.set_subscribe_qos(config[CONF_SUBSCRIBE_QOS]))
|
||||||
if not config.get(CONF_DISCOVERY, True):
|
if not config.get(CONF_DISCOVERY, True):
|
||||||
cg.add(var.disable_discovery())
|
cg.add(var.disable_discovery())
|
||||||
if CONF_STATE_TOPIC in config:
|
if CONF_STATE_TOPIC in config:
|
||||||
|
@ -552,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)
|
||||||
|
|
|
@ -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.
|
||||||
|
|
|
@ -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
|
||||||
|
|
||||||
|
|
|
@ -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";
|
||||||
|
|
||||||
|
|
|
@ -16,6 +16,8 @@ static const char *const TAG = "mqtt.component";
|
||||||
|
|
||||||
void MQTTComponent::set_qos(uint8_t qos) { this->qos_ = qos; }
|
void MQTTComponent::set_qos(uint8_t qos) { this->qos_ = qos; }
|
||||||
|
|
||||||
|
void MQTTComponent::set_subscribe_qos(uint8_t qos) { this->subscribe_qos_ = qos; }
|
||||||
|
|
||||||
void MQTTComponent::set_retain(bool retain) { this->retain_ = retain; }
|
void MQTTComponent::set_retain(bool retain) { this->retain_ = retain; }
|
||||||
|
|
||||||
std::string MQTTComponent::get_discovery_topic_(const MQTTDiscoveryInfo &discovery_info) const {
|
std::string MQTTComponent::get_discovery_topic_(const MQTTDiscoveryInfo &discovery_info) const {
|
||||||
|
@ -76,6 +78,10 @@ bool MQTTComponent::send_discovery_() {
|
||||||
config.command_topic = true;
|
config.command_topic = true;
|
||||||
|
|
||||||
this->send_discovery(root, config);
|
this->send_discovery(root, config);
|
||||||
|
// Set subscription QoS (default is 0)
|
||||||
|
if (this->subscribe_qos_ != 0) {
|
||||||
|
root[MQTT_QOS] = this->subscribe_qos_;
|
||||||
|
}
|
||||||
|
|
||||||
// Fields from EntityBase
|
// Fields from EntityBase
|
||||||
if (this->get_entity()->has_own_name()) {
|
if (this->get_entity()->has_own_name()) {
|
||||||
|
|
|
@ -89,6 +89,9 @@ class MQTTComponent : public Component {
|
||||||
void disable_discovery();
|
void disable_discovery();
|
||||||
bool is_discovery_enabled() const;
|
bool is_discovery_enabled() const;
|
||||||
|
|
||||||
|
/// Set the QOS for subscribe messages (used in discovery).
|
||||||
|
void set_subscribe_qos(uint8_t qos);
|
||||||
|
|
||||||
/// Override this method to return the component type (e.g. "light", "sensor", ...)
|
/// Override this method to return the component type (e.g. "light", "sensor", ...)
|
||||||
virtual std::string component_type() const = 0;
|
virtual std::string component_type() const = 0;
|
||||||
|
|
||||||
|
@ -204,6 +207,7 @@ class MQTTComponent : public Component {
|
||||||
bool command_retain_{false};
|
bool command_retain_{false};
|
||||||
bool retain_{true};
|
bool retain_{true};
|
||||||
uint8_t qos_{0};
|
uint8_t qos_{0};
|
||||||
|
uint8_t subscribe_qos_{0};
|
||||||
bool discovery_enabled_{true};
|
bool discovery_enabled_{true};
|
||||||
bool resend_state_{false};
|
bool resend_state_{false};
|
||||||
};
|
};
|
||||||
|
|
|
@ -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";
|
||||||
|
@ -180,6 +181,7 @@ constexpr const char *const MQTT_PRESET_MODE_COMMAND_TOPIC = "pr_mode_cmd_t";
|
||||||
constexpr const char *const MQTT_PRESET_MODE_STATE_TOPIC = "pr_mode_stat_t";
|
constexpr const char *const MQTT_PRESET_MODE_STATE_TOPIC = "pr_mode_stat_t";
|
||||||
constexpr const char *const MQTT_PRESET_MODE_VALUE_TEMPLATE = "pr_mode_val_tpl";
|
constexpr const char *const MQTT_PRESET_MODE_VALUE_TEMPLATE = "pr_mode_val_tpl";
|
||||||
constexpr const char *const MQTT_PRESET_MODES = "pr_modes";
|
constexpr const char *const MQTT_PRESET_MODES = "pr_modes";
|
||||||
|
constexpr const char *const MQTT_QOS = "qos";
|
||||||
constexpr const char *const MQTT_RED_TEMPLATE = "r_tpl";
|
constexpr const char *const MQTT_RED_TEMPLATE = "r_tpl";
|
||||||
constexpr const char *const MQTT_RETAIN = "ret";
|
constexpr const char *const MQTT_RETAIN = "ret";
|
||||||
constexpr const char *const MQTT_RGB_COMMAND_TEMPLATE = "rgb_cmd_tpl";
|
constexpr const char *const MQTT_RGB_COMMAND_TEMPLATE = "rgb_cmd_tpl";
|
||||||
|
@ -231,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";
|
||||||
|
@ -312,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";
|
||||||
|
@ -441,6 +445,7 @@ constexpr const char *const MQTT_PRESET_MODE_COMMAND_TOPIC = "preset_mode_comman
|
||||||
constexpr const char *const MQTT_PRESET_MODE_STATE_TOPIC = "preset_mode_state_topic";
|
constexpr const char *const MQTT_PRESET_MODE_STATE_TOPIC = "preset_mode_state_topic";
|
||||||
constexpr const char *const MQTT_PRESET_MODE_VALUE_TEMPLATE = "preset_mode_value_template";
|
constexpr const char *const MQTT_PRESET_MODE_VALUE_TEMPLATE = "preset_mode_value_template";
|
||||||
constexpr const char *const MQTT_PRESET_MODES = "preset_modes";
|
constexpr const char *const MQTT_PRESET_MODES = "preset_modes";
|
||||||
|
constexpr const char *const MQTT_QOS = "qos";
|
||||||
constexpr const char *const MQTT_RED_TEMPLATE = "red_template";
|
constexpr const char *const MQTT_RED_TEMPLATE = "red_template";
|
||||||
constexpr const char *const MQTT_RETAIN = "retain";
|
constexpr const char *const MQTT_RETAIN = "retain";
|
||||||
constexpr const char *const MQTT_RGB_COMMAND_TEMPLATE = "rgb_command_template";
|
constexpr const char *const MQTT_RGB_COMMAND_TEMPLATE = "rgb_command_template";
|
||||||
|
@ -492,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";
|
||||||
|
|
|
@ -215,16 +215,10 @@ void OnlineImage::draw_pixel_(int x, int y, Color color) {
|
||||||
}
|
}
|
||||||
case ImageType::IMAGE_TYPE_RGB565: {
|
case ImageType::IMAGE_TYPE_RGB565: {
|
||||||
uint16_t col565 = display::ColorUtil::color_to_565(color);
|
uint16_t col565 = display::ColorUtil::color_to_565(color);
|
||||||
if (this->has_transparency()) {
|
|
||||||
if (col565 == 0x0020) {
|
|
||||||
col565 = 0;
|
|
||||||
}
|
|
||||||
if (color.w < 0x80) {
|
|
||||||
col565 = 0x0020;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
this->buffer_[pos + 0] = static_cast<uint8_t>((col565 >> 8) & 0xFF);
|
this->buffer_[pos + 0] = static_cast<uint8_t>((col565 >> 8) & 0xFF);
|
||||||
this->buffer_[pos + 1] = static_cast<uint8_t>(col565 & 0xFF);
|
this->buffer_[pos + 1] = static_cast<uint8_t>(col565 & 0xFF);
|
||||||
|
if (this->has_transparency())
|
||||||
|
this->buffer_[pos + 2] = color.w;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case ImageType::IMAGE_TYPE_RGBA: {
|
case ImageType::IMAGE_TYPE_RGBA: {
|
||||||
|
|
|
@ -86,13 +86,9 @@ class OnlineImage : public PollingComponent,
|
||||||
Allocator allocator_{Allocator::Flags::ALLOW_FAILURE};
|
Allocator allocator_{Allocator::Flags::ALLOW_FAILURE};
|
||||||
|
|
||||||
uint32_t get_buffer_size_() const { return get_buffer_size_(this->buffer_width_, this->buffer_height_); }
|
uint32_t get_buffer_size_() const { return get_buffer_size_(this->buffer_width_, this->buffer_height_); }
|
||||||
int get_buffer_size_(int width, int height) const {
|
int get_buffer_size_(int width, int height) const { return (this->get_bpp() * width + 7u) / 8u * height; }
|
||||||
return std::ceil(image::image_type_to_bpp(this->type_) * width * height / 8.0);
|
|
||||||
}
|
|
||||||
|
|
||||||
int get_position_(int x, int y) const {
|
int get_position_(int x, int y) const { return (x + y * this->buffer_width_) * this->get_bpp() / 8; }
|
||||||
return ((x + y * this->buffer_width_) * image::image_type_to_bpp(this->type_)) / 8;
|
|
||||||
}
|
|
||||||
|
|
||||||
ESPHOME_ALWAYS_INLINE bool auto_resize_() const { return this->fixed_width_ == 0 || this->fixed_height_ == 0; }
|
ESPHOME_ALWAYS_INLINE bool auto_resize_() const { return this->fixed_width_ == 0 || this->fixed_height_ == 0; }
|
||||||
|
|
||||||
|
|
|
@ -1,9 +1,10 @@
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
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 CONF_ID, PLATFORM_ESP32, PLATFORM_ESP8266
|
from esphome.const import CONF_ID, PLATFORM_ESP32, PLATFORM_ESP8266
|
||||||
|
from . import generate
|
||||||
|
|
||||||
CODEOWNERS = ["@olegtarasov"]
|
CODEOWNERS = ["@olegtarasov"]
|
||||||
MULTI_CONF = True
|
MULTI_CONF = True
|
||||||
|
@ -15,15 +16,14 @@ CONF_DHW_ENABLE = "dhw_enable"
|
||||||
CONF_COOLING_ENABLE = "cooling_enable"
|
CONF_COOLING_ENABLE = "cooling_enable"
|
||||||
CONF_OTC_ACTIVE = "otc_active"
|
CONF_OTC_ACTIVE = "otc_active"
|
||||||
CONF_CH2_ACTIVE = "ch2_active"
|
CONF_CH2_ACTIVE = "ch2_active"
|
||||||
|
CONF_SUMMER_MODE_ACTIVE = "summer_mode_active"
|
||||||
|
CONF_DHW_BLOCK = "dhw_block"
|
||||||
CONF_SYNC_MODE = "sync_mode"
|
CONF_SYNC_MODE = "sync_mode"
|
||||||
|
|
||||||
opentherm_ns = cg.esphome_ns.namespace("opentherm")
|
|
||||||
OpenthermHub = opentherm_ns.class_("OpenthermHub", cg.Component)
|
|
||||||
|
|
||||||
CONFIG_SCHEMA = cv.All(
|
CONFIG_SCHEMA = cv.All(
|
||||||
cv.Schema(
|
cv.Schema(
|
||||||
{
|
{
|
||||||
cv.GenerateID(): cv.declare_id(OpenthermHub),
|
cv.GenerateID(): cv.declare_id(generate.OpenthermHub),
|
||||||
cv.Required(CONF_IN_PIN): pins.internal_gpio_input_pin_schema,
|
cv.Required(CONF_IN_PIN): pins.internal_gpio_input_pin_schema,
|
||||||
cv.Required(CONF_OUT_PIN): pins.internal_gpio_output_pin_schema,
|
cv.Required(CONF_OUT_PIN): pins.internal_gpio_output_pin_schema,
|
||||||
cv.Optional(CONF_CH_ENABLE, True): cv.boolean,
|
cv.Optional(CONF_CH_ENABLE, True): cv.boolean,
|
||||||
|
@ -31,6 +31,8 @@ CONFIG_SCHEMA = cv.All(
|
||||||
cv.Optional(CONF_COOLING_ENABLE, False): cv.boolean,
|
cv.Optional(CONF_COOLING_ENABLE, False): cv.boolean,
|
||||||
cv.Optional(CONF_OTC_ACTIVE, False): cv.boolean,
|
cv.Optional(CONF_OTC_ACTIVE, False): cv.boolean,
|
||||||
cv.Optional(CONF_CH2_ACTIVE, False): cv.boolean,
|
cv.Optional(CONF_CH2_ACTIVE, False): cv.boolean,
|
||||||
|
cv.Optional(CONF_SUMMER_MODE_ACTIVE, 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,
|
||||||
}
|
}
|
||||||
).extend(cv.COMPONENT_SCHEMA),
|
).extend(cv.COMPONENT_SCHEMA),
|
||||||
|
@ -39,8 +41,6 @@ CONFIG_SCHEMA = cv.All(
|
||||||
|
|
||||||
|
|
||||||
async def to_code(config: dict[str, Any]) -> None:
|
async def to_code(config: dict[str, Any]) -> None:
|
||||||
# Create the hub, passing the two callbacks defined below
|
|
||||||
# Since the hub is used in the callbacks, we need to define it first
|
|
||||||
var = cg.new_Pvariable(config[CONF_ID])
|
var = cg.new_Pvariable(config[CONF_ID])
|
||||||
await cg.register_component(var, config)
|
await cg.register_component(var, config)
|
||||||
|
|
||||||
|
@ -53,5 +53,7 @@ async def to_code(config: dict[str, Any]) -> None:
|
||||||
|
|
||||||
non_sensors = {CONF_ID, CONF_IN_PIN, CONF_OUT_PIN}
|
non_sensors = {CONF_ID, CONF_IN_PIN, CONF_OUT_PIN}
|
||||||
for key, value in config.items():
|
for key, value in config.items():
|
||||||
if key not in non_sensors:
|
if key in non_sensors:
|
||||||
|
continue
|
||||||
|
|
||||||
cg.add(getattr(var, f"set_{key}")(value))
|
cg.add(getattr(var, f"set_{key}")(value))
|
||||||
|
|
5
esphome/components/opentherm/const.py
Normal file
5
esphome/components/opentherm/const.py
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
OPENTHERM = "opentherm"
|
||||||
|
|
||||||
|
CONF_OPENTHERM_ID = "opentherm_id"
|
||||||
|
|
||||||
|
SENSOR = "sensor"
|
140
esphome/components/opentherm/generate.py
Normal file
140
esphome/components/opentherm/generate.py
Normal file
|
@ -0,0 +1,140 @@
|
||||||
|
from collections.abc import Awaitable
|
||||||
|
from typing import Any, Callable
|
||||||
|
|
||||||
|
import esphome.codegen as cg
|
||||||
|
from esphome.const import CONF_ID
|
||||||
|
from . import const
|
||||||
|
from .schema import TSchema
|
||||||
|
|
||||||
|
opentherm_ns = cg.esphome_ns.namespace("opentherm")
|
||||||
|
OpenthermHub = opentherm_ns.class_("OpenthermHub", cg.Component)
|
||||||
|
|
||||||
|
|
||||||
|
def define_has_component(component_type: str, keys: list[str]) -> None:
|
||||||
|
cg.add_define(
|
||||||
|
f"OPENTHERM_{component_type.upper()}_LIST(F, sep)",
|
||||||
|
cg.RawExpression(
|
||||||
|
" sep ".join(map(lambda key: f"F({key}_{component_type.lower()})", keys))
|
||||||
|
),
|
||||||
|
)
|
||||||
|
for key in keys:
|
||||||
|
cg.add_define(f"OPENTHERM_HAS_{component_type.upper()}_{key}")
|
||||||
|
|
||||||
|
|
||||||
|
def define_message_handler(
|
||||||
|
component_type: str, keys: list[str], schemas: dict[str, TSchema]
|
||||||
|
) -> None:
|
||||||
|
# The macros defined here should be able to generate things like this:
|
||||||
|
# // Parsing a message and publishing to sensors
|
||||||
|
# case MessageId::Message:
|
||||||
|
# // Can have multiple sensors here, for example for a Status message with multiple flags
|
||||||
|
# this->thing_binary_sensor->publish_state(parse_flag8_lb_0(response));
|
||||||
|
# this->other_binary_sensor->publish_state(parse_flag8_lb_1(response));
|
||||||
|
# break;
|
||||||
|
# // Building a message for a write request
|
||||||
|
# case MessageId::Message: {
|
||||||
|
# unsigned int data = 0;
|
||||||
|
# data = write_flag8_lb_0(some_input_switch->state, data); // Where input_sensor can also be a number/output/switch
|
||||||
|
# data = write_u8_hb(some_number->state, data);
|
||||||
|
# return opentherm_->build_request_(MessageType::WriteData, MessageId::Message, data);
|
||||||
|
# }
|
||||||
|
|
||||||
|
messages: dict[str, list[tuple[str, str]]] = {}
|
||||||
|
for key in keys:
|
||||||
|
msg = schemas[key].message
|
||||||
|
if msg not in messages:
|
||||||
|
messages[msg] = []
|
||||||
|
messages[msg].append((key, schemas[key].message_data))
|
||||||
|
|
||||||
|
cg.add_define(
|
||||||
|
f"OPENTHERM_{component_type.upper()}_MESSAGE_HANDLERS(MESSAGE, ENTITY, entity_sep, postscript, msg_sep)",
|
||||||
|
cg.RawExpression(
|
||||||
|
" msg_sep ".join(
|
||||||
|
[
|
||||||
|
f"MESSAGE({msg}) "
|
||||||
|
+ " entity_sep ".join(
|
||||||
|
[
|
||||||
|
f"ENTITY({key}_{component_type.lower()}, {msg_data})"
|
||||||
|
for key, msg_data in keys
|
||||||
|
]
|
||||||
|
)
|
||||||
|
+ " postscript"
|
||||||
|
for msg, keys in messages.items()
|
||||||
|
]
|
||||||
|
)
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def define_readers(component_type: str, keys: list[str]) -> None:
|
||||||
|
for key in keys:
|
||||||
|
cg.add_define(
|
||||||
|
f"OPENTHERM_READ_{key}",
|
||||||
|
cg.RawExpression(f"this->{key}_{component_type.lower()}->state"),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def add_messages(hub: cg.MockObj, keys: list[str], schemas: dict[str, TSchema]):
|
||||||
|
messages: set[tuple[str, bool]] = set()
|
||||||
|
for key in keys:
|
||||||
|
messages.add((schemas[key].message, schemas[key].keep_updated))
|
||||||
|
for msg, keep_updated in messages:
|
||||||
|
msg_expr = cg.RawExpression(f"esphome::opentherm::MessageId::{msg}")
|
||||||
|
if keep_updated:
|
||||||
|
cg.add(hub.add_repeating_message(msg_expr))
|
||||||
|
else:
|
||||||
|
cg.add(hub.add_initial_message(msg_expr))
|
||||||
|
|
||||||
|
|
||||||
|
def add_property_set(var: cg.MockObj, config_key: str, config: dict[str, Any]) -> None:
|
||||||
|
if config_key in config:
|
||||||
|
cg.add(getattr(var, f"set_{config_key}")(config[config_key]))
|
||||||
|
|
||||||
|
|
||||||
|
Create = Callable[[dict[str, Any], str, cg.MockObj], Awaitable[cg.Pvariable]]
|
||||||
|
|
||||||
|
|
||||||
|
def create_only_conf(
|
||||||
|
create: Callable[[dict[str, Any]], Awaitable[cg.Pvariable]]
|
||||||
|
) -> Create:
|
||||||
|
return lambda conf, _key, _hub: create(conf)
|
||||||
|
|
||||||
|
|
||||||
|
async def component_to_code(
|
||||||
|
component_type: str,
|
||||||
|
schemas: dict[str, TSchema],
|
||||||
|
type: cg.MockObjClass,
|
||||||
|
create: Create,
|
||||||
|
config: dict[str, Any],
|
||||||
|
) -> list[str]:
|
||||||
|
"""Generate the code for each configured component in the schema of a component type.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
- component_type: The type of component, e.g. "sensor" or "binary_sensor"
|
||||||
|
- schema_: The schema for that component type, a list of available components
|
||||||
|
- type: The type of the component, e.g. sensor.Sensor or OpenthermOutput
|
||||||
|
- create: A constructor function for the component, which receives the config,
|
||||||
|
the key and the hub and should asynchronously return the new component
|
||||||
|
- config: The configuration for this component type
|
||||||
|
|
||||||
|
Returns: The list of keys for the created components
|
||||||
|
"""
|
||||||
|
cg.add_define(f"OPENTHERM_USE_{component_type.upper()}")
|
||||||
|
|
||||||
|
hub = await cg.get_variable(config[const.CONF_OPENTHERM_ID])
|
||||||
|
|
||||||
|
keys: list[str] = []
|
||||||
|
for key, conf in config.items():
|
||||||
|
if not isinstance(conf, dict):
|
||||||
|
continue
|
||||||
|
id = conf[CONF_ID]
|
||||||
|
if id and id.type == type:
|
||||||
|
entity = await create(conf, key, hub)
|
||||||
|
cg.add(getattr(hub, f"set_{key}_{component_type.lower()}")(entity))
|
||||||
|
keys.append(key)
|
||||||
|
|
||||||
|
define_has_component(component_type, keys)
|
||||||
|
define_message_handler(component_type, keys, schemas)
|
||||||
|
add_messages(hub, keys, schemas)
|
||||||
|
|
||||||
|
return keys
|
|
@ -7,50 +7,114 @@ namespace esphome {
|
||||||
namespace opentherm {
|
namespace opentherm {
|
||||||
|
|
||||||
static const char *const TAG = "opentherm";
|
static const char *const TAG = "opentherm";
|
||||||
|
namespace message_data {
|
||||||
|
bool parse_flag8_lb_0(OpenthermData &data) { return read_bit(data.valueLB, 0); }
|
||||||
|
bool parse_flag8_lb_1(OpenthermData &data) { return read_bit(data.valueLB, 1); }
|
||||||
|
bool parse_flag8_lb_2(OpenthermData &data) { return read_bit(data.valueLB, 2); }
|
||||||
|
bool parse_flag8_lb_3(OpenthermData &data) { return read_bit(data.valueLB, 3); }
|
||||||
|
bool parse_flag8_lb_4(OpenthermData &data) { return read_bit(data.valueLB, 4); }
|
||||||
|
bool parse_flag8_lb_5(OpenthermData &data) { return read_bit(data.valueLB, 5); }
|
||||||
|
bool parse_flag8_lb_6(OpenthermData &data) { return read_bit(data.valueLB, 6); }
|
||||||
|
bool parse_flag8_lb_7(OpenthermData &data) { return read_bit(data.valueLB, 7); }
|
||||||
|
bool parse_flag8_hb_0(OpenthermData &data) { return read_bit(data.valueHB, 0); }
|
||||||
|
bool parse_flag8_hb_1(OpenthermData &data) { return read_bit(data.valueHB, 1); }
|
||||||
|
bool parse_flag8_hb_2(OpenthermData &data) { return read_bit(data.valueHB, 2); }
|
||||||
|
bool parse_flag8_hb_3(OpenthermData &data) { return read_bit(data.valueHB, 3); }
|
||||||
|
bool parse_flag8_hb_4(OpenthermData &data) { return read_bit(data.valueHB, 4); }
|
||||||
|
bool parse_flag8_hb_5(OpenthermData &data) { return read_bit(data.valueHB, 5); }
|
||||||
|
bool parse_flag8_hb_6(OpenthermData &data) { return read_bit(data.valueHB, 6); }
|
||||||
|
bool parse_flag8_hb_7(OpenthermData &data) { return read_bit(data.valueHB, 7); }
|
||||||
|
uint8_t parse_u8_lb(OpenthermData &data) { return data.valueLB; }
|
||||||
|
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_hb(OpenthermData &data) { return (int8_t) data.valueHB; }
|
||||||
|
uint16_t parse_u16(OpenthermData &data) { return data.u16(); }
|
||||||
|
int16_t parse_s16(OpenthermData &data) { return data.s16(); }
|
||||||
|
float parse_f88(OpenthermData &data) { return data.f88(); }
|
||||||
|
|
||||||
OpenthermData OpenthermHub::build_request_(MessageId request_id) {
|
void write_flag8_lb_0(const bool value, OpenthermData &data) { data.valueLB = write_bit(data.valueLB, 0, value); }
|
||||||
|
void write_flag8_lb_1(const bool value, OpenthermData &data) { data.valueLB = write_bit(data.valueLB, 1, value); }
|
||||||
|
void write_flag8_lb_2(const bool value, OpenthermData &data) { data.valueLB = write_bit(data.valueLB, 2, value); }
|
||||||
|
void write_flag8_lb_3(const bool value, OpenthermData &data) { data.valueLB = write_bit(data.valueLB, 3, value); }
|
||||||
|
void write_flag8_lb_4(const bool value, OpenthermData &data) { data.valueLB = write_bit(data.valueLB, 4, value); }
|
||||||
|
void write_flag8_lb_5(const bool value, OpenthermData &data) { data.valueLB = write_bit(data.valueLB, 5, value); }
|
||||||
|
void write_flag8_lb_6(const bool value, OpenthermData &data) { data.valueLB = write_bit(data.valueLB, 6, value); }
|
||||||
|
void write_flag8_lb_7(const bool value, OpenthermData &data) { data.valueLB = write_bit(data.valueLB, 7, value); }
|
||||||
|
void write_flag8_hb_0(const bool value, OpenthermData &data) { data.valueHB = write_bit(data.valueHB, 0, value); }
|
||||||
|
void write_flag8_hb_1(const bool value, OpenthermData &data) { data.valueHB = write_bit(data.valueHB, 1, value); }
|
||||||
|
void write_flag8_hb_2(const bool value, OpenthermData &data) { data.valueHB = write_bit(data.valueHB, 2, value); }
|
||||||
|
void write_flag8_hb_3(const bool value, OpenthermData &data) { data.valueHB = write_bit(data.valueHB, 3, value); }
|
||||||
|
void write_flag8_hb_4(const bool value, OpenthermData &data) { data.valueHB = write_bit(data.valueHB, 4, value); }
|
||||||
|
void write_flag8_hb_5(const bool value, OpenthermData &data) { data.valueHB = write_bit(data.valueHB, 5, value); }
|
||||||
|
void write_flag8_hb_6(const bool value, OpenthermData &data) { data.valueHB = write_bit(data.valueHB, 6, value); }
|
||||||
|
void write_flag8_hb_7(const bool value, OpenthermData &data) { data.valueHB = write_bit(data.valueHB, 7, value); }
|
||||||
|
void write_u8_lb(const uint8_t value, OpenthermData &data) { data.valueLB = value; }
|
||||||
|
void write_u8_hb(const uint8_t value, OpenthermData &data) { data.valueHB = value; }
|
||||||
|
void write_s8_lb(const int8_t value, OpenthermData &data) { data.valueLB = (uint8_t) value; }
|
||||||
|
void write_s8_hb(const int8_t value, OpenthermData &data) { data.valueHB = (uint8_t) value; }
|
||||||
|
void write_u16(const uint16_t value, OpenthermData &data) { data.u16(value); }
|
||||||
|
void write_s16(const int16_t value, OpenthermData &data) { data.s16(value); }
|
||||||
|
void write_f88(const float value, OpenthermData &data) { data.f88(value); }
|
||||||
|
|
||||||
|
} // namespace message_data
|
||||||
|
|
||||||
|
OpenthermData OpenthermHub::build_request_(MessageId request_id) const {
|
||||||
OpenthermData data;
|
OpenthermData data;
|
||||||
data.type = 0;
|
data.type = 0;
|
||||||
data.id = 0;
|
data.id = 0;
|
||||||
data.valueHB = 0;
|
data.valueHB = 0;
|
||||||
data.valueLB = 0;
|
data.valueLB = 0;
|
||||||
|
|
||||||
// First, handle the status request. This requires special logic, because we
|
// We need this special logic for STATUS message because we have two options for specifying boiler modes:
|
||||||
// wouldn't want to inadvertently disable domestic hot water, for example.
|
// with static config values in the hub, or with separate switches.
|
||||||
// It is also included in the macro-generated code below, but that will
|
|
||||||
// never be executed, because we short-circuit it here.
|
|
||||||
if (request_id == MessageId::STATUS) {
|
if (request_id == MessageId::STATUS) {
|
||||||
bool const ch_enabled = this->ch_enable;
|
// NOLINTBEGIN
|
||||||
bool dhw_enabled = this->dhw_enable;
|
bool const ch_enabled = this->ch_enable && OPENTHERM_READ_ch_enable && OPENTHERM_READ_t_set > 0.0;
|
||||||
bool cooling_enabled = this->cooling_enable;
|
bool const dhw_enabled = this->dhw_enable && OPENTHERM_READ_dhw_enable;
|
||||||
bool otc_enabled = this->otc_active;
|
bool const cooling_enabled =
|
||||||
bool ch2_enabled = this->ch2_active;
|
this->cooling_enable && OPENTHERM_READ_cooling_enable && OPENTHERM_READ_cooling_control > 0.0;
|
||||||
|
bool const otc_enabled = this->otc_active && OPENTHERM_READ_otc_active;
|
||||||
|
bool const ch2_enabled = this->ch2_active && OPENTHERM_READ_ch2_active && OPENTHERM_READ_t_set_ch2 > 0.0;
|
||||||
|
bool const summer_mode_is_active = this->summer_mode_active && OPENTHERM_READ_summer_mode_active;
|
||||||
|
bool const dhw_blocked = this->dhw_block && OPENTHERM_READ_dhw_block;
|
||||||
|
// NOLINTEND
|
||||||
|
|
||||||
data.type = MessageType::READ_DATA;
|
data.type = MessageType::READ_DATA;
|
||||||
data.id = MessageId::STATUS;
|
data.id = MessageId::STATUS;
|
||||||
data.valueHB = ch_enabled | (dhw_enabled << 1) | (cooling_enabled << 2) | (otc_enabled << 3) | (ch2_enabled << 4);
|
data.valueHB = ch_enabled | (dhw_enabled << 1) | (cooling_enabled << 2) | (otc_enabled << 3) | (ch2_enabled << 4) |
|
||||||
|
(summer_mode_is_active << 5) | (dhw_blocked << 6);
|
||||||
|
|
||||||
|
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"
|
||||||
|
|
||||||
// TODO: This is a placeholder for an auto-generated switch statement which builds request structure based on
|
switch (request_id) { OPENTHERM_SENSOR_MESSAGE_HANDLERS(OPENTHERM_MESSAGE_READ_MESSAGE, OPENTHERM_IGNORE, , , ) }
|
||||||
// which sensors are enabled in config.
|
|
||||||
|
|
||||||
#pragma GCC diagnostic pop
|
#pragma GCC diagnostic pop
|
||||||
|
|
||||||
return data;
|
// And if we get here, a message was requested which somehow wasn't handled.
|
||||||
}
|
// This shouldn't happen due to the way the defines are configured, so we
|
||||||
return OpenthermData();
|
// log an error and just return a 0 message.
|
||||||
|
ESP_LOGE(TAG, "Tried to create a request with unknown id %d. This should never happen, so please open an issue.",
|
||||||
|
request_id);
|
||||||
|
return {};
|
||||||
}
|
}
|
||||||
|
|
||||||
OpenthermHub::OpenthermHub() : Component() {}
|
OpenthermHub::OpenthermHub() : Component(), in_pin_{}, out_pin_{} {}
|
||||||
|
|
||||||
void OpenthermHub::process_response(OpenthermData &data) {
|
void OpenthermHub::process_response(OpenthermData &data) {
|
||||||
ESP_LOGD(TAG, "Received OpenTherm response with id %d (%s)", data.id,
|
ESP_LOGD(TAG, "Received OpenTherm response with id %d (%s)", data.id,
|
||||||
this->opentherm_->message_id_to_str((MessageId) data.id));
|
this->opentherm_->message_id_to_str((MessageId) data.id));
|
||||||
ESP_LOGD(TAG, "%s", this->opentherm_->debug_data(data).c_str());
|
ESP_LOGD(TAG, "%s", this->opentherm_->debug_data(data).c_str());
|
||||||
|
|
||||||
|
switch (data.id) {
|
||||||
|
OPENTHERM_SENSOR_MESSAGE_HANDLERS(OPENTHERM_MESSAGE_RESPONSE_MESSAGE, OPENTHERM_MESSAGE_RESPONSE_ENTITY, ,
|
||||||
|
OPENTHERM_MESSAGE_RESPONSE_POSTSCRIPT, )
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
void OpenthermHub::setup() {
|
void OpenthermHub::setup() {
|
||||||
|
@ -254,15 +318,17 @@ void OpenthermHub::handle_timeout_error_() {
|
||||||
this->stop_opentherm_();
|
this->stop_opentherm_();
|
||||||
}
|
}
|
||||||
|
|
||||||
#define ID(x) x
|
|
||||||
#define SHOW2(x) #x
|
|
||||||
#define SHOW(x) SHOW2(x)
|
|
||||||
|
|
||||||
void OpenthermHub::dump_config() {
|
void OpenthermHub::dump_config() {
|
||||||
ESP_LOGCONFIG(TAG, "OpenTherm:");
|
ESP_LOGCONFIG(TAG, "OpenTherm:");
|
||||||
LOG_PIN(" In: ", this->in_pin_);
|
LOG_PIN(" In: ", this->in_pin_);
|
||||||
LOG_PIN(" Out: ", this->out_pin_);
|
LOG_PIN(" Out: ", this->out_pin_);
|
||||||
ESP_LOGCONFIG(TAG, " Sync mode: %d", this->sync_mode_);
|
ESP_LOGCONFIG(TAG, " Sync mode: %d", this->sync_mode_);
|
||||||
|
ESP_LOGCONFIG(TAG, " Sensors: %s", SHOW(OPENTHERM_SENSOR_LIST(ID, )));
|
||||||
|
ESP_LOGCONFIG(TAG, " Binary sensors: %s", SHOW(OPENTHERM_BINARY_SENSOR_LIST(ID, )));
|
||||||
|
ESP_LOGCONFIG(TAG, " Switches: %s", SHOW(OPENTHERM_SWITCH_LIST(ID, )));
|
||||||
|
ESP_LOGCONFIG(TAG, " Input sensors: %s", SHOW(OPENTHERM_INPUT_SENSOR_LIST(ID, )));
|
||||||
|
ESP_LOGCONFIG(TAG, " Outputs: %s", SHOW(OPENTHERM_OUTPUT_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", type);
|
||||||
|
|
|
@ -7,11 +7,17 @@
|
||||||
|
|
||||||
#include "opentherm.h"
|
#include "opentherm.h"
|
||||||
|
|
||||||
|
#ifdef OPENTHERM_USE_SENSOR
|
||||||
|
#include "esphome/components/sensor/sensor.h"
|
||||||
|
#endif
|
||||||
|
|
||||||
#include <memory>
|
#include <memory>
|
||||||
#include <unordered_map>
|
#include <unordered_map>
|
||||||
#include <unordered_set>
|
#include <unordered_set>
|
||||||
#include <functional>
|
#include <functional>
|
||||||
|
|
||||||
|
#include "opentherm_macros.h"
|
||||||
|
|
||||||
namespace esphome {
|
namespace esphome {
|
||||||
namespace opentherm {
|
namespace opentherm {
|
||||||
|
|
||||||
|
@ -23,6 +29,8 @@ class OpenthermHub : public Component {
|
||||||
// The OpenTherm interface
|
// The OpenTherm interface
|
||||||
std::unique_ptr<OpenTherm> opentherm_;
|
std::unique_ptr<OpenTherm> opentherm_;
|
||||||
|
|
||||||
|
OPENTHERM_SENSOR_LIST(OPENTHERM_DECLARE_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::unordered_set<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
|
||||||
|
@ -44,7 +52,7 @@ class OpenthermHub : public Component {
|
||||||
bool sync_mode_ = false;
|
bool sync_mode_ = false;
|
||||||
|
|
||||||
// Create OpenTherm messages based on the message id
|
// Create OpenTherm messages based on the message id
|
||||||
OpenthermData build_request_(MessageId request_id);
|
OpenthermData build_request_(MessageId request_id) const;
|
||||||
void handle_protocol_write_error_();
|
void handle_protocol_write_error_();
|
||||||
void handle_protocol_read_error_();
|
void handle_protocol_read_error_();
|
||||||
void handle_timeout_error_();
|
void handle_timeout_error_();
|
||||||
|
@ -78,6 +86,8 @@ class OpenthermHub : public Component {
|
||||||
void set_in_pin(InternalGPIOPin *in_pin) { this->in_pin_ = in_pin; }
|
void set_in_pin(InternalGPIOPin *in_pin) { this->in_pin_ = in_pin; }
|
||||||
void set_out_pin(InternalGPIOPin *out_pin) { this->out_pin_ = out_pin; }
|
void set_out_pin(InternalGPIOPin *out_pin) { this->out_pin_ = out_pin; }
|
||||||
|
|
||||||
|
OPENTHERM_SENSOR_LIST(OPENTHERM_SET_SENSOR, )
|
||||||
|
|
||||||
// Add a request to the set of initial requests
|
// Add a request to the set of initial requests
|
||||||
void add_initial_message(MessageId message_id) { this->initial_messages_.insert(message_id); }
|
void add_initial_message(MessageId message_id) { this->initial_messages_.insert(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
|
||||||
|
@ -86,9 +96,10 @@ class OpenthermHub : public Component {
|
||||||
// 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_.insert(message_id); }
|
||||||
|
|
||||||
// There are five 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.
|
||||||
bool ch_enable = true, dhw_enable = true, cooling_enable = false, otc_active = false, ch2_active = false;
|
bool ch_enable = true, dhw_enable = true, cooling_enable = false, otc_active = false, ch2_active = false,
|
||||||
|
summer_mode_active = false, dhw_block = false;
|
||||||
|
|
||||||
// Setters for the status variables
|
// Setters for the status variables
|
||||||
void set_ch_enable(bool value) { this->ch_enable = value; }
|
void set_ch_enable(bool value) { this->ch_enable = value; }
|
||||||
|
@ -96,6 +107,8 @@ class OpenthermHub : public Component {
|
||||||
void set_cooling_enable(bool value) { this->cooling_enable = value; }
|
void set_cooling_enable(bool value) { this->cooling_enable = value; }
|
||||||
void set_otc_active(bool value) { this->otc_active = value; }
|
void set_otc_active(bool value) { this->otc_active = value; }
|
||||||
void set_ch2_active(bool value) { this->ch2_active = value; }
|
void set_ch2_active(bool value) { this->ch2_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_sync_mode(bool sync_mode) { this->sync_mode_ = sync_mode; }
|
void set_sync_mode(bool sync_mode) { this->sync_mode_ = sync_mode; }
|
||||||
|
|
||||||
float get_setup_priority() const override { return setup_priority::HARDWARE; }
|
float get_setup_priority() const override { return setup_priority::HARDWARE; }
|
||||||
|
|
|
@ -283,6 +283,9 @@ bool OpenTherm::init_esp32_timer_() {
|
||||||
.clk_src = TIMER_SRC_CLK_DEFAULT,
|
.clk_src = TIMER_SRC_CLK_DEFAULT,
|
||||||
#endif
|
#endif
|
||||||
.divider = 80,
|
.divider = 80,
|
||||||
|
#if defined(SOC_TIMER_GROUP_SUPPORT_XTAL) && ESP_IDF_VERSION_MAJOR < 5
|
||||||
|
.clk_src = TIMER_SRC_CLK_APB
|
||||||
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
esp_err_t result;
|
esp_err_t result;
|
||||||
|
|
|
@ -20,7 +20,6 @@
|
||||||
namespace esphome {
|
namespace esphome {
|
||||||
namespace opentherm {
|
namespace opentherm {
|
||||||
|
|
||||||
// TODO: Account for immutable semantics change in hub.cpp when doing later installments of OpenTherm PR
|
|
||||||
template<class T> constexpr T read_bit(T value, uint8_t bit) { return (value >> bit) & 0x01; }
|
template<class T> constexpr T read_bit(T value, uint8_t bit) { return (value >> bit) & 0x01; }
|
||||||
|
|
||||||
template<class T> constexpr T set_bit(T value, uint8_t bit) { return value |= (1UL << bit); }
|
template<class T> constexpr T set_bit(T value, uint8_t bit) { return value |= (1UL << bit); }
|
||||||
|
@ -28,7 +27,7 @@ template<class T> constexpr T set_bit(T value, uint8_t bit) { return value |= (1
|
||||||
template<class T> constexpr T clear_bit(T value, uint8_t bit) { return value &= ~(1UL << bit); }
|
template<class T> constexpr T clear_bit(T value, uint8_t bit) { return value &= ~(1UL << bit); }
|
||||||
|
|
||||||
template<class T> constexpr T write_bit(T value, uint8_t bit, uint8_t bit_value) {
|
template<class T> constexpr T write_bit(T value, uint8_t bit, uint8_t bit_value) {
|
||||||
return bit_value ? setBit(value, bit) : clearBit(value, bit);
|
return bit_value ? set_bit(value, bit) : clear_bit(value, bit);
|
||||||
}
|
}
|
||||||
|
|
||||||
enum OperationMode {
|
enum OperationMode {
|
||||||
|
|
91
esphome/components/opentherm/opentherm_macros.h
Normal file
91
esphome/components/opentherm/opentherm_macros.h
Normal file
|
@ -0,0 +1,91 @@
|
||||||
|
#pragma once
|
||||||
|
namespace esphome {
|
||||||
|
namespace opentherm {
|
||||||
|
|
||||||
|
// ===== hub.h macros =====
|
||||||
|
|
||||||
|
// *_LIST macros will be generated in defines.h if at least one sensor from each platform is used.
|
||||||
|
// These lists will look like this:
|
||||||
|
// #define OPENTHERM_BINARY_SENSOR_LIST(F, sep) F(sensor_1) sep F(sensor_2)
|
||||||
|
// These lists will be used in hub.h to define sensor fields (passing macros like OPENTHERM_DECLARE_SENSOR as F)
|
||||||
|
// and setters (passing macros like OPENTHERM_SET_SENSOR as F) (see below)
|
||||||
|
// In order for things not to break, we define empty lists here in case some platforms are not used in config.
|
||||||
|
#ifndef OPENTHERM_SENSOR_LIST
|
||||||
|
#define OPENTHERM_SENSOR_LIST(F, sep)
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// Use macros to create fields for every entity specified in the ESPHome configuration
|
||||||
|
#define OPENTHERM_DECLARE_SENSOR(entity) sensor::Sensor *entity;
|
||||||
|
|
||||||
|
// Setter macros
|
||||||
|
#define OPENTHERM_SET_SENSOR(entity) \
|
||||||
|
void set_##entity(sensor::Sensor *sensor) { this->entity = sensor; }
|
||||||
|
|
||||||
|
// ===== hub.cpp macros =====
|
||||||
|
|
||||||
|
// *_MESSAGE_HANDLERS are generated in defines.h and look like this:
|
||||||
|
// OPENTHERM_NUMBER_MESSAGE_HANDLERS(MESSAGE, ENTITY, entity_sep, postscript, msg_sep) MESSAGE(COOLING_CONTROL)
|
||||||
|
// ENTITY(cooling_control_number, f88) postscript msg_sep They contain placeholders for message part and entities parts,
|
||||||
|
// since one message can contain multiple entities. MESSAGE part is substituted with OPENTHERM_MESSAGE_WRITE_MESSAGE,
|
||||||
|
// OPENTHERM_MESSAGE_READ_MESSAGE or OPENTHERM_MESSAGE_RESPONSE_MESSAGE. ENTITY part is substituted with
|
||||||
|
// OPENTHERM_MESSAGE_WRITE_ENTITY or OPENTHERM_MESSAGE_RESPONSE_ENTITY. OPENTHERM_IGNORE is used for sensor read
|
||||||
|
// requests since no data needs to be sent or processed, just the data id.
|
||||||
|
|
||||||
|
// In order for things not to break, we define empty lists here in case some platforms are not used in config.
|
||||||
|
#ifndef OPENTHERM_SENSOR_MESSAGE_HANDLERS
|
||||||
|
#define OPENTHERM_SENSOR_MESSAGE_HANDLERS(MESSAGE, ENTITY, entity_sep, postscript, msg_sep)
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// Read data request builder
|
||||||
|
#define OPENTHERM_MESSAGE_READ_MESSAGE(msg) \
|
||||||
|
case MessageId::msg: \
|
||||||
|
data.type = MessageType::READ_DATA; \
|
||||||
|
data.id = request_id; \
|
||||||
|
return data;
|
||||||
|
|
||||||
|
// Data processing builders
|
||||||
|
#define OPENTHERM_MESSAGE_RESPONSE_MESSAGE(msg) case MessageId::msg:
|
||||||
|
#define OPENTHERM_MESSAGE_RESPONSE_ENTITY(key, msg_data) this->key->publish_state(message_data::parse_##msg_data(data));
|
||||||
|
#define OPENTHERM_MESSAGE_RESPONSE_POSTSCRIPT break;
|
||||||
|
|
||||||
|
#define OPENTHERM_IGNORE(x, y)
|
||||||
|
|
||||||
|
// Default macros for STATUS entities
|
||||||
|
#ifndef OPENTHERM_READ_ch_enable
|
||||||
|
#define OPENTHERM_READ_ch_enable true
|
||||||
|
#endif
|
||||||
|
#ifndef OPENTHERM_READ_dhw_enable
|
||||||
|
#define OPENTHERM_READ_dhw_enable true
|
||||||
|
#endif
|
||||||
|
#ifndef OPENTHERM_READ_t_set
|
||||||
|
#define OPENTHERM_READ_t_set 0.0
|
||||||
|
#endif
|
||||||
|
#ifndef OPENTHERM_READ_cooling_enable
|
||||||
|
#define OPENTHERM_READ_cooling_enable false
|
||||||
|
#endif
|
||||||
|
#ifndef OPENTHERM_READ_cooling_control
|
||||||
|
#define OPENTHERM_READ_cooling_control 0.0
|
||||||
|
#endif
|
||||||
|
#ifndef OPENTHERM_READ_otc_active
|
||||||
|
#define OPENTHERM_READ_otc_active false
|
||||||
|
#endif
|
||||||
|
#ifndef OPENTHERM_READ_ch2_active
|
||||||
|
#define OPENTHERM_READ_ch2_active false
|
||||||
|
#endif
|
||||||
|
#ifndef OPENTHERM_READ_t_set_ch2
|
||||||
|
#define OPENTHERM_READ_t_set_ch2 0.0
|
||||||
|
#endif
|
||||||
|
#ifndef OPENTHERM_READ_summer_mode_active
|
||||||
|
#define OPENTHERM_READ_summer_mode_active false
|
||||||
|
#endif
|
||||||
|
#ifndef OPENTHERM_READ_dhw_block
|
||||||
|
#define OPENTHERM_READ_dhw_block false
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// These macros utilize the structure of *_LIST macros in order
|
||||||
|
#define ID(x) x
|
||||||
|
#define SHOW_INNER(x) #x
|
||||||
|
#define SHOW(x) SHOW_INNER(x)
|
||||||
|
|
||||||
|
} // namespace opentherm
|
||||||
|
} // namespace esphome
|
438
esphome/components/opentherm/schema.py
Normal file
438
esphome/components/opentherm/schema.py
Normal file
|
@ -0,0 +1,438 @@
|
||||||
|
# This file contains a schema for all supported sensors, binary sensors and
|
||||||
|
# inputs of the OpenTherm component.
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import Optional, TypeVar
|
||||||
|
|
||||||
|
from esphome.const import (
|
||||||
|
UNIT_CELSIUS,
|
||||||
|
UNIT_EMPTY,
|
||||||
|
UNIT_KILOWATT,
|
||||||
|
UNIT_MICROAMP,
|
||||||
|
UNIT_PERCENT,
|
||||||
|
UNIT_REVOLUTIONS_PER_MINUTE,
|
||||||
|
DEVICE_CLASS_CURRENT,
|
||||||
|
DEVICE_CLASS_EMPTY,
|
||||||
|
DEVICE_CLASS_PRESSURE,
|
||||||
|
DEVICE_CLASS_TEMPERATURE,
|
||||||
|
STATE_CLASS_MEASUREMENT,
|
||||||
|
STATE_CLASS_NONE,
|
||||||
|
STATE_CLASS_TOTAL_INCREASING,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class EntitySchema:
|
||||||
|
description: str
|
||||||
|
"""Description of the item, based on the OpenTherm spec"""
|
||||||
|
|
||||||
|
message: str
|
||||||
|
"""OpenTherm message id used to read or write the value"""
|
||||||
|
|
||||||
|
keep_updated: bool
|
||||||
|
"""Whether the value should be read or write repeatedly (True) or only during
|
||||||
|
the initialization phase (False)
|
||||||
|
"""
|
||||||
|
|
||||||
|
message_data: str
|
||||||
|
"""Instructions on how to interpret the data in the message
|
||||||
|
- flag8_[hb|lb]_[0-7]: data is a byte of single bit flags,
|
||||||
|
this flag is set in the high (hb) or low byte (lb),
|
||||||
|
at position 0 to 7
|
||||||
|
- u8_[hb|lb]: data is an unsigned 8-bit integer,
|
||||||
|
in the high (hb) or low byte (lb)
|
||||||
|
- s8_[hb|lb]: data is an signed 8-bit integer,
|
||||||
|
in the high (hb) or low byte (lb)
|
||||||
|
- f88: data is a signed fixed point value with
|
||||||
|
1 sign bit, 7 integer bits, 8 fractional bits
|
||||||
|
- u16: data is an unsigned 16-bit integer
|
||||||
|
- s16: data is a signed 16-bit integer
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
TSchema = TypeVar("TSchema", bound=EntitySchema)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class SensorSchema(EntitySchema):
|
||||||
|
accuracy_decimals: int
|
||||||
|
state_class: str
|
||||||
|
unit_of_measurement: Optional[str] = None
|
||||||
|
icon: Optional[str] = None
|
||||||
|
device_class: Optional[str] = None
|
||||||
|
disabled_by_default: bool = False
|
||||||
|
|
||||||
|
|
||||||
|
SENSORS: dict[str, SensorSchema] = {
|
||||||
|
"rel_mod_level": SensorSchema(
|
||||||
|
description="Relative modulation level",
|
||||||
|
unit_of_measurement=UNIT_PERCENT,
|
||||||
|
accuracy_decimals=2,
|
||||||
|
icon="mdi:percent",
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="MODULATION_LEVEL",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"ch_pressure": SensorSchema(
|
||||||
|
description="Water pressure in CH circuit",
|
||||||
|
unit_of_measurement="bar",
|
||||||
|
accuracy_decimals=2,
|
||||||
|
device_class=DEVICE_CLASS_PRESSURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="CH_WATER_PRESSURE",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"dhw_flow_rate": SensorSchema(
|
||||||
|
description="Water flow rate in DHW circuit",
|
||||||
|
unit_of_measurement="l/min",
|
||||||
|
accuracy_decimals=2,
|
||||||
|
icon="mdi:waves-arrow-right",
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="DHW_FLOW_RATE",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"t_boiler": SensorSchema(
|
||||||
|
description="Boiler water temperature",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=2,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="FEED_TEMP",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"t_dhw": SensorSchema(
|
||||||
|
description="DHW temperature",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=2,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="DHW_TEMP",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"t_outside": SensorSchema(
|
||||||
|
description="Outside temperature",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=2,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="OUTSIDE_TEMP",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"t_ret": SensorSchema(
|
||||||
|
description="Return water temperature",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=2,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="RETURN_WATER_TEMP",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"t_storage": SensorSchema(
|
||||||
|
description="Solar storage temperature",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=2,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="SOLAR_STORE_TEMP",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"t_collector": SensorSchema(
|
||||||
|
description="Solar collector temperature",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="SOLAR_COLLECT_TEMP",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="s16",
|
||||||
|
),
|
||||||
|
"t_flow_ch2": SensorSchema(
|
||||||
|
description="Flow water temperature CH2 circuit",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=2,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="FEED_TEMP_CH2",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"t_dhw2": SensorSchema(
|
||||||
|
description="Domestic hot water temperature 2",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=2,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="DHW2_TEMP",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"t_exhaust": SensorSchema(
|
||||||
|
description="Boiler exhaust temperature",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="EXHAUST_TEMP",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="s16",
|
||||||
|
),
|
||||||
|
"fan_speed": SensorSchema(
|
||||||
|
description="Boiler fan speed",
|
||||||
|
unit_of_measurement=UNIT_REVOLUTIONS_PER_MINUTE,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
device_class=DEVICE_CLASS_EMPTY,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="FAN_SPEED",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="u16",
|
||||||
|
),
|
||||||
|
"flame_current": SensorSchema(
|
||||||
|
description="Boiler flame current",
|
||||||
|
unit_of_measurement=UNIT_MICROAMP,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
device_class=DEVICE_CLASS_CURRENT,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="FLAME_CURRENT",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"burner_starts": SensorSchema(
|
||||||
|
description="Number of starts burner",
|
||||||
|
accuracy_decimals=0,
|
||||||
|
icon="mdi:gas-burner",
|
||||||
|
state_class=STATE_CLASS_TOTAL_INCREASING,
|
||||||
|
message="BURNER_STARTS",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="u16",
|
||||||
|
),
|
||||||
|
"ch_pump_starts": SensorSchema(
|
||||||
|
description="Number of starts CH pump",
|
||||||
|
accuracy_decimals=0,
|
||||||
|
icon="mdi:pump",
|
||||||
|
state_class=STATE_CLASS_TOTAL_INCREASING,
|
||||||
|
message="CH_PUMP_STARTS",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="u16",
|
||||||
|
),
|
||||||
|
"dhw_pump_valve_starts": SensorSchema(
|
||||||
|
description="Number of starts DHW pump/valve",
|
||||||
|
accuracy_decimals=0,
|
||||||
|
icon="mdi:water-pump",
|
||||||
|
state_class=STATE_CLASS_TOTAL_INCREASING,
|
||||||
|
message="DHW_PUMP_STARTS",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="u16",
|
||||||
|
),
|
||||||
|
"dhw_burner_starts": SensorSchema(
|
||||||
|
description="Number of starts burner during DHW mode",
|
||||||
|
accuracy_decimals=0,
|
||||||
|
icon="mdi:gas-burner",
|
||||||
|
state_class=STATE_CLASS_TOTAL_INCREASING,
|
||||||
|
message="DHW_BURNER_STARTS",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="u16",
|
||||||
|
),
|
||||||
|
"burner_operation_hours": SensorSchema(
|
||||||
|
description="Number of hours that burner is in operation",
|
||||||
|
accuracy_decimals=0,
|
||||||
|
icon="mdi:clock-outline",
|
||||||
|
state_class=STATE_CLASS_TOTAL_INCREASING,
|
||||||
|
message="BURNER_HOURS",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="u16",
|
||||||
|
),
|
||||||
|
"ch_pump_operation_hours": SensorSchema(
|
||||||
|
description="Number of hours that CH pump has been running",
|
||||||
|
accuracy_decimals=0,
|
||||||
|
icon="mdi:clock-outline",
|
||||||
|
state_class=STATE_CLASS_TOTAL_INCREASING,
|
||||||
|
message="CH_PUMP_HOURS",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="u16",
|
||||||
|
),
|
||||||
|
"dhw_pump_valve_operation_hours": SensorSchema(
|
||||||
|
description="Number of hours that DHW pump has been running or DHW valve has been opened",
|
||||||
|
accuracy_decimals=0,
|
||||||
|
icon="mdi:clock-outline",
|
||||||
|
state_class=STATE_CLASS_TOTAL_INCREASING,
|
||||||
|
message="DHW_PUMP_HOURS",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="u16",
|
||||||
|
),
|
||||||
|
"dhw_burner_operation_hours": SensorSchema(
|
||||||
|
description="Number of hours that burner is in operation during DHW mode",
|
||||||
|
accuracy_decimals=0,
|
||||||
|
icon="mdi:clock-outline",
|
||||||
|
state_class=STATE_CLASS_TOTAL_INCREASING,
|
||||||
|
message="DHW_BURNER_HOURS",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="u16",
|
||||||
|
),
|
||||||
|
"t_dhw_set_ub": SensorSchema(
|
||||||
|
description="Upper bound for adjustment of DHW setpoint",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="DHW_BOUNDS",
|
||||||
|
keep_updated=False,
|
||||||
|
message_data="s8_hb",
|
||||||
|
),
|
||||||
|
"t_dhw_set_lb": SensorSchema(
|
||||||
|
description="Lower bound for adjustment of DHW setpoint",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="DHW_BOUNDS",
|
||||||
|
keep_updated=False,
|
||||||
|
message_data="s8_lb",
|
||||||
|
),
|
||||||
|
"max_t_set_ub": SensorSchema(
|
||||||
|
description="Upper bound for adjustment of max CH setpoint",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="CH_BOUNDS",
|
||||||
|
keep_updated=False,
|
||||||
|
message_data="s8_hb",
|
||||||
|
),
|
||||||
|
"max_t_set_lb": SensorSchema(
|
||||||
|
description="Lower bound for adjustment of max CH setpoint",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="CH_BOUNDS",
|
||||||
|
keep_updated=False,
|
||||||
|
message_data="s8_lb",
|
||||||
|
),
|
||||||
|
"t_dhw_set": SensorSchema(
|
||||||
|
description="Domestic hot water temperature setpoint",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=2,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="DHW_SETPOINT",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"max_t_set": SensorSchema(
|
||||||
|
description="Maximum allowable CH water setpoint",
|
||||||
|
unit_of_measurement=UNIT_CELSIUS,
|
||||||
|
accuracy_decimals=2,
|
||||||
|
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="MAX_CH_SETPOINT",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"oem_fault_code": SensorSchema(
|
||||||
|
description="OEM fault code",
|
||||||
|
unit_of_measurement=UNIT_EMPTY,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
state_class=STATE_CLASS_NONE,
|
||||||
|
message="FAULT_FLAGS",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="u8_lb",
|
||||||
|
),
|
||||||
|
"oem_diagnostic_code": SensorSchema(
|
||||||
|
description="OEM diagnostic code",
|
||||||
|
unit_of_measurement=UNIT_EMPTY,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
state_class=STATE_CLASS_NONE,
|
||||||
|
message="OEM_DIAGNOSTIC",
|
||||||
|
keep_updated=True,
|
||||||
|
message_data="u16",
|
||||||
|
),
|
||||||
|
"max_capacity": SensorSchema(
|
||||||
|
description="Maximum boiler capacity (KW)",
|
||||||
|
unit_of_measurement=UNIT_KILOWATT,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
disabled_by_default=True,
|
||||||
|
message="MAX_BOILER_CAPACITY",
|
||||||
|
keep_updated=False,
|
||||||
|
message_data="u8_hb",
|
||||||
|
),
|
||||||
|
"min_mod_level": SensorSchema(
|
||||||
|
description="Minimum modulation level",
|
||||||
|
unit_of_measurement=UNIT_PERCENT,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
icon="mdi:percent",
|
||||||
|
disabled_by_default=True,
|
||||||
|
state_class=STATE_CLASS_MEASUREMENT,
|
||||||
|
message="MAX_BOILER_CAPACITY",
|
||||||
|
keep_updated=False,
|
||||||
|
message_data="u8_lb",
|
||||||
|
),
|
||||||
|
"opentherm_version_device": SensorSchema(
|
||||||
|
description="Version of OpenTherm implemented by device",
|
||||||
|
unit_of_measurement=UNIT_EMPTY,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
state_class=STATE_CLASS_NONE,
|
||||||
|
disabled_by_default=True,
|
||||||
|
message="OT_VERSION_DEVICE",
|
||||||
|
keep_updated=False,
|
||||||
|
message_data="f88",
|
||||||
|
),
|
||||||
|
"device_type": SensorSchema(
|
||||||
|
description="Device product type",
|
||||||
|
unit_of_measurement=UNIT_EMPTY,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
state_class=STATE_CLASS_NONE,
|
||||||
|
disabled_by_default=True,
|
||||||
|
message="VERSION_DEVICE",
|
||||||
|
keep_updated=False,
|
||||||
|
message_data="u8_hb",
|
||||||
|
),
|
||||||
|
"device_version": SensorSchema(
|
||||||
|
description="Device product version",
|
||||||
|
unit_of_measurement=UNIT_EMPTY,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
state_class=STATE_CLASS_NONE,
|
||||||
|
disabled_by_default=True,
|
||||||
|
message="VERSION_DEVICE",
|
||||||
|
keep_updated=False,
|
||||||
|
message_data="u8_lb",
|
||||||
|
),
|
||||||
|
"device_id": SensorSchema(
|
||||||
|
description="Device ID code",
|
||||||
|
unit_of_measurement=UNIT_EMPTY,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
state_class=STATE_CLASS_NONE,
|
||||||
|
disabled_by_default=True,
|
||||||
|
message="DEVICE_CONFIG",
|
||||||
|
keep_updated=False,
|
||||||
|
message_data="u8_lb",
|
||||||
|
),
|
||||||
|
"otc_hc_ratio_ub": SensorSchema(
|
||||||
|
description="OTC heat curve ratio upper bound",
|
||||||
|
unit_of_measurement=UNIT_EMPTY,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
state_class=STATE_CLASS_NONE,
|
||||||
|
disabled_by_default=True,
|
||||||
|
message="OTC_CURVE_BOUNDS",
|
||||||
|
keep_updated=False,
|
||||||
|
message_data="u8_hb",
|
||||||
|
),
|
||||||
|
"otc_hc_ratio_lb": SensorSchema(
|
||||||
|
description="OTC heat curve ratio lower bound",
|
||||||
|
unit_of_measurement=UNIT_EMPTY,
|
||||||
|
accuracy_decimals=0,
|
||||||
|
state_class=STATE_CLASS_NONE,
|
||||||
|
disabled_by_default=True,
|
||||||
|
message="OTC_CURVE_BOUNDS",
|
||||||
|
keep_updated=False,
|
||||||
|
message_data="u8_lb",
|
||||||
|
),
|
||||||
|
}
|
35
esphome/components/opentherm/sensor/__init__.py
Normal file
35
esphome/components/opentherm/sensor/__init__.py
Normal file
|
@ -0,0 +1,35 @@
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
import esphome.config_validation as cv
|
||||||
|
from esphome.components import sensor
|
||||||
|
from .. import const, schema, validate, generate
|
||||||
|
|
||||||
|
DEPENDENCIES = [const.OPENTHERM]
|
||||||
|
COMPONENT_TYPE = const.SENSOR
|
||||||
|
|
||||||
|
|
||||||
|
def get_entity_validation_schema(entity: schema.SensorSchema) -> cv.Schema:
|
||||||
|
return sensor.sensor_schema(
|
||||||
|
unit_of_measurement=entity.unit_of_measurement
|
||||||
|
or sensor._UNDEF, # pylint: disable=protected-access
|
||||||
|
accuracy_decimals=entity.accuracy_decimals,
|
||||||
|
device_class=entity.device_class
|
||||||
|
or sensor._UNDEF, # pylint: disable=protected-access
|
||||||
|
icon=entity.icon or sensor._UNDEF, # pylint: disable=protected-access
|
||||||
|
state_class=entity.state_class,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
CONFIG_SCHEMA = validate.create_component_schema(
|
||||||
|
schema.SENSORS, get_entity_validation_schema
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def to_code(config: dict[str, Any]) -> None:
|
||||||
|
await generate.component_to_code(
|
||||||
|
COMPONENT_TYPE,
|
||||||
|
schema.SENSORS,
|
||||||
|
sensor.Sensor,
|
||||||
|
generate.create_only_conf(sensor.new_sensor),
|
||||||
|
config,
|
||||||
|
)
|
31
esphome/components/opentherm/validate.py
Normal file
31
esphome/components/opentherm/validate.py
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
from typing import Callable
|
||||||
|
|
||||||
|
from voluptuous import Schema
|
||||||
|
|
||||||
|
import esphome.config_validation as cv
|
||||||
|
|
||||||
|
from . import const, schema, generate
|
||||||
|
from .schema import TSchema
|
||||||
|
|
||||||
|
|
||||||
|
def create_entities_schema(
|
||||||
|
entities: dict[str, schema.EntitySchema],
|
||||||
|
get_entity_validation_schema: Callable[[TSchema], cv.Schema],
|
||||||
|
) -> Schema:
|
||||||
|
entity_schema = {}
|
||||||
|
for key, entity in entities.items():
|
||||||
|
entity_schema[cv.Optional(key)] = get_entity_validation_schema(entity)
|
||||||
|
return cv.Schema(entity_schema)
|
||||||
|
|
||||||
|
|
||||||
|
def create_component_schema(
|
||||||
|
entities: dict[str, schema.EntitySchema],
|
||||||
|
get_entity_validation_schema: Callable[[TSchema], cv.Schema],
|
||||||
|
) -> Schema:
|
||||||
|
return (
|
||||||
|
cv.Schema(
|
||||||
|
{cv.GenerateID(const.CONF_OPENTHERM_ID): cv.use_id(generate.OpenthermHub)}
|
||||||
|
)
|
||||||
|
.extend(create_entities_schema(entities, get_entity_validation_schema))
|
||||||
|
.extend(cv.COMPONENT_SCHEMA)
|
||||||
|
)
|
|
@ -1,15 +1,15 @@
|
||||||
import esphome.codegen as cg
|
|
||||||
import esphome.config_validation as cv
|
|
||||||
from esphome import pins
|
from esphome import pins
|
||||||
|
import esphome.codegen as cg
|
||||||
from esphome.components import display, spi
|
from esphome.components import display, spi
|
||||||
|
import esphome.config_validation as cv
|
||||||
from esphome.const import (
|
from esphome.const import (
|
||||||
|
CONF_CONTRAST,
|
||||||
|
CONF_CS_PIN,
|
||||||
CONF_DC_PIN,
|
CONF_DC_PIN,
|
||||||
CONF_ID,
|
CONF_ID,
|
||||||
CONF_LAMBDA,
|
CONF_LAMBDA,
|
||||||
CONF_PAGES,
|
CONF_PAGES,
|
||||||
CONF_RESET_PIN,
|
CONF_RESET_PIN,
|
||||||
CONF_CS_PIN,
|
|
||||||
CONF_CONTRAST,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
DEPENDENCIES = ["spi"]
|
DEPENDENCIES = ["spi"]
|
||||||
|
@ -35,6 +35,10 @@ CONFIG_SCHEMA = cv.All(
|
||||||
cv.has_at_most_one_key(CONF_PAGES, CONF_LAMBDA),
|
cv.has_at_most_one_key(CONF_PAGES, CONF_LAMBDA),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
FINAL_VALIDATE_SCHEMA = spi.final_validate_device_schema(
|
||||||
|
"pcd8544", require_miso=False, require_mosi=True
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
async def to_code(config):
|
async def to_code(config):
|
||||||
var = cg.new_Pvariable(config[CONF_ID])
|
var = cg.new_Pvariable(config[CONF_ID])
|
||||||
|
|
|
@ -7,47 +7,56 @@ namespace prometheus {
|
||||||
|
|
||||||
void PrometheusHandler::handleRequest(AsyncWebServerRequest *req) {
|
void PrometheusHandler::handleRequest(AsyncWebServerRequest *req) {
|
||||||
AsyncResponseStream *stream = req->beginResponseStream("text/plain; version=0.0.4; charset=utf-8");
|
AsyncResponseStream *stream = req->beginResponseStream("text/plain; version=0.0.4; charset=utf-8");
|
||||||
|
std::string area = App.get_area();
|
||||||
|
std::string node = App.get_name();
|
||||||
|
std::string friendly_name = App.get_friendly_name();
|
||||||
|
|
||||||
#ifdef USE_SENSOR
|
#ifdef USE_SENSOR
|
||||||
this->sensor_type_(stream);
|
this->sensor_type_(stream);
|
||||||
for (auto *obj : App.get_sensors())
|
for (auto *obj : App.get_sensors())
|
||||||
this->sensor_row_(stream, obj);
|
this->sensor_row_(stream, obj, area, node, friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef USE_BINARY_SENSOR
|
#ifdef USE_BINARY_SENSOR
|
||||||
this->binary_sensor_type_(stream);
|
this->binary_sensor_type_(stream);
|
||||||
for (auto *obj : App.get_binary_sensors())
|
for (auto *obj : App.get_binary_sensors())
|
||||||
this->binary_sensor_row_(stream, obj);
|
this->binary_sensor_row_(stream, obj, area, node, friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef USE_FAN
|
#ifdef USE_FAN
|
||||||
this->fan_type_(stream);
|
this->fan_type_(stream);
|
||||||
for (auto *obj : App.get_fans())
|
for (auto *obj : App.get_fans())
|
||||||
this->fan_row_(stream, obj);
|
this->fan_row_(stream, obj, area, node, friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef USE_LIGHT
|
#ifdef USE_LIGHT
|
||||||
this->light_type_(stream);
|
this->light_type_(stream);
|
||||||
for (auto *obj : App.get_lights())
|
for (auto *obj : App.get_lights())
|
||||||
this->light_row_(stream, obj);
|
this->light_row_(stream, obj, area, node, friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef USE_COVER
|
#ifdef USE_COVER
|
||||||
this->cover_type_(stream);
|
this->cover_type_(stream);
|
||||||
for (auto *obj : App.get_covers())
|
for (auto *obj : App.get_covers())
|
||||||
this->cover_row_(stream, obj);
|
this->cover_row_(stream, obj, area, node, friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef USE_SWITCH
|
#ifdef USE_SWITCH
|
||||||
this->switch_type_(stream);
|
this->switch_type_(stream);
|
||||||
for (auto *obj : App.get_switches())
|
for (auto *obj : App.get_switches())
|
||||||
this->switch_row_(stream, obj);
|
this->switch_row_(stream, obj, area, node, friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef USE_LOCK
|
#ifdef USE_LOCK
|
||||||
this->lock_type_(stream);
|
this->lock_type_(stream);
|
||||||
for (auto *obj : App.get_locks())
|
for (auto *obj : App.get_locks())
|
||||||
this->lock_row_(stream, obj);
|
this->lock_row_(stream, obj, area, node, friendly_name);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef USE_TEXT_SENSOR
|
||||||
|
this->text_sensor_type_(stream);
|
||||||
|
for (auto *obj : App.get_text_sensors())
|
||||||
|
this->text_sensor_row_(stream, obj, area, node, friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
req->send(stream);
|
req->send(stream);
|
||||||
|
@ -63,25 +72,53 @@ std::string PrometheusHandler::relabel_name_(EntityBase *obj) {
|
||||||
return item == relabel_map_name_.end() ? obj->get_name() : item->second;
|
return item == relabel_map_name_.end() ? obj->get_name() : item->second;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
void PrometheusHandler::add_area_label_(AsyncResponseStream *stream, std::string &area) {
|
||||||
|
if (!area.empty()) {
|
||||||
|
stream->print(F("\",area=\""));
|
||||||
|
stream->print(area.c_str());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void PrometheusHandler::add_node_label_(AsyncResponseStream *stream, std::string &node) {
|
||||||
|
if (!node.empty()) {
|
||||||
|
stream->print(F("\",node=\""));
|
||||||
|
stream->print(node.c_str());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void PrometheusHandler::add_friendly_name_label_(AsyncResponseStream *stream, std::string &friendly_name) {
|
||||||
|
if (!friendly_name.empty()) {
|
||||||
|
stream->print(F("\",friendly_name=\""));
|
||||||
|
stream->print(friendly_name.c_str());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Type-specific implementation
|
// Type-specific implementation
|
||||||
#ifdef USE_SENSOR
|
#ifdef USE_SENSOR
|
||||||
void PrometheusHandler::sensor_type_(AsyncResponseStream *stream) {
|
void PrometheusHandler::sensor_type_(AsyncResponseStream *stream) {
|
||||||
stream->print(F("#TYPE esphome_sensor_value gauge\n"));
|
stream->print(F("#TYPE esphome_sensor_value gauge\n"));
|
||||||
stream->print(F("#TYPE esphome_sensor_failed gauge\n"));
|
stream->print(F("#TYPE esphome_sensor_failed gauge\n"));
|
||||||
}
|
}
|
||||||
void PrometheusHandler::sensor_row_(AsyncResponseStream *stream, sensor::Sensor *obj) {
|
void PrometheusHandler::sensor_row_(AsyncResponseStream *stream, sensor::Sensor *obj, std::string &area,
|
||||||
|
std::string &node, std::string &friendly_name) {
|
||||||
if (obj->is_internal() && !this->include_internal_)
|
if (obj->is_internal() && !this->include_internal_)
|
||||||
return;
|
return;
|
||||||
if (!std::isnan(obj->state)) {
|
if (!std::isnan(obj->state)) {
|
||||||
// We have a valid value, output this value
|
// We have a valid value, output this value
|
||||||
stream->print(F("esphome_sensor_failed{id=\""));
|
stream->print(F("esphome_sensor_failed{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} 0\n"));
|
stream->print(F("\"} 0\n"));
|
||||||
// Data itself
|
// Data itself
|
||||||
stream->print(F("esphome_sensor_value{id=\""));
|
stream->print(F("esphome_sensor_value{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\",unit=\""));
|
stream->print(F("\",unit=\""));
|
||||||
|
@ -93,6 +130,9 @@ void PrometheusHandler::sensor_row_(AsyncResponseStream *stream, sensor::Sensor
|
||||||
// Invalid state
|
// Invalid state
|
||||||
stream->print(F("esphome_sensor_failed{id=\""));
|
stream->print(F("esphome_sensor_failed{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} 1\n"));
|
stream->print(F("\"} 1\n"));
|
||||||
|
@ -106,19 +146,26 @@ void PrometheusHandler::binary_sensor_type_(AsyncResponseStream *stream) {
|
||||||
stream->print(F("#TYPE esphome_binary_sensor_value gauge\n"));
|
stream->print(F("#TYPE esphome_binary_sensor_value gauge\n"));
|
||||||
stream->print(F("#TYPE esphome_binary_sensor_failed gauge\n"));
|
stream->print(F("#TYPE esphome_binary_sensor_failed gauge\n"));
|
||||||
}
|
}
|
||||||
void PrometheusHandler::binary_sensor_row_(AsyncResponseStream *stream, binary_sensor::BinarySensor *obj) {
|
void PrometheusHandler::binary_sensor_row_(AsyncResponseStream *stream, binary_sensor::BinarySensor *obj,
|
||||||
|
std::string &area, std::string &node, std::string &friendly_name) {
|
||||||
if (obj->is_internal() && !this->include_internal_)
|
if (obj->is_internal() && !this->include_internal_)
|
||||||
return;
|
return;
|
||||||
if (obj->has_state()) {
|
if (obj->has_state()) {
|
||||||
// We have a valid value, output this value
|
// We have a valid value, output this value
|
||||||
stream->print(F("esphome_binary_sensor_failed{id=\""));
|
stream->print(F("esphome_binary_sensor_failed{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} 0\n"));
|
stream->print(F("\"} 0\n"));
|
||||||
// Data itself
|
// Data itself
|
||||||
stream->print(F("esphome_binary_sensor_value{id=\""));
|
stream->print(F("esphome_binary_sensor_value{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} "));
|
stream->print(F("\"} "));
|
||||||
|
@ -128,6 +175,9 @@ void PrometheusHandler::binary_sensor_row_(AsyncResponseStream *stream, binary_s
|
||||||
// Invalid state
|
// Invalid state
|
||||||
stream->print(F("esphome_binary_sensor_failed{id=\""));
|
stream->print(F("esphome_binary_sensor_failed{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} 1\n"));
|
stream->print(F("\"} 1\n"));
|
||||||
|
@ -142,17 +192,24 @@ void PrometheusHandler::fan_type_(AsyncResponseStream *stream) {
|
||||||
stream->print(F("#TYPE esphome_fan_speed gauge\n"));
|
stream->print(F("#TYPE esphome_fan_speed gauge\n"));
|
||||||
stream->print(F("#TYPE esphome_fan_oscillation gauge\n"));
|
stream->print(F("#TYPE esphome_fan_oscillation gauge\n"));
|
||||||
}
|
}
|
||||||
void PrometheusHandler::fan_row_(AsyncResponseStream *stream, fan::Fan *obj) {
|
void PrometheusHandler::fan_row_(AsyncResponseStream *stream, fan::Fan *obj, std::string &area, std::string &node,
|
||||||
|
std::string &friendly_name) {
|
||||||
if (obj->is_internal() && !this->include_internal_)
|
if (obj->is_internal() && !this->include_internal_)
|
||||||
return;
|
return;
|
||||||
stream->print(F("esphome_fan_failed{id=\""));
|
stream->print(F("esphome_fan_failed{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} 0\n"));
|
stream->print(F("\"} 0\n"));
|
||||||
// Data itself
|
// Data itself
|
||||||
stream->print(F("esphome_fan_value{id=\""));
|
stream->print(F("esphome_fan_value{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} "));
|
stream->print(F("\"} "));
|
||||||
|
@ -162,6 +219,9 @@ void PrometheusHandler::fan_row_(AsyncResponseStream *stream, fan::Fan *obj) {
|
||||||
if (obj->get_traits().supports_speed()) {
|
if (obj->get_traits().supports_speed()) {
|
||||||
stream->print(F("esphome_fan_speed{id=\""));
|
stream->print(F("esphome_fan_speed{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} "));
|
stream->print(F("\"} "));
|
||||||
|
@ -172,6 +232,9 @@ void PrometheusHandler::fan_row_(AsyncResponseStream *stream, fan::Fan *obj) {
|
||||||
if (obj->get_traits().supports_oscillation()) {
|
if (obj->get_traits().supports_oscillation()) {
|
||||||
stream->print(F("esphome_fan_oscillation{id=\""));
|
stream->print(F("esphome_fan_oscillation{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} "));
|
stream->print(F("\"} "));
|
||||||
|
@ -187,12 +250,16 @@ void PrometheusHandler::light_type_(AsyncResponseStream *stream) {
|
||||||
stream->print(F("#TYPE esphome_light_color gauge\n"));
|
stream->print(F("#TYPE esphome_light_color gauge\n"));
|
||||||
stream->print(F("#TYPE esphome_light_effect_active gauge\n"));
|
stream->print(F("#TYPE esphome_light_effect_active gauge\n"));
|
||||||
}
|
}
|
||||||
void PrometheusHandler::light_row_(AsyncResponseStream *stream, light::LightState *obj) {
|
void PrometheusHandler::light_row_(AsyncResponseStream *stream, light::LightState *obj, std::string &area,
|
||||||
|
std::string &node, std::string &friendly_name) {
|
||||||
if (obj->is_internal() && !this->include_internal_)
|
if (obj->is_internal() && !this->include_internal_)
|
||||||
return;
|
return;
|
||||||
// State
|
// State
|
||||||
stream->print(F("esphome_light_state{id=\""));
|
stream->print(F("esphome_light_state{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} "));
|
stream->print(F("\"} "));
|
||||||
|
@ -205,6 +272,9 @@ void PrometheusHandler::light_row_(AsyncResponseStream *stream, light::LightStat
|
||||||
color.as_rgbw(&r, &g, &b, &w);
|
color.as_rgbw(&r, &g, &b, &w);
|
||||||
stream->print(F("esphome_light_color{id=\""));
|
stream->print(F("esphome_light_color{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\",channel=\"brightness\"} "));
|
stream->print(F("\",channel=\"brightness\"} "));
|
||||||
|
@ -212,6 +282,9 @@ void PrometheusHandler::light_row_(AsyncResponseStream *stream, light::LightStat
|
||||||
stream->print(F("\n"));
|
stream->print(F("\n"));
|
||||||
stream->print(F("esphome_light_color{id=\""));
|
stream->print(F("esphome_light_color{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\",channel=\"r\"} "));
|
stream->print(F("\",channel=\"r\"} "));
|
||||||
|
@ -219,6 +292,9 @@ void PrometheusHandler::light_row_(AsyncResponseStream *stream, light::LightStat
|
||||||
stream->print(F("\n"));
|
stream->print(F("\n"));
|
||||||
stream->print(F("esphome_light_color{id=\""));
|
stream->print(F("esphome_light_color{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\",channel=\"g\"} "));
|
stream->print(F("\",channel=\"g\"} "));
|
||||||
|
@ -226,6 +302,9 @@ void PrometheusHandler::light_row_(AsyncResponseStream *stream, light::LightStat
|
||||||
stream->print(F("\n"));
|
stream->print(F("\n"));
|
||||||
stream->print(F("esphome_light_color{id=\""));
|
stream->print(F("esphome_light_color{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\",channel=\"b\"} "));
|
stream->print(F("\",channel=\"b\"} "));
|
||||||
|
@ -233,6 +312,9 @@ void PrometheusHandler::light_row_(AsyncResponseStream *stream, light::LightStat
|
||||||
stream->print(F("\n"));
|
stream->print(F("\n"));
|
||||||
stream->print(F("esphome_light_color{id=\""));
|
stream->print(F("esphome_light_color{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\",channel=\"w\"} "));
|
stream->print(F("\",channel=\"w\"} "));
|
||||||
|
@ -243,12 +325,18 @@ void PrometheusHandler::light_row_(AsyncResponseStream *stream, light::LightStat
|
||||||
if (effect == "None") {
|
if (effect == "None") {
|
||||||
stream->print(F("esphome_light_effect_active{id=\""));
|
stream->print(F("esphome_light_effect_active{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\",effect=\"None\"} 0\n"));
|
stream->print(F("\",effect=\"None\"} 0\n"));
|
||||||
} else {
|
} else {
|
||||||
stream->print(F("esphome_light_effect_active{id=\""));
|
stream->print(F("esphome_light_effect_active{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\",effect=\""));
|
stream->print(F("\",effect=\""));
|
||||||
|
@ -263,19 +351,26 @@ void PrometheusHandler::cover_type_(AsyncResponseStream *stream) {
|
||||||
stream->print(F("#TYPE esphome_cover_value gauge\n"));
|
stream->print(F("#TYPE esphome_cover_value gauge\n"));
|
||||||
stream->print(F("#TYPE esphome_cover_failed gauge\n"));
|
stream->print(F("#TYPE esphome_cover_failed gauge\n"));
|
||||||
}
|
}
|
||||||
void PrometheusHandler::cover_row_(AsyncResponseStream *stream, cover::Cover *obj) {
|
void PrometheusHandler::cover_row_(AsyncResponseStream *stream, cover::Cover *obj, std::string &area, std::string &node,
|
||||||
|
std::string &friendly_name) {
|
||||||
if (obj->is_internal() && !this->include_internal_)
|
if (obj->is_internal() && !this->include_internal_)
|
||||||
return;
|
return;
|
||||||
if (!std::isnan(obj->position)) {
|
if (!std::isnan(obj->position)) {
|
||||||
// We have a valid value, output this value
|
// We have a valid value, output this value
|
||||||
stream->print(F("esphome_cover_failed{id=\""));
|
stream->print(F("esphome_cover_failed{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} 0\n"));
|
stream->print(F("\"} 0\n"));
|
||||||
// Data itself
|
// Data itself
|
||||||
stream->print(F("esphome_cover_value{id=\""));
|
stream->print(F("esphome_cover_value{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} "));
|
stream->print(F("\"} "));
|
||||||
|
@ -284,6 +379,9 @@ void PrometheusHandler::cover_row_(AsyncResponseStream *stream, cover::Cover *ob
|
||||||
if (obj->get_traits().get_supports_tilt()) {
|
if (obj->get_traits().get_supports_tilt()) {
|
||||||
stream->print(F("esphome_cover_tilt{id=\""));
|
stream->print(F("esphome_cover_tilt{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} "));
|
stream->print(F("\"} "));
|
||||||
|
@ -294,6 +392,9 @@ void PrometheusHandler::cover_row_(AsyncResponseStream *stream, cover::Cover *ob
|
||||||
// Invalid state
|
// Invalid state
|
||||||
stream->print(F("esphome_cover_failed{id=\""));
|
stream->print(F("esphome_cover_failed{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} 1\n"));
|
stream->print(F("\"} 1\n"));
|
||||||
|
@ -306,17 +407,24 @@ void PrometheusHandler::switch_type_(AsyncResponseStream *stream) {
|
||||||
stream->print(F("#TYPE esphome_switch_value gauge\n"));
|
stream->print(F("#TYPE esphome_switch_value gauge\n"));
|
||||||
stream->print(F("#TYPE esphome_switch_failed gauge\n"));
|
stream->print(F("#TYPE esphome_switch_failed gauge\n"));
|
||||||
}
|
}
|
||||||
void PrometheusHandler::switch_row_(AsyncResponseStream *stream, switch_::Switch *obj) {
|
void PrometheusHandler::switch_row_(AsyncResponseStream *stream, switch_::Switch *obj, std::string &area,
|
||||||
|
std::string &node, std::string &friendly_name) {
|
||||||
if (obj->is_internal() && !this->include_internal_)
|
if (obj->is_internal() && !this->include_internal_)
|
||||||
return;
|
return;
|
||||||
stream->print(F("esphome_switch_failed{id=\""));
|
stream->print(F("esphome_switch_failed{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} 0\n"));
|
stream->print(F("\"} 0\n"));
|
||||||
// Data itself
|
// Data itself
|
||||||
stream->print(F("esphome_switch_value{id=\""));
|
stream->print(F("esphome_switch_value{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} "));
|
stream->print(F("\"} "));
|
||||||
|
@ -330,17 +438,24 @@ void PrometheusHandler::lock_type_(AsyncResponseStream *stream) {
|
||||||
stream->print(F("#TYPE esphome_lock_value gauge\n"));
|
stream->print(F("#TYPE esphome_lock_value gauge\n"));
|
||||||
stream->print(F("#TYPE esphome_lock_failed gauge\n"));
|
stream->print(F("#TYPE esphome_lock_failed gauge\n"));
|
||||||
}
|
}
|
||||||
void PrometheusHandler::lock_row_(AsyncResponseStream *stream, lock::Lock *obj) {
|
void PrometheusHandler::lock_row_(AsyncResponseStream *stream, lock::Lock *obj, std::string &area, std::string &node,
|
||||||
|
std::string &friendly_name) {
|
||||||
if (obj->is_internal() && !this->include_internal_)
|
if (obj->is_internal() && !this->include_internal_)
|
||||||
return;
|
return;
|
||||||
stream->print(F("esphome_lock_failed{id=\""));
|
stream->print(F("esphome_lock_failed{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} 0\n"));
|
stream->print(F("\"} 0\n"));
|
||||||
// Data itself
|
// Data itself
|
||||||
stream->print(F("esphome_lock_value{id=\""));
|
stream->print(F("esphome_lock_value{id=\""));
|
||||||
stream->print(relabel_id_(obj).c_str());
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
stream->print(F("\",name=\""));
|
stream->print(F("\",name=\""));
|
||||||
stream->print(relabel_name_(obj).c_str());
|
stream->print(relabel_name_(obj).c_str());
|
||||||
stream->print(F("\"} "));
|
stream->print(F("\"} "));
|
||||||
|
@ -349,6 +464,53 @@ void PrometheusHandler::lock_row_(AsyncResponseStream *stream, lock::Lock *obj)
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
// Type-specific implementation
|
||||||
|
#ifdef USE_TEXT_SENSOR
|
||||||
|
void PrometheusHandler::text_sensor_type_(AsyncResponseStream *stream) {
|
||||||
|
stream->print(F("#TYPE esphome_text_sensor_value gauge\n"));
|
||||||
|
stream->print(F("#TYPE esphome_text_sensor_failed gauge\n"));
|
||||||
|
}
|
||||||
|
void PrometheusHandler::text_sensor_row_(AsyncResponseStream *stream, text_sensor::TextSensor *obj, std::string &area,
|
||||||
|
std::string &node, std::string &friendly_name) {
|
||||||
|
if (obj->is_internal() && !this->include_internal_)
|
||||||
|
return;
|
||||||
|
if (obj->has_state()) {
|
||||||
|
// We have a valid value, output this value
|
||||||
|
stream->print(F("esphome_text_sensor_failed{id=\""));
|
||||||
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
|
stream->print(F("\",name=\""));
|
||||||
|
stream->print(relabel_name_(obj).c_str());
|
||||||
|
stream->print(F("\"} 0\n"));
|
||||||
|
// Data itself
|
||||||
|
stream->print(F("esphome_text_sensor_value{id=\""));
|
||||||
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
|
stream->print(F("\",name=\""));
|
||||||
|
stream->print(relabel_name_(obj).c_str());
|
||||||
|
stream->print(F("\",value=\""));
|
||||||
|
stream->print(obj->state.c_str());
|
||||||
|
stream->print(F("\"} "));
|
||||||
|
stream->print(F("1.0"));
|
||||||
|
stream->print(F("\n"));
|
||||||
|
} else {
|
||||||
|
// Invalid state
|
||||||
|
stream->print(F("esphome_text_sensor_failed{id=\""));
|
||||||
|
stream->print(relabel_id_(obj).c_str());
|
||||||
|
add_area_label_(stream, area);
|
||||||
|
add_node_label_(stream, node);
|
||||||
|
add_friendly_name_label_(stream, friendly_name);
|
||||||
|
stream->print(F("\",name=\""));
|
||||||
|
stream->print(relabel_name_(obj).c_str());
|
||||||
|
stream->print(F("\"} 1\n"));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
} // namespace prometheus
|
} // namespace prometheus
|
||||||
} // namespace esphome
|
} // namespace esphome
|
||||||
#endif
|
#endif
|
||||||
|
|
|
@ -60,54 +60,72 @@ class PrometheusHandler : public AsyncWebHandler, public Component {
|
||||||
protected:
|
protected:
|
||||||
std::string relabel_id_(EntityBase *obj);
|
std::string relabel_id_(EntityBase *obj);
|
||||||
std::string relabel_name_(EntityBase *obj);
|
std::string relabel_name_(EntityBase *obj);
|
||||||
|
void add_area_label_(AsyncResponseStream *stream, std::string &area);
|
||||||
|
void add_node_label_(AsyncResponseStream *stream, std::string &node);
|
||||||
|
void add_friendly_name_label_(AsyncResponseStream *stream, std::string &friendly_name);
|
||||||
|
|
||||||
#ifdef USE_SENSOR
|
#ifdef USE_SENSOR
|
||||||
/// Return the type for prometheus
|
/// Return the type for prometheus
|
||||||
void sensor_type_(AsyncResponseStream *stream);
|
void sensor_type_(AsyncResponseStream *stream);
|
||||||
/// Return the sensor state as prometheus data point
|
/// Return the sensor state as prometheus data point
|
||||||
void sensor_row_(AsyncResponseStream *stream, sensor::Sensor *obj);
|
void sensor_row_(AsyncResponseStream *stream, sensor::Sensor *obj, std::string &area, std::string &node,
|
||||||
|
std::string &friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef USE_BINARY_SENSOR
|
#ifdef USE_BINARY_SENSOR
|
||||||
/// Return the type for prometheus
|
/// Return the type for prometheus
|
||||||
void binary_sensor_type_(AsyncResponseStream *stream);
|
void binary_sensor_type_(AsyncResponseStream *stream);
|
||||||
/// Return the sensor state as prometheus data point
|
/// Return the sensor state as prometheus data point
|
||||||
void binary_sensor_row_(AsyncResponseStream *stream, binary_sensor::BinarySensor *obj);
|
void binary_sensor_row_(AsyncResponseStream *stream, binary_sensor::BinarySensor *obj, std::string &area,
|
||||||
|
std::string &node, std::string &friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef USE_FAN
|
#ifdef USE_FAN
|
||||||
/// Return the type for prometheus
|
/// Return the type for prometheus
|
||||||
void fan_type_(AsyncResponseStream *stream);
|
void fan_type_(AsyncResponseStream *stream);
|
||||||
/// Return the sensor state as prometheus data point
|
/// Return the sensor state as prometheus data point
|
||||||
void fan_row_(AsyncResponseStream *stream, fan::Fan *obj);
|
void fan_row_(AsyncResponseStream *stream, fan::Fan *obj, std::string &area, std::string &node,
|
||||||
|
std::string &friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef USE_LIGHT
|
#ifdef USE_LIGHT
|
||||||
/// Return the type for prometheus
|
/// Return the type for prometheus
|
||||||
void light_type_(AsyncResponseStream *stream);
|
void light_type_(AsyncResponseStream *stream);
|
||||||
/// Return the Light Values state as prometheus data point
|
/// Return the Light Values state as prometheus data point
|
||||||
void light_row_(AsyncResponseStream *stream, light::LightState *obj);
|
void light_row_(AsyncResponseStream *stream, light::LightState *obj, std::string &area, std::string &node,
|
||||||
|
std::string &friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef USE_COVER
|
#ifdef USE_COVER
|
||||||
/// Return the type for prometheus
|
/// Return the type for prometheus
|
||||||
void cover_type_(AsyncResponseStream *stream);
|
void cover_type_(AsyncResponseStream *stream);
|
||||||
/// Return the switch Values state as prometheus data point
|
/// Return the switch Values state as prometheus data point
|
||||||
void cover_row_(AsyncResponseStream *stream, cover::Cover *obj);
|
void cover_row_(AsyncResponseStream *stream, cover::Cover *obj, std::string &area, std::string &node,
|
||||||
|
std::string &friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef USE_SWITCH
|
#ifdef USE_SWITCH
|
||||||
/// Return the type for prometheus
|
/// Return the type for prometheus
|
||||||
void switch_type_(AsyncResponseStream *stream);
|
void switch_type_(AsyncResponseStream *stream);
|
||||||
/// Return the switch Values state as prometheus data point
|
/// Return the switch Values state as prometheus data point
|
||||||
void switch_row_(AsyncResponseStream *stream, switch_::Switch *obj);
|
void switch_row_(AsyncResponseStream *stream, switch_::Switch *obj, std::string &area, std::string &node,
|
||||||
|
std::string &friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef USE_LOCK
|
#ifdef USE_LOCK
|
||||||
/// Return the type for prometheus
|
/// Return the type for prometheus
|
||||||
void lock_type_(AsyncResponseStream *stream);
|
void lock_type_(AsyncResponseStream *stream);
|
||||||
/// Return the lock Values state as prometheus data point
|
/// Return the lock Values state as prometheus data point
|
||||||
void lock_row_(AsyncResponseStream *stream, lock::Lock *obj);
|
void lock_row_(AsyncResponseStream *stream, lock::Lock *obj, std::string &area, std::string &node,
|
||||||
|
std::string &friendly_name);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef USE_TEXT_SENSOR
|
||||||
|
/// Return the type for prometheus
|
||||||
|
void text_sensor_type_(AsyncResponseStream *stream);
|
||||||
|
/// Return the lock Values state as prometheus data point
|
||||||
|
void text_sensor_row_(AsyncResponseStream *stream, text_sensor::TextSensor *obj, std::string &area, std::string &node,
|
||||||
|
std::string &friendly_name);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
web_server_base::WebServerBase *base_;
|
web_server_base::WebServerBase *base_;
|
||||||
|
|
|
@ -17,7 +17,7 @@ from esphome.const import (
|
||||||
PLATFORM_RP2040,
|
PLATFORM_RP2040,
|
||||||
)
|
)
|
||||||
from esphome.core import CORE, EsphomeError, coroutine_with_priority
|
from esphome.core import CORE, EsphomeError, coroutine_with_priority
|
||||||
from esphome.helpers import copy_file_if_changed, mkdir_p, write_file
|
from esphome.helpers import copy_file_if_changed, mkdir_p, write_file, read_file
|
||||||
|
|
||||||
from .const import KEY_BOARD, KEY_PIO_FILES, KEY_RP2040, rp2040_ns
|
from .const import KEY_BOARD, KEY_PIO_FILES, KEY_RP2040, rp2040_ns
|
||||||
|
|
||||||
|
@ -26,7 +26,7 @@ from .gpio import rp2040_pin_to_code # noqa
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
CODEOWNERS = ["@jesserockz"]
|
CODEOWNERS = ["@jesserockz"]
|
||||||
AUTO_LOAD = []
|
AUTO_LOAD = ["preferences"]
|
||||||
|
|
||||||
|
|
||||||
def set_core_data(config):
|
def set_core_data(config):
|
||||||
|
@ -230,11 +230,14 @@ def generate_pio_files() -> bool:
|
||||||
|
|
||||||
|
|
||||||
# Called by writer.py
|
# Called by writer.py
|
||||||
def copy_files() -> bool:
|
def copy_files():
|
||||||
dir = os.path.dirname(__file__)
|
dir = os.path.dirname(__file__)
|
||||||
post_build_file = os.path.join(dir, "post_build.py.script")
|
post_build_file = os.path.join(dir, "post_build.py.script")
|
||||||
copy_file_if_changed(
|
copy_file_if_changed(
|
||||||
post_build_file,
|
post_build_file,
|
||||||
CORE.relative_build_path("post_build.py"),
|
CORE.relative_build_path("post_build.py"),
|
||||||
)
|
)
|
||||||
return generate_pio_files()
|
if generate_pio_files():
|
||||||
|
path = CORE.relative_src_path("esphome.h")
|
||||||
|
content = read_file(path).rstrip("\n")
|
||||||
|
write_file(path, content + '\n#include "pio_includes.h"\n')
|
||||||
|
|
|
@ -1,6 +1,8 @@
|
||||||
|
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.const import (
|
from esphome.const import (
|
||||||
|
CONF_ANALOG,
|
||||||
CONF_ID,
|
CONF_ID,
|
||||||
CONF_INPUT,
|
CONF_INPUT,
|
||||||
CONF_INVERTED,
|
CONF_INVERTED,
|
||||||
|
@ -10,10 +12,8 @@ from esphome.const import (
|
||||||
CONF_OUTPUT,
|
CONF_OUTPUT,
|
||||||
CONF_PULLDOWN,
|
CONF_PULLDOWN,
|
||||||
CONF_PULLUP,
|
CONF_PULLUP,
|
||||||
CONF_ANALOG,
|
|
||||||
)
|
)
|
||||||
from esphome.core import CORE
|
from esphome.core import CORE
|
||||||
from esphome import pins
|
|
||||||
|
|
||||||
from . import boards
|
from . import boards
|
||||||
from .const import KEY_BOARD, KEY_RP2040, rp2040_ns
|
from .const import KEY_BOARD, KEY_RP2040, rp2040_ns
|
||||||
|
@ -41,8 +41,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:
|
||||||
|
|
|
@ -84,6 +84,26 @@ void RpiDpiRgb::draw_pixels_at(int x_start, int y_start, int w, int h, const uin
|
||||||
ESP_LOGE(TAG, "lcd_lcd_panel_draw_bitmap failed: %s", esp_err_to_name(err));
|
ESP_LOGE(TAG, "lcd_lcd_panel_draw_bitmap failed: %s", esp_err_to_name(err));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
int RpiDpiRgb::get_width() {
|
||||||
|
switch (this->rotation_) {
|
||||||
|
case display::DISPLAY_ROTATION_90_DEGREES:
|
||||||
|
case display::DISPLAY_ROTATION_270_DEGREES:
|
||||||
|
return this->get_height_internal();
|
||||||
|
default:
|
||||||
|
return this->get_width_internal();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
int RpiDpiRgb::get_height() {
|
||||||
|
switch (this->rotation_) {
|
||||||
|
case display::DISPLAY_ROTATION_90_DEGREES:
|
||||||
|
case display::DISPLAY_ROTATION_270_DEGREES:
|
||||||
|
return this->get_width_internal();
|
||||||
|
default:
|
||||||
|
return this->get_height_internal();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
void RpiDpiRgb::draw_pixel_at(int x, int y, Color color) {
|
void RpiDpiRgb::draw_pixel_at(int x, int y, Color color) {
|
||||||
if (!this->get_clipping().inside(x, y))
|
if (!this->get_clipping().inside(x, y))
|
||||||
return; // NOLINT
|
return; // NOLINT
|
||||||
|
|
|
@ -24,6 +24,7 @@ class RpiDpiRgb : public display::Display {
|
||||||
void update() override { this->do_update_(); }
|
void update() override { this->do_update_(); }
|
||||||
void setup() override;
|
void setup() override;
|
||||||
void loop() override;
|
void loop() override;
|
||||||
|
float get_setup_priority() const override { return setup_priority::HARDWARE; }
|
||||||
void draw_pixels_at(int x_start, int y_start, int w, int h, const uint8_t *ptr, display::ColorOrder order,
|
void draw_pixels_at(int x_start, int y_start, int w, int h, const uint8_t *ptr, display::ColorOrder order,
|
||||||
display::ColorBitness bitness, bool big_endian, int x_offset, int y_offset, int x_pad) override;
|
display::ColorBitness bitness, bool big_endian, int x_offset, int y_offset, int x_pad) override;
|
||||||
void draw_pixel_at(int x, int y, Color color) override;
|
void draw_pixel_at(int x, int y, Color color) override;
|
||||||
|
@ -44,8 +45,8 @@ class RpiDpiRgb : public display::Display {
|
||||||
this->width_ = width;
|
this->width_ = width;
|
||||||
this->height_ = height;
|
this->height_ = height;
|
||||||
}
|
}
|
||||||
int get_width() override { return this->width_; }
|
int get_width() override;
|
||||||
int get_height() override { return this->height_; }
|
int get_height() override;
|
||||||
void set_hsync_back_porch(uint16_t hsync_back_porch) { this->hsync_back_porch_ = hsync_back_porch; }
|
void set_hsync_back_porch(uint16_t hsync_back_porch) { this->hsync_back_porch_ = hsync_back_porch; }
|
||||||
void set_hsync_front_porch(uint16_t hsync_front_porch) { this->hsync_front_porch_ = hsync_front_porch; }
|
void set_hsync_front_porch(uint16_t hsync_front_porch) { this->hsync_front_porch_ = hsync_front_porch; }
|
||||||
void set_hsync_pulse_width(uint16_t hsync_pulse_width) { this->hsync_pulse_width_ = hsync_pulse_width; }
|
void set_hsync_pulse_width(uint16_t hsync_pulse_width) { this->hsync_pulse_width_ = hsync_pulse_width; }
|
||||||
|
|
|
@ -26,7 +26,10 @@ inline double deg2rad(double degrees) {
|
||||||
return degrees * PI_ON_180;
|
return degrees * PI_ON_180;
|
||||||
}
|
}
|
||||||
|
|
||||||
void Rtttl::dump_config() { ESP_LOGCONFIG(TAG, "Rtttl"); }
|
void Rtttl::dump_config() {
|
||||||
|
ESP_LOGCONFIG(TAG, "Rtttl:");
|
||||||
|
ESP_LOGCONFIG(TAG, " Gain: %f", gain_);
|
||||||
|
}
|
||||||
|
|
||||||
void Rtttl::play(std::string rtttl) {
|
void Rtttl::play(std::string rtttl) {
|
||||||
if (this->state_ != State::STATE_STOPPED && this->state_ != State::STATE_STOPPING) {
|
if (this->state_ != State::STATE_STOPPED && this->state_ != State::STATE_STOPPING) {
|
||||||
|
|
|
@ -39,6 +39,7 @@ class Rtttl : public Component {
|
||||||
#ifdef USE_SPEAKER
|
#ifdef USE_SPEAKER
|
||||||
void set_speaker(speaker::Speaker *speaker) { this->speaker_ = speaker; }
|
void set_speaker(speaker::Speaker *speaker) { this->speaker_ = speaker; }
|
||||||
#endif
|
#endif
|
||||||
|
float get_gain() { return gain_; }
|
||||||
void set_gain(float gain) {
|
void set_gain(float gain) {
|
||||||
if (gain < 0.1f)
|
if (gain < 0.1f)
|
||||||
gain = 0.1f;
|
gain = 0.1f;
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue