diff --git a/.clang-tidy b/.clang-tidy
index c9b77b5720..946f2950d8 100644
--- a/.clang-tidy
+++ b/.clang-tidy
@@ -5,9 +5,12 @@ Checks: >-
-altera-*,
-android-*,
-boost-*,
+ -bugprone-easily-swappable-parameters,
+ -bugprone-implicit-widening-of-multiplication-result,
-bugprone-narrowing-conversions,
-bugprone-signed-char-misuse,
-cert-dcl50-cpp,
+ -cert-err33-c,
-cert-err58-cpp,
-cert-oop57-cpp,
-cert-str34-c,
@@ -15,6 +18,7 @@ Checks: >-
-clang-analyzer-osx.*,
-clang-diagnostic-delete-abstract-non-virtual-dtor,
-clang-diagnostic-delete-non-abstract-non-virtual-dtor,
+ -clang-diagnostic-ignored-optimization-argument,
-clang-diagnostic-shadow-field,
-clang-diagnostic-unused-const-variable,
-clang-diagnostic-unused-parameter,
@@ -25,6 +29,7 @@ Checks: >-
-cppcoreguidelines-macro-usage,
-cppcoreguidelines-narrowing-conversions,
-cppcoreguidelines-non-private-member-variables-in-classes,
+ -cppcoreguidelines-prefer-member-initializer,
-cppcoreguidelines-pro-bounds-array-to-pointer-decay,
-cppcoreguidelines-pro-bounds-constant-array-index,
-cppcoreguidelines-pro-bounds-pointer-arithmetic,
@@ -36,6 +41,7 @@ Checks: >-
-cppcoreguidelines-pro-type-union-access,
-cppcoreguidelines-pro-type-vararg,
-cppcoreguidelines-special-member-functions,
+ -cppcoreguidelines-virtual-class-destructor,
-fuchsia-multiple-inheritance,
-fuchsia-overloaded-operator,
-fuchsia-statically-constructed-objects,
@@ -68,6 +74,7 @@ Checks: >-
-modernize-use-nodiscard,
-mpi-*,
-objc-*,
+ -readability-container-data-pointer,
-readability-convert-member-functions-to-static,
-readability-else-after-return,
-readability-function-cognitive-complexity,
@@ -82,8 +89,6 @@ WarningsAsErrors: '*'
AnalyzeTemporaryDtors: false
FormatStyle: google
CheckOptions:
- - key: google-readability-braces-around-statements.ShortStatementLines
- value: '1'
- key: google-readability-function-size.StatementThreshold
value: '800'
- key: google-runtime-int.TypeSuffix
@@ -158,3 +163,9 @@ CheckOptions:
value: ''
- key: readability-qualified-auto.AddConstToQualified
value: 0
+ - key: readability-identifier-length.MinimumVariableNameLength
+ value: 0
+ - key: readability-identifier-length.MinimumParameterNameLength
+ value: 0
+ - key: readability-identifier-length.MinimumLoopCounterNameLength
+ value: 0
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
index b3fa6d4932..8d9565ad5f 100644
--- a/.devcontainer/devcontainer.json
+++ b/.devcontainer/devcontainer.json
@@ -5,33 +5,59 @@
"script/devcontainer-post-create"
],
"containerEnv": {
- "DEVCONTAINER": "1"
+ "DEVCONTAINER": "1",
+ "PIP_BREAK_SYSTEM_PACKAGES": "1",
+ "PIP_ROOT_USER_ACTION": "ignore"
},
"runArgs": [
"--privileged",
"-e",
"ESPHOME_DASHBOARD_USE_PING=1"
+ // uncomment and edit the path in order to pass though local USB serial to the conatiner
+ // , "--device=/dev/ttyACM0"
],
"appPort": 6052,
+ // if you are using avahi in the host device, uncomment these to allow the
+ // devcontainer to find devices via mdns
+ //"mounts": [
+ // "type=bind,source=/dev/bus/usb,target=/dev/bus/usb",
+ // "type=bind,source=/var/run/dbus,target=/var/run/dbus",
+ // "type=bind,source=/var/run/avahi-daemon/socket,target=/var/run/avahi-daemon/socket"
+ //],
"customizations": {
"vscode": {
"extensions": [
// python
"ms-python.python",
+ "ms-python.pylint",
+ "ms-python.flake8",
+ "ms-python.black-formatter",
"visualstudioexptteam.vscodeintellicode",
// yaml
"redhat.vscode-yaml",
// cpp
"ms-vscode.cpptools",
// editorconfig
- "editorconfig.editorconfig",
+ "editorconfig.editorconfig"
],
"settings": {
"python.languageServer": "Pylance",
"python.pythonPath": "/usr/bin/python3",
- "python.linting.pylintEnabled": true,
- "python.linting.enabled": true,
- "python.formatting.provider": "black",
+ "pylint.args": [
+ "--rcfile=${workspaceFolder}/pyproject.toml"
+ ],
+ "flake8.args": [
+ "--config=${workspaceFolder}/.flake8"
+ ],
+ "black-formatter.args": [
+ "--config",
+ "${workspaceFolder}/pyproject.toml"
+ ],
+ "[python]": {
+ // VS will say "Value is not accepted" before building the devcontainer, but the warning
+ // should go away after build is completed.
+ "editor.defaultFormatter": "ms-python.black-formatter"
+ },
"editor.formatOnPaste": false,
"editor.formatOnSave": true,
"editor.formatOnType": true,
@@ -40,6 +66,8 @@
"yaml.customTags": [
"!secret scalar",
"!lambda scalar",
+ "!extend scalar",
+ "!remove scalar",
"!include_dir_named scalar",
"!include_dir_list scalar",
"!include_dir_merge_list scalar",
diff --git a/.dockerignore b/.dockerignore
index 9f14b98059..7998ff877f 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -75,6 +75,9 @@ target/
# pyenv
.python-version
+# asdf
+.tool-versions
+
# celery beat schedule file
celerybeat-schedule
diff --git a/.flake8 b/.flake8
new file mode 100644
index 0000000000..2724da06b6
--- /dev/null
+++ b/.flake8
@@ -0,0 +1,42 @@
+[flake8]
+max-line-length = 120
+# Following 4 for black compatibility
+# E501: line too long
+# W503: Line break occurred before a binary operator
+# E203: Whitespace before ':'
+# D202 No blank lines allowed after function docstring
+
+# TODO fix flake8
+# D100 Missing docstring in public module
+# D101 Missing docstring in public class
+# D102 Missing docstring in public method
+# D103 Missing docstring in public function
+# D104 Missing docstring in public package
+# D105 Missing docstring in magic method
+# D107 Missing docstring in __init__
+# D200 One-line docstring should fit on one line with quotes
+# D205 1 blank line required between summary line and description
+# D209 Multi-line docstring closing quotes should be on a separate line
+# D400 First line should end with a period
+# D401 First line should be in imperative mood
+
+ignore =
+ E501,
+ W503,
+ E203,
+ D202,
+
+ D100,
+ D101,
+ D102,
+ D103,
+ D104,
+ D105,
+ D107,
+ D200,
+ D205,
+ D209,
+ D400,
+ D401,
+
+exclude = api_pb2.py
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 3221b8ac5c..5703d39be1 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -7,11 +7,16 @@
- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Code quality improvements to existing code or addition of tests
- [ ] Other
-**Related issue or feature (if applicable):** fixes
+**Related issue or feature (if applicable):**
-**Pull request in [esphome-docs](https://github.com/esphome/esphome-docs) with documentation (if applicable):** esphome/esphome-docs#
+- fixes
+
+**Pull request in [esphome-docs](https://github.com/esphome/esphome-docs) with documentation (if applicable):**
+
+- esphome/esphome-docs#
## Test Environment
@@ -19,14 +24,10 @@
- [ ] ESP32 IDF
- [ ] ESP8266
- [ ] RP2040
+- [ ] BK72xx
+- [ ] RTL87xx
## Example entry for `config.yaml`:
-
```yaml
# Example config.yaml
diff --git a/.github/actions/build-image/action.yaml b/.github/actions/build-image/action.yaml
new file mode 100644
index 0000000000..5c686605c3
--- /dev/null
+++ b/.github/actions/build-image/action.yaml
@@ -0,0 +1,97 @@
+name: Build Image
+inputs:
+ platform:
+ description: "Platform to build for"
+ required: true
+ example: "linux/amd64"
+ target:
+ description: "Target to build"
+ required: true
+ example: "docker"
+ baseimg:
+ description: "Base image type"
+ required: true
+ example: "docker"
+ suffix:
+ description: "Suffix to add to tags"
+ required: true
+ version:
+ description: "Version to build"
+ required: true
+ example: "2023.12.0"
+runs:
+ using: "composite"
+ steps:
+ - name: Generate short tags
+ id: tags
+ shell: bash
+ run: |
+ output=$(docker/generate_tags.py \
+ --tag "${{ inputs.version }}" \
+ --suffix "${{ inputs.suffix }}")
+ echo $output
+ for l in $output; do
+ echo $l >> $GITHUB_OUTPUT
+ done
+
+ # set cache-to only if dev branch
+ - id: cache-to
+ shell: bash
+ run: |-
+ if [[ "${{ github.ref }}" == "refs/heads/dev" ]]; then
+ echo "value=type=gha,mode=max" >> $GITHUB_OUTPUT
+ else
+ echo "value=" >> $GITHUB_OUTPUT
+ fi
+
+ - name: Build and push to ghcr by digest
+ id: build-ghcr
+ uses: docker/build-push-action@v6.9.0
+ env:
+ DOCKER_BUILD_SUMMARY: false
+ DOCKER_BUILD_RECORD_UPLOAD: false
+ with:
+ context: .
+ file: ./docker/Dockerfile
+ platforms: ${{ inputs.platform }}
+ target: ${{ inputs.target }}
+ cache-from: type=gha
+ cache-to: ${{ steps.cache-to.outputs.value }}
+ build-args: |
+ BASEIMGTYPE=${{ inputs.baseimg }}
+ BUILD_VERSION=${{ inputs.version }}
+ outputs: |
+ type=image,name=ghcr.io/${{ steps.tags.outputs.image_name }},push-by-digest=true,name-canonical=true,push=true
+
+ - name: Export ghcr digests
+ shell: bash
+ run: |
+ mkdir -p /tmp/digests/${{ inputs.target }}/ghcr
+ digest="${{ steps.build-ghcr.outputs.digest }}"
+ touch "/tmp/digests/${{ inputs.target }}/ghcr/${digest#sha256:}"
+
+ - name: Build and push to dockerhub by digest
+ id: build-dockerhub
+ uses: docker/build-push-action@v6.9.0
+ env:
+ DOCKER_BUILD_SUMMARY: false
+ DOCKER_BUILD_RECORD_UPLOAD: false
+ with:
+ context: .
+ file: ./docker/Dockerfile
+ platforms: ${{ inputs.platform }}
+ target: ${{ inputs.target }}
+ cache-from: type=gha
+ cache-to: ${{ steps.cache-to.outputs.value }}
+ build-args: |
+ BASEIMGTYPE=${{ inputs.baseimg }}
+ BUILD_VERSION=${{ inputs.version }}
+ outputs: |
+ type=image,name=docker.io/${{ steps.tags.outputs.image_name }},push-by-digest=true,name-canonical=true,push=true
+
+ - name: Export dockerhub digests
+ shell: bash
+ run: |
+ mkdir -p /tmp/digests/${{ inputs.target }}/dockerhub
+ digest="${{ steps.build-dockerhub.outputs.digest }}"
+ touch "/tmp/digests/${{ inputs.target }}/dockerhub/${digest#sha256:}"
diff --git a/.github/actions/restore-python/action.yml b/.github/actions/restore-python/action.yml
new file mode 100644
index 0000000000..06c54578f5
--- /dev/null
+++ b/.github/actions/restore-python/action.yml
@@ -0,0 +1,47 @@
+name: Restore Python
+inputs:
+ python-version:
+ description: Python version to restore
+ required: true
+ type: string
+ cache-key:
+ description: Cache key to use
+ required: true
+ type: string
+outputs:
+ python-version:
+ description: Python version restored
+ value: ${{ steps.python.outputs.python-version }}
+runs:
+ using: "composite"
+ steps:
+ - name: Set up Python ${{ inputs.python-version }}
+ id: python
+ uses: actions/setup-python@v5.3.0
+ with:
+ python-version: ${{ inputs.python-version }}
+ - name: Restore Python virtual environment
+ id: cache-venv
+ uses: actions/cache/restore@v4.1.2
+ with:
+ path: venv
+ # yamllint disable-line rule:line-length
+ key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-venv-${{ inputs.cache-key }}
+ - name: Create Python virtual environment
+ if: steps.cache-venv.outputs.cache-hit != 'true' && runner.os != 'Windows'
+ shell: bash
+ run: |
+ python -m venv venv
+ source venv/bin/activate
+ python --version
+ pip install -r requirements.txt -r requirements_optional.txt -r requirements_test.txt
+ pip install -e .
+ - name: Create Python virtual environment
+ if: steps.cache-venv.outputs.cache-hit != 'true' && runner.os == 'Windows'
+ shell: bash
+ run: |
+ python -m venv venv
+ ./venv/Scripts/activate
+ python --version
+ pip install -r requirements.txt -r requirements_optional.txt -r requirements_test.txt
+ pip install -e .
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
index 666532f360..bb35f16048 100644
--- a/.github/dependabot.yml
+++ b/.github/dependabot.yml
@@ -13,3 +13,20 @@ updates:
schedule:
interval: daily
open-pull-requests-limit: 10
+ groups:
+ docker-actions:
+ applies-to: version-updates
+ patterns:
+ - "docker/setup-qemu-action"
+ - "docker/login-action"
+ - "docker/setup-buildx-action"
+ - package-ecosystem: github-actions
+ directory: "/.github/actions/build-image"
+ schedule:
+ interval: daily
+ open-pull-requests-limit: 10
+ - package-ecosystem: github-actions
+ directory: "/.github/actions/restore-python"
+ schedule:
+ interval: daily
+ open-pull-requests-limit: 10
diff --git a/.github/workflows/ci-api-proto.yml b/.github/workflows/ci-api-proto.yml
new file mode 100644
index 0000000000..a6b2e2b2b3
--- /dev/null
+++ b/.github/workflows/ci-api-proto.yml
@@ -0,0 +1,80 @@
+name: API Proto CI
+
+on:
+ pull_request:
+ paths:
+ - "esphome/components/api/api.proto"
+ - "esphome/components/api/api_pb2.cpp"
+ - "esphome/components/api/api_pb2.h"
+ - "esphome/components/api/api_pb2_service.cpp"
+ - "esphome/components/api/api_pb2_service.h"
+ - "script/api_protobuf/api_protobuf.py"
+ - ".github/workflows/ci-api-proto.yml"
+
+permissions:
+ contents: read
+ pull-requests: write
+
+jobs:
+ check:
+ name: Check generated files
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4.1.7
+ - name: Set up Python
+ uses: actions/setup-python@v5.3.0
+ with:
+ python-version: "3.11"
+
+ - name: Install apt dependencies
+ run: |
+ sudo apt update
+ sudo apt-cache show protobuf-compiler
+ sudo apt install -y protobuf-compiler
+ protoc --version
+ - name: Install python dependencies
+ run: pip install aioesphomeapi -c requirements.txt -r requirements_dev.txt
+ - name: Generate files
+ run: script/api_protobuf/api_protobuf.py
+ - name: Check for changes
+ run: |
+ if ! git diff --quiet; then
+ echo "## Job Failed" | tee -a $GITHUB_STEP_SUMMARY
+ echo "You have altered the generated proto files but they do not match what is expected." | tee -a $GITHUB_STEP_SUMMARY
+ echo "Please run 'script/api_protobuf/api_protobuf.py' and commit the changes." | tee -a $GITHUB_STEP_SUMMARY
+ exit 1
+ fi
+ - if: failure()
+ name: Review PR
+ uses: actions/github-script@v7.0.1
+ with:
+ script: |
+ await github.rest.pulls.createReview({
+ pull_number: context.issue.number,
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ event: 'REQUEST_CHANGES',
+ body: 'You have altered the generated proto files but they do not match what is expected.\nPlease run "script/api_protobuf/api_protobuf.py" and commit the changes.'
+ })
+ - if: success()
+ name: Dismiss review
+ uses: actions/github-script@v7.0.1
+ with:
+ script: |
+ let reviews = await github.rest.pulls.listReviews({
+ pull_number: context.issue.number,
+ owner: context.repo.owner,
+ repo: context.repo.repo
+ });
+ for (let review of reviews.data) {
+ if (review.user.login === 'github-actions[bot]' && review.state === 'CHANGES_REQUESTED') {
+ await github.rest.pulls.dismissReview({
+ pull_number: context.issue.number,
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ review_id: review.id,
+ message: 'Files now match the expected proto files.'
+ });
+ }
+ }
diff --git a/.github/workflows/ci-docker.yml b/.github/workflows/ci-docker.yml
index eb3a5a945c..435a58498e 100644
--- a/.github/workflows/ci-docker.yml
+++ b/.github/workflows/ci-docker.yml
@@ -2,13 +2,13 @@
name: CI for docker images
# Only run when docker paths change
-# yamllint disable-line rule:truthy
+
on:
push:
branches: [dev, beta, release]
paths:
- "docker/**"
- - ".github/workflows/**"
+ - ".github/workflows/ci-docker.yml"
- "requirements*.txt"
- "platformio.ini"
- "script/platformio_install_deps.py"
@@ -16,7 +16,7 @@ on:
pull_request:
paths:
- "docker/**"
- - ".github/workflows/**"
+ - ".github/workflows/ci-docker.yml"
- "requirements*.txt"
- "platformio.ini"
- "script/platformio_install_deps.py"
@@ -40,15 +40,15 @@ jobs:
arch: [amd64, armv7, aarch64]
build_type: ["ha-addon", "docker", "lint"]
steps:
- - uses: actions/checkout@v3
+ - uses: actions/checkout@v4.1.7
- name: Set up Python
- uses: actions/setup-python@v4
+ uses: actions/setup-python@v5.3.0
with:
python-version: "3.9"
- name: Set up Docker Buildx
- uses: docker/setup-buildx-action@v2
+ uses: docker/setup-buildx-action@v3.7.1
- name: Set up QEMU
- uses: docker/setup-qemu-action@v2
+ uses: docker/setup-qemu-action@v3.2.0
- name: Set TAG
run: |
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 2b04d04672..82a55d0e2a 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -1,12 +1,18 @@
---
name: CI
-# yamllint disable-line rule:truthy
on:
push:
branches: [dev, beta, release]
pull_request:
+ paths:
+ - "**"
+ - "!.github/workflows/*.yml"
+ - "!.github/actions/build-image/*"
+ - ".github/workflows/ci.yml"
+ - "!.yamllint"
+ - "!.github/dependabot.yml"
merge_group:
permissions:
@@ -15,7 +21,6 @@ permissions:
env:
DEFAULT_PYTHON: "3.9"
PYUPGRADE_TARGET: "--py39-plus"
- CLANG_FORMAT_VERSION: "13.0.1"
concurrency:
# yamllint disable-line rule:line-length
@@ -26,20 +31,26 @@ jobs:
common:
name: Create common environment
runs-on: ubuntu-latest
+ outputs:
+ cache-key: ${{ steps.cache-key.outputs.key }}
steps:
- name: Check out code from GitHub
- uses: actions/checkout@v3.5.2
+ uses: actions/checkout@v4.1.7
+ - name: Generate cache-key
+ id: cache-key
+ run: echo key="${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}" >> $GITHUB_OUTPUT
- name: Set up Python ${{ env.DEFAULT_PYTHON }}
- uses: actions/setup-python@v4.6.0
+ id: python
+ uses: actions/setup-python@v5.3.0
with:
python-version: ${{ env.DEFAULT_PYTHON }}
- name: Restore Python virtual environment
id: cache-venv
- uses: actions/cache@v3.3.1
+ uses: actions/cache@v4.1.2
with:
path: venv
# yamllint disable-line rule:line-length
- key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-venv-${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}
+ key: ${{ runner.os }}-${{ steps.python.outputs.python-version }}-venv-${{ steps.cache-key.outputs.key }}
- name: Create Python virtual environment
if: steps.cache-venv.outputs.cache-hit != 'true'
run: |
@@ -49,15 +60,6 @@ jobs:
pip install -r requirements.txt -r requirements_optional.txt -r requirements_test.txt
pip install -e .
- yamllint:
- name: yamllint
- runs-on: ubuntu-latest
- steps:
- - name: Check out code from GitHub
- uses: actions/checkout@v3.5.2
- - name: Run yamllint
- uses: frenck/action-yamllint@v1.4.0
-
black:
name: Check black
runs-on: ubuntu-latest
@@ -65,13 +67,12 @@ jobs:
- common
steps:
- name: Check out code from GitHub
- uses: actions/checkout@v3.5.2
- - name: Restore Python virtual environment
- uses: actions/cache/restore@v3.3.1
+ uses: actions/checkout@v4.1.7
+ - name: Restore Python
+ uses: ./.github/actions/restore-python
with:
- path: venv
- # yamllint disable-line rule:line-length
- key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-venv-${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}
+ python-version: ${{ env.DEFAULT_PYTHON }}
+ cache-key: ${{ needs.common.outputs.cache-key }}
- name: Run black
run: |
. venv/bin/activate
@@ -87,13 +88,12 @@ jobs:
- common
steps:
- name: Check out code from GitHub
- uses: actions/checkout@v3.5.2
- - name: Restore Python virtual environment
- uses: actions/cache/restore@v3.3.1
+ uses: actions/checkout@v4.1.7
+ - name: Restore Python
+ uses: ./.github/actions/restore-python
with:
- path: venv
- # yamllint disable-line rule:line-length
- key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-venv-${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}
+ python-version: ${{ env.DEFAULT_PYTHON }}
+ cache-key: ${{ needs.common.outputs.cache-key }}
- name: Run flake8
run: |
. venv/bin/activate
@@ -109,13 +109,12 @@ jobs:
- common
steps:
- name: Check out code from GitHub
- uses: actions/checkout@v3.5.2
- - name: Restore Python virtual environment
- uses: actions/cache/restore@v3.3.1
+ uses: actions/checkout@v4.1.7
+ - name: Restore Python
+ uses: ./.github/actions/restore-python
with:
- path: venv
- # yamllint disable-line rule:line-length
- key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-venv-${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}
+ python-version: ${{ env.DEFAULT_PYTHON }}
+ cache-key: ${{ needs.common.outputs.cache-key }}
- name: Run pylint
run: |
. venv/bin/activate
@@ -131,13 +130,12 @@ jobs:
- common
steps:
- name: Check out code from GitHub
- uses: actions/checkout@v3.5.2
- - name: Restore Python virtual environment
- uses: actions/cache/restore@v3.3.1
+ uses: actions/checkout@v4.1.7
+ - name: Restore Python
+ uses: ./.github/actions/restore-python
with:
- path: venv
- # yamllint disable-line rule:line-length
- key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-venv-${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}
+ python-version: ${{ env.DEFAULT_PYTHON }}
+ cache-key: ${{ needs.common.outputs.cache-key }}
- name: Run pyupgrade
run: |
. venv/bin/activate
@@ -153,13 +151,12 @@ jobs:
- common
steps:
- name: Check out code from GitHub
- uses: actions/checkout@v3.5.2
- - name: Restore Python virtual environment
- uses: actions/cache/restore@v3.3.1
+ uses: actions/checkout@v4.1.7
+ - name: Restore Python
+ uses: ./.github/actions/restore-python
with:
- path: venv
- # yamllint disable-line rule:line-length
- key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-venv-${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}
+ python-version: ${{ env.DEFAULT_PYTHON }}
+ cache-key: ${{ needs.common.outputs.cache-key }}
- name: Register matcher
run: echo "::add-matcher::.github/workflows/matchers/ci-custom.json"
- name: Run script/ci-custom
@@ -170,24 +167,61 @@ jobs:
pytest:
name: Run pytest
- runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ python-version:
+ - "3.9"
+ - "3.10"
+ - "3.11"
+ - "3.12"
+ os:
+ - ubuntu-latest
+ - macOS-latest
+ - windows-latest
+ exclude:
+ # Minimize CI resource usage
+ # by only running the Python version
+ # version used for docker images on Windows and macOS
+ - python-version: "3.12"
+ os: windows-latest
+ - python-version: "3.10"
+ os: windows-latest
+ - python-version: "3.9"
+ os: windows-latest
+ - python-version: "3.12"
+ os: macOS-latest
+ - python-version: "3.10"
+ os: macOS-latest
+ - python-version: "3.9"
+ os: macOS-latest
+ runs-on: ${{ matrix.os }}
needs:
- common
steps:
- name: Check out code from GitHub
- uses: actions/checkout@v3.5.2
- - name: Restore Python virtual environment
- uses: actions/cache/restore@v3.3.1
+ uses: actions/checkout@v4.1.7
+ - name: Restore Python
+ uses: ./.github/actions/restore-python
with:
- path: venv
- # yamllint disable-line rule:line-length
- key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-venv-${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}
+ python-version: ${{ matrix.python-version }}
+ cache-key: ${{ needs.common.outputs.cache-key }}
- name: Register matcher
run: echo "::add-matcher::.github/workflows/matchers/pytest.json"
- name: Run pytest
+ if: matrix.os == 'windows-latest'
+ run: |
+ ./venv/Scripts/activate
+ pytest -vv --cov-report=xml --tb=native tests
+ - name: Run pytest
+ if: matrix.os == 'ubuntu-latest' || matrix.os == 'macOS-latest'
run: |
. venv/bin/activate
- pytest -vv --tb=native tests
+ pytest -vv --cov-report=xml --tb=native tests
+ - name: Upload coverage to Codecov
+ uses: codecov/codecov-action@v4
+ with:
+ token: ${{ secrets.CODECOV_TOKEN }}
clang-format:
name: Check clang-format
@@ -196,17 +230,16 @@ jobs:
- common
steps:
- name: Check out code from GitHub
- uses: actions/checkout@v3.5.2
- - name: Restore Python virtual environment
- uses: actions/cache/restore@v3.3.1
+ uses: actions/checkout@v4.1.7
+ - name: Restore Python
+ uses: ./.github/actions/restore-python
with:
- path: venv
- # yamllint disable-line rule:line-length
- key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-venv-${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}
+ python-version: ${{ env.DEFAULT_PYTHON }}
+ cache-key: ${{ needs.common.outputs.cache-key }}
- name: Install clang-format
run: |
. venv/bin/activate
- pip install clang-format==${{ env.CLANG_FORMAT_VERSION }}
+ pip install clang-format -c requirements_dev.txt
- name: Run clang-format
run: |
. venv/bin/activate
@@ -216,44 +249,6 @@ jobs:
run: script/ci-suggest-changes
if: always()
- compile-tests:
- name: Run YAML test ${{ matrix.file }}
- runs-on: ubuntu-latest
- needs:
- - common
- - black
- - ci-custom
- - clang-format
- - flake8
- - pylint
- - pytest
- - pyupgrade
- - yamllint
- strategy:
- fail-fast: false
- max-parallel: 2
- matrix:
- file: [1, 2, 3, 3.1, 4, 5, 6, 7, 8]
- steps:
- - name: Check out code from GitHub
- uses: actions/checkout@v3.5.2
- - name: Restore Python virtual environment
- uses: actions/cache/restore@v3.3.1
- with:
- path: venv
- # yamllint disable-line rule:line-length
- key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-venv-${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}
- - name: Cache platformio
- uses: actions/cache@v3.3.1
- with:
- path: ~/.platformio
- # yamllint disable-line rule:line-length
- key: platformio-test${{ matrix.file }}-${{ hashFiles('platformio.ini') }}
- - name: Run esphome compile tests/test${{ matrix.file }}.yaml
- run: |
- . venv/bin/activate
- esphome compile tests/test${{ matrix.file }}.yaml
-
clang-tidy:
name: ${{ matrix.name }}
runs-on: ubuntu-latest
@@ -266,7 +261,6 @@ jobs:
- pylint
- pytest
- pyupgrade
- - yamllint
strategy:
fail-fast: false
max-parallel: 2
@@ -299,29 +293,44 @@ jobs:
steps:
- name: Check out code from GitHub
- uses: actions/checkout@v3.5.2
- - name: Restore Python virtual environment
- uses: actions/cache/restore@v3.3.1
+ uses: actions/checkout@v4.1.7
+ - name: Restore Python
+ uses: ./.github/actions/restore-python
with:
- path: venv
- # yamllint disable-line rule:line-length
- key: ${{ runner.os }}-${{ env.DEFAULT_PYTHON }}-venv-${{ hashFiles('requirements.txt', 'requirements_optional.txt', 'requirements_test.txt') }}
- # Use per check platformio cache because checks use different parts
+ python-version: ${{ env.DEFAULT_PYTHON }}
+ cache-key: ${{ needs.common.outputs.cache-key }}
+
- name: Cache platformio
- uses: actions/cache@v3.3.1
+ if: github.ref == 'refs/heads/dev'
+ uses: actions/cache@v4.1.2
with:
path: ~/.platformio
- # yamllint disable-line rule:line-length
- key: platformio-${{ matrix.pio_cache_key }}-${{ hashFiles('platformio.ini') }}
+ key: platformio-${{ matrix.pio_cache_key }}
+
+ - name: Cache platformio
+ if: github.ref != 'refs/heads/dev'
+ uses: actions/cache/restore@v4.1.2
+ with:
+ path: ~/.platformio
+ key: platformio-${{ matrix.pio_cache_key }}
- name: Install clang-tidy
- run: sudo apt-get install clang-tidy-11
+ run: |
+ sudo apt-get update
+ sudo apt-get install clang-tidy-14
- name: Register problem matchers
run: |
echo "::add-matcher::.github/workflows/matchers/gcc.json"
echo "::add-matcher::.github/workflows/matchers/clang-tidy.json"
+ - name: Run 'pio run --list-targets -e esp32-idf-tidy'
+ if: matrix.name == 'Run script/clang-tidy for ESP32 IDF'
+ run: |
+ . venv/bin/activate
+ mkdir -p .temp
+ pio run --list-targets -e esp32-idf-tidy
+
- name: Run clang-tidy
run: |
. venv/bin/activate
@@ -335,6 +344,143 @@ jobs:
# yamllint disable-line rule:line-length
if: always()
+ list-components:
+ runs-on: ubuntu-latest
+ needs:
+ - common
+ if: github.event_name == 'pull_request'
+ outputs:
+ components: ${{ steps.list-components.outputs.components }}
+ count: ${{ steps.list-components.outputs.count }}
+ steps:
+ - name: Check out code from GitHub
+ uses: actions/checkout@v4.1.7
+ with:
+ # Fetch enough history so `git merge-base refs/remotes/origin/dev HEAD` works.
+ fetch-depth: 500
+ - name: Get target branch
+ id: target-branch
+ run: |
+ echo "branch=${{ github.event.pull_request.base.ref }}" >> $GITHUB_OUTPUT
+ - name: Fetch ${{ steps.target-branch.outputs.branch }} branch
+ run: |
+ git -c protocol.version=2 fetch --no-tags --prune --no-recurse-submodules --depth=1 origin +refs/heads/${{ steps.target-branch.outputs.branch }}:refs/remotes/origin/${{ steps.target-branch.outputs.branch }}
+ git merge-base refs/remotes/origin/${{ steps.target-branch.outputs.branch }} HEAD
+ - name: Restore Python
+ uses: ./.github/actions/restore-python
+ with:
+ python-version: ${{ env.DEFAULT_PYTHON }}
+ cache-key: ${{ needs.common.outputs.cache-key }}
+ - name: Find changed components
+ id: list-components
+ run: |
+ . venv/bin/activate
+ components=$(script/list-components.py --changed --branch ${{ steps.target-branch.outputs.branch }})
+ output_components=$(echo "$components" | jq -R -s -c 'split("\n")[:-1] | map(select(length > 0))')
+ count=$(echo "$output_components" | jq length)
+
+ echo "components=$output_components" >> $GITHUB_OUTPUT
+ echo "count=$count" >> $GITHUB_OUTPUT
+
+ echo "$count Components:"
+ echo "$output_components" | jq
+
+ test-build-components:
+ name: Component test ${{ matrix.file }}
+ runs-on: ubuntu-latest
+ needs:
+ - common
+ - list-components
+ if: github.event_name == 'pull_request' && fromJSON(needs.list-components.outputs.count) > 0 && fromJSON(needs.list-components.outputs.count) < 100
+ strategy:
+ fail-fast: false
+ max-parallel: 2
+ matrix:
+ file: ${{ fromJson(needs.list-components.outputs.components) }}
+ steps:
+ - name: Install dependencies
+ run: |
+ sudo apt-get update
+ sudo apt-get install libsdl2-dev
+
+ - name: Check out code from GitHub
+ uses: actions/checkout@v4.1.7
+ - name: Restore Python
+ uses: ./.github/actions/restore-python
+ with:
+ python-version: ${{ env.DEFAULT_PYTHON }}
+ cache-key: ${{ needs.common.outputs.cache-key }}
+ - name: test_build_components -e config -c ${{ matrix.file }}
+ run: |
+ . venv/bin/activate
+ ./script/test_build_components -e config -c ${{ matrix.file }}
+ - name: test_build_components -e compile -c ${{ matrix.file }}
+ run: |
+ . venv/bin/activate
+ ./script/test_build_components -e compile -c ${{ matrix.file }}
+
+ test-build-components-splitter:
+ name: Split components for testing into 20 groups maximum
+ runs-on: ubuntu-latest
+ needs:
+ - common
+ - list-components
+ if: github.event_name == 'pull_request' && fromJSON(needs.list-components.outputs.count) >= 100
+ outputs:
+ matrix: ${{ steps.split.outputs.components }}
+ steps:
+ - name: Check out code from GitHub
+ uses: actions/checkout@v4.1.7
+ - name: Split components into 20 groups
+ id: split
+ run: |
+ components=$(echo '${{ needs.list-components.outputs.components }}' | jq -c '.[]' | shuf | jq -s -c '[_nwise(20) | join(" ")]')
+ echo "components=$components" >> $GITHUB_OUTPUT
+
+ test-build-components-split:
+ name: Test split components
+ runs-on: ubuntu-latest
+ needs:
+ - common
+ - list-components
+ - test-build-components-splitter
+ if: github.event_name == 'pull_request' && fromJSON(needs.list-components.outputs.count) >= 100
+ strategy:
+ fail-fast: false
+ max-parallel: 4
+ matrix:
+ components: ${{ fromJson(needs.test-build-components-splitter.outputs.matrix) }}
+ steps:
+ - name: List components
+ run: echo ${{ matrix.components }}
+
+ - name: Install dependencies
+ run: |
+ sudo apt-get update
+ sudo apt-get install libsdl2-dev
+
+ - name: Check out code from GitHub
+ uses: actions/checkout@v4.1.7
+ - name: Restore Python
+ uses: ./.github/actions/restore-python
+ with:
+ python-version: ${{ env.DEFAULT_PYTHON }}
+ cache-key: ${{ needs.common.outputs.cache-key }}
+ - name: Validate config
+ run: |
+ . venv/bin/activate
+ for component in ${{ matrix.components }}; do
+ ./script/test_build_components -e config -c $component
+ done
+ - name: Compile config
+ run: |
+ . venv/bin/activate
+ mkdir build_cache
+ export PLATFORMIO_BUILD_CACHE_DIR=$PWD/build_cache
+ for component in ${{ matrix.components }}; do
+ ./script/test_build_components -e compile -c $component
+ done
+
ci-status:
name: CI Status
runs-on: ubuntu-latest
@@ -347,9 +493,11 @@ jobs:
- pylint
- pytest
- pyupgrade
- - yamllint
- - compile-tests
- clang-tidy
+ - list-components
+ - test-build-components
+ - test-build-components-splitter
+ - test-build-components-split
if: always()
steps:
- name: Success
@@ -357,4 +505,8 @@ jobs:
run: exit 0
- name: Failure
if: ${{ contains(needs.*.result, 'failure') }}
- run: exit 1
+ env:
+ JSON_DOC: ${{ toJSON(needs) }}
+ run: |
+ echo $JSON_DOC | jq
+ exit 1
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
new file mode 100644
index 0000000000..ddeb0a99d2
--- /dev/null
+++ b/.github/workflows/codeql.yml
@@ -0,0 +1,91 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL Advanced"
+
+on:
+ workflow_dispatch:
+ schedule:
+ - cron: "30 18 * * 4"
+
+jobs:
+ analyze:
+ name: Analyze (${{ matrix.language }})
+ # Runner size impacts CodeQL analysis time. To learn more, please see:
+ # - https://gh.io/recommended-hardware-resources-for-running-codeql
+ # - https://gh.io/supported-runners-and-hardware-resources
+ # - https://gh.io/using-larger-runners (GitHub.com only)
+ # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+ runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+ permissions:
+ # required for all workflows
+ security-events: write
+
+ # required to fetch internal or private CodeQL packs
+ packages: read
+
+ # only required for workflows in private repositories
+ actions: read
+ contents: read
+
+ strategy:
+ fail-fast: false
+ matrix:
+ include:
+ # - language: c-cpp
+ # build-mode: autobuild
+ - language: python
+ build-mode: none
+ # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
+ # Use `c-cpp` to analyze code written in C, C++ or both
+ # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+ # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+ # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+ # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+ # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+ # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ # Initializes the CodeQL tools for scanning.
+ - name: Initialize CodeQL
+ uses: github/codeql-action/init@v3
+ with:
+ languages: ${{ matrix.language }}
+ build-mode: ${{ matrix.build-mode }}
+ # If you wish to specify custom queries, you can do so here or in a config file.
+ # By default, queries listed here will override any specified in a config file.
+ # Prefix the list here with "+" to use these queries and those in the config file.
+
+ # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+ # queries: security-extended,security-and-quality
+
+ # If the analyze step fails for one of the languages you are analyzing with
+ # "We were unable to automatically build your code", modify the matrix above
+ # to set the build mode to "manual" for that language. Then modify this step
+ # to build your code.
+ # ℹ️ Command-line programs to run using the OS shell.
+ # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+ - if: matrix.build-mode == 'manual'
+ shell: bash
+ run: |
+ echo 'If you are using a "manual" build mode for one or more of the' \
+ 'languages you are analyzing, replace this with the commands to build' \
+ 'your code, for example:'
+ echo ' make bootstrap'
+ echo ' make release'
+ exit 1
+
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v3
+ with:
+ category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/lock.yml b/.github/workflows/lock.yml
index e762512ff6..ee10f49f61 100644
--- a/.github/workflows/lock.yml
+++ b/.github/workflows/lock.yml
@@ -1,7 +1,6 @@
---
name: Lock
-# yamllint disable-line rule:truthy
on:
schedule:
- cron: "30 0 * * *"
@@ -18,7 +17,7 @@ jobs:
lock:
runs-on: ubuntu-latest
steps:
- - uses: dessant/lock-threads@v4
+ - uses: dessant/lock-threads@v5.0.1
with:
pr-inactive-days: "1"
pr-lock-reason: ""
diff --git a/.github/workflows/needs-docs.yml b/.github/workflows/needs-docs.yml
new file mode 100644
index 0000000000..628b5cc5e3
--- /dev/null
+++ b/.github/workflows/needs-docs.yml
@@ -0,0 +1,24 @@
+name: Needs Docs
+
+on:
+ pull_request:
+ types: [labeled, unlabeled]
+
+jobs:
+ check:
+ name: Check
+ runs-on: ubuntu-latest
+ steps:
+ - name: Check for needs-docs label
+ uses: actions/github-script@v7.0.1
+ with:
+ script: |
+ const { data: labels } = await github.rest.issues.listLabelsOnIssue({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ issue_number: context.issue.number
+ });
+ const needsDocs = labels.find(label => label.name === 'needs-docs');
+ if (needsDocs) {
+ core.setFailed('Pull request needs docs');
+ }
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 7ebd04e793..82d7ae5ee8 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,7 +1,6 @@
---
name: Publish Release
-# yamllint disable-line rule:truthy
on:
workflow_dispatch:
release:
@@ -18,14 +17,16 @@ jobs:
runs-on: ubuntu-latest
outputs:
tag: ${{ steps.tag.outputs.tag }}
+ branch_build: ${{ steps.tag.outputs.branch_build }}
steps:
- - uses: actions/checkout@v3
+ - uses: actions/checkout@v4.1.7
- name: Get tag
id: tag
# yamllint disable rule:line-length
run: |
- if [[ "$GITHUB_EVENT_NAME" = "release" ]]; then
- TAG="${GITHUB_REF#refs/tags/}"
+ if [[ "${{ github.event_name }}" = "release" ]]; then
+ TAG="${{ github.event.release.tag_name}}"
+ BRANCH_BUILD="false"
else
TAG=$(cat esphome/const.py | sed -n -E "s/^__version__\s+=\s+\"(.+)\"$/\1/p")
today="$(date --utc '+%Y%m%d')"
@@ -33,77 +34,167 @@ jobs:
BRANCH=${GITHUB_REF#refs/heads/}
if [[ "$BRANCH" != "dev" ]]; then
TAG="${TAG}-${BRANCH}"
+ BRANCH_BUILD="true"
+ else
+ BRANCH_BUILD="false"
fi
fi
echo "tag=${TAG}" >> $GITHUB_OUTPUT
+ echo "branch_build=${BRANCH_BUILD}" >> $GITHUB_OUTPUT
# yamllint enable rule:line-length
deploy-pypi:
name: Build and publish to PyPi
if: github.repository == 'esphome/esphome' && github.event_name == 'release'
runs-on: ubuntu-latest
+ permissions:
+ contents: read
+ id-token: write
steps:
- - uses: actions/checkout@v3
+ - uses: actions/checkout@v4.1.7
- name: Set up Python
- uses: actions/setup-python@v4
+ uses: actions/setup-python@v5.3.0
with:
python-version: "3.x"
- name: Set up python environment
- run: |
- script/setup
- pip install setuptools wheel twine
- - name: Build
- run: python setup.py sdist bdist_wheel
- - name: Upload
env:
- TWINE_USERNAME: __token__
- TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
- run: twine upload dist/*
+ ESPHOME_NO_VENV: 1
+ run: script/setup
+ - name: Build
+ run: |-
+ pip3 install build
+ python3 -m build
+ - name: Publish
+ uses: pypa/gh-action-pypi-publish@v1.11.0
deploy-docker:
- name: Build and publish ESPHome ${{ matrix.image.title}}
+ name: Build ESPHome ${{ matrix.platform }}
if: github.repository == 'esphome/esphome'
permissions:
contents: read
packages: write
runs-on: ubuntu-latest
- continue-on-error: ${{ matrix.image.title == 'lint' }}
needs: [init]
+ strategy:
+ fail-fast: false
+ matrix:
+ platform:
+ - linux/amd64
+ - linux/arm/v7
+ - linux/arm64
+ steps:
+ - uses: actions/checkout@v4.1.7
+ - name: Set up Python
+ uses: actions/setup-python@v5.3.0
+ with:
+ python-version: "3.9"
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3.7.1
+ - name: Set up QEMU
+ if: matrix.platform != 'linux/amd64'
+ uses: docker/setup-qemu-action@v3.2.0
+
+ - name: Log in to docker hub
+ uses: docker/login-action@v3.3.0
+ with:
+ username: ${{ secrets.DOCKER_USER }}
+ password: ${{ secrets.DOCKER_PASSWORD }}
+ - name: Log in to the GitHub container registry
+ uses: docker/login-action@v3.3.0
+ with:
+ registry: ghcr.io
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+
+ - name: Build docker
+ uses: ./.github/actions/build-image
+ with:
+ platform: ${{ matrix.platform }}
+ target: docker
+ baseimg: docker
+ suffix: ""
+ version: ${{ needs.init.outputs.tag }}
+
+ - name: Build ha-addon
+ uses: ./.github/actions/build-image
+ with:
+ platform: ${{ matrix.platform }}
+ target: hassio
+ baseimg: hassio
+ suffix: "hassio"
+ version: ${{ needs.init.outputs.tag }}
+
+ - name: Build lint
+ uses: ./.github/actions/build-image
+ with:
+ platform: ${{ matrix.platform }}
+ target: lint
+ baseimg: docker
+ suffix: lint
+ version: ${{ needs.init.outputs.tag }}
+
+ - name: Sanitize platform name
+ id: sanitize
+ run: |
+ echo "${{ matrix.platform }}" | sed 's|/|-|g' > /tmp/platform
+ echo name=$(cat /tmp/platform) >> $GITHUB_OUTPUT
+
+ - name: Upload digests
+ uses: actions/upload-artifact@v4.4.3
+ with:
+ name: digests-${{ steps.sanitize.outputs.name }}
+ path: /tmp/digests
+ retention-days: 1
+
+ deploy-manifest:
+ name: Publish ESPHome ${{ matrix.image.title }} to ${{ matrix.registry }}
+ runs-on: ubuntu-latest
+ needs:
+ - init
+ - deploy-docker
+ if: github.repository == 'esphome/esphome'
+ permissions:
+ contents: read
+ packages: write
strategy:
fail-fast: false
matrix:
image:
- title: "ha-addon"
- suffix: "hassio"
target: "hassio"
- baseimg: "hassio"
+ suffix: "hassio"
- title: "docker"
- suffix: ""
target: "docker"
- baseimg: "docker"
+ suffix: ""
- title: "lint"
- suffix: "lint"
target: "lint"
- baseimg: "docker"
+ suffix: "lint"
+ registry:
+ - ghcr
+ - dockerhub
steps:
- - uses: actions/checkout@v3
- - name: Set up Python
- uses: actions/setup-python@v4
+ - uses: actions/checkout@v4.1.7
+
+ - name: Download digests
+ uses: actions/download-artifact@v4.1.8
with:
- python-version: "3.9"
+ pattern: digests-*
+ path: /tmp/digests
+ merge-multiple: true
- name: Set up Docker Buildx
- uses: docker/setup-buildx-action@v2
- - name: Set up QEMU
- uses: docker/setup-qemu-action@v2
+ uses: docker/setup-buildx-action@v3.7.1
- name: Log in to docker hub
- uses: docker/login-action@v2
+ if: matrix.registry == 'dockerhub'
+ uses: docker/login-action@v3.3.0
with:
username: ${{ secrets.DOCKER_USER }}
password: ${{ secrets.DOCKER_PASSWORD }}
- name: Log in to the GitHub container registry
- uses: docker/login-action@v2
+ if: matrix.registry == 'ghcr'
+ uses: docker/login-action@v3.3.0
with:
registry: ghcr.io
username: ${{ github.actor }}
@@ -112,44 +203,44 @@ jobs:
- name: Generate short tags
id: tags
run: |
- docker/generate_tags.py \
+ output=$(docker/generate_tags.py \
--tag "${{ needs.init.outputs.tag }}" \
- --suffix "${{ matrix.image.suffix }}"
+ --suffix "${{ matrix.image.suffix }}" \
+ --registry "${{ matrix.registry }}")
+ echo $output
+ for l in $output; do
+ echo $l >> $GITHUB_OUTPUT
+ done
- - name: Build and push
- uses: docker/build-push-action@v4
- with:
- context: .
- file: ./docker/Dockerfile
- platforms: linux/amd64,linux/arm/v7,linux/arm64
- target: ${{ matrix.image.target }}
- push: true
- # yamllint disable rule:line-length
- cache-from: type=registry,ref=ghcr.io/${{ steps.tags.outputs.image }}:cache-${{ steps.tags.outputs.channel }}
- cache-to: type=registry,ref=ghcr.io/${{ steps.tags.outputs.image }}:cache-${{ steps.tags.outputs.channel }},mode=max
- # yamllint enable rule:line-length
- tags: ${{ steps.tags.outputs.tags }}
- build-args: |
- BASEIMGTYPE=${{ matrix.image.baseimg }}
- BUILD_VERSION=${{ needs.init.outputs.tag }}
+ - name: Create manifest list and push
+ working-directory: /tmp/digests/${{ matrix.image.target }}/${{ matrix.registry }}
+ run: |
+ docker buildx imagetools create $(jq -Rcnr 'inputs | . / "," | map("-t " + .) | join(" ")' <<< "${{ steps.tags.outputs.tags}}") \
+ $(printf '${{ steps.tags.outputs.image }}@sha256:%s ' *)
deploy-ha-addon-repo:
- if: github.repository == 'esphome/esphome' && github.event_name == 'release'
+ if: github.repository == 'esphome/esphome' && needs.init.outputs.branch_build == 'false'
runs-on: ubuntu-latest
- needs: [deploy-docker]
+ needs:
+ - init
+ - deploy-manifest
steps:
- name: Trigger Workflow
- uses: actions/github-script@v6
+ uses: actions/github-script@v7.0.1
with:
github-token: ${{ secrets.DEPLOY_HA_ADDON_REPO_TOKEN }}
script: |
+ let description = "ESPHome";
+ if (context.eventName == "release") {
+ description = ${{ toJSON(github.event.release.body) }};
+ }
github.rest.actions.createWorkflowDispatch({
owner: "esphome",
repo: "home-assistant-addon",
workflow_id: "bump-version.yml",
ref: "main",
inputs: {
- version: "${{ github.event.release.tag_name }}",
- content: ${{ toJSON(github.event.release.body) }}
+ version: "${{ needs.init.outputs.tag }}",
+ content: description
}
})
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
index 3a3e390eef..95f275e5a4 100644
--- a/.github/workflows/stale.yml
+++ b/.github/workflows/stale.yml
@@ -1,7 +1,6 @@
---
name: Stale
-# yamllint disable-line rule:truthy
on:
schedule:
- cron: "30 0 * * *"
@@ -18,7 +17,7 @@ jobs:
stale:
runs-on: ubuntu-latest
steps:
- - uses: actions/stale@v8
+ - uses: actions/stale@v9.0.0
with:
days-before-pr-stale: 90
days-before-pr-close: 7
@@ -38,7 +37,7 @@ jobs:
close-issues:
runs-on: ubuntu-latest
steps:
- - uses: actions/stale@v8
+ - uses: actions/stale@v9.0.0
with:
days-before-pr-stale: -1
days-before-pr-close: -1
diff --git a/.github/workflows/sync-device-classes.yml b/.github/workflows/sync-device-classes.yml
index 896a0369ac..7a46d596a1 100644
--- a/.github/workflows/sync-device-classes.yml
+++ b/.github/workflows/sync-device-classes.yml
@@ -4,30 +4,27 @@ name: Synchronise Device Classes from Home Assistant
on:
workflow_dispatch:
schedule:
- - cron: '45 6 * * *'
-
-permissions:
- contents: write
- pull-requests: write
+ - cron: "45 6 * * *"
jobs:
sync:
name: Sync Device Classes
runs-on: ubuntu-latest
+ if: github.repository == 'esphome/esphome'
steps:
- name: Checkout
- uses: actions/checkout@v3
+ uses: actions/checkout@v4.1.7
- name: Checkout Home Assistant
- uses: actions/checkout@v3
+ uses: actions/checkout@v4.1.7
with:
repository: home-assistant/core
path: lib/home-assistant
- name: Setup Python
- uses: actions/setup-python@v4
+ uses: actions/setup-python@v5.3.0
with:
- python-version: 3.11
+ python-version: 3.12
- name: Install Home Assistant
run: |
@@ -38,17 +35,8 @@ jobs:
run: |
python ./script/sync-device_class.py
- - name: Get PR template
- id: pr-template-body
- run: |
- body=$(cat .github/PULL_REQUEST_TEMPLATE.md)
- delimiter="$(openssl rand -hex 8)"
- echo "body<<$delimiter" >> $GITHUB_OUTPUT
- echo "$body" >> $GITHUB_OUTPUT
- echo "$delimiter" >> $GITHUB_OUTPUT
-
- name: Commit changes
- uses: peter-evans/create-pull-request@v5
+ uses: peter-evans/create-pull-request@v7.0.5
with:
commit-message: "Synchronise Device Classes from Home Assistant"
committer: esphomebot
@@ -56,5 +44,5 @@ jobs:
branch: sync/device-classes
delete-branch: true
title: "Synchronise Device Classes from Home Assistant"
- body: ${{ steps.pr-template-body.outputs.body }}
+ body-path: .github/PULL_REQUEST_TEMPLATE.md
token: ${{ secrets.DEVICE_CLASS_SYNC_TOKEN }}
diff --git a/.github/workflows/yaml-lint.yml b/.github/workflows/yaml-lint.yml
new file mode 100644
index 0000000000..1c0b5f58ad
--- /dev/null
+++ b/.github/workflows/yaml-lint.yml
@@ -0,0 +1,25 @@
+---
+name: YAML lint
+
+on:
+ push:
+ branches: [dev, beta, release]
+ paths:
+ - "**.yaml"
+ - "**.yml"
+ pull_request:
+ paths:
+ - "**.yaml"
+ - "**.yml"
+
+jobs:
+ yamllint:
+ name: yamllint
+ runs-on: ubuntu-latest
+ steps:
+ - name: Check out code from GitHub
+ uses: actions/checkout@v4.1.7
+ - name: Run yamllint
+ uses: frenck/action-yamllint@v1.5.0
+ with:
+ strict: true
diff --git a/.gitignore b/.gitignore
index 71b66b2499..ad38e26fdd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -13,6 +13,12 @@ __pycache__/
# Intellij Idea
.idea
+# Eclipse
+.project
+.cproject
+.pydevproject
+.settings/
+
# Vim
*.swp
@@ -69,6 +75,9 @@ cov.xml
# pyenv
.python-version
+# asdf
+.tool-versions
+
# Environments
.env
.venv
@@ -129,4 +138,8 @@ tests/.esphome/
sdkconfig.*
!sdkconfig.defaults
-.tests/
\ No newline at end of file
+.tests/
+
+/components
+/managed_components
+
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 617d6f5d9f..aeb434167a 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -2,8 +2,17 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- - repo: https://github.com/psf/black
- rev: 23.3.0
+ - repo: https://github.com/astral-sh/ruff-pre-commit
+ # Ruff version.
+ rev: v0.5.4
+ hooks:
+ # Run the linter.
+ - id: ruff
+ args: [--fix]
+ # Run the formatter.
+ - id: ruff-format
+ - repo: https://github.com/psf/black-pre-commit-mirror
+ rev: 24.4.2
hooks:
- id: black
args:
@@ -11,7 +20,7 @@ repos:
- --quiet
files: ^((esphome|script|tests)/.+)?[^/]+\.py$
- repo: https://github.com/PyCQA/flake8
- rev: 6.0.0
+ rev: 6.1.0
hooks:
- id: flake8
additional_dependencies:
@@ -27,7 +36,23 @@ repos:
- --branch=release
- --branch=beta
- repo: https://github.com/asottile/pyupgrade
- rev: v3.4.0
+ rev: v3.15.2
hooks:
- id: pyupgrade
args: [--py39-plus]
+ - repo: https://github.com/adrienverge/yamllint.git
+ rev: v1.35.1
+ hooks:
+ - id: yamllint
+ - repo: https://github.com/pre-commit/mirrors-clang-format
+ rev: v13.0.1
+ hooks:
+ - id: clang-format
+ types_or: [c, c++]
+ - repo: local
+ hooks:
+ - id: pylint
+ name: pylint
+ entry: script/run-in-env.sh pylint
+ language: script
+ types: [python]
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
index 307dd496f0..acf1f29410 100644
--- a/.vscode/tasks.json
+++ b/.vscode/tasks.json
@@ -36,6 +36,24 @@
]
}
]
+ },
+ {
+ "label": "Generate proto files",
+ "type": "shell",
+ "command": "${command:python.interpreterPath}",
+ "args": [
+ "./script/api_protobuf/api_protobuf.py"
+ ],
+ "group": {
+ "kind": "build",
+ "isDefault": true
+ },
+ "presentation": {
+ "reveal": "never",
+ "close": true,
+ "panel": "new"
+ },
+ "problemMatcher": []
}
]
}
diff --git a/.yamllint b/.yamllint
index 4fea263214..22e9237f61 100644
--- a/.yamllint
+++ b/.yamllint
@@ -1,3 +1,19 @@
---
-ignore: |
- venv/
+extends: default
+
+ignore-from-file: .gitignore
+
+rules:
+ document-start: disable
+ empty-lines:
+ level: error
+ max: 1
+ max-start: 0
+ max-end: 1
+ indentation:
+ level: error
+ spaces: 2
+ indent-sequences: true
+ check-multi-line-strings: false
+ line-length: disable
+ truthy: disable
diff --git a/CODEOWNERS b/CODEOWNERS
index 1b75203654..8fbbacef59 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -6,143 +6,243 @@
# the integration's code owner is automatically notified.
# Core Code
-setup.py @esphome/core
+pyproject.toml @esphome/core
esphome/*.py @esphome/core
esphome/core/* @esphome/core
# Integrations
+esphome/components/a01nyub/* @MrSuicideParrot
+esphome/components/a02yyuw/* @TH-Braemer
esphome/components/absolute_humidity/* @DAVe3283
esphome/components/ac_dimmer/* @glmnet
esphome/components/adc/* @esphome/core
esphome/components/adc128s102/* @DeerMaximum
esphome/components/addressable_light/* @justfalter
+esphome/components/ade7880/* @kpfleming
+esphome/components/ade7953/* @angelnu
+esphome/components/ade7953_i2c/* @angelnu
+esphome/components/ade7953_spi/* @angelnu
+esphome/components/ads1118/* @solomondg1
+esphome/components/ags10/* @mak-42
+esphome/components/aic3204/* @kbx81
esphome/components/airthings_ble/* @jeromelaban
+esphome/components/airthings_wave_base/* @jeromelaban @kpfleming @ncareau
esphome/components/airthings_wave_mini/* @ncareau
esphome/components/airthings_wave_plus/* @jeromelaban
+esphome/components/alarm_control_panel/* @grahambrown11 @hwstar
+esphome/components/alpha3/* @jan-hofmeier
+esphome/components/am2315c/* @swoboda1337
esphome/components/am43/* @buxtronix
esphome/components/am43/cover/* @buxtronix
esphome/components/am43/sensor/* @buxtronix
esphome/components/analog_threshold/* @ianchi
esphome/components/animation/* @syndlex
esphome/components/anova/* @buxtronix
+esphome/components/apds9306/* @aodrenah
esphome/components/api/* @OttoWinter
+esphome/components/as5600/* @ammmze
+esphome/components/as5600/sensor/* @ammmze
esphome/components/as7341/* @mrgnr
esphome/components/async_tcp/* @OttoWinter
+esphome/components/at581x/* @X-Ryl669
esphome/components/atc_mithermometer/* @ahpohl
+esphome/components/atm90e26/* @danieltwagner
+esphome/components/atm90e32/* @circuitsetup @descipher
+esphome/components/audio/* @kahrendt
+esphome/components/audio_dac/* @kbx81
+esphome/components/axs15231/* @clydebarrow
esphome/components/b_parasite/* @rbaron
esphome/components/ballu/* @bazuchan
esphome/components/bang_bang/* @OttoWinter
esphome/components/bedjet/* @jhansche
esphome/components/bedjet/climate/* @jhansche
esphome/components/bedjet/fan/* @jhansche
+esphome/components/bedjet/sensor/* @javawizard @jhansche
+esphome/components/beken_spi_led_strip/* @Mat931
esphome/components/bh1750/* @OttoWinter
esphome/components/binary_sensor/* @esphome/core
+esphome/components/bk72xx/* @kuba2k2
+esphome/components/bl0906/* @athom-tech @jesserockz @tarontop
esphome/components/bl0939/* @ziceva
esphome/components/bl0940/* @tobias-
-esphome/components/bl0942/* @dbuezas
-esphome/components/ble_client/* @buxtronix
+esphome/components/bl0942/* @dbuezas @dwmw2
+esphome/components/ble_client/* @buxtronix @clydebarrow
esphome/components/bluetooth_proxy/* @jesserockz
+esphome/components/bme280_base/* @esphome/core
+esphome/components/bme280_spi/* @apbodrov
esphome/components/bme680_bsec/* @trvrnrth
-esphome/components/bmp3xx/* @martgras
+esphome/components/bme68x_bsec2/* @kbx81 @neffs
+esphome/components/bme68x_bsec2_i2c/* @kbx81 @neffs
+esphome/components/bmi160/* @flaviut
+esphome/components/bmp280_base/* @ademuri
+esphome/components/bmp280_i2c/* @ademuri
+esphome/components/bmp280_spi/* @ademuri
+esphome/components/bmp3xx/* @latonita
+esphome/components/bmp3xx_base/* @latonita @martgras
+esphome/components/bmp3xx_i2c/* @latonita
+esphome/components/bmp3xx_spi/* @latonita
+esphome/components/bmp581/* @kahrendt
esphome/components/bp1658cj/* @Cossid
esphome/components/bp5758d/* @Cossid
esphome/components/button/* @esphome/core
+esphome/components/bytebuffer/* @clydebarrow
esphome/components/canbus/* @danielschramm @mvturnho
-esphome/components/cap1188/* @MrEditor97
+esphome/components/cap1188/* @mreditor97
esphome/components/captive_portal/* @OttoWinter
esphome/components/ccs811/* @habbie
esphome/components/cd74hc4067/* @asoehlke
+esphome/components/ch422g/* @clydebarrow @jesterret
esphome/components/climate/* @esphome/core
esphome/components/climate_ir/* @glmnet
esphome/components/color_temperature/* @jesserockz
+esphome/components/combination/* @Cat-Ion @kahrendt
esphome/components/coolix/* @glmnet
esphome/components/copy/* @OttoWinter
esphome/components/cover/* @esphome/core
esphome/components/cs5460a/* @balrog-kun
esphome/components/cse7761/* @berfenger
+esphome/components/cst226/* @clydebarrow
+esphome/components/cst816/* @clydebarrow
esphome/components/ct_clamp/* @jesserockz
esphome/components/current_based/* @djwmarcx
esphome/components/dac7678/* @NickB1
+esphome/components/daikin_arc/* @MagicBear
esphome/components/daikin_brc/* @hagak
+esphome/components/dallas_temp/* @ssieb
esphome/components/daly_bms/* @s1lvi0
esphome/components/dashboard_import/* @esphome/core
+esphome/components/datetime/* @jesserockz @rfdarter
esphome/components/debug/* @OttoWinter
esphome/components/delonghi/* @grob6000
esphome/components/dfplayer/* @glmnet
+esphome/components/dfrobot_sen0395/* @niklasweber
esphome/components/dht/* @OttoWinter
esphome/components/display_menu_base/* @numo68
esphome/components/dps310/* @kbx81
esphome/components/ds1307/* @badbadc0ffee
esphome/components/dsmr/* @glmnet @zuidwijk
+esphome/components/duty_time/* @dudanov
esphome/components/ee895/* @Stock-M
-esphome/components/ektf2232/* @jesserockz
+esphome/components/ektf2232/touchscreen/* @jesserockz
+esphome/components/emc2101/* @ellull
+esphome/components/emmeti/* @E440QF
+esphome/components/ens160/* @latonita
+esphome/components/ens160_base/* @latonita @vincentscode
+esphome/components/ens160_i2c/* @latonita
+esphome/components/ens160_spi/* @latonita
esphome/components/ens210/* @itn3rd77
+esphome/components/es8311/* @kahrendt @kroimon
esphome/components/esp32/* @esphome/core
-esphome/components/esp32_ble/* @jesserockz
+esphome/components/esp32_ble/* @Rapsssito @jesserockz
esphome/components/esp32_ble_client/* @jesserockz
-esphome/components/esp32_ble_server/* @jesserockz
+esphome/components/esp32_ble_server/* @Rapsssito @clydebarrow @jesserockz
esphome/components/esp32_camera_web_server/* @ayufan
esphome/components/esp32_can/* @Sympatron
esphome/components/esp32_improv/* @jesserockz
+esphome/components/esp32_rmt/* @jesserockz
esphome/components/esp32_rmt_led_strip/* @jesserockz
esphome/components/esp8266/* @esphome/core
esphome/components/ethernet_info/* @gtjadsonsantos
+esphome/components/event/* @nohat
esphome/components/exposure_notifications/* @OttoWinter
esphome/components/ezo/* @ssieb
esphome/components/ezo_pmp/* @carlos-sarmiento
esphome/components/factory_reset/* @anatoly-savchenkov
esphome/components/fastled_base/* @OttoWinter
esphome/components/feedback/* @ianchi
-esphome/components/fingerprint_grow/* @OnFreund @loongyh
+esphome/components/fingerprint_grow/* @OnFreund @alexborro @loongyh
+esphome/components/font/* @clydebarrow @esphome/core
esphome/components/fs3000/* @kahrendt
+esphome/components/ft5x06/* @clydebarrow
+esphome/components/ft63x6/* @gpambrozio
+esphome/components/gcja5/* @gcormier
+esphome/components/gdk101/* @Szewcson
esphome/components/globals/* @esphome/core
+esphome/components/gp2y1010au0f/* @zry98
esphome/components/gp8403/* @jesserockz
esphome/components/gpio/* @esphome/core
+esphome/components/gpio/one_wire/* @ssieb
esphome/components/gps/* @coogle
esphome/components/graph/* @synco
+esphome/components/graphical_display_menu/* @MrMDavidson
+esphome/components/gree/* @orestismers
+esphome/components/grove_gas_mc_v2/* @YorkshireIoT
+esphome/components/grove_tb6612fng/* @max246
esphome/components/growatt_solar/* @leeuwte
-esphome/components/haier/* @Yarikx
+esphome/components/gt911/* @clydebarrow @jesserockz
+esphome/components/haier/* @paveldn
+esphome/components/haier/binary_sensor/* @paveldn
+esphome/components/haier/button/* @paveldn
+esphome/components/haier/sensor/* @paveldn
+esphome/components/haier/switch/* @paveldn
+esphome/components/haier/text_sensor/* @paveldn
esphome/components/havells_solar/* @sourabhjaiswal
esphome/components/hbridge/fan/* @WeekendWarrior
esphome/components/hbridge/light/* @DotNetDann
+esphome/components/he60r/* @clydebarrow
esphome/components/heatpumpir/* @rob-deutsch
esphome/components/hitachi_ac424/* @sourabhjaiswal
esphome/components/hm3301/* @freekode
-esphome/components/homeassistant/* @OttoWinter
+esphome/components/hmac_md5/* @dwmw2
+esphome/components/homeassistant/* @OttoWinter @esphome/core
+esphome/components/homeassistant/number/* @landonr
+esphome/components/homeassistant/switch/* @Links2004
+esphome/components/honeywell_hih_i2c/* @Benichou34
esphome/components/honeywellabp/* @RubyBailey
-esphome/components/host/* @esphome/core
+esphome/components/honeywellabp2_i2c/* @jpfaff
+esphome/components/host/* @clydebarrow @esphome/core
+esphome/components/host/time/* @clydebarrow
esphome/components/hrxl_maxsonar_wr/* @netmikey
esphome/components/hte501/* @Stock-M
+esphome/components/http_request/ota/* @oarcher
+esphome/components/http_request/update/* @jesserockz
+esphome/components/htu31d/* @betterengineering
esphome/components/hydreon_rgxx/* @functionpointer
esphome/components/hyt271/* @Philippe12
esphome/components/i2c/* @esphome/core
+esphome/components/i2c_device/* @gabest11
esphome/components/i2s_audio/* @jesserockz
esphome/components/i2s_audio/media_player/* @jesserockz
esphome/components/i2s_audio/microphone/* @jesserockz
-esphome/components/i2s_audio/speaker/* @jesserockz
-esphome/components/ili9xxx/* @nielsnl68
+esphome/components/i2s_audio/speaker/* @jesserockz @kahrendt
+esphome/components/iaqcore/* @yozik04
+esphome/components/ili9xxx/* @clydebarrow @nielsnl68
esphome/components/improv_base/* @esphome/core
esphome/components/improv_serial/* @esphome/core
-esphome/components/ina260/* @MrEditor97
+esphome/components/ina226/* @Sergio303 @latonita
+esphome/components/ina260/* @mreditor97
+esphome/components/ina2xx_base/* @latonita
+esphome/components/ina2xx_i2c/* @latonita
+esphome/components/ina2xx_spi/* @latonita
esphome/components/inkbird_ibsth1_mini/* @fkirill
esphome/components/inkplate6/* @jesserockz
esphome/components/integration/* @OttoWinter
esphome/components/internal_temperature/* @Mat931
esphome/components/interval/* @esphome/core
+esphome/components/jsn_sr04t/* @Mafus1
esphome/components/json/* @OttoWinter
-esphome/components/kalman_combinator/* @Cat-Ion
+esphome/components/kamstrup_kmp/* @cfeenstra1024
esphome/components/key_collector/* @ssieb
esphome/components/key_provider/* @ssieb
esphome/components/kuntze/* @ssieb
esphome/components/lcd_menu/* @numo68
-esphome/components/ld2410/* @sebcaps
+esphome/components/ld2410/* @regevbr @sebcaps
+esphome/components/ld2420/* @descipher
esphome/components/ledc/* @OttoWinter
+esphome/components/libretiny/* @kuba2k2
+esphome/components/libretiny_pwm/* @kuba2k2
esphome/components/light/* @esphome/core
+esphome/components/lightwaverf/* @max246
esphome/components/lilygo_t5_47/touchscreen/* @jesserockz
esphome/components/lock/* @esphome/core
esphome/components/logger/* @esphome/core
-esphome/components/ltr390/* @sjtrny
+esphome/components/ltr390/* @latonita @sjtrny
+esphome/components/ltr501/* @latonita
+esphome/components/ltr_als_ps/* @latonita
+esphome/components/lvgl/* @clydebarrow
+esphome/components/m5stack_8angle/* @rnauber
esphome/components/matrix_keypad/* @ssieb
+esphome/components/max17043/* @blacknell
esphome/components/max31865/* @DAVe3283
esphome/components/max44009/* @berfenger
esphome/components/max6956/* @looping40
@@ -159,11 +259,13 @@ esphome/components/mcp2515/* @danielschramm @mvturnho
esphome/components/mcp3204/* @rsumner
esphome/components/mcp4728/* @berfenger
esphome/components/mcp47a1/* @jesserockz
-esphome/components/mcp9600/* @MrEditor97
+esphome/components/mcp9600/* @mreditor97
esphome/components/mcp9808/* @k7hpn
esphome/components/md5/* @esphome/core
esphome/components/mdns/* @esphome/core
esphome/components/media_player/* @jesserockz
+esphome/components/micro_wake_word/* @jesserockz @kahrendt
+esphome/components/micronova/* @jorre05
esphome/components/microphone/* @jesserockz
esphome/components/mics_4514/* @jesserockz
esphome/components/midea/* @dudanov
@@ -172,6 +274,7 @@ esphome/components/mitsubishi/* @RubyBailey
esphome/components/mlx90393/* @functionpointer
esphome/components/mlx90614/* @jesserockz
esphome/components/mmc5603/* @benhoff
+esphome/components/mmc5983/* @agoode
esphome/components/modbus_controller/* @martgras
esphome/components/modbus_controller/binary_sensor/* @martgras
esphome/components/modbus_controller/number/* @martgras
@@ -185,59 +288,84 @@ esphome/components/mopeka_pro_check/* @spbrogan
esphome/components/mopeka_std_check/* @Fabian-Schmidt
esphome/components/mpl3115a2/* @kbickar
esphome/components/mpu6886/* @fabaff
+esphome/components/ms8607/* @e28eta
+esphome/components/nau7802/* @cujomalainey
esphome/components/network/* @esphome/core
-esphome/components/nextion/* @senexcrenshaw
+esphome/components/nextion/* @edwardtfn @senexcrenshaw
esphome/components/nextion/binary_sensor/* @senexcrenshaw
esphome/components/nextion/sensor/* @senexcrenshaw
esphome/components/nextion/switch/* @senexcrenshaw
esphome/components/nextion/text_sensor/* @senexcrenshaw
-esphome/components/nfc/* @jesserockz
+esphome/components/nfc/* @jesserockz @kbx81
+esphome/components/noblex/* @AGalfra
+esphome/components/npi19/* @bakerkj
esphome/components/number/* @esphome/core
+esphome/components/one_wire/* @ssieb
+esphome/components/online_image/* @guillempages
+esphome/components/opentherm/* @olegtarasov
esphome/components/ota/* @esphome/core
esphome/components/output/* @esphome/core
esphome/components/pca6416a/* @Mat931
-esphome/components/pca9554/* @hwstar
+esphome/components/pca9554/* @clydebarrow @hwstar
esphome/components/pcf85063/* @brogon
+esphome/components/pcf8563/* @KoenBreeman
esphome/components/pid/* @OttoWinter
esphome/components/pipsolar/* @andreashergert1984
esphome/components/pm1006/* @habbie
esphome/components/pmsa003i/* @sjtrny
+esphome/components/pmwcs3/* @SeByDocKy
esphome/components/pn532/* @OttoWinter @jesserockz
esphome/components/pn532_i2c/* @OttoWinter @jesserockz
esphome/components/pn532_spi/* @OttoWinter @jesserockz
+esphome/components/pn7150/* @jesserockz @kbx81
+esphome/components/pn7150_i2c/* @jesserockz @kbx81
+esphome/components/pn7160/* @jesserockz @kbx81
+esphome/components/pn7160_i2c/* @jesserockz @kbx81
+esphome/components/pn7160_spi/* @jesserockz @kbx81
esphome/components/power_supply/* @esphome/core
esphome/components/preferences/* @esphome/core
esphome/components/psram/* @esphome/core
-esphome/components/pulse_meter/* @cstaahl @stevebaxter
+esphome/components/pulse_meter/* @TrentHouliston @cstaahl @stevebaxter
esphome/components/pvvx_mithermometer/* @pasiz
+esphome/components/pylontech/* @functionpointer
esphome/components/qmp6988/* @andrewpc
esphome/components/qr_code/* @wjtje
+esphome/components/qspi_dbi/* @clydebarrow
+esphome/components/qwiic_pir/* @kahrendt
esphome/components/radon_eye_ble/* @jeffeb3
esphome/components/radon_eye_rd200/* @jeffeb3
esphome/components/rc522/* @glmnet
esphome/components/rc522_i2c/* @glmnet
esphome/components/rc522_spi/* @glmnet
+esphome/components/resistance_sampler/* @jesserockz
esphome/components/restart/* @esphome/core
esphome/components/rf_bridge/* @jesserockz
esphome/components/rgbct/* @jesserockz
esphome/components/rp2040/* @jesserockz
esphome/components/rp2040_pio_led_strip/* @Papa-DMan
esphome/components/rp2040_pwm/* @jesserockz
+esphome/components/rpi_dpi_rgb/* @clydebarrow
+esphome/components/rtl87xx/* @kuba2k2
esphome/components/rtttl/* @glmnet
-esphome/components/safe_mode/* @jsuanet @paulmonigatti
+esphome/components/safe_mode/* @jsuanet @kbx81 @paulmonigatti
esphome/components/scd4x/* @martgras @sjtrny
esphome/components/script/* @esphome/core
+esphome/components/sdl/* @clydebarrow
esphome/components/sdm_meter/* @jesserockz @polyfaces
esphome/components/sdp3x/* @Azimath
+esphome/components/seeed_mr24hpc1/* @limengdu
esphome/components/selec_meter/* @sourabhjaiswal
esphome/components/select/* @esphome/core
+esphome/components/sen0321/* @notjj
esphome/components/sen21231/* @shreyaskarnik
esphome/components/sen5x/* @martgras
esphome/components/sensirion_common/* @martgras
esphome/components/sensor/* @esphome/core
+esphome/components/sfa30/* @ghsensdev
esphome/components/sgp40/* @SenexCrenshaw
esphome/components/sgp4x/* @SenexCrenshaw @martgras
esphome/components/shelly_dimmer/* @edge90 @rnauber
+esphome/components/sht3xd/* @mrtoy-me
esphome/components/sht4x/* @sjtrny
esphome/components/shutdown/* @esphome/core @jsuanet
esphome/components/sigma_delta_output/* @Cat-Ion
@@ -251,8 +379,10 @@ esphome/components/smt100/* @piechade
esphome/components/sn74hc165/* @jesserockz
esphome/components/socket/* @esphome/core
esphome/components/sonoff_d1/* @anatoly-savchenkov
-esphome/components/speaker/* @jesserockz
-esphome/components/spi/* @esphome/core
+esphome/components/speaker/* @jesserockz @kahrendt
+esphome/components/spi/* @clydebarrow @esphome/core
+esphome/components/spi_device/* @clydebarrow
+esphome/components/spi_led_strip/* @clydebarrow
esphome/components/sprinkler/* @kbx81
esphome/components/sps30/* @martgras
esphome/components/ssd1322_base/* @kbx81
@@ -266,20 +396,35 @@ esphome/components/ssd1331_base/* @kbx81
esphome/components/ssd1331_spi/* @kbx81
esphome/components/ssd1351_base/* @kbx81
esphome/components/ssd1351_spi/* @kbx81
+esphome/components/st7567_base/* @latonita
+esphome/components/st7567_i2c/* @latonita
+esphome/components/st7567_spi/* @latonita
+esphome/components/st7701s/* @clydebarrow
esphome/components/st7735/* @SenexCrenshaw
esphome/components/st7789v/* @kbx81
esphome/components/st7920/* @marsjan155
+esphome/components/statsd/* @Links2004
esphome/components/substitutions/* @esphome/core
esphome/components/sun/* @OttoWinter
+esphome/components/sun_gtil2/* @Mat931
esphome/components/switch/* @esphome/core
esphome/components/t6615/* @tylermenezes
+esphome/components/tc74/* @sethgirvan
esphome/components/tca9548a/* @andreashergert1984
+esphome/components/tca9555/* @mobrembski
esphome/components/tcl112/* @glmnet
esphome/components/tee501/* @Stock-M
esphome/components/teleinfo/* @0hax
+esphome/components/tem3200/* @bakerkj
+esphome/components/template/alarm_control_panel/* @grahambrown11 @hwstar
+esphome/components/template/datetime/* @rfdarter
+esphome/components/template/event/* @nohat
+esphome/components/template/fan/* @ssieb
+esphome/components/text/* @mauritskorse
esphome/components/thermostat/* @kbx81
esphome/components/time/* @OttoWinter
esphome/components/tlc5947/* @rnauber
+esphome/components/tlc5971/* @IJIJI
esphome/components/tm1621/* @Philippe12
esphome/components/tm1637/* @glmnet
esphome/components/tm1638/* @skykingjwc
@@ -289,8 +434,9 @@ esphome/components/tmp1075/* @sybrenstuvel
esphome/components/tmp117/* @Azimath
esphome/components/tof10120/* @wstrzalka
esphome/components/toshiba/* @kbx81
-esphome/components/touchscreen/* @jesserockz
+esphome/components/touchscreen/* @jesserockz @nielsnl68
esphome/components/tsl2591/* @wjcarpenter
+esphome/components/tt21100/* @kroimon
esphome/components/tuya/binary_sensor/* @jesserockz
esphome/components/tuya/climate/* @jesserockz
esphome/components/tuya/number/* @frankiboy1
@@ -299,21 +445,49 @@ esphome/components/tuya/sensor/* @jesserockz
esphome/components/tuya/switch/* @jesserockz
esphome/components/tuya/text_sensor/* @dentra
esphome/components/uart/* @esphome/core
+esphome/components/uart/button/* @ssieb
+esphome/components/udp/* @clydebarrow
esphome/components/ufire_ec/* @pvizeli
esphome/components/ufire_ise/* @pvizeli
esphome/components/ultrasonic/* @OttoWinter
+esphome/components/update/* @jesserockz
+esphome/components/uponor_smatrix/* @kroimon
+esphome/components/valve/* @esphome/core
esphome/components/vbus/* @ssieb
+esphome/components/veml3235/* @kbx81
+esphome/components/veml7700/* @latonita
esphome/components/version/* @esphome/core
esphome/components/voice_assistant/* @jesserockz
-esphome/components/wake_on_lan/* @willwill2will54
+esphome/components/wake_on_lan/* @clydebarrow @willwill2will54
+esphome/components/watchdog/* @oarcher
+esphome/components/waveshare_epaper/* @clydebarrow
esphome/components/web_server_base/* @OttoWinter
+esphome/components/web_server_idf/* @dentra
+esphome/components/weikai/* @DrCoolZic
+esphome/components/weikai_i2c/* @DrCoolZic
+esphome/components/weikai_spi/* @DrCoolZic
esphome/components/whirlpool/* @glmnet
esphome/components/whynter/* @aeonsablaze
esphome/components/wiegand/* @ssieb
+esphome/components/wireguard/* @droscy @lhoracek @thomas0bernard
+esphome/components/wk2132_i2c/* @DrCoolZic
+esphome/components/wk2132_spi/* @DrCoolZic
+esphome/components/wk2168_i2c/* @DrCoolZic
+esphome/components/wk2168_spi/* @DrCoolZic
+esphome/components/wk2204_i2c/* @DrCoolZic
+esphome/components/wk2204_spi/* @DrCoolZic
+esphome/components/wk2212_i2c/* @DrCoolZic
+esphome/components/wk2212_spi/* @DrCoolZic
esphome/components/wl_134/* @hobbypunk90
esphome/components/x9c/* @EtienneMD
+esphome/components/xgzp68xx/* @gcormier
+esphome/components/xiaomi_hhccjcy10/* @fariouche
+esphome/components/xiaomi_lywsd02mmc/* @juanluss31
esphome/components/xiaomi_lywsd03mmc/* @ahpohl
esphome/components/xiaomi_mhoc303/* @drug123
esphome/components/xiaomi_mhoc401/* @vevsvevs
esphome/components/xiaomi_rtcgq02lm/* @jesserockz
-esphome/components/xpt2046/* @nielsnl68 @numo68
+esphome/components/xl9535/* @mreditor97
+esphome/components/xpt2046/touchscreen/* @nielsnl68 @numo68
+esphome/components/zhlt01/* @cfeenstra1024
+esphome/components/zio_ultrasonic/* @kahrendt
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ec23656763..1c92d91159 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -10,5 +10,3 @@ Things to note when contributing:
for more information.
- Please also update the tests in the `tests/` folder. You can do so by just adding a line in one of the YAML files
which checks if your new feature compiles correctly.
- - Sometimes I will let pull requests linger because I'm not 100% sure about them. Please feel free to ping
- me after some time.
diff --git a/README.md b/README.md
index bb6fb37d3a..da1b2b3650 100644
--- a/README.md
+++ b/README.md
@@ -7,3 +7,5 @@
For issues, please go to [the issue tracker](https://github.com/esphome/issues/issues).
For feature requests, please see [feature requests](https://github.com/esphome/feature-requests/issues).
+
+[![ESPHome - A project from the Open Home Foundation](https://www.openhomefoundation.org/badges/esphome.png)](https://www.openhomefoundation.org/)
diff --git a/docker/Dockerfile b/docker/Dockerfile
index 95b6677815..44ee879a12 100644
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@@ -5,30 +5,41 @@
# One of "docker", "hassio"
ARG BASEIMGTYPE=docker
+
# https://github.com/hassio-addons/addon-debian-base/releases
-FROM ghcr.io/hassio-addons/debian-base:6.2.3 AS base-hassio
-# https://hub.docker.com/_/debian?tab=tags&page=1&name=bullseye
-FROM debian:bullseye-20230208-slim AS base-docker
+FROM ghcr.io/hassio-addons/debian-base:7.2.0 AS base-hassio
+# https://hub.docker.com/_/debian?tab=tags&page=1&name=bookworm
+FROM debian:12.2-slim AS base-docker
FROM base-${BASEIMGTYPE} AS base
+
ARG TARGETARCH
ARG TARGETVARIANT
+
+# Note that --break-system-packages is used below because
+# https://peps.python.org/pep-0668/ added a safety check that prevents
+# installing packages with the same name as a system package. This is
+# not a problem for us because we are not concerned about overwriting
+# system packages because we are running in an isolated container.
+
RUN \
apt-get update \
# Use pinned versions so that we get updates with build caching
&& apt-get install -y --no-install-recommends \
- python3=3.9.2-3 \
- python3-pip=20.3.4-4+deb11u1 \
- python3-setuptools=52.0.0-4 \
- python3-pil=8.1.2+dfsg-0.3+deb11u1 \
- python3-cryptography=3.3.2-1 \
- python3-venv=3.9.2-3 \
- iputils-ping=3:20210202-1 \
- git=1:2.30.2-1+deb11u2 \
- curl=7.74.0-1.3+deb11u7 \
- openssh-client=1:8.4p1-5+deb11u1 \
+ python3-pip=23.0.1+dfsg-1 \
+ python3-setuptools=66.1.1-1 \
+ python3-venv=3.11.2-1+b1 \
+ python3-wheel=0.38.4-2 \
+ iputils-ping=3:20221126-1 \
+ git=1:2.39.5-0+deb12u1 \
+ curl=7.88.1-10+deb12u7 \
+ openssh-client=1:9.2p1-2+deb12u3 \
+ python3-cffi=1.15.1-5 \
+ libcairo2=1.16.0-7 \
+ libmagic1=1:5.44-3 \
+ patch=2.7.6-7 \
&& rm -rf \
/tmp/* \
/var/{cache,log}/* \
@@ -45,14 +56,18 @@ ENV \
# See: https://unix.stackexchange.com/questions/553743/correct-way-to-add-lib-ld-linux-so-3-in-debian
RUN \
if [ "$TARGETARCH$TARGETVARIANT" = "armv7" ]; then \
- ln -s /lib/arm-linux-gnueabihf/ld-linux.so.3 /lib/ld-linux.so.3; \
+ ln -s /lib/arm-linux-gnueabihf/ld-linux-armhf.so.3 /lib/ld-linux.so.3; \
fi
RUN \
# Ubuntu python3-pip is missing wheel
- pip3 install --no-cache-dir \
- wheel==0.37.1 \
- platformio==6.1.7 \
+ if [ "$TARGETARCH$TARGETVARIANT" = "armv7" ]; then \
+ export PIP_EXTRA_INDEX_URL="https://www.piwheels.org/simple"; \
+ fi; \
+ pip3 install \
+ --break-system-packages --no-cache-dir \
+ # Keep platformio version in sync with requirements.txt
+ platformio==6.1.16 \
# Change some platformio settings
&& platformio settings set enable_telemetry No \
&& platformio settings set check_platformio_interval 1000000 \
@@ -60,10 +75,57 @@ RUN \
# First install requirements to leverage caching when requirements don't change
-COPY requirements.txt requirements_optional.txt script/platformio_install_deps.py platformio.ini /
-RUN \
- pip3 install --no-cache-dir -r /requirements.txt -r /requirements_optional.txt \
- && /platformio_install_deps.py /platformio.ini --libraries
+# tmpfs is for https://github.com/rust-lang/cargo/issues/8719
+
+COPY requirements.txt requirements_optional.txt /
+RUN --mount=type=tmpfs,target=/root/.cargo <}``, and that dict is then handed off to the specified validators.
+ """
return maybe_conf(CONF_ID, *validators)
def maybe_conf(conf, *validators):
+ """Allow a raw value to be specified in place of a config block.
+ If the value that's being validated is a dictionary, it's passed as-is to the specified validators. Otherwise, it's
+ wrapped in a dict that looks like ``{: }``, and that dict is then handed off to the specified
+ validators.
+ (This is a general case of ``maybe_simple_id`` that allows the wrapping key to be something other than ``id``.)
+ """
validator = cv.All(*validators)
@schema_extractor("maybe")
@@ -62,6 +75,13 @@ def validate_potentially_and_condition(value):
return validate_condition(value)
+def validate_potentially_or_condition(value):
+ if isinstance(value, list):
+ with cv.remove_prepend_path(["or"]):
+ return validate_condition({"or": value})
+ return validate_condition(value)
+
+
DelayAction = cg.esphome_ns.class_("DelayAction", Action, cg.Component)
LambdaAction = cg.esphome_ns.class_("LambdaAction", Action)
IfAction = cg.esphome_ns.class_("IfAction", Action)
@@ -69,6 +89,8 @@ WhileAction = cg.esphome_ns.class_("WhileAction", Action)
RepeatAction = cg.esphome_ns.class_("RepeatAction", Action)
WaitUntilAction = cg.esphome_ns.class_("WaitUntilAction", Action, cg.Component)
UpdateComponentAction = cg.esphome_ns.class_("UpdateComponentAction", Action)
+SuspendComponentAction = cg.esphome_ns.class_("SuspendComponentAction", Action)
+ResumeComponentAction = cg.esphome_ns.class_("ResumeComponentAction", Action)
Automation = cg.esphome_ns.class_("Automation")
LambdaCondition = cg.esphome_ns.class_("LambdaCondition", Condition)
@@ -138,6 +160,7 @@ AUTOMATION_SCHEMA = cv.Schema(
AndCondition = cg.esphome_ns.class_("AndCondition", Condition)
OrCondition = cg.esphome_ns.class_("OrCondition", Condition)
NotCondition = cg.esphome_ns.class_("NotCondition", Condition)
+XorCondition = cg.esphome_ns.class_("XorCondition", Condition)
@register_condition("and", AndCondition, validate_condition_list)
@@ -152,12 +175,30 @@ async def or_condition_to_code(config, condition_id, template_arg, args):
return cg.new_Pvariable(condition_id, template_arg, conditions)
+@register_condition("all", AndCondition, validate_condition_list)
+async def all_condition_to_code(config, condition_id, template_arg, args):
+ conditions = await build_condition_list(config, template_arg, args)
+ return cg.new_Pvariable(condition_id, template_arg, conditions)
+
+
+@register_condition("any", OrCondition, validate_condition_list)
+async def any_condition_to_code(config, condition_id, template_arg, args):
+ conditions = await build_condition_list(config, template_arg, args)
+ return cg.new_Pvariable(condition_id, template_arg, conditions)
+
+
@register_condition("not", NotCondition, validate_potentially_and_condition)
async def not_condition_to_code(config, condition_id, template_arg, args):
condition = await build_condition(config, template_arg, args)
return cg.new_Pvariable(condition_id, template_arg, condition)
+@register_condition("xor", XorCondition, validate_condition_list)
+async def xor_condition_to_code(config, condition_id, template_arg, args):
+ conditions = await build_condition_list(config, template_arg, args)
+ return cg.new_Pvariable(condition_id, template_arg, conditions)
+
+
@register_condition("lambda", LambdaCondition, cv.returning_lambda)
async def lambda_condition_to_code(config, condition_id, template_arg, args):
lambda_ = await cg.process_lambda(config, args, return_type=bool)
@@ -203,15 +244,21 @@ async def delay_action_to_code(config, action_id, template_arg, args):
IfAction,
cv.All(
{
- cv.Required(CONF_CONDITION): validate_potentially_and_condition,
+ cv.Exclusive(
+ CONF_CONDITION, CONF_CONDITION
+ ): validate_potentially_and_condition,
+ cv.Exclusive(CONF_ANY, CONF_CONDITION): validate_potentially_or_condition,
+ cv.Exclusive(CONF_ALL, CONF_CONDITION): validate_potentially_and_condition,
cv.Optional(CONF_THEN): validate_action_list,
cv.Optional(CONF_ELSE): validate_action_list,
},
cv.has_at_least_one_key(CONF_THEN, CONF_ELSE),
+ cv.has_at_least_one_key(CONF_CONDITION, CONF_ANY, CONF_ALL),
),
)
async def if_action_to_code(config, action_id, template_arg, args):
- conditions = await build_condition(config[CONF_CONDITION], template_arg, args)
+ cond_conf = next(el for el in config if el in (CONF_ANY, CONF_ALL, CONF_CONDITION))
+ conditions = await build_condition(config[cond_conf], template_arg, args)
var = cg.new_Pvariable(action_id, template_arg, conditions)
if CONF_THEN in config:
actions = await build_action_list(config[CONF_THEN], template_arg, args)
@@ -303,6 +350,41 @@ async def component_update_action_to_code(config, action_id, template_arg, args)
return cg.new_Pvariable(action_id, template_arg, comp)
+@register_action(
+ "component.suspend",
+ SuspendComponentAction,
+ maybe_simple_id(
+ {
+ cv.Required(CONF_ID): cv.use_id(cg.PollingComponent),
+ }
+ ),
+)
+async def component_suspend_action_to_code(config, action_id, template_arg, args):
+ comp = await cg.get_variable(config[CONF_ID])
+ return cg.new_Pvariable(action_id, template_arg, comp)
+
+
+@register_action(
+ "component.resume",
+ ResumeComponentAction,
+ maybe_simple_id(
+ {
+ cv.Required(CONF_ID): cv.use_id(cg.PollingComponent),
+ cv.Optional(CONF_UPDATE_INTERVAL): cv.templatable(
+ cv.positive_time_period_milliseconds
+ ),
+ }
+ ),
+)
+async def component_resume_action_to_code(config, action_id, template_arg, args):
+ comp = await cg.get_variable(config[CONF_ID])
+ var = cg.new_Pvariable(action_id, template_arg, comp)
+ if CONF_UPDATE_INTERVAL in config:
+ template_ = await cg.templatable(config[CONF_UPDATE_INTERVAL], args, int)
+ cg.add(var.set_update_interval(template_))
+ return var
+
+
async def build_action(full_config, template_arg, args):
registry_entry, config = cg.extract_registry_entry_config(
ACTION_REGISTRY, full_config
diff --git a/esphome/codegen.py b/esphome/codegen.py
index 43b44256e2..bfa1683ce7 100644
--- a/esphome/codegen.py
+++ b/esphome/codegen.py
@@ -8,83 +8,86 @@
# want to break suddenly due to a rename (this file will get backports for features).
# pylint: disable=unused-import
-from esphome.cpp_generator import ( # noqa
+from esphome.cpp_generator import ( # noqa: F401
+ ArrayInitializer,
Expression,
+ LineComment,
+ MockObj,
+ MockObjClass,
+ Pvariable,
RawExpression,
RawStatement,
- TemplateArguments,
- StructInitializer,
- ArrayInitializer,
- safe_exp,
Statement,
- LineComment,
- progmem_array,
- static_const_array,
- statement,
- variable,
- with_local_variable,
- new_variable,
- Pvariable,
- new_Pvariable,
+ StructInitializer,
+ TemplateArguments,
add,
- add_global,
- add_library,
add_build_flag,
add_define,
+ add_global,
+ add_library,
add_platformio_option,
get_variable,
get_variable_with_full_id,
- process_lambda,
is_template,
+ new_Pvariable,
+ new_variable,
+ process_lambda,
+ progmem_array,
+ safe_exp,
+ statement,
+ static_const_array,
templatable,
- MockObj,
- MockObjClass,
+ variable,
+ with_local_variable,
)
-from esphome.cpp_helpers import ( # noqa
- gpio_pin_expression,
- register_component,
+from esphome.cpp_helpers import ( # noqa: F401
build_registry_entry,
build_registry_list,
extract_registry_entry_config,
- register_parented,
+ gpio_pin_expression,
past_safe_mode,
+ register_component,
+ register_parented,
)
-from esphome.cpp_types import ( # noqa
- global_ns,
- void,
- nullptr,
- float_,
- double,
+from esphome.cpp_types import ( # noqa: F401
+ NAN,
+ App,
+ Application,
+ Component,
+ ComponentPtr,
+ Controller,
+ EntityBase,
+ EntityCategory,
+ ESPTime,
+ GPIOPin,
+ InternalGPIOPin,
+ JsonObject,
+ JsonObjectConst,
+ Parented,
+ PollingComponent,
+ arduino_json_ns,
bool_,
+ const_char_ptr,
+ double,
+ esphome_ns,
+ float_,
+ global_ns,
+ gpio_Flags,
+ int16,
+ int32,
+ int64,
int_,
+ nullptr,
+ optional,
+ size_t,
std_ns,
+ std_shared_ptr,
std_string,
+ std_string_ref,
std_vector,
uint8,
uint16,
uint32,
uint64,
- int16,
- int32,
- int64,
- size_t,
- const_char_ptr,
- NAN,
- esphome_ns,
- App,
- EntityBase,
- Component,
- ComponentPtr,
- PollingComponent,
- Application,
- optional,
- arduino_json_ns,
- JsonObject,
- JsonObjectConst,
- Controller,
- GPIOPin,
- InternalGPIOPin,
- gpio_Flags,
- EntityCategory,
- Parented,
+ void,
)
diff --git a/esphome/components/a01nyub/__init__.py b/esphome/components/a01nyub/__init__.py
new file mode 100644
index 0000000000..4c84847fb6
--- /dev/null
+++ b/esphome/components/a01nyub/__init__.py
@@ -0,0 +1 @@
+CODEOWNERS = ["@MrSuicideParrot"]
diff --git a/esphome/components/a01nyub/a01nyub.cpp b/esphome/components/a01nyub/a01nyub.cpp
new file mode 100644
index 0000000000..d0bc89a0c9
--- /dev/null
+++ b/esphome/components/a01nyub/a01nyub.cpp
@@ -0,0 +1,44 @@
+// Datasheet https://wiki.dfrobot.com/A01NYUB%20Waterproof%20Ultrasonic%20Sensor%20SKU:%20SEN0313
+
+#include "a01nyub.h"
+#include "esphome/core/helpers.h"
+#include "esphome/core/log.h"
+
+namespace esphome {
+namespace a01nyub {
+
+static const char *const TAG = "a01nyub.sensor";
+
+void A01nyubComponent::loop() {
+ uint8_t data;
+ while (this->available() > 0) {
+ this->read_byte(&data);
+ if (this->buffer_.empty() && (data != 0xff))
+ continue;
+ buffer_.push_back(data);
+ if (this->buffer_.size() == 4)
+ this->check_buffer_();
+ }
+}
+
+void A01nyubComponent::check_buffer_() {
+ uint8_t checksum = this->buffer_[0] + this->buffer_[1] + this->buffer_[2];
+ if (this->buffer_[3] == checksum) {
+ float distance = (this->buffer_[1] << 8) + this->buffer_[2];
+ if (distance > 280) {
+ float meters = distance / 1000.0;
+ ESP_LOGV(TAG, "Distance from sensor: %f mm, %f m", distance, meters);
+ this->publish_state(meters);
+ } else {
+ ESP_LOGW(TAG, "Invalid data read from sensor: %s", format_hex_pretty(this->buffer_).c_str());
+ }
+ } else {
+ ESP_LOGW(TAG, "checksum failed: %02x != %02x", checksum, this->buffer_[3]);
+ }
+ this->buffer_.clear();
+}
+
+void A01nyubComponent::dump_config() { LOG_SENSOR("", "A01nyub Sensor", this); }
+
+} // namespace a01nyub
+} // namespace esphome
diff --git a/esphome/components/a01nyub/a01nyub.h b/esphome/components/a01nyub/a01nyub.h
new file mode 100644
index 0000000000..6b22e9bcad
--- /dev/null
+++ b/esphome/components/a01nyub/a01nyub.h
@@ -0,0 +1,27 @@
+#pragma once
+
+#include
+
+#include "esphome/core/component.h"
+#include "esphome/components/sensor/sensor.h"
+#include "esphome/components/uart/uart.h"
+
+namespace esphome {
+namespace a01nyub {
+
+class A01nyubComponent : public sensor::Sensor, public Component, public uart::UARTDevice {
+ public:
+ // Nothing really public.
+
+ // ========== INTERNAL METHODS ==========
+ void loop() override;
+ void dump_config() override;
+
+ protected:
+ void check_buffer_();
+
+ std::vector buffer_;
+};
+
+} // namespace a01nyub
+} // namespace esphome
diff --git a/esphome/components/a01nyub/sensor.py b/esphome/components/a01nyub/sensor.py
new file mode 100644
index 0000000000..b57daa0357
--- /dev/null
+++ b/esphome/components/a01nyub/sensor.py
@@ -0,0 +1,41 @@
+import esphome.codegen as cg
+from esphome.components import sensor, uart
+from esphome.const import (
+ STATE_CLASS_MEASUREMENT,
+ UNIT_METER,
+ ICON_ARROW_EXPAND_VERTICAL,
+ DEVICE_CLASS_DISTANCE,
+)
+
+CODEOWNERS = ["@MrSuicideParrot"]
+DEPENDENCIES = ["uart"]
+
+a01nyub_ns = cg.esphome_ns.namespace("a01nyub")
+A01nyubComponent = a01nyub_ns.class_(
+ "A01nyubComponent", sensor.Sensor, cg.Component, uart.UARTDevice
+)
+
+CONFIG_SCHEMA = sensor.sensor_schema(
+ A01nyubComponent,
+ unit_of_measurement=UNIT_METER,
+ icon=ICON_ARROW_EXPAND_VERTICAL,
+ accuracy_decimals=3,
+ state_class=STATE_CLASS_MEASUREMENT,
+ device_class=DEVICE_CLASS_DISTANCE,
+).extend(uart.UART_DEVICE_SCHEMA)
+
+FINAL_VALIDATE_SCHEMA = uart.final_validate_device_schema(
+ "a01nyub",
+ baud_rate=9600,
+ require_tx=False,
+ require_rx=True,
+ data_bits=8,
+ parity=None,
+ stop_bits=1,
+)
+
+
+async def to_code(config):
+ var = await sensor.new_sensor(config)
+ await cg.register_component(var, config)
+ await uart.register_uart_device(var, config)
diff --git a/esphome/components/a02yyuw/__init__.py b/esphome/components/a02yyuw/__init__.py
new file mode 100644
index 0000000000..6724dbb970
--- /dev/null
+++ b/esphome/components/a02yyuw/__init__.py
@@ -0,0 +1 @@
+CODEOWNERS = ["@TH-Braemer"]
diff --git a/esphome/components/a02yyuw/a02yyuw.cpp b/esphome/components/a02yyuw/a02yyuw.cpp
new file mode 100644
index 0000000000..ee378c3283
--- /dev/null
+++ b/esphome/components/a02yyuw/a02yyuw.cpp
@@ -0,0 +1,43 @@
+// Datasheet https://wiki.dfrobot.com/_A02YYUW_Waterproof_Ultrasonic_Sensor_SKU_SEN0311
+
+#include "a02yyuw.h"
+#include "esphome/core/helpers.h"
+#include "esphome/core/log.h"
+
+namespace esphome {
+namespace a02yyuw {
+
+static const char *const TAG = "a02yyuw.sensor";
+
+void A02yyuwComponent::loop() {
+ uint8_t data;
+ while (this->available() > 0) {
+ this->read_byte(&data);
+ if (this->buffer_.empty() && (data != 0xff))
+ continue;
+ buffer_.push_back(data);
+ if (this->buffer_.size() == 4)
+ this->check_buffer_();
+ }
+}
+
+void A02yyuwComponent::check_buffer_() {
+ uint8_t checksum = this->buffer_[0] + this->buffer_[1] + this->buffer_[2];
+ if (this->buffer_[3] == checksum) {
+ float distance = (this->buffer_[1] << 8) + this->buffer_[2];
+ if (distance > 30) {
+ ESP_LOGV(TAG, "Distance from sensor: %f mm", distance);
+ this->publish_state(distance);
+ } else {
+ ESP_LOGW(TAG, "Invalid data read from sensor: %s", format_hex_pretty(this->buffer_).c_str());
+ }
+ } else {
+ ESP_LOGW(TAG, "checksum failed: %02x != %02x", checksum, this->buffer_[3]);
+ }
+ this->buffer_.clear();
+}
+
+void A02yyuwComponent::dump_config() { LOG_SENSOR("", "A02yyuw Sensor", this); }
+
+} // namespace a02yyuw
+} // namespace esphome
diff --git a/esphome/components/a02yyuw/a02yyuw.h b/esphome/components/a02yyuw/a02yyuw.h
new file mode 100644
index 0000000000..6ff370fdc3
--- /dev/null
+++ b/esphome/components/a02yyuw/a02yyuw.h
@@ -0,0 +1,27 @@
+#pragma once
+
+#include
+
+#include "esphome/core/component.h"
+#include "esphome/components/sensor/sensor.h"
+#include "esphome/components/uart/uart.h"
+
+namespace esphome {
+namespace a02yyuw {
+
+class A02yyuwComponent : public sensor::Sensor, public Component, public uart::UARTDevice {
+ public:
+ // Nothing really public.
+
+ // ========== INTERNAL METHODS ==========
+ void loop() override;
+ void dump_config() override;
+
+ protected:
+ void check_buffer_();
+
+ std::vector buffer_;
+};
+
+} // namespace a02yyuw
+} // namespace esphome
diff --git a/esphome/components/a02yyuw/sensor.py b/esphome/components/a02yyuw/sensor.py
new file mode 100644
index 0000000000..d491a51be9
--- /dev/null
+++ b/esphome/components/a02yyuw/sensor.py
@@ -0,0 +1,41 @@
+import esphome.codegen as cg
+from esphome.components import sensor, uart
+from esphome.const import (
+ STATE_CLASS_MEASUREMENT,
+ ICON_ARROW_EXPAND_VERTICAL,
+ DEVICE_CLASS_DISTANCE,
+ UNIT_MILLIMETER,
+)
+
+CODEOWNERS = ["@TH-Braemer"]
+DEPENDENCIES = ["uart"]
+
+a02yyuw_ns = cg.esphome_ns.namespace("a02yyuw")
+A02yyuwComponent = a02yyuw_ns.class_(
+ "A02yyuwComponent", sensor.Sensor, cg.Component, uart.UARTDevice
+)
+
+CONFIG_SCHEMA = sensor.sensor_schema(
+ A02yyuwComponent,
+ unit_of_measurement=UNIT_MILLIMETER,
+ icon=ICON_ARROW_EXPAND_VERTICAL,
+ accuracy_decimals=0,
+ state_class=STATE_CLASS_MEASUREMENT,
+ device_class=DEVICE_CLASS_DISTANCE,
+).extend(uart.UART_DEVICE_SCHEMA)
+
+FINAL_VALIDATE_SCHEMA = uart.final_validate_device_schema(
+ "a02yyuw",
+ baud_rate=9600,
+ require_tx=False,
+ require_rx=True,
+ data_bits=8,
+ parity=None,
+ stop_bits=1,
+)
+
+
+async def to_code(config):
+ var = await sensor.new_sensor(config)
+ await cg.register_component(var, config)
+ await uart.register_uart_device(var, config)
diff --git a/esphome/components/a4988/stepper.py b/esphome/components/a4988/stepper.py
index 7f53856c7b..744e9dc1cc 100644
--- a/esphome/components/a4988/stepper.py
+++ b/esphome/components/a4988/stepper.py
@@ -28,6 +28,6 @@ async def to_code(config):
dir_pin = await cg.gpio_pin_expression(config[CONF_DIR_PIN])
cg.add(var.set_dir_pin(dir_pin))
- if CONF_SLEEP_PIN in config:
- sleep_pin = await cg.gpio_pin_expression(config[CONF_SLEEP_PIN])
+ if sleep_pin_config := config.get(CONF_SLEEP_PIN):
+ sleep_pin = await cg.gpio_pin_expression(sleep_pin_config)
cg.add(var.set_sleep_pin(sleep_pin))
diff --git a/esphome/components/adc/__init__.py b/esphome/components/adc/__init__.py
index cceaa594ef..11b0ba2389 100644
--- a/esphome/components/adc/__init__.py
+++ b/esphome/components/adc/__init__.py
@@ -1,13 +1,16 @@
import esphome.codegen as cg
import esphome.config_validation as cv
from esphome import pins
-from esphome.const import CONF_INPUT
+from esphome.const import CONF_ANALOG, CONF_INPUT, CONF_NUMBER
from esphome.core import CORE
from esphome.components.esp32 import get_esp32_variant
+from esphome.const import PLATFORM_ESP8266
from esphome.components.esp32.const import (
VARIANT_ESP32,
+ VARIANT_ESP32C2,
VARIANT_ESP32C3,
+ VARIANT_ESP32C6,
VARIANT_ESP32H2,
VARIANT_ESP32S2,
VARIANT_ESP32S3,
@@ -15,15 +18,28 @@ from esphome.components.esp32.const import (
CODEOWNERS = ["@esphome/core"]
+adc_ns = cg.esphome_ns.namespace("adc")
+
+
+"""
+From the below patch versions (and 5.2+) ADC_ATTEN_DB_11 is deprecated and replaced with ADC_ATTEN_DB_12.
+4.4.7
+5.0.5
+5.1.3
+5.2+
+"""
+
ATTENUATION_MODES = {
"0db": cg.global_ns.ADC_ATTEN_DB_0,
"2.5db": cg.global_ns.ADC_ATTEN_DB_2_5,
"6db": cg.global_ns.ADC_ATTEN_DB_6,
- "11db": cg.global_ns.ADC_ATTEN_DB_11,
+ "11db": adc_ns.ADC_ATTEN_DB_12_COMPAT,
+ "12db": adc_ns.ADC_ATTEN_DB_12_COMPAT,
"auto": "auto",
}
adc1_channel_t = cg.global_ns.enum("adc1_channel_t")
+adc2_channel_t = cg.global_ns.enum("adc2_channel_t")
# From https://github.com/espressif/esp-idf/blob/master/components/driver/include/driver/adc_common.h
# pin to adc1 channel mapping
@@ -69,6 +85,22 @@ ESP32_VARIANT_ADC1_PIN_TO_CHANNEL = {
3: adc1_channel_t.ADC1_CHANNEL_3,
4: adc1_channel_t.ADC1_CHANNEL_4,
},
+ VARIANT_ESP32C2: {
+ 0: adc1_channel_t.ADC1_CHANNEL_0,
+ 1: adc1_channel_t.ADC1_CHANNEL_1,
+ 2: adc1_channel_t.ADC1_CHANNEL_2,
+ 3: adc1_channel_t.ADC1_CHANNEL_3,
+ 4: adc1_channel_t.ADC1_CHANNEL_4,
+ },
+ VARIANT_ESP32C6: {
+ 0: adc1_channel_t.ADC1_CHANNEL_0,
+ 1: adc1_channel_t.ADC1_CHANNEL_1,
+ 2: adc1_channel_t.ADC1_CHANNEL_2,
+ 3: adc1_channel_t.ADC1_CHANNEL_3,
+ 4: adc1_channel_t.ADC1_CHANNEL_4,
+ 5: adc1_channel_t.ADC1_CHANNEL_5,
+ 6: adc1_channel_t.ADC1_CHANNEL_6,
+ },
VARIANT_ESP32H2: {
0: adc1_channel_t.ADC1_CHANNEL_0,
1: adc1_channel_t.ADC1_CHANNEL_1,
@@ -78,41 +110,99 @@ ESP32_VARIANT_ADC1_PIN_TO_CHANNEL = {
},
}
+ESP32_VARIANT_ADC2_PIN_TO_CHANNEL = {
+ # TODO: add other variants
+ VARIANT_ESP32: {
+ 4: adc2_channel_t.ADC2_CHANNEL_0,
+ 0: adc2_channel_t.ADC2_CHANNEL_1,
+ 2: adc2_channel_t.ADC2_CHANNEL_2,
+ 15: adc2_channel_t.ADC2_CHANNEL_3,
+ 13: adc2_channel_t.ADC2_CHANNEL_4,
+ 12: adc2_channel_t.ADC2_CHANNEL_5,
+ 14: adc2_channel_t.ADC2_CHANNEL_6,
+ 27: adc2_channel_t.ADC2_CHANNEL_7,
+ 25: adc2_channel_t.ADC2_CHANNEL_8,
+ 26: adc2_channel_t.ADC2_CHANNEL_9,
+ },
+ VARIANT_ESP32S2: {
+ 11: adc2_channel_t.ADC2_CHANNEL_0,
+ 12: adc2_channel_t.ADC2_CHANNEL_1,
+ 13: adc2_channel_t.ADC2_CHANNEL_2,
+ 14: adc2_channel_t.ADC2_CHANNEL_3,
+ 15: adc2_channel_t.ADC2_CHANNEL_4,
+ 16: adc2_channel_t.ADC2_CHANNEL_5,
+ 17: adc2_channel_t.ADC2_CHANNEL_6,
+ 18: adc2_channel_t.ADC2_CHANNEL_7,
+ 19: adc2_channel_t.ADC2_CHANNEL_8,
+ 20: adc2_channel_t.ADC2_CHANNEL_9,
+ },
+ VARIANT_ESP32S3: {
+ 11: adc2_channel_t.ADC2_CHANNEL_0,
+ 12: adc2_channel_t.ADC2_CHANNEL_1,
+ 13: adc2_channel_t.ADC2_CHANNEL_2,
+ 14: adc2_channel_t.ADC2_CHANNEL_3,
+ 15: adc2_channel_t.ADC2_CHANNEL_4,
+ 16: adc2_channel_t.ADC2_CHANNEL_5,
+ 17: adc2_channel_t.ADC2_CHANNEL_6,
+ 18: adc2_channel_t.ADC2_CHANNEL_7,
+ 19: adc2_channel_t.ADC2_CHANNEL_8,
+ 20: adc2_channel_t.ADC2_CHANNEL_9,
+ },
+ VARIANT_ESP32C3: {
+ 5: adc2_channel_t.ADC2_CHANNEL_0,
+ },
+ VARIANT_ESP32C2: {},
+ VARIANT_ESP32C6: {},
+ VARIANT_ESP32H2: {},
+}
+
def validate_adc_pin(value):
if str(value).upper() == "VCC":
- return cv.only_on_esp8266("VCC")
+ if CORE.is_rp2040:
+ return pins.internal_gpio_input_pin_schema(29)
+ return cv.only_on([PLATFORM_ESP8266])("VCC")
if str(value).upper() == "TEMPERATURE":
return cv.only_on_rp2040("TEMPERATURE")
if CORE.is_esp32:
- value = pins.internal_gpio_input_pin_number(value)
+ conf = pins.internal_gpio_input_pin_schema(value)
+ value = conf[CONF_NUMBER]
variant = get_esp32_variant()
- if variant not in ESP32_VARIANT_ADC1_PIN_TO_CHANNEL:
+ if (
+ variant not in ESP32_VARIANT_ADC1_PIN_TO_CHANNEL
+ and variant not in ESP32_VARIANT_ADC2_PIN_TO_CHANNEL
+ ):
raise cv.Invalid(f"This ESP32 variant ({variant}) is not supported")
- if value not in ESP32_VARIANT_ADC1_PIN_TO_CHANNEL[variant]:
+ if (
+ value not in ESP32_VARIANT_ADC1_PIN_TO_CHANNEL[variant]
+ and value not in ESP32_VARIANT_ADC2_PIN_TO_CHANNEL[variant]
+ ):
raise cv.Invalid(f"{variant} doesn't support ADC on this pin")
- return pins.internal_gpio_input_pin_schema(value)
+
+ return conf
if CORE.is_esp8266:
- from esphome.components.esp8266.gpio import CONF_ANALOG
+ conf = pins.gpio_pin_schema(
+ {CONF_ANALOG: True, CONF_INPUT: True}, internal=True
+ )(value)
- value = pins.internal_gpio_pin_number({CONF_ANALOG: True, CONF_INPUT: True})(
- value
- )
+ if conf[CONF_NUMBER] != 17: # A0
+ raise cv.Invalid("ESP8266: Only pin A0 (GPIO17) supports ADC")
+ return conf
- if value != 17: # A0
- raise cv.Invalid("ESP8266: Only pin A0 (GPIO17) supports ADC.")
+ if CORE.is_rp2040:
+ conf = pins.internal_gpio_input_pin_schema(value)
+ number = conf[CONF_NUMBER]
+ if number not in (26, 27, 28, 29):
+ raise cv.Invalid("RP2040: Only pins 26, 27, 28 and 29 support ADC")
+ return conf
+
+ if CORE.is_libretiny:
return pins.gpio_pin_schema(
{CONF_ANALOG: True, CONF_INPUT: True}, internal=True
)(value)
- if CORE.is_rp2040:
- value = pins.internal_gpio_input_pin_number(value)
- if value not in (26, 27, 28, 29):
- raise cv.Invalid("RP2040: Only pins 26, 27, 28 and 29 support ADC.")
- return pins.internal_gpio_input_pin_schema(value)
-
raise NotImplementedError
diff --git a/esphome/components/adc/adc_sensor.cpp b/esphome/components/adc/adc_sensor.cpp
index 9bfe0f5eed..7257793016 100644
--- a/esphome/components/adc/adc_sensor.cpp
+++ b/esphome/components/adc/adc_sensor.cpp
@@ -1,6 +1,6 @@
#include "adc_sensor.h"
-#include "esphome/core/log.h"
#include "esphome/core/helpers.h"
+#include "esphome/core/log.h"
#ifdef USE_ESP8266
#ifdef USE_ADC_SENSOR_VCC
@@ -12,6 +12,9 @@ ADC_MODE(ADC_VCC)
#endif
#ifdef USE_RP2040
+#ifdef CYW43_USES_VSYS_PIN
+#include "pico/cyw43_arch.h"
+#endif
#include
#endif
@@ -20,15 +23,15 @@ namespace adc {
static const char *const TAG = "adc";
-// 13bit for S2, and 12bit for all other esp32 variants
+// 13-bit for S2, 12-bit for all other ESP32 variants
#ifdef USE_ESP32
static const adc_bits_width_t ADC_WIDTH_MAX_SOC_BITS = static_cast(ADC_WIDTH_MAX - 1);
#ifndef SOC_ADC_RTC_MAX_BITWIDTH
#if USE_ESP32_VARIANT_ESP32S2
-static const int SOC_ADC_RTC_MAX_BITWIDTH = 13;
+static const int32_t SOC_ADC_RTC_MAX_BITWIDTH = 13;
#else
-static const int SOC_ADC_RTC_MAX_BITWIDTH = 12;
+static const int32_t SOC_ADC_RTC_MAX_BITWIDTH = 12;
#endif
#endif
@@ -43,20 +46,27 @@ extern "C"
ADCSensor::setup() {
ESP_LOGCONFIG(TAG, "Setting up ADC '%s'...", this->get_name().c_str());
#if !defined(USE_ADC_SENSOR_VCC) && !defined(USE_RP2040)
- pin_->setup();
+ this->pin_->setup();
#endif
#ifdef USE_ESP32
- adc1_config_width(ADC_WIDTH_MAX_SOC_BITS);
- if (!autorange_) {
- adc1_config_channel_atten(channel_, attenuation_);
+ if (this->channel1_ != ADC1_CHANNEL_MAX) {
+ adc1_config_width(ADC_WIDTH_MAX_SOC_BITS);
+ if (!this->autorange_) {
+ adc1_config_channel_atten(this->channel1_, this->attenuation_);
+ }
+ } else if (this->channel2_ != ADC2_CHANNEL_MAX) {
+ if (!this->autorange_) {
+ adc2_config_channel_atten(this->channel2_, this->attenuation_);
+ }
}
// load characteristics for each attenuation
- for (int i = 0; i < (int) ADC_ATTEN_MAX; i++) {
- auto cal_value = esp_adc_cal_characterize(ADC_UNIT_1, (adc_atten_t) i, ADC_WIDTH_MAX_SOC_BITS,
+ for (int32_t i = 0; i <= ADC_ATTEN_DB_12_COMPAT; i++) {
+ auto adc_unit = this->channel1_ != ADC1_CHANNEL_MAX ? ADC_UNIT_1 : ADC_UNIT_2;
+ auto cal_value = esp_adc_cal_characterize(adc_unit, (adc_atten_t) i, ADC_WIDTH_MAX_SOC_BITS,
1100, // default vref
- &cal_characteristics_[i]);
+ &this->cal_characteristics_[i]);
switch (cal_value) {
case ESP_ADC_CAL_VAL_EFUSE_VREF:
ESP_LOGV(TAG, "Using eFuse Vref for calibration");
@@ -85,44 +95,50 @@ extern "C"
void ADCSensor::dump_config() {
LOG_SENSOR("", "ADC Sensor", this);
-#ifdef USE_ESP8266
+#if defined(USE_ESP8266) || defined(USE_LIBRETINY)
#ifdef USE_ADC_SENSOR_VCC
ESP_LOGCONFIG(TAG, " Pin: VCC");
#else
- LOG_PIN(" Pin: ", pin_);
+ LOG_PIN(" Pin: ", this->pin_);
#endif
-#endif // USE_ESP8266
+#endif // USE_ESP8266 || USE_LIBRETINY
#ifdef USE_ESP32
- LOG_PIN(" Pin: ", pin_);
- if (autorange_) {
- ESP_LOGCONFIG(TAG, " Attenuation: auto");
+ LOG_PIN(" Pin: ", this->pin_);
+ if (this->autorange_) {
+ ESP_LOGCONFIG(TAG, " Attenuation: auto");
} else {
switch (this->attenuation_) {
case ADC_ATTEN_DB_0:
- ESP_LOGCONFIG(TAG, " Attenuation: 0db");
+ ESP_LOGCONFIG(TAG, " Attenuation: 0db");
break;
case ADC_ATTEN_DB_2_5:
- ESP_LOGCONFIG(TAG, " Attenuation: 2.5db");
+ ESP_LOGCONFIG(TAG, " Attenuation: 2.5db");
break;
case ADC_ATTEN_DB_6:
- ESP_LOGCONFIG(TAG, " Attenuation: 6db");
+ ESP_LOGCONFIG(TAG, " Attenuation: 6db");
break;
- case ADC_ATTEN_DB_11:
- ESP_LOGCONFIG(TAG, " Attenuation: 11db");
+ case ADC_ATTEN_DB_12_COMPAT:
+ ESP_LOGCONFIG(TAG, " Attenuation: 12db");
break;
default: // This is to satisfy the unused ADC_ATTEN_MAX
break;
}
}
#endif // USE_ESP32
+
#ifdef USE_RP2040
if (this->is_temperature_) {
ESP_LOGCONFIG(TAG, " Pin: Temperature");
} else {
- LOG_PIN(" Pin: ", pin_);
+#ifdef USE_ADC_SENSOR_VCC
+ ESP_LOGCONFIG(TAG, " Pin: VCC");
+#else
+ LOG_PIN(" Pin: ", this->pin_);
+#endif // USE_ADC_SENSOR_VCC
}
-#endif
+#endif // USE_RP2040
+ ESP_LOGCONFIG(TAG, " Samples: %i", this->sample_count_);
LOG_UPDATE_INTERVAL(this);
}
@@ -133,14 +149,24 @@ void ADCSensor::update() {
this->publish_state(value_v);
}
+void ADCSensor::set_sample_count(uint8_t sample_count) {
+ if (sample_count != 0) {
+ this->sample_count_ = sample_count;
+ }
+}
+
#ifdef USE_ESP8266
float ADCSensor::sample() {
+ uint32_t raw = 0;
+ for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
#ifdef USE_ADC_SENSOR_VCC
- int raw = ESP.getVcc(); // NOLINT(readability-static-accessed-through-instance)
+ raw += ESP.getVcc(); // NOLINT(readability-static-accessed-through-instance)
#else
- int raw = analogRead(this->pin_->get_pin()); // NOLINT
+ raw += analogRead(this->pin_->get_pin()); // NOLINT
#endif
- if (output_raw_) {
+ }
+ raw = (raw + (this->sample_count_ >> 1)) / this->sample_count_; // NOLINT(clang-analyzer-core.DivideZero)
+ if (this->output_raw_) {
return raw;
}
return raw / 1024.0f;
@@ -149,53 +175,81 @@ float ADCSensor::sample() {
#ifdef USE_ESP32
float ADCSensor::sample() {
- if (!autorange_) {
- int raw = adc1_get_raw(channel_);
- if (raw == -1) {
- return NAN;
+ if (!this->autorange_) {
+ uint32_t sum = 0;
+ for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
+ int raw = -1;
+ if (this->channel1_ != ADC1_CHANNEL_MAX) {
+ raw = adc1_get_raw(this->channel1_);
+ } else if (this->channel2_ != ADC2_CHANNEL_MAX) {
+ adc2_get_raw(this->channel2_, ADC_WIDTH_MAX_SOC_BITS, &raw);
+ }
+ if (raw == -1) {
+ return NAN;
+ }
+ sum += raw;
}
- if (output_raw_) {
- return raw;
+ sum = (sum + (this->sample_count_ >> 1)) / this->sample_count_; // NOLINT(clang-analyzer-core.DivideZero)
+ if (this->output_raw_) {
+ return sum;
}
- uint32_t mv = esp_adc_cal_raw_to_voltage(raw, &cal_characteristics_[(int) attenuation_]);
+ uint32_t mv = esp_adc_cal_raw_to_voltage(sum, &this->cal_characteristics_[(int32_t) this->attenuation_]);
return mv / 1000.0f;
}
- int raw11, raw6 = ADC_MAX, raw2 = ADC_MAX, raw0 = ADC_MAX;
- adc1_config_channel_atten(channel_, ADC_ATTEN_DB_11);
- raw11 = adc1_get_raw(channel_);
- if (raw11 < ADC_MAX) {
- adc1_config_channel_atten(channel_, ADC_ATTEN_DB_6);
- raw6 = adc1_get_raw(channel_);
- if (raw6 < ADC_MAX) {
- adc1_config_channel_atten(channel_, ADC_ATTEN_DB_2_5);
- raw2 = adc1_get_raw(channel_);
- if (raw2 < ADC_MAX) {
- adc1_config_channel_atten(channel_, ADC_ATTEN_DB_0);
- raw0 = adc1_get_raw(channel_);
+ int raw12 = ADC_MAX, raw6 = ADC_MAX, raw2 = ADC_MAX, raw0 = ADC_MAX;
+
+ if (this->channel1_ != ADC1_CHANNEL_MAX) {
+ adc1_config_channel_atten(this->channel1_, ADC_ATTEN_DB_12_COMPAT);
+ raw12 = adc1_get_raw(this->channel1_);
+ if (raw12 < ADC_MAX) {
+ adc1_config_channel_atten(this->channel1_, ADC_ATTEN_DB_6);
+ raw6 = adc1_get_raw(this->channel1_);
+ if (raw6 < ADC_MAX) {
+ adc1_config_channel_atten(this->channel1_, ADC_ATTEN_DB_2_5);
+ raw2 = adc1_get_raw(this->channel1_);
+ if (raw2 < ADC_MAX) {
+ adc1_config_channel_atten(this->channel1_, ADC_ATTEN_DB_0);
+ raw0 = adc1_get_raw(this->channel1_);
+ }
+ }
+ }
+ } else if (this->channel2_ != ADC2_CHANNEL_MAX) {
+ adc2_config_channel_atten(this->channel2_, ADC_ATTEN_DB_12_COMPAT);
+ adc2_get_raw(this->channel2_, ADC_WIDTH_MAX_SOC_BITS, &raw12);
+ if (raw12 < ADC_MAX) {
+ adc2_config_channel_atten(this->channel2_, ADC_ATTEN_DB_6);
+ adc2_get_raw(this->channel2_, ADC_WIDTH_MAX_SOC_BITS, &raw6);
+ if (raw6 < ADC_MAX) {
+ adc2_config_channel_atten(this->channel2_, ADC_ATTEN_DB_2_5);
+ adc2_get_raw(this->channel2_, ADC_WIDTH_MAX_SOC_BITS, &raw2);
+ if (raw2 < ADC_MAX) {
+ adc2_config_channel_atten(this->channel2_, ADC_ATTEN_DB_0);
+ adc2_get_raw(this->channel2_, ADC_WIDTH_MAX_SOC_BITS, &raw0);
+ }
}
}
}
- if (raw0 == -1 || raw2 == -1 || raw6 == -1 || raw11 == -1) {
+ if (raw0 == -1 || raw2 == -1 || raw6 == -1 || raw12 == -1) {
return NAN;
}
- uint32_t mv11 = esp_adc_cal_raw_to_voltage(raw11, &cal_characteristics_[(int) ADC_ATTEN_DB_11]);
- uint32_t mv6 = esp_adc_cal_raw_to_voltage(raw6, &cal_characteristics_[(int) ADC_ATTEN_DB_6]);
- uint32_t mv2 = esp_adc_cal_raw_to_voltage(raw2, &cal_characteristics_[(int) ADC_ATTEN_DB_2_5]);
- uint32_t mv0 = esp_adc_cal_raw_to_voltage(raw0, &cal_characteristics_[(int) ADC_ATTEN_DB_0]);
+ uint32_t mv12 = esp_adc_cal_raw_to_voltage(raw12, &this->cal_characteristics_[(int32_t) ADC_ATTEN_DB_12_COMPAT]);
+ uint32_t mv6 = esp_adc_cal_raw_to_voltage(raw6, &this->cal_characteristics_[(int32_t) ADC_ATTEN_DB_6]);
+ uint32_t mv2 = esp_adc_cal_raw_to_voltage(raw2, &this->cal_characteristics_[(int32_t) ADC_ATTEN_DB_2_5]);
+ uint32_t mv0 = esp_adc_cal_raw_to_voltage(raw0, &this->cal_characteristics_[(int32_t) ADC_ATTEN_DB_0]);
// Contribution of each value, in range 0-2048 (12 bit ADC) or 0-4096 (13 bit ADC)
- uint32_t c11 = std::min(raw11, ADC_HALF);
+ uint32_t c12 = std::min(raw12, ADC_HALF);
uint32_t c6 = ADC_HALF - std::abs(raw6 - ADC_HALF);
uint32_t c2 = ADC_HALF - std::abs(raw2 - ADC_HALF);
uint32_t c0 = std::min(ADC_MAX - raw0, ADC_HALF);
// max theoretical csum value is 4096*4 = 16384
- uint32_t csum = c11 + c6 + c2 + c0;
+ uint32_t csum = c12 + c6 + c2 + c0;
// each mv is max 3900; so max value is 3900*4096*4, fits in unsigned32
- uint32_t mv_scaled = (mv11 * c11) + (mv6 * c6) + (mv2 * c2) + (mv0 * c0);
+ uint32_t mv_scaled = (mv12 * c12) + (mv6 * c6) + (mv2 * c2) + (mv0 * c0);
return mv_scaled / (float) (csum * 1000U);
}
#endif // USE_ESP32
@@ -206,23 +260,70 @@ float ADCSensor::sample() {
adc_set_temp_sensor_enabled(true);
delay(1);
adc_select_input(4);
+ uint32_t raw = 0;
+ for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
+ raw += adc_read();
+ }
+ raw = (raw + (this->sample_count_ >> 1)) / this->sample_count_; // NOLINT(clang-analyzer-core.DivideZero)
+ adc_set_temp_sensor_enabled(false);
+ if (this->output_raw_) {
+ return raw;
+ }
+ return raw * 3.3f / 4096.0f;
} else {
uint8_t pin = this->pin_->get_pin();
+#ifdef CYW43_USES_VSYS_PIN
+ if (pin == PICO_VSYS_PIN) {
+ // Measuring VSYS on Raspberry Pico W needs to be wrapped with
+ // `cyw43_thread_enter()`/`cyw43_thread_exit()` as discussed in
+ // https://github.com/raspberrypi/pico-sdk/issues/1222, since Wifi chip and
+ // VSYS ADC both share GPIO29
+ cyw43_thread_enter();
+ }
+#endif // CYW43_USES_VSYS_PIN
+
adc_gpio_init(pin);
adc_select_input(pin - 26);
- }
- int raw = adc_read();
- if (this->is_temperature_) {
- adc_set_temp_sensor_enabled(false);
+ uint32_t raw = 0;
+ for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
+ raw += adc_read();
+ }
+ raw = (raw + (this->sample_count_ >> 1)) / this->sample_count_; // NOLINT(clang-analyzer-core.DivideZero)
+
+#ifdef CYW43_USES_VSYS_PIN
+ if (pin == PICO_VSYS_PIN) {
+ cyw43_thread_exit();
+ }
+#endif // CYW43_USES_VSYS_PIN
+
+ if (this->output_raw_) {
+ return raw;
+ }
+ float coeff = pin == PICO_VSYS_PIN ? 3.0 : 1.0;
+ return raw * 3.3f / 4096.0f * coeff;
}
- if (output_raw_) {
- return raw;
- }
- return raw * 3.3f / 4096.0f;
}
#endif
+#ifdef USE_LIBRETINY
+float ADCSensor::sample() {
+ uint32_t raw = 0;
+ if (this->output_raw_) {
+ for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
+ raw += analogRead(this->pin_->get_pin()); // NOLINT
+ }
+ raw = (raw + (this->sample_count_ >> 1)) / this->sample_count_; // NOLINT(clang-analyzer-core.DivideZero)
+ return raw;
+ }
+ for (uint8_t sample = 0; sample < this->sample_count_; sample++) {
+ raw += analogReadVoltage(this->pin_->get_pin()); // NOLINT
+ }
+ raw = (raw + (this->sample_count_ >> 1)) / this->sample_count_; // NOLINT(clang-analyzer-core.DivideZero)
+ return raw / 1000.0f;
+}
+#endif // USE_LIBRETINY
+
#ifdef USE_ESP8266
std::string ADCSensor::unique_id() { return get_mac_address() + "-adc"; }
#endif
diff --git a/esphome/components/adc/adc_sensor.h b/esphome/components/adc/adc_sensor.h
index 22cddde6f8..b697d6dd7e 100644
--- a/esphome/components/adc/adc_sensor.h
+++ b/esphome/components/adc/adc_sensor.h
@@ -1,37 +1,60 @@
#pragma once
-#include "esphome/core/component.h"
-#include "esphome/core/hal.h"
-#include "esphome/core/defines.h"
#include "esphome/components/sensor/sensor.h"
#include "esphome/components/voltage_sampler/voltage_sampler.h"
+#include "esphome/core/component.h"
+#include "esphome/core/defines.h"
+#include "esphome/core/hal.h"
#ifdef USE_ESP32
-#include "driver/adc.h"
#include
+#include "driver/adc.h"
#endif
namespace esphome {
namespace adc {
+#ifdef USE_ESP32
+// clang-format off
+#if (ESP_IDF_VERSION_MAJOR == 4 && ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 7)) || \
+ (ESP_IDF_VERSION_MAJOR == 5 && \
+ ((ESP_IDF_VERSION_MINOR == 0 && ESP_IDF_VERSION_PATCH >= 5) || \
+ (ESP_IDF_VERSION_MINOR == 1 && ESP_IDF_VERSION_PATCH >= 3) || \
+ (ESP_IDF_VERSION_MINOR >= 2)) \
+ )
+// clang-format on
+static const adc_atten_t ADC_ATTEN_DB_12_COMPAT = ADC_ATTEN_DB_12;
+#else
+static const adc_atten_t ADC_ATTEN_DB_12_COMPAT = ADC_ATTEN_DB_11;
+#endif
+#endif // USE_ESP32
+
class ADCSensor : public sensor::Sensor, public PollingComponent, public voltage_sampler::VoltageSampler {
public:
#ifdef USE_ESP32
/// Set the attenuation for this pin. Only available on the ESP32.
- void set_attenuation(adc_atten_t attenuation) { attenuation_ = attenuation; }
- void set_channel(adc1_channel_t channel) { channel_ = channel; }
- void set_autorange(bool autorange) { autorange_ = autorange; }
+ void set_attenuation(adc_atten_t attenuation) { this->attenuation_ = attenuation; }
+ void set_channel1(adc1_channel_t channel) {
+ this->channel1_ = channel;
+ this->channel2_ = ADC2_CHANNEL_MAX;
+ }
+ void set_channel2(adc2_channel_t channel) {
+ this->channel2_ = channel;
+ this->channel1_ = ADC1_CHANNEL_MAX;
+ }
+ void set_autorange(bool autorange) { this->autorange_ = autorange; }
#endif
- /// Update adc values.
+ /// Update ADC values
void update() override;
- /// Setup ADc
+ /// Setup ADC
void setup() override;
void dump_config() override;
- /// `HARDWARE_LATE` setup priority.
+ /// `HARDWARE_LATE` setup priority
float get_setup_priority() const override;
void set_pin(InternalGPIOPin *pin) { this->pin_ = pin; }
- void set_output_raw(bool output_raw) { output_raw_ = output_raw; }
+ void set_output_raw(bool output_raw) { this->output_raw_ = output_raw; }
+ void set_sample_count(uint8_t sample_count);
float sample() override;
#ifdef USE_ESP8266
@@ -39,12 +62,13 @@ class ADCSensor : public sensor::Sensor, public PollingComponent, public voltage
#endif
#ifdef USE_RP2040
- void set_is_temperature() { is_temperature_ = true; }
+ void set_is_temperature() { this->is_temperature_ = true; }
#endif
protected:
InternalGPIOPin *pin_;
bool output_raw_{false};
+ uint8_t sample_count_{1};
#ifdef USE_RP2040
bool is_temperature_{false};
@@ -52,9 +76,14 @@ class ADCSensor : public sensor::Sensor, public PollingComponent, public voltage
#ifdef USE_ESP32
adc_atten_t attenuation_{ADC_ATTEN_DB_0};
- adc1_channel_t channel_{};
+ adc1_channel_t channel1_{ADC1_CHANNEL_MAX};
+ adc2_channel_t channel2_{ADC2_CHANNEL_MAX};
bool autorange_{false};
- esp_adc_cal_characteristics_t cal_characteristics_[(int) ADC_ATTEN_MAX] = {};
+#if ESP_IDF_VERSION_MAJOR >= 5
+ esp_adc_cal_characteristics_t cal_characteristics_[SOC_ADC_ATTEN_NUM] = {};
+#else
+ esp_adc_cal_characteristics_t cal_characteristics_[ADC_ATTEN_MAX] = {};
+#endif
#endif
};
diff --git a/esphome/components/adc/sensor.py b/esphome/components/adc/sensor.py
index 4695e96570..59ea9e184c 100644
--- a/esphome/components/adc/sensor.py
+++ b/esphome/components/adc/sensor.py
@@ -1,5 +1,9 @@
+import logging
+
import esphome.codegen as cg
import esphome.config_validation as cv
+import esphome.final_validate as fv
+from esphome.core import CORE
from esphome.components import sensor, voltage_sampler
from esphome.components.esp32 import get_esp32_variant
from esphome.const import (
@@ -8,28 +12,62 @@ from esphome.const import (
CONF_NUMBER,
CONF_PIN,
CONF_RAW,
+ CONF_WIFI,
DEVICE_CLASS_VOLTAGE,
STATE_CLASS_MEASUREMENT,
UNIT_VOLT,
)
-from esphome.core import CORE
-
from . import (
ATTENUATION_MODES,
ESP32_VARIANT_ADC1_PIN_TO_CHANNEL,
+ ESP32_VARIANT_ADC2_PIN_TO_CHANNEL,
+ adc_ns,
validate_adc_pin,
)
+_LOGGER = logging.getLogger(__name__)
+
AUTO_LOAD = ["voltage_sampler"]
+CONF_SAMPLES = "samples"
+
+
+_attenuation = cv.enum(ATTENUATION_MODES, lower=True)
+
def validate_config(config):
if config[CONF_RAW] and config.get(CONF_ATTENUATION, None) == "auto":
- raise cv.Invalid("Automatic attenuation cannot be used when raw output is set.")
+ raise cv.Invalid("Automatic attenuation cannot be used when raw output is set")
+
+ if config.get(CONF_ATTENUATION, None) == "auto" and config.get(CONF_SAMPLES, 1) > 1:
+ raise cv.Invalid(
+ "Automatic attenuation cannot be used when multisampling is set"
+ )
+ if config.get(CONF_ATTENUATION) == "11db":
+ _LOGGER.warning(
+ "`attenuation: 11db` is deprecated, use `attenuation: 12db` instead"
+ )
+ # Alter value here so `config` command prints the recommended change
+ config[CONF_ATTENUATION] = _attenuation("12db")
+
+ return config
+
+
+def final_validate_config(config):
+ if CORE.is_esp32:
+ variant = get_esp32_variant()
+ if (
+ CONF_WIFI in fv.full_config.get()
+ and config[CONF_PIN][CONF_NUMBER]
+ in ESP32_VARIANT_ADC2_PIN_TO_CHANNEL[variant]
+ ):
+ raise cv.Invalid(
+ f"{variant} doesn't support ADC on this pin when Wi-Fi is configured"
+ )
+
return config
-adc_ns = cg.esphome_ns.namespace("adc")
ADCSensor = adc_ns.class_(
"ADCSensor", sensor.Sensor, cg.PollingComponent, voltage_sampler.VoltageSampler
)
@@ -47,14 +85,17 @@ CONFIG_SCHEMA = cv.All(
cv.Required(CONF_PIN): validate_adc_pin,
cv.Optional(CONF_RAW, default=False): cv.boolean,
cv.SplitDefault(CONF_ATTENUATION, esp32="0db"): cv.All(
- cv.only_on_esp32, cv.enum(ATTENUATION_MODES, lower=True)
+ cv.only_on_esp32, _attenuation
),
+ cv.Optional(CONF_SAMPLES, default=1): cv.int_range(min=1, max=255),
}
)
.extend(cv.polling_component_schema("60s")),
validate_config,
)
+FINAL_VALIDATE_SCHEMA = final_validate_config
+
async def to_code(config):
var = cg.new_Pvariable(config[CONF_ID])
@@ -69,17 +110,27 @@ async def to_code(config):
pin = await cg.gpio_pin_expression(config[CONF_PIN])
cg.add(var.set_pin(pin))
- if CONF_RAW in config:
- cg.add(var.set_output_raw(config[CONF_RAW]))
+ cg.add(var.set_output_raw(config[CONF_RAW]))
+ cg.add(var.set_sample_count(config[CONF_SAMPLES]))
- if CONF_ATTENUATION in config:
- if config[CONF_ATTENUATION] == "auto":
+ if attenuation := config.get(CONF_ATTENUATION):
+ if attenuation == "auto":
cg.add(var.set_autorange(cg.global_ns.true))
else:
- cg.add(var.set_attenuation(config[CONF_ATTENUATION]))
+ cg.add(var.set_attenuation(attenuation))
if CORE.is_esp32:
variant = get_esp32_variant()
pin_num = config[CONF_PIN][CONF_NUMBER]
- chan = ESP32_VARIANT_ADC1_PIN_TO_CHANNEL[variant][pin_num]
- cg.add(var.set_channel(chan))
+ if (
+ variant in ESP32_VARIANT_ADC1_PIN_TO_CHANNEL
+ and pin_num in ESP32_VARIANT_ADC1_PIN_TO_CHANNEL[variant]
+ ):
+ chan = ESP32_VARIANT_ADC1_PIN_TO_CHANNEL[variant][pin_num]
+ cg.add(var.set_channel1(chan))
+ elif (
+ variant in ESP32_VARIANT_ADC2_PIN_TO_CHANNEL
+ and pin_num in ESP32_VARIANT_ADC2_PIN_TO_CHANNEL[variant]
+ ):
+ chan = ESP32_VARIANT_ADC2_PIN_TO_CHANNEL[variant][pin_num]
+ cg.add(var.set_channel2(chan))
diff --git a/esphome/components/addressable_light/addressable_light_display.h b/esphome/components/addressable_light/addressable_light_display.h
index 8893c39be6..f47389fd05 100644
--- a/esphome/components/addressable_light/addressable_light_display.h
+++ b/esphome/components/addressable_light/addressable_light_display.h
@@ -10,7 +10,7 @@
namespace esphome {
namespace addressable_light {
-class AddressableLightDisplay : public display::DisplayBuffer, public PollingComponent {
+class AddressableLightDisplay : public display::DisplayBuffer {
public:
light::AddressableLight *get_light() const { return this->light_; }
diff --git a/esphome/components/addressable_light/display.py b/esphome/components/addressable_light/display.py
index 0684bf8dfc..327ec8296a 100644
--- a/esphome/components/addressable_light/display.py
+++ b/esphome/components/addressable_light/display.py
@@ -45,19 +45,18 @@ async def to_code(config):
cg.add(var.set_height(config[CONF_HEIGHT]))
cg.add(var.set_light(wrapped_light))
- await cg.register_component(var, config)
await display.register_display(var, config)
- if CONF_PIXEL_MAPPER in config:
+ if pixel_mapper := config.get(CONF_PIXEL_MAPPER):
pixel_mapper_template_ = await cg.process_lambda(
- config[CONF_PIXEL_MAPPER],
+ pixel_mapper,
[(int, "x"), (int, "y")],
return_type=cg.int_,
)
cg.add(var.set_pixel_mapper(pixel_mapper_template_))
- if CONF_LAMBDA in config:
+ if lambda_config := config.get(CONF_LAMBDA):
lambda_ = await cg.process_lambda(
- config[CONF_LAMBDA], [(display.DisplayBufferRef, "it")], return_type=cg.void
+ lambda_config, [(display.DisplayRef, "it")], return_type=cg.void
)
cg.add(var.set_writer(lambda_))
diff --git a/esphome/components/ade7880/__init__.py b/esphome/components/ade7880/__init__.py
new file mode 100644
index 0000000000..aed63c7dfa
--- /dev/null
+++ b/esphome/components/ade7880/__init__.py
@@ -0,0 +1 @@
+CODEOWNERS = ["@kpfleming"]
diff --git a/esphome/components/ade7880/ade7880.cpp b/esphome/components/ade7880/ade7880.cpp
new file mode 100644
index 0000000000..4a45b3b321
--- /dev/null
+++ b/esphome/components/ade7880/ade7880.cpp
@@ -0,0 +1,304 @@
+// This component was developed using knowledge gathered by a number
+// of people who reverse-engineered the Shelly 3EM:
+//
+// @AndreKR on GitHub
+// Axel (@Axel830 on GitHub)
+// Marko (@goodkiller on GitHub)
+// Michaël Piron (@michaelpiron on GitHub)
+// Theo Arends (@arendst on GitHub)
+
+#include "ade7880.h"
+#include "ade7880_registers.h"
+#include "esphome/core/log.h"
+
+#include
+
+namespace esphome {
+namespace ade7880 {
+
+static const char *const TAG = "ade7880";
+
+void IRAM_ATTR ADE7880Store::gpio_intr(ADE7880Store *arg) { arg->reset_done = true; }
+
+void ADE7880::setup() {
+ if (this->irq0_pin_ != nullptr) {
+ this->irq0_pin_->setup();
+ }
+ this->irq1_pin_->setup();
+ if (this->reset_pin_ != nullptr) {
+ this->reset_pin_->setup();
+ }
+ this->store_.irq1_pin = this->irq1_pin_->to_isr();
+ this->irq1_pin_->attach_interrupt(ADE7880Store::gpio_intr, &this->store_, gpio::INTERRUPT_FALLING_EDGE);
+
+ // if IRQ1 is already asserted, the cause must be determined
+ if (this->irq1_pin_->digital_read() == 0) {
+ ESP_LOGD(TAG, "IRQ1 found asserted during setup()");
+ auto status1 = read_u32_register16_(STATUS1);
+ if ((status1 & ~STATUS1_RSTDONE) != 0) {
+ // not safe to proceed, must initiate reset
+ ESP_LOGD(TAG, "IRQ1 asserted for !RSTDONE, resetting device");
+ this->reset_device_();
+ return;
+ }
+ if ((status1 & STATUS1_RSTDONE) == STATUS1_RSTDONE) {
+ // safe to proceed, device has just completed reset cycle
+ ESP_LOGD(TAG, "Acknowledging RSTDONE");
+ this->write_u32_register16_(STATUS0, 0xFFFF);
+ this->write_u32_register16_(STATUS1, 0xFFFF);
+ this->init_device_();
+ return;
+ }
+ }
+
+ this->reset_device_();
+}
+
+void ADE7880::loop() {
+ // check for completion of a reset cycle
+ if (!this->store_.reset_done) {
+ return;
+ }
+
+ ESP_LOGD(TAG, "Acknowledging RSTDONE");
+ this->write_u32_register16_(STATUS0, 0xFFFF);
+ this->write_u32_register16_(STATUS1, 0xFFFF);
+ this->init_device_();
+ this->store_.reset_done = false;
+ this->store_.reset_pending = false;
+}
+
+template
+void ADE7880::update_sensor_from_s24zp_register16_(sensor::Sensor *sensor, uint16_t a_register, F &&f) {
+ if (sensor == nullptr) {
+ return;
+ }
+
+ float val = this->read_s24zp_register16_(a_register);
+ sensor->publish_state(f(val));
+}
+
+template
+void ADE7880::update_sensor_from_s16_register16_(sensor::Sensor *sensor, uint16_t a_register, F &&f) {
+ if (sensor == nullptr) {
+ return;
+ }
+
+ float val = this->read_s16_register16_(a_register);
+ sensor->publish_state(f(val));
+}
+
+template
+void ADE7880::update_sensor_from_s32_register16_(sensor::Sensor *sensor, uint16_t a_register, F &&f) {
+ if (sensor == nullptr) {
+ return;
+ }
+
+ float val = this->read_s32_register16_(a_register);
+ sensor->publish_state(f(val));
+}
+
+void ADE7880::update() {
+ if (this->store_.reset_pending) {
+ return;
+ }
+
+ auto start = millis();
+
+ if (this->channel_n_ != nullptr) {
+ auto *chan = this->channel_n_;
+ this->update_sensor_from_s24zp_register16_(chan->current, NIRMS, [](float val) { return val / 100000.0f; });
+ }
+
+ if (this->channel_a_ != nullptr) {
+ auto *chan = this->channel_a_;
+ this->update_sensor_from_s24zp_register16_(chan->current, AIRMS, [](float val) { return val / 100000.0f; });
+ this->update_sensor_from_s24zp_register16_(chan->voltage, BVRMS, [](float val) { return val / 10000.0f; });
+ this->update_sensor_from_s24zp_register16_(chan->active_power, AWATT, [](float val) { return val / 100.0f; });
+ this->update_sensor_from_s24zp_register16_(chan->apparent_power, AVA, [](float val) { return val / 100.0f; });
+ this->update_sensor_from_s16_register16_(chan->power_factor, APF,
+ [](float val) { return std::abs(val / -327.68f); });
+ this->update_sensor_from_s32_register16_(chan->forward_active_energy, AFWATTHR, [&chan](float val) {
+ return chan->forward_active_energy_total += val / 14400.0f;
+ });
+ this->update_sensor_from_s32_register16_(chan->reverse_active_energy, AFWATTHR, [&chan](float val) {
+ return chan->reverse_active_energy_total += val / 14400.0f;
+ });
+ }
+
+ if (this->channel_b_ != nullptr) {
+ auto *chan = this->channel_b_;
+ this->update_sensor_from_s24zp_register16_(chan->current, BIRMS, [](float val) { return val / 100000.0f; });
+ this->update_sensor_from_s24zp_register16_(chan->voltage, BVRMS, [](float val) { return val / 10000.0f; });
+ this->update_sensor_from_s24zp_register16_(chan->active_power, BWATT, [](float val) { return val / 100.0f; });
+ this->update_sensor_from_s24zp_register16_(chan->apparent_power, BVA, [](float val) { return val / 100.0f; });
+ this->update_sensor_from_s16_register16_(chan->power_factor, BPF,
+ [](float val) { return std::abs(val / -327.68f); });
+ this->update_sensor_from_s32_register16_(chan->forward_active_energy, BFWATTHR, [&chan](float val) {
+ return chan->forward_active_energy_total += val / 14400.0f;
+ });
+ this->update_sensor_from_s32_register16_(chan->reverse_active_energy, BFWATTHR, [&chan](float val) {
+ return chan->reverse_active_energy_total += val / 14400.0f;
+ });
+ }
+
+ if (this->channel_c_ != nullptr) {
+ auto *chan = this->channel_c_;
+ this->update_sensor_from_s24zp_register16_(chan->current, CIRMS, [](float val) { return val / 100000.0f; });
+ this->update_sensor_from_s24zp_register16_(chan->voltage, CVRMS, [](float val) { return val / 10000.0f; });
+ this->update_sensor_from_s24zp_register16_(chan->active_power, CWATT, [](float val) { return val / 100.0f; });
+ this->update_sensor_from_s24zp_register16_(chan->apparent_power, CVA, [](float val) { return val / 100.0f; });
+ this->update_sensor_from_s16_register16_(chan->power_factor, CPF,
+ [](float val) { return std::abs(val / -327.68f); });
+ this->update_sensor_from_s32_register16_(chan->forward_active_energy, CFWATTHR, [&chan](float val) {
+ return chan->forward_active_energy_total += val / 14400.0f;
+ });
+ this->update_sensor_from_s32_register16_(chan->reverse_active_energy, CFWATTHR, [&chan](float val) {
+ return chan->reverse_active_energy_total += val / 14400.0f;
+ });
+ }
+
+ ESP_LOGD(TAG, "update took %" PRIu32 " ms", millis() - start);
+}
+
+void ADE7880::dump_config() {
+ ESP_LOGCONFIG(TAG, "ADE7880:");
+ LOG_PIN(" IRQ0 Pin: ", this->irq0_pin_);
+ LOG_PIN(" IRQ1 Pin: ", this->irq1_pin_);
+ LOG_PIN(" RESET Pin: ", this->reset_pin_);
+ ESP_LOGCONFIG(TAG, " Frequency: %.0f Hz", this->frequency_);
+
+ if (this->channel_a_ != nullptr) {
+ ESP_LOGCONFIG(TAG, " Phase A:");
+ LOG_SENSOR(" ", "Current", this->channel_a_->current);
+ LOG_SENSOR(" ", "Voltage", this->channel_a_->voltage);
+ LOG_SENSOR(" ", "Active Power", this->channel_a_->active_power);
+ LOG_SENSOR(" ", "Apparent Power", this->channel_a_->apparent_power);
+ LOG_SENSOR(" ", "Power Factor", this->channel_a_->power_factor);
+ LOG_SENSOR(" ", "Forward Active Energy", this->channel_a_->forward_active_energy);
+ LOG_SENSOR(" ", "Reverse Active Energy", this->channel_a_->reverse_active_energy);
+ ESP_LOGCONFIG(TAG, " Calibration:");
+ ESP_LOGCONFIG(TAG, " Current: %" PRId32, this->channel_a_->current_gain_calibration);
+ ESP_LOGCONFIG(TAG, " Voltage: %" PRId32, this->channel_a_->voltage_gain_calibration);
+ ESP_LOGCONFIG(TAG, " Power: %" PRId32, this->channel_a_->power_gain_calibration);
+ ESP_LOGCONFIG(TAG, " Phase Angle: %u", this->channel_a_->phase_angle_calibration);
+ }
+
+ if (this->channel_b_ != nullptr) {
+ ESP_LOGCONFIG(TAG, " Phase B:");
+ LOG_SENSOR(" ", "Current", this->channel_b_->current);
+ LOG_SENSOR(" ", "Voltage", this->channel_b_->voltage);
+ LOG_SENSOR(" ", "Active Power", this->channel_b_->active_power);
+ LOG_SENSOR(" ", "Apparent Power", this->channel_b_->apparent_power);
+ LOG_SENSOR(" ", "Power Factor", this->channel_b_->power_factor);
+ LOG_SENSOR(" ", "Forward Active Energy", this->channel_b_->forward_active_energy);
+ LOG_SENSOR(" ", "Reverse Active Energy", this->channel_b_->reverse_active_energy);
+ ESP_LOGCONFIG(TAG, " Calibration:");
+ ESP_LOGCONFIG(TAG, " Current: %" PRId32, this->channel_b_->current_gain_calibration);
+ ESP_LOGCONFIG(TAG, " Voltage: %" PRId32, this->channel_b_->voltage_gain_calibration);
+ ESP_LOGCONFIG(TAG, " Power: %" PRId32, this->channel_b_->power_gain_calibration);
+ ESP_LOGCONFIG(TAG, " Phase Angle: %u", this->channel_b_->phase_angle_calibration);
+ }
+
+ if (this->channel_c_ != nullptr) {
+ ESP_LOGCONFIG(TAG, " Phase C:");
+ LOG_SENSOR(" ", "Current", this->channel_c_->current);
+ LOG_SENSOR(" ", "Voltage", this->channel_c_->voltage);
+ LOG_SENSOR(" ", "Active Power", this->channel_c_->active_power);
+ LOG_SENSOR(" ", "Apparent Power", this->channel_c_->apparent_power);
+ LOG_SENSOR(" ", "Power Factor", this->channel_c_->power_factor);
+ LOG_SENSOR(" ", "Forward Active Energy", this->channel_c_->forward_active_energy);
+ LOG_SENSOR(" ", "Reverse Active Energy", this->channel_c_->reverse_active_energy);
+ ESP_LOGCONFIG(TAG, " Calibration:");
+ ESP_LOGCONFIG(TAG, " Current: %" PRId32, this->channel_c_->current_gain_calibration);
+ ESP_LOGCONFIG(TAG, " Voltage: %" PRId32, this->channel_c_->voltage_gain_calibration);
+ ESP_LOGCONFIG(TAG, " Power: %" PRId32, this->channel_c_->power_gain_calibration);
+ ESP_LOGCONFIG(TAG, " Phase Angle: %u", this->channel_c_->phase_angle_calibration);
+ }
+
+ if (this->channel_n_ != nullptr) {
+ ESP_LOGCONFIG(TAG, " Neutral:");
+ LOG_SENSOR(" ", "Current", this->channel_n_->current);
+ ESP_LOGCONFIG(TAG, " Calibration:");
+ ESP_LOGCONFIG(TAG, " Current: %" PRId32, this->channel_n_->current_gain_calibration);
+ }
+
+ LOG_I2C_DEVICE(this);
+ LOG_UPDATE_INTERVAL(this);
+}
+
+void ADE7880::calibrate_s10zp_reading_(uint16_t a_register, int16_t calibration) {
+ if (calibration == 0) {
+ return;
+ }
+
+ this->write_s10zp_register16_(a_register, calibration);
+}
+
+void ADE7880::calibrate_s24zpse_reading_(uint16_t a_register, int32_t calibration) {
+ if (calibration == 0) {
+ return;
+ }
+
+ this->write_s24zpse_register16_(a_register, calibration);
+}
+
+void ADE7880::init_device_() {
+ this->write_u8_register16_(CONFIG2, CONFIG2_I2C_LOCK);
+
+ this->write_u16_register16_(GAIN, 0);
+
+ if (this->frequency_ > 55) {
+ this->write_u16_register16_(COMPMODE, COMPMODE_DEFAULT | COMPMODE_SELFREQ);
+ }
+
+ if (this->channel_n_ != nullptr) {
+ this->calibrate_s24zpse_reading_(NIGAIN, this->channel_n_->current_gain_calibration);
+ }
+
+ if (this->channel_a_ != nullptr) {
+ this->calibrate_s24zpse_reading_(AIGAIN, this->channel_a_->current_gain_calibration);
+ this->calibrate_s24zpse_reading_(AVGAIN, this->channel_a_->voltage_gain_calibration);
+ this->calibrate_s24zpse_reading_(APGAIN, this->channel_a_->power_gain_calibration);
+ this->calibrate_s10zp_reading_(APHCAL, this->channel_a_->phase_angle_calibration);
+ }
+
+ if (this->channel_b_ != nullptr) {
+ this->calibrate_s24zpse_reading_(BIGAIN, this->channel_b_->current_gain_calibration);
+ this->calibrate_s24zpse_reading_(BVGAIN, this->channel_b_->voltage_gain_calibration);
+ this->calibrate_s24zpse_reading_(BPGAIN, this->channel_b_->power_gain_calibration);
+ this->calibrate_s10zp_reading_(BPHCAL, this->channel_b_->phase_angle_calibration);
+ }
+
+ if (this->channel_c_ != nullptr) {
+ this->calibrate_s24zpse_reading_(CIGAIN, this->channel_c_->current_gain_calibration);
+ this->calibrate_s24zpse_reading_(CVGAIN, this->channel_c_->voltage_gain_calibration);
+ this->calibrate_s24zpse_reading_(CPGAIN, this->channel_c_->power_gain_calibration);
+ this->calibrate_s10zp_reading_(CPHCAL, this->channel_c_->phase_angle_calibration);
+ }
+
+ // write three default values to data memory RAM to flush the I2C write queue
+ this->write_s32_register16_(VLEVEL, 0);
+ this->write_s32_register16_(VLEVEL, 0);
+ this->write_s32_register16_(VLEVEL, 0);
+
+ this->write_u8_register16_(DSPWP_SEL, DSPWP_SEL_SET);
+ this->write_u8_register16_(DSPWP_SET, DSPWP_SET_RO);
+ this->write_u16_register16_(RUN, RUN_ENABLE);
+}
+
+void ADE7880::reset_device_() {
+ if (this->reset_pin_ != nullptr) {
+ ESP_LOGD(TAG, "Reset device using RESET pin");
+ this->reset_pin_->digital_write(false);
+ delay(1);
+ this->reset_pin_->digital_write(true);
+ } else {
+ ESP_LOGD(TAG, "Reset device using SWRST command");
+ this->write_u16_register16_(CONFIG, CONFIG_SWRST);
+ }
+ this->store_.reset_pending = true;
+}
+
+} // namespace ade7880
+} // namespace esphome
diff --git a/esphome/components/ade7880/ade7880.h b/esphome/components/ade7880/ade7880.h
new file mode 100644
index 0000000000..a565357dc5
--- /dev/null
+++ b/esphome/components/ade7880/ade7880.h
@@ -0,0 +1,131 @@
+#pragma once
+
+// This component was developed using knowledge gathered by a number
+// of people who reverse-engineered the Shelly 3EM:
+//
+// @AndreKR on GitHub
+// Axel (@Axel830 on GitHub)
+// Marko (@goodkiller on GitHub)
+// Michaël Piron (@michaelpiron on GitHub)
+// Theo Arends (@arendst on GitHub)
+
+#include "esphome/core/component.h"
+#include "esphome/core/hal.h"
+#include "esphome/components/i2c/i2c.h"
+#include "esphome/components/sensor/sensor.h"
+
+#include "ade7880_registers.h"
+
+namespace esphome {
+namespace ade7880 {
+
+struct NeutralChannel {
+ void set_current(sensor::Sensor *sens) { this->current = sens; }
+
+ void set_current_gain_calibration(int32_t val) { this->current_gain_calibration = val; }
+
+ sensor::Sensor *current{nullptr};
+ int32_t current_gain_calibration{0};
+};
+
+struct PowerChannel {
+ void set_current(sensor::Sensor *sens) { this->current = sens; }
+ void set_voltage(sensor::Sensor *sens) { this->voltage = sens; }
+ void set_active_power(sensor::Sensor *sens) { this->active_power = sens; }
+ void set_apparent_power(sensor::Sensor *sens) { this->apparent_power = sens; }
+ void set_power_factor(sensor::Sensor *sens) { this->power_factor = sens; }
+ void set_forward_active_energy(sensor::Sensor *sens) { this->forward_active_energy = sens; }
+ void set_reverse_active_energy(sensor::Sensor *sens) { this->reverse_active_energy = sens; }
+
+ void set_current_gain_calibration(int32_t val) { this->current_gain_calibration = val; }
+ void set_voltage_gain_calibration(int32_t val) { this->voltage_gain_calibration = val; }
+ void set_power_gain_calibration(int32_t val) { this->power_gain_calibration = val; }
+ void set_phase_angle_calibration(int32_t val) { this->phase_angle_calibration = val; }
+
+ sensor::Sensor *current{nullptr};
+ sensor::Sensor *voltage{nullptr};
+ sensor::Sensor *active_power{nullptr};
+ sensor::Sensor *apparent_power{nullptr};
+ sensor::Sensor *power_factor{nullptr};
+ sensor::Sensor *forward_active_energy{nullptr};
+ sensor::Sensor *reverse_active_energy{nullptr};
+ int32_t current_gain_calibration{0};
+ int32_t voltage_gain_calibration{0};
+ int32_t power_gain_calibration{0};
+ uint16_t phase_angle_calibration{0};
+ float forward_active_energy_total{0};
+ float reverse_active_energy_total{0};
+};
+
+// Store data in a class that doesn't use multiple-inheritance (no vtables in flash!)
+struct ADE7880Store {
+ volatile bool reset_done{false};
+ bool reset_pending{false};
+ ISRInternalGPIOPin irq1_pin;
+
+ static void gpio_intr(ADE7880Store *arg);
+};
+
+class ADE7880 : public i2c::I2CDevice, public PollingComponent {
+ public:
+ void set_irq0_pin(InternalGPIOPin *pin) { this->irq0_pin_ = pin; }
+ void set_irq1_pin(InternalGPIOPin *pin) { this->irq1_pin_ = pin; }
+ void set_reset_pin(InternalGPIOPin *pin) { this->reset_pin_ = pin; }
+ void set_frequency(float frequency) { this->frequency_ = frequency; }
+ void set_channel_n(NeutralChannel *channel) { this->channel_n_ = channel; }
+ void set_channel_a(PowerChannel *channel) { this->channel_a_ = channel; }
+ void set_channel_b(PowerChannel *channel) { this->channel_b_ = channel; }
+ void set_channel_c(PowerChannel *channel) { this->channel_c_ = channel; }
+
+ void setup() override;
+
+ void loop() override;
+
+ void update() override;
+
+ void dump_config() override;
+
+ float get_setup_priority() const override { return setup_priority::DATA; }
+
+ protected:
+ ADE7880Store store_{};
+ InternalGPIOPin *irq0_pin_{nullptr};
+ InternalGPIOPin *irq1_pin_{nullptr};
+ InternalGPIOPin *reset_pin_{nullptr};
+ float frequency_;
+ NeutralChannel *channel_n_{nullptr};
+ PowerChannel *channel_a_{nullptr};
+ PowerChannel *channel_b_{nullptr};
+ PowerChannel *channel_c_{nullptr};
+
+ void calibrate_s10zp_reading_(uint16_t a_register, int16_t calibration);
+ void calibrate_s24zpse_reading_(uint16_t a_register, int32_t calibration);
+
+ void init_device_();
+
+ // each of these functions allow the caller to pass in a lambda (or any other callable)
+ // which modifies the value read from the register before it is passed to the sensor
+ // the callable will be passed a 'float' value and is expected to return a 'float'
+ template void update_sensor_from_s24zp_register16_(sensor::Sensor *sensor, uint16_t a_register, F &&f);
+ template void update_sensor_from_s16_register16_(sensor::Sensor *sensor, uint16_t a_register, F &&f);
+ template void update_sensor_from_s32_register16_(sensor::Sensor *sensor, uint16_t a_register, F &&f);
+
+ void reset_device_();
+
+ uint8_t read_u8_register16_(uint16_t a_register);
+ int16_t read_s16_register16_(uint16_t a_register);
+ uint16_t read_u16_register16_(uint16_t a_register);
+ int32_t read_s24zp_register16_(uint16_t a_register);
+ int32_t read_s32_register16_(uint16_t a_register);
+ uint32_t read_u32_register16_(uint16_t a_register);
+
+ void write_u8_register16_(uint16_t a_register, uint8_t value);
+ void write_s10zp_register16_(uint16_t a_register, int16_t value);
+ void write_u16_register16_(uint16_t a_register, uint16_t value);
+ void write_s24zpse_register16_(uint16_t a_register, int32_t value);
+ void write_s32_register16_(uint16_t a_register, int32_t value);
+ void write_u32_register16_(uint16_t a_register, uint32_t value);
+};
+
+} // namespace ade7880
+} // namespace esphome
diff --git a/esphome/components/ade7880/ade7880_i2c.cpp b/esphome/components/ade7880/ade7880_i2c.cpp
new file mode 100644
index 0000000000..fae20f175d
--- /dev/null
+++ b/esphome/components/ade7880/ade7880_i2c.cpp
@@ -0,0 +1,101 @@
+// This component was developed using knowledge gathered by a number
+// of people who reverse-engineered the Shelly 3EM:
+//
+// @AndreKR on GitHub
+// Axel (@Axel830 on GitHub)
+// Marko (@goodkiller on GitHub)
+// Michaël Piron (@michaelpiron on GitHub)
+// Theo Arends (@arendst on GitHub)
+
+#include "ade7880.h"
+
+namespace esphome {
+namespace ade7880 {
+
+// adapted from https://stackoverflow.com/a/55912127/1886371
+template inline T sign_extend(const T &v) noexcept {
+ using S = struct { signed Val : Bits; };
+ return reinterpret_cast(&v)->Val;
+}
+
+// Register types
+// unsigned 8-bit (uint8_t)
+// signed 10-bit - 16-bit ZP on wire (int16_t, needs sign extension)
+// unsigned 16-bit (uint16_t)
+// unsigned 20-bit - 32-bit ZP on wire (uint32_t)
+// signed 24-bit - 32-bit ZPSE on wire (int32_t, needs sign extension)
+// signed 24-bit - 32-bit ZP on wire (int32_t, needs sign extension)
+// signed 24-bit - 32-bit SE on wire (int32_t)
+// signed 28-bit - 32-bit ZP on wire (int32_t, needs sign extension)
+// unsigned 32-bit (uint32_t)
+// signed 32-bit (int32_t)
+
+uint8_t ADE7880::read_u8_register16_(uint16_t a_register) {
+ uint8_t in;
+ this->read_register16(a_register, &in, sizeof(in));
+ return in;
+}
+
+int16_t ADE7880::read_s16_register16_(uint16_t a_register) {
+ int16_t in;
+ this->read_register16(a_register, reinterpret_cast(&in), sizeof(in));
+ return convert_big_endian(in);
+}
+
+uint16_t ADE7880::read_u16_register16_(uint16_t a_register) {
+ uint16_t in;
+ this->read_register16(a_register, reinterpret_cast(&in), sizeof(in));
+ return convert_big_endian(in);
+}
+
+int32_t ADE7880::read_s24zp_register16_(uint16_t a_register) {
+ // s24zp means 24 bit signed value in the lower 24 bits of a 32-bit register
+ int32_t in;
+ this->read_register16(a_register, reinterpret_cast(&in), sizeof(in));
+ return sign_extend<24>(convert_big_endian(in));
+}
+
+int32_t ADE7880::read_s32_register16_(uint16_t a_register) {
+ int32_t in;
+ this->read_register16(a_register, reinterpret_cast(&in), sizeof(in));
+ return convert_big_endian(in);
+}
+
+uint32_t ADE7880::read_u32_register16_(uint16_t a_register) {
+ uint32_t in;
+ this->read_register16(a_register, reinterpret_cast(&in), sizeof(in));
+ return convert_big_endian(in);
+}
+
+void ADE7880::write_u8_register16_(uint16_t a_register, uint8_t value) {
+ this->write_register16(a_register, &value, sizeof(value));
+}
+
+void ADE7880::write_s10zp_register16_(uint16_t a_register, int16_t value) {
+ int16_t out = convert_big_endian(value & 0x03FF);
+ this->write_register16(a_register, reinterpret_cast(&out), sizeof(out));
+}
+
+void ADE7880::write_u16_register16_(uint16_t a_register, uint16_t value) {
+ uint16_t out = convert_big_endian(value);
+ this->write_register16(a_register, reinterpret_cast(&out), sizeof(out));
+}
+
+void ADE7880::write_s24zpse_register16_(uint16_t a_register, int32_t value) {
+ // s24zpse means a 24-bit signed value, sign-extended to 28 bits, in the lower 28 bits of a 32-bit register
+ int32_t out = convert_big_endian(value & 0x0FFFFFFF);
+ this->write_register16(a_register, reinterpret_cast(&out), sizeof(out));
+}
+
+void ADE7880::write_s32_register16_(uint16_t a_register, int32_t value) {
+ int32_t out = convert_big_endian(value);
+ this->write_register16(a_register, reinterpret_cast(&out), sizeof(out));
+}
+
+void ADE7880::write_u32_register16_(uint16_t a_register, uint32_t value) {
+ uint32_t out = convert_big_endian(value);
+ this->write_register16(a_register, reinterpret_cast(&out), sizeof(out));
+}
+
+} // namespace ade7880
+} // namespace esphome
diff --git a/esphome/components/ade7880/ade7880_registers.h b/esphome/components/ade7880/ade7880_registers.h
new file mode 100644
index 0000000000..8b5b68abb0
--- /dev/null
+++ b/esphome/components/ade7880/ade7880_registers.h
@@ -0,0 +1,243 @@
+#pragma once
+
+// This file is a modified version of the one created by Michaël Piron (@michaelpiron on GitHub)
+
+// Source: https://www.analog.com/media/en/technical-documentation/application-notes/AN-1127.pdf
+
+namespace esphome {
+namespace ade7880 {
+
+// DSP Data Memory RAM registers
+constexpr uint16_t AIGAIN = 0x4380;
+constexpr uint16_t AVGAIN = 0x4381;
+constexpr uint16_t BIGAIN = 0x4382;
+constexpr uint16_t BVGAIN = 0x4383;
+constexpr uint16_t CIGAIN = 0x4384;
+constexpr uint16_t CVGAIN = 0x4385;
+constexpr uint16_t NIGAIN = 0x4386;
+
+constexpr uint16_t DICOEFF = 0x4388;
+
+constexpr uint16_t APGAIN = 0x4389;
+constexpr uint16_t AWATTOS = 0x438A;
+constexpr uint16_t BPGAIN = 0x438B;
+constexpr uint16_t BWATTOS = 0x438C;
+constexpr uint16_t CPGAIN = 0x438D;
+constexpr uint16_t CWATTOS = 0x438E;
+constexpr uint16_t AIRMSOS = 0x438F;
+constexpr uint16_t AVRMSOS = 0x4390;
+constexpr uint16_t BIRMSOS = 0x4391;
+constexpr uint16_t BVRMSOS = 0x4392;
+constexpr uint16_t CIRMSOS = 0x4393;
+constexpr uint16_t CVRMSOS = 0x4394;
+constexpr uint16_t NIRMSOS = 0x4395;
+constexpr uint16_t HPGAIN = 0x4398;
+constexpr uint16_t ISUMLVL = 0x4399;
+
+constexpr uint16_t VLEVEL = 0x439F;
+
+constexpr uint16_t AFWATTOS = 0x43A2;
+constexpr uint16_t BFWATTOS = 0x43A3;
+constexpr uint16_t CFWATTOS = 0x43A4;
+
+constexpr uint16_t AFVAROS = 0x43A5;
+constexpr uint16_t BFVAROS = 0x43A6;
+constexpr uint16_t CFVAROS = 0x43A7;
+
+constexpr uint16_t AFIRMSOS = 0x43A8;
+constexpr uint16_t BFIRMSOS = 0x43A9;
+constexpr uint16_t CFIRMSOS = 0x43AA;
+
+constexpr uint16_t AFVRMSOS = 0x43AB;
+constexpr uint16_t BFVRMSOS = 0x43AC;
+constexpr uint16_t CFVRMSOS = 0x43AD;
+
+constexpr uint16_t HXWATTOS = 0x43AE;
+constexpr uint16_t HYWATTOS = 0x43AF;
+constexpr uint16_t HZWATTOS = 0x43B0;
+constexpr uint16_t HXVAROS = 0x43B1;
+constexpr uint16_t HYVAROS = 0x43B2;
+constexpr uint16_t HZVAROS = 0x43B3;
+
+constexpr uint16_t HXIRMSOS = 0x43B4;
+constexpr uint16_t HYIRMSOS = 0x43B5;
+constexpr uint16_t HZIRMSOS = 0x43B6;
+constexpr uint16_t HXVRMSOS = 0x43B7;
+constexpr uint16_t HYVRMSOS = 0x43B8;
+constexpr uint16_t HZVRMSOS = 0x43B9;
+
+constexpr uint16_t AIRMS = 0x43C0;
+constexpr uint16_t AVRMS = 0x43C1;
+constexpr uint16_t BIRMS = 0x43C2;
+constexpr uint16_t BVRMS = 0x43C3;
+constexpr uint16_t CIRMS = 0x43C4;
+constexpr uint16_t CVRMS = 0x43C5;
+constexpr uint16_t NIRMS = 0x43C6;
+
+constexpr uint16_t ISUM = 0x43C7;
+
+// Internal DSP Memory RAM registers
+constexpr uint16_t RUN = 0xE228;
+
+constexpr uint16_t AWATTHR = 0xE400;
+constexpr uint16_t BWATTHR = 0xE401;
+constexpr uint16_t CWATTHR = 0xE402;
+constexpr uint16_t AFWATTHR = 0xE403;
+constexpr uint16_t BFWATTHR = 0xE404;
+constexpr uint16_t CFWATTHR = 0xE405;
+constexpr uint16_t AFVARHR = 0xE409;
+constexpr uint16_t BFVARHR = 0xE40A;
+constexpr uint16_t CFVARHR = 0xE40B;
+
+constexpr uint16_t AVAHR = 0xE40C;
+constexpr uint16_t BVAHR = 0xE40D;
+constexpr uint16_t CVAHR = 0xE40E;
+
+constexpr uint16_t IPEAK = 0xE500;
+constexpr uint16_t VPEAK = 0xE501;
+
+constexpr uint16_t STATUS0 = 0xE502;
+constexpr uint16_t STATUS1 = 0xE503;
+
+constexpr uint16_t AIMAV = 0xE504;
+constexpr uint16_t BIMAV = 0xE505;
+constexpr uint16_t CIMAV = 0xE506;
+
+constexpr uint16_t OILVL = 0xE507;
+constexpr uint16_t OVLVL = 0xE508;
+constexpr uint16_t SAGLVL = 0xE509;
+constexpr uint16_t MASK0 = 0xE50A;
+constexpr uint16_t MASK1 = 0xE50B;
+
+constexpr uint16_t IAWV = 0xE50C;
+constexpr uint16_t IBWV = 0xE50D;
+constexpr uint16_t ICWV = 0xE50E;
+constexpr uint16_t INWV = 0xE50F;
+constexpr uint16_t VAWV = 0xE510;
+constexpr uint16_t VBWV = 0xE511;
+constexpr uint16_t VCWV = 0xE512;
+
+constexpr uint16_t AWATT = 0xE513;
+constexpr uint16_t BWATT = 0xE514;
+constexpr uint16_t CWATT = 0xE515;
+
+constexpr uint16_t AFVAR = 0xE516;
+constexpr uint16_t BFVAR = 0xE517;
+constexpr uint16_t CFVAR = 0xE518;
+
+constexpr uint16_t AVA = 0xE519;
+constexpr uint16_t BVA = 0xE51A;
+constexpr uint16_t CVA = 0xE51B;
+
+constexpr uint16_t CHECKSUM = 0xE51F;
+constexpr uint16_t VNOM = 0xE520;
+constexpr uint16_t LAST_RWDATA_24BIT = 0xE5FF;
+constexpr uint16_t PHSTATUS = 0xE600;
+constexpr uint16_t ANGLE0 = 0xE601;
+constexpr uint16_t ANGLE1 = 0xE602;
+constexpr uint16_t ANGLE2 = 0xE603;
+constexpr uint16_t PHNOLOAD = 0xE608;
+constexpr uint16_t LINECYC = 0xE60C;
+constexpr uint16_t ZXTOUT = 0xE60D;
+constexpr uint16_t COMPMODE = 0xE60E;
+constexpr uint16_t GAIN = 0xE60F;
+constexpr uint16_t CFMODE = 0xE610;
+constexpr uint16_t CF1DEN = 0xE611;
+constexpr uint16_t CF2DEN = 0xE612;
+constexpr uint16_t CF3DEN = 0xE613;
+constexpr uint16_t APHCAL = 0xE614;
+constexpr uint16_t BPHCAL = 0xE615;
+constexpr uint16_t CPHCAL = 0xE616;
+constexpr uint16_t PHSIGN = 0xE617;
+constexpr uint16_t CONFIG = 0xE618;
+constexpr uint16_t MMODE = 0xE700;
+constexpr uint16_t ACCMODE = 0xE701;
+constexpr uint16_t LCYCMODE = 0xE702;
+constexpr uint16_t PEAKCYC = 0xE703;
+constexpr uint16_t SAGCYC = 0xE704;
+constexpr uint16_t CFCYC = 0xE705;
+constexpr uint16_t HSDC_CFG = 0xE706;
+constexpr uint16_t VERSION = 0xE707;
+constexpr uint16_t DSPWP_SET = 0xE7E3;
+constexpr uint16_t LAST_RWDATA_8BIT = 0xE7FD;
+constexpr uint16_t DSPWP_SEL = 0xE7FE;
+constexpr uint16_t FVRMS = 0xE880;
+constexpr uint16_t FIRMS = 0xE881;
+constexpr uint16_t FWATT = 0xE882;
+constexpr uint16_t FVAR = 0xE883;
+constexpr uint16_t FVA = 0xE884;
+constexpr uint16_t FPF = 0xE885;
+constexpr uint16_t VTHDN = 0xE886;
+constexpr uint16_t ITHDN = 0xE887;
+constexpr uint16_t HXVRMS = 0xE888;
+constexpr uint16_t HXIRMS = 0xE889;
+constexpr uint16_t HXWATT = 0xE88A;
+constexpr uint16_t HXVAR = 0xE88B;
+constexpr uint16_t HXVA = 0xE88C;
+constexpr uint16_t HXPF = 0xE88D;
+constexpr uint16_t HXVHD = 0xE88E;
+constexpr uint16_t HXIHD = 0xE88F;
+constexpr uint16_t HYVRMS = 0xE890;
+constexpr uint16_t HYIRMS = 0xE891;
+constexpr uint16_t HYWATT = 0xE892;
+constexpr uint16_t HYVAR = 0xE893;
+constexpr uint16_t HYVA = 0xE894;
+constexpr uint16_t HYPF = 0xE895;
+constexpr uint16_t HYVHD = 0xE896;
+constexpr uint16_t HYIHD = 0xE897;
+constexpr uint16_t HZVRMS = 0xE898;
+constexpr uint16_t HZIRMS = 0xE899;
+constexpr uint16_t HZWATT = 0xE89A;
+constexpr uint16_t HZVAR = 0xE89B;
+constexpr uint16_t HZVA = 0xE89C;
+constexpr uint16_t HZPF = 0xE89D;
+constexpr uint16_t HZVHD = 0xE89E;
+constexpr uint16_t HZIHD = 0xE89F;
+constexpr uint16_t HCONFIG = 0xE900;
+constexpr uint16_t APF = 0xE902;
+constexpr uint16_t BPF = 0xE903;
+constexpr uint16_t CPF = 0xE904;
+constexpr uint16_t APERIOD = 0xE905;
+constexpr uint16_t BPERIOD = 0xE906;
+constexpr uint16_t CPERIOD = 0xE907;
+constexpr uint16_t APNOLOAD = 0xE908;
+constexpr uint16_t VARNOLOAD = 0xE909;
+constexpr uint16_t VANOLOAD = 0xE90A;
+constexpr uint16_t LAST_ADD = 0xE9FE;
+constexpr uint16_t LAST_RWDATA_16BIT = 0xE9FF;
+constexpr uint16_t CONFIG3 = 0xEA00;
+constexpr uint16_t LAST_OP = 0xEA01;
+constexpr uint16_t WTHR = 0xEA02;
+constexpr uint16_t VARTHR = 0xEA03;
+constexpr uint16_t VATHR = 0xEA04;
+
+constexpr uint16_t HX_REG = 0xEA08;
+constexpr uint16_t HY_REG = 0xEA09;
+constexpr uint16_t HZ_REG = 0xEA0A;
+constexpr uint16_t LPOILVL = 0xEC00;
+constexpr uint16_t CONFIG2 = 0xEC01;
+
+// STATUS1 Register Bits
+constexpr uint32_t STATUS1_RSTDONE = (1 << 15);
+
+// CONFIG Register Bits
+constexpr uint16_t CONFIG_SWRST = (1 << 7);
+
+// CONFIG2 Register Bits
+constexpr uint8_t CONFIG2_I2C_LOCK = (1 << 1);
+
+// COMPMODE Register Bits
+constexpr uint16_t COMPMODE_DEFAULT = 0x01FF;
+constexpr uint16_t COMPMODE_SELFREQ = (1 << 14);
+
+// RUN Register Bits
+constexpr uint16_t RUN_ENABLE = (1 << 0);
+
+// DSPWP_SET Register Bits
+constexpr uint8_t DSPWP_SET_RO = (1 << 7);
+
+// DSPWP_SEL Register Bits
+constexpr uint8_t DSPWP_SEL_SET = 0xAD;
+
+} // namespace ade7880
+} // namespace esphome
diff --git a/esphome/components/ade7880/sensor.py b/esphome/components/ade7880/sensor.py
new file mode 100644
index 0000000000..e075adb04c
--- /dev/null
+++ b/esphome/components/ade7880/sensor.py
@@ -0,0 +1,290 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import sensor, i2c
+from esphome import pins
+from esphome.const import (
+ CONF_ACTIVE_POWER,
+ CONF_APPARENT_POWER,
+ CONF_CALIBRATION,
+ CONF_CURRENT,
+ CONF_FORWARD_ACTIVE_ENERGY,
+ CONF_FREQUENCY,
+ CONF_ID,
+ CONF_NAME,
+ CONF_PHASE_A,
+ CONF_PHASE_ANGLE,
+ CONF_PHASE_B,
+ CONF_PHASE_C,
+ CONF_POWER_FACTOR,
+ CONF_RESET_PIN,
+ CONF_REVERSE_ACTIVE_ENERGY,
+ CONF_VOLTAGE,
+ CONF_VOLTAGE_GAIN,
+ DEVICE_CLASS_APPARENT_POWER,
+ DEVICE_CLASS_CURRENT,
+ DEVICE_CLASS_ENERGY,
+ DEVICE_CLASS_POWER,
+ DEVICE_CLASS_POWER_FACTOR,
+ DEVICE_CLASS_VOLTAGE,
+ STATE_CLASS_MEASUREMENT,
+ STATE_CLASS_TOTAL_INCREASING,
+ UNIT_AMPERE,
+ UNIT_PERCENT,
+ UNIT_VOLT,
+ UNIT_VOLT_AMPS,
+ UNIT_VOLT_AMPS_REACTIVE_HOURS,
+ UNIT_WATT,
+ UNIT_WATT_HOURS,
+)
+
+DEPENDENCIES = ["i2c"]
+
+ade7880_ns = cg.esphome_ns.namespace("ade7880")
+ADE7880 = ade7880_ns.class_("ADE7880", cg.PollingComponent, i2c.I2CDevice)
+NeutralChannel = ade7880_ns.struct("NeutralChannel")
+PowerChannel = ade7880_ns.struct("PowerChannel")
+
+CONF_CURRENT_GAIN = "current_gain"
+CONF_IRQ0_PIN = "irq0_pin"
+CONF_IRQ1_PIN = "irq1_pin"
+CONF_POWER_GAIN = "power_gain"
+
+CONF_NEUTRAL = "neutral"
+
+NEUTRAL_CHANNEL_SCHEMA = cv.Schema(
+ {
+ cv.GenerateID(): cv.declare_id(NeutralChannel),
+ cv.Optional(CONF_NAME): cv.string_strict,
+ cv.Required(CONF_CURRENT): cv.maybe_simple_value(
+ sensor.sensor_schema(
+ unit_of_measurement=UNIT_AMPERE,
+ accuracy_decimals=2,
+ device_class=DEVICE_CLASS_CURRENT,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ key=CONF_NAME,
+ ),
+ cv.Required(CONF_CALIBRATION): cv.Schema(
+ {
+ cv.Required(CONF_CURRENT_GAIN): cv.int_,
+ },
+ ),
+ }
+)
+
+POWER_CHANNEL_SCHEMA = cv.Schema(
+ {
+ cv.GenerateID(): cv.declare_id(PowerChannel),
+ cv.Optional(CONF_NAME): cv.string_strict,
+ cv.Optional(CONF_VOLTAGE): cv.maybe_simple_value(
+ sensor.sensor_schema(
+ unit_of_measurement=UNIT_VOLT,
+ accuracy_decimals=1,
+ device_class=DEVICE_CLASS_VOLTAGE,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ key=CONF_NAME,
+ ),
+ cv.Optional(CONF_CURRENT): cv.maybe_simple_value(
+ sensor.sensor_schema(
+ unit_of_measurement=UNIT_AMPERE,
+ accuracy_decimals=2,
+ device_class=DEVICE_CLASS_CURRENT,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ key=CONF_NAME,
+ ),
+ cv.Optional(CONF_ACTIVE_POWER): cv.maybe_simple_value(
+ sensor.sensor_schema(
+ unit_of_measurement=UNIT_WATT,
+ accuracy_decimals=1,
+ device_class=DEVICE_CLASS_POWER,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ key=CONF_NAME,
+ ),
+ cv.Optional(CONF_APPARENT_POWER): cv.maybe_simple_value(
+ sensor.sensor_schema(
+ unit_of_measurement=UNIT_VOLT_AMPS,
+ accuracy_decimals=1,
+ device_class=DEVICE_CLASS_APPARENT_POWER,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ key=CONF_NAME,
+ ),
+ cv.Optional(CONF_POWER_FACTOR): cv.maybe_simple_value(
+ sensor.sensor_schema(
+ unit_of_measurement=UNIT_PERCENT,
+ accuracy_decimals=0,
+ device_class=DEVICE_CLASS_POWER_FACTOR,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ key=CONF_NAME,
+ ),
+ cv.Optional(CONF_FORWARD_ACTIVE_ENERGY): cv.maybe_simple_value(
+ sensor.sensor_schema(
+ unit_of_measurement=UNIT_WATT_HOURS,
+ accuracy_decimals=2,
+ device_class=DEVICE_CLASS_ENERGY,
+ state_class=STATE_CLASS_TOTAL_INCREASING,
+ ),
+ key=CONF_NAME,
+ ),
+ cv.Optional(CONF_REVERSE_ACTIVE_ENERGY): cv.maybe_simple_value(
+ sensor.sensor_schema(
+ unit_of_measurement=UNIT_VOLT_AMPS_REACTIVE_HOURS,
+ accuracy_decimals=2,
+ device_class=DEVICE_CLASS_ENERGY,
+ state_class=STATE_CLASS_TOTAL_INCREASING,
+ ),
+ key=CONF_NAME,
+ ),
+ cv.Required(CONF_CALIBRATION): cv.Schema(
+ {
+ cv.Required(CONF_CURRENT_GAIN): cv.int_,
+ cv.Required(CONF_VOLTAGE_GAIN): cv.int_,
+ cv.Required(CONF_POWER_GAIN): cv.int_,
+ cv.Required(CONF_PHASE_ANGLE): cv.int_,
+ },
+ ),
+ }
+)
+
+CONFIG_SCHEMA = (
+ cv.Schema(
+ {
+ cv.GenerateID(): cv.declare_id(ADE7880),
+ cv.Optional(CONF_FREQUENCY, default="50Hz"): cv.All(
+ cv.frequency, cv.Range(min=45.0, max=66.0)
+ ),
+ cv.Optional(CONF_IRQ0_PIN): pins.internal_gpio_input_pin_schema,
+ cv.Required(CONF_IRQ1_PIN): pins.internal_gpio_input_pin_schema,
+ cv.Optional(CONF_RESET_PIN): pins.internal_gpio_output_pin_schema,
+ cv.Optional(CONF_PHASE_A): POWER_CHANNEL_SCHEMA,
+ cv.Optional(CONF_PHASE_B): POWER_CHANNEL_SCHEMA,
+ cv.Optional(CONF_PHASE_C): POWER_CHANNEL_SCHEMA,
+ cv.Optional(CONF_NEUTRAL): NEUTRAL_CHANNEL_SCHEMA,
+ }
+ )
+ .extend(cv.polling_component_schema("60s"))
+ .extend(i2c.i2c_device_schema(0x38))
+)
+
+
+async def neutral_channel(config):
+ var = cg.new_Pvariable(config[CONF_ID])
+
+ current = config[CONF_CURRENT]
+ sens = await sensor.new_sensor(current)
+ cg.add(var.set_current(sens))
+
+ cg.add(
+ var.set_current_gain_calibration(config[CONF_CALIBRATION][CONF_CURRENT_GAIN])
+ )
+
+ return var
+
+
+async def power_channel(config):
+ var = cg.new_Pvariable(config[CONF_ID])
+
+ for sensor_type in [
+ CONF_CURRENT,
+ CONF_VOLTAGE,
+ CONF_ACTIVE_POWER,
+ CONF_APPARENT_POWER,
+ CONF_POWER_FACTOR,
+ CONF_FORWARD_ACTIVE_ENERGY,
+ CONF_REVERSE_ACTIVE_ENERGY,
+ ]:
+ if conf := config.get(sensor_type):
+ sens = await sensor.new_sensor(conf)
+ cg.add(getattr(var, f"set_{sensor_type}")(sens))
+
+ for calib_type in [
+ CONF_CURRENT_GAIN,
+ CONF_VOLTAGE_GAIN,
+ CONF_POWER_GAIN,
+ CONF_PHASE_ANGLE,
+ ]:
+ cg.add(
+ getattr(var, f"set_{calib_type}_calibration")(
+ config[CONF_CALIBRATION][calib_type]
+ )
+ )
+
+ return var
+
+
+def final_validate(config):
+ for channel in [CONF_PHASE_A, CONF_PHASE_B, CONF_PHASE_C]:
+ if channel := config.get(channel):
+ channel_name = channel.get(CONF_NAME)
+
+ for sensor_type in [
+ CONF_CURRENT,
+ CONF_VOLTAGE,
+ CONF_ACTIVE_POWER,
+ CONF_APPARENT_POWER,
+ CONF_POWER_FACTOR,
+ CONF_FORWARD_ACTIVE_ENERGY,
+ CONF_REVERSE_ACTIVE_ENERGY,
+ ]:
+ if conf := channel.get(sensor_type):
+ sensor_name = conf.get(CONF_NAME)
+ if (
+ sensor_name
+ and channel_name
+ and not sensor_name.startswith(channel_name)
+ ):
+ conf[CONF_NAME] = f"{channel_name} {sensor_name}"
+
+ if channel := config.get(CONF_NEUTRAL):
+ channel_name = channel.get(CONF_NAME)
+ if conf := channel.get(CONF_CURRENT):
+ sensor_name = conf.get(CONF_NAME)
+ if (
+ sensor_name
+ and channel_name
+ and not sensor_name.startswith(channel_name)
+ ):
+ conf[CONF_NAME] = f"{channel_name} {sensor_name}"
+
+
+FINAL_VALIDATE_SCHEMA = final_validate
+
+
+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)
+
+ if irq0_pin := config.get(CONF_IRQ0_PIN):
+ pin = await cg.gpio_pin_expression(irq0_pin)
+ cg.add(var.set_irq0_pin(pin))
+
+ pin = await cg.gpio_pin_expression(config[CONF_IRQ1_PIN])
+ cg.add(var.set_irq1_pin(pin))
+
+ if reset_pin := config.get(CONF_RESET_PIN):
+ pin = await cg.gpio_pin_expression(reset_pin)
+ cg.add(var.set_reset_pin(pin))
+
+ if frequency := config.get(CONF_FREQUENCY):
+ cg.add(var.set_frequency(frequency))
+
+ if channel := config.get(CONF_PHASE_A):
+ chan = await power_channel(channel)
+ cg.add(var.set_channel_a(chan))
+
+ if channel := config.get(CONF_PHASE_B):
+ chan = await power_channel(channel)
+ cg.add(var.set_channel_b(chan))
+
+ if channel := config.get(CONF_PHASE_C):
+ chan = await power_channel(channel)
+ cg.add(var.set_channel_c(chan))
+
+ if channel := config.get(CONF_NEUTRAL):
+ chan = await neutral_channel(channel)
+ cg.add(var.set_channel_n(chan))
diff --git a/esphome/components/ade7953/__init__.py b/esphome/components/ade7953/__init__.py
index e69de29bb2..d3078a0b67 100644
--- a/esphome/components/ade7953/__init__.py
+++ b/esphome/components/ade7953/__init__.py
@@ -0,0 +1 @@
+CODEOWNERS = ["@angelnu"]
diff --git a/esphome/components/ade7953/ade7953.cpp b/esphome/components/ade7953/ade7953.cpp
deleted file mode 100644
index 2c61fc6a44..0000000000
--- a/esphome/components/ade7953/ade7953.cpp
+++ /dev/null
@@ -1,53 +0,0 @@
-#include "ade7953.h"
-#include "esphome/core/log.h"
-
-namespace esphome {
-namespace ade7953 {
-
-static const char *const TAG = "ade7953";
-
-void ADE7953::dump_config() {
- ESP_LOGCONFIG(TAG, "ADE7953:");
- LOG_PIN(" IRQ Pin: ", irq_pin_);
- LOG_I2C_DEVICE(this);
- LOG_UPDATE_INTERVAL(this);
- LOG_SENSOR(" ", "Voltage Sensor", this->voltage_sensor_);
- LOG_SENSOR(" ", "Current A Sensor", this->current_a_sensor_);
- LOG_SENSOR(" ", "Current B Sensor", this->current_b_sensor_);
- LOG_SENSOR(" ", "Active Power A Sensor", this->active_power_a_sensor_);
- LOG_SENSOR(" ", "Active Power B Sensor", this->active_power_b_sensor_);
-}
-
-#define ADE_PUBLISH_(name, val, factor) \
- if (err == i2c::ERROR_OK && this->name##_sensor_) { \
- float value = (val) / (factor); \
- this->name##_sensor_->publish_state(value); \
- }
-#define ADE_PUBLISH(name, val, factor) ADE_PUBLISH_(name, val, factor)
-
-void ADE7953::update() {
- if (!this->is_setup_)
- return;
-
- uint32_t val;
- i2c::ErrorCode err = ade_read_32_(0x0312, &val);
- ADE_PUBLISH(active_power_a, (int32_t) val, 154.0f);
- err = ade_read_32_(0x0313, &val);
- ADE_PUBLISH(active_power_b, (int32_t) val, 154.0f);
- err = ade_read_32_(0x031A, &val);
- ADE_PUBLISH(current_a, (uint32_t) val, 100000.0f);
- err = ade_read_32_(0x031B, &val);
- ADE_PUBLISH(current_b, (uint32_t) val, 100000.0f);
- err = ade_read_32_(0x031C, &val);
- ADE_PUBLISH(voltage, (uint32_t) val, 26000.0f);
-
- // auto apparent_power_a = this->ade_read_(0x0310);
- // auto apparent_power_b = this->ade_read_(0x0311);
- // auto reactive_power_a = this->ade_read_(0x0314);
- // auto reactive_power_b = this->ade_read_(0x0315);
- // auto power_factor_a = this->ade_read_(0x010A);
- // auto power_factor_b = this->ade_read_(0x010B);
-}
-
-} // namespace ade7953
-} // namespace esphome
diff --git a/esphome/components/ade7953/ade7953.h b/esphome/components/ade7953/ade7953.h
deleted file mode 100644
index c0c1cc4db8..0000000000
--- a/esphome/components/ade7953/ade7953.h
+++ /dev/null
@@ -1,97 +0,0 @@
-#pragma once
-
-#include "esphome/core/component.h"
-#include "esphome/core/hal.h"
-#include "esphome/components/i2c/i2c.h"
-#include "esphome/components/sensor/sensor.h"
-
-#include
-
-namespace esphome {
-namespace ade7953 {
-
-class ADE7953 : public i2c::I2CDevice, public PollingComponent {
- public:
- void set_irq_pin(InternalGPIOPin *irq_pin) { irq_pin_ = irq_pin; }
- void set_voltage_sensor(sensor::Sensor *voltage_sensor) { voltage_sensor_ = voltage_sensor; }
- void set_current_a_sensor(sensor::Sensor *current_a_sensor) { current_a_sensor_ = current_a_sensor; }
- void set_current_b_sensor(sensor::Sensor *current_b_sensor) { current_b_sensor_ = current_b_sensor; }
- void set_active_power_a_sensor(sensor::Sensor *active_power_a_sensor) {
- active_power_a_sensor_ = active_power_a_sensor;
- }
- void set_active_power_b_sensor(sensor::Sensor *active_power_b_sensor) {
- active_power_b_sensor_ = active_power_b_sensor;
- }
-
- void setup() override {
- if (this->irq_pin_ != nullptr) {
- this->irq_pin_->setup();
- }
- this->set_timeout(100, [this]() {
- this->ade_write_8_(0x0010, 0x04);
- this->ade_write_8_(0x00FE, 0xAD);
- this->ade_write_16_(0x0120, 0x0030);
- this->is_setup_ = true;
- });
- }
-
- void dump_config() override;
-
- void update() override;
-
- protected:
- i2c::ErrorCode ade_write_8_(uint16_t reg, uint8_t value) {
- std::vector data;
- data.push_back(reg >> 8);
- data.push_back(reg >> 0);
- data.push_back(value);
- return write(data.data(), data.size());
- }
- i2c::ErrorCode ade_write_16_(uint16_t reg, uint16_t value) {
- std::vector data;
- data.push_back(reg >> 8);
- data.push_back(reg >> 0);
- data.push_back(value >> 8);
- data.push_back(value >> 0);
- return write(data.data(), data.size());
- }
- i2c::ErrorCode ade_write_32_(uint16_t reg, uint32_t value) {
- std::vector data;
- data.push_back(reg >> 8);
- data.push_back(reg >> 0);
- data.push_back(value >> 24);
- data.push_back(value >> 16);
- data.push_back(value >> 8);
- data.push_back(value >> 0);
- return write(data.data(), data.size());
- }
- i2c::ErrorCode ade_read_32_(uint16_t reg, uint32_t *value) {
- uint8_t reg_data[2];
- reg_data[0] = reg >> 8;
- reg_data[1] = reg >> 0;
- i2c::ErrorCode err = write(reg_data, 2);
- if (err != i2c::ERROR_OK)
- return err;
- uint8_t recv[4];
- err = read(recv, 4);
- if (err != i2c::ERROR_OK)
- return err;
- *value = 0;
- *value |= ((uint32_t) recv[0]) << 24;
- *value |= ((uint32_t) recv[1]) << 16;
- *value |= ((uint32_t) recv[2]) << 8;
- *value |= ((uint32_t) recv[3]);
- return i2c::ERROR_OK;
- }
-
- InternalGPIOPin *irq_pin_{nullptr};
- bool is_setup_{false};
- sensor::Sensor *voltage_sensor_{nullptr};
- sensor::Sensor *current_a_sensor_{nullptr};
- sensor::Sensor *current_b_sensor_{nullptr};
- sensor::Sensor *active_power_a_sensor_{nullptr};
- sensor::Sensor *active_power_b_sensor_{nullptr};
-};
-
-} // namespace ade7953
-} // namespace esphome
diff --git a/esphome/components/ade7953/sensor.py b/esphome/components/ade7953/sensor.py
index d02f466091..fc79888129 100644
--- a/esphome/components/ade7953/sensor.py
+++ b/esphome/components/ade7953/sensor.py
@@ -1,90 +1,5 @@
-import esphome.codegen as cg
import esphome.config_validation as cv
-from esphome.components import sensor, i2c
-from esphome import pins
-from esphome.const import (
- CONF_ID,
- CONF_VOLTAGE,
- DEVICE_CLASS_CURRENT,
- DEVICE_CLASS_POWER,
- DEVICE_CLASS_VOLTAGE,
- STATE_CLASS_MEASUREMENT,
- UNIT_VOLT,
- UNIT_AMPERE,
- UNIT_WATT,
+
+CONFIG_SCHEMA = cv.invalid(
+ "The ade7953 sensor component has been renamed to ade7953_i2c."
)
-
-DEPENDENCIES = ["i2c"]
-
-ade7953_ns = cg.esphome_ns.namespace("ade7953")
-ADE7953 = ade7953_ns.class_("ADE7953", cg.PollingComponent, i2c.I2CDevice)
-
-CONF_IRQ_PIN = "irq_pin"
-CONF_CURRENT_A = "current_a"
-CONF_CURRENT_B = "current_b"
-CONF_ACTIVE_POWER_A = "active_power_a"
-CONF_ACTIVE_POWER_B = "active_power_b"
-
-CONFIG_SCHEMA = (
- cv.Schema(
- {
- cv.GenerateID(): cv.declare_id(ADE7953),
- cv.Optional(CONF_IRQ_PIN): pins.internal_gpio_input_pin_schema,
- cv.Optional(CONF_VOLTAGE): sensor.sensor_schema(
- unit_of_measurement=UNIT_VOLT,
- accuracy_decimals=1,
- device_class=DEVICE_CLASS_VOLTAGE,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- cv.Optional(CONF_CURRENT_A): sensor.sensor_schema(
- unit_of_measurement=UNIT_AMPERE,
- accuracy_decimals=2,
- device_class=DEVICE_CLASS_CURRENT,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- cv.Optional(CONF_CURRENT_B): sensor.sensor_schema(
- unit_of_measurement=UNIT_AMPERE,
- accuracy_decimals=2,
- device_class=DEVICE_CLASS_CURRENT,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- cv.Optional(CONF_ACTIVE_POWER_A): sensor.sensor_schema(
- unit_of_measurement=UNIT_WATT,
- accuracy_decimals=1,
- device_class=DEVICE_CLASS_POWER,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- cv.Optional(CONF_ACTIVE_POWER_B): sensor.sensor_schema(
- unit_of_measurement=UNIT_WATT,
- accuracy_decimals=1,
- device_class=DEVICE_CLASS_POWER,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- }
- )
- .extend(cv.polling_component_schema("60s"))
- .extend(i2c.i2c_device_schema(0x38))
-)
-
-
-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)
-
- if CONF_IRQ_PIN in config:
- irq_pin = await cg.gpio_pin_expression(config[CONF_IRQ_PIN])
- cg.add(var.set_irq_pin(irq_pin))
-
- for key in [
- CONF_VOLTAGE,
- CONF_CURRENT_A,
- CONF_CURRENT_B,
- CONF_ACTIVE_POWER_A,
- CONF_ACTIVE_POWER_B,
- ]:
- if key not in config:
- continue
- conf = config[key]
- sens = await sensor.new_sensor(conf)
- cg.add(getattr(var, f"set_{key}_sensor")(sens))
diff --git a/esphome/components/ade7953_base/__init__.py b/esphome/components/ade7953_base/__init__.py
new file mode 100644
index 0000000000..af3f629ca8
--- /dev/null
+++ b/esphome/components/ade7953_base/__init__.py
@@ -0,0 +1,201 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import sensor
+from esphome import pins
+from esphome.const import (
+ CONF_IRQ_PIN,
+ CONF_VOLTAGE,
+ CONF_FREQUENCY,
+ CONF_VOLTAGE_GAIN,
+ DEVICE_CLASS_CURRENT,
+ DEVICE_CLASS_APPARENT_POWER,
+ DEVICE_CLASS_POWER,
+ DEVICE_CLASS_REACTIVE_POWER,
+ DEVICE_CLASS_POWER_FACTOR,
+ DEVICE_CLASS_VOLTAGE,
+ DEVICE_CLASS_FREQUENCY,
+ STATE_CLASS_MEASUREMENT,
+ UNIT_VOLT,
+ UNIT_HERTZ,
+ UNIT_AMPERE,
+ UNIT_VOLT_AMPS,
+ UNIT_WATT,
+ UNIT_VOLT_AMPS_REACTIVE,
+ UNIT_PERCENT,
+)
+
+CONF_CURRENT_A = "current_a"
+CONF_CURRENT_B = "current_b"
+CONF_ACTIVE_POWER_A = "active_power_a"
+CONF_ACTIVE_POWER_B = "active_power_b"
+CONF_APPARENT_POWER_A = "apparent_power_a"
+CONF_APPARENT_POWER_B = "apparent_power_b"
+CONF_REACTIVE_POWER_A = "reactive_power_a"
+CONF_REACTIVE_POWER_B = "reactive_power_b"
+CONF_POWER_FACTOR_A = "power_factor_a"
+CONF_POWER_FACTOR_B = "power_factor_b"
+CONF_VOLTAGE_PGA_GAIN = "voltage_pga_gain"
+CONF_CURRENT_PGA_GAIN_A = "current_pga_gain_a"
+CONF_CURRENT_PGA_GAIN_B = "current_pga_gain_b"
+CONF_CURRENT_GAIN_A = "current_gain_a"
+CONF_CURRENT_GAIN_B = "current_gain_b"
+CONF_ACTIVE_POWER_GAIN_A = "active_power_gain_a"
+CONF_ACTIVE_POWER_GAIN_B = "active_power_gain_b"
+CONF_USE_ACCUMULATED_ENERGY_REGISTERS = "use_accumulated_energy_registers"
+PGA_GAINS = {
+ "1x": 0b000,
+ "2x": 0b001,
+ "4x": 0b010,
+ "8x": 0b011,
+ "16x": 0b100,
+ "22x": 0b101,
+}
+
+ade7953_base_ns = cg.esphome_ns.namespace("ade7953_base")
+ADE7953 = ade7953_base_ns.class_("ADE7953", cg.PollingComponent)
+
+ADE7953_CONFIG_SCHEMA = cv.Schema(
+ {
+ cv.Optional(CONF_IRQ_PIN): pins.internal_gpio_input_pin_schema,
+ cv.Optional(CONF_VOLTAGE): sensor.sensor_schema(
+ unit_of_measurement=UNIT_VOLT,
+ accuracy_decimals=1,
+ device_class=DEVICE_CLASS_VOLTAGE,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_FREQUENCY): sensor.sensor_schema(
+ unit_of_measurement=UNIT_HERTZ,
+ accuracy_decimals=2,
+ device_class=DEVICE_CLASS_FREQUENCY,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_CURRENT_A): sensor.sensor_schema(
+ unit_of_measurement=UNIT_AMPERE,
+ accuracy_decimals=2,
+ device_class=DEVICE_CLASS_CURRENT,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_CURRENT_B): sensor.sensor_schema(
+ unit_of_measurement=UNIT_AMPERE,
+ accuracy_decimals=2,
+ device_class=DEVICE_CLASS_CURRENT,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_ACTIVE_POWER_A): sensor.sensor_schema(
+ unit_of_measurement=UNIT_WATT,
+ accuracy_decimals=1,
+ device_class=DEVICE_CLASS_POWER,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_ACTIVE_POWER_B): sensor.sensor_schema(
+ unit_of_measurement=UNIT_WATT,
+ accuracy_decimals=1,
+ device_class=DEVICE_CLASS_POWER,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_APPARENT_POWER_A): sensor.sensor_schema(
+ unit_of_measurement=UNIT_VOLT_AMPS,
+ accuracy_decimals=1,
+ device_class=DEVICE_CLASS_APPARENT_POWER,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_APPARENT_POWER_B): sensor.sensor_schema(
+ unit_of_measurement=UNIT_VOLT_AMPS,
+ accuracy_decimals=1,
+ device_class=DEVICE_CLASS_APPARENT_POWER,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_REACTIVE_POWER_A): sensor.sensor_schema(
+ unit_of_measurement=UNIT_VOLT_AMPS_REACTIVE,
+ accuracy_decimals=1,
+ device_class=DEVICE_CLASS_REACTIVE_POWER,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_REACTIVE_POWER_B): sensor.sensor_schema(
+ unit_of_measurement=UNIT_VOLT_AMPS_REACTIVE,
+ accuracy_decimals=1,
+ device_class=DEVICE_CLASS_REACTIVE_POWER,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_POWER_FACTOR_A): sensor.sensor_schema(
+ unit_of_measurement=UNIT_PERCENT,
+ accuracy_decimals=2,
+ device_class=DEVICE_CLASS_POWER_FACTOR,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_POWER_FACTOR_B): sensor.sensor_schema(
+ unit_of_measurement=UNIT_PERCENT,
+ accuracy_decimals=2,
+ device_class=DEVICE_CLASS_POWER_FACTOR,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(
+ CONF_VOLTAGE_PGA_GAIN,
+ default="1x",
+ ): cv.one_of(*PGA_GAINS, lower=True),
+ cv.Optional(
+ CONF_CURRENT_PGA_GAIN_A,
+ default="1x",
+ ): cv.one_of(*PGA_GAINS, lower=True),
+ cv.Optional(
+ CONF_CURRENT_PGA_GAIN_B,
+ default="1x",
+ ): cv.one_of(*PGA_GAINS, lower=True),
+ cv.Optional(CONF_VOLTAGE_GAIN, default=0x400000): cv.hex_int_range(
+ min=0x100000, max=0x800000
+ ),
+ cv.Optional(CONF_CURRENT_GAIN_A, default=0x400000): cv.hex_int_range(
+ min=0x100000, max=0x800000
+ ),
+ cv.Optional(CONF_CURRENT_GAIN_B, default=0x400000): cv.hex_int_range(
+ min=0x100000, max=0x800000
+ ),
+ cv.Optional(CONF_ACTIVE_POWER_GAIN_A, default=0x400000): cv.hex_int_range(
+ min=0x100000, max=0x800000
+ ),
+ cv.Optional(CONF_ACTIVE_POWER_GAIN_B, default=0x400000): cv.hex_int_range(
+ min=0x100000, max=0x800000
+ ),
+ cv.Optional(CONF_USE_ACCUMULATED_ENERGY_REGISTERS, default=False): cv.boolean,
+ }
+).extend(cv.polling_component_schema("60s"))
+
+
+async def register_ade7953(var, config):
+ await cg.register_component(var, config)
+
+ if irq_pin_config := config.get(CONF_IRQ_PIN):
+ irq_pin = await cg.gpio_pin_expression(irq_pin_config)
+ cg.add(var.set_irq_pin(irq_pin))
+
+ cg.add(var.set_pga_v(PGA_GAINS[config.get(CONF_VOLTAGE_PGA_GAIN)]))
+ cg.add(var.set_pga_ia(PGA_GAINS[config.get(CONF_CURRENT_PGA_GAIN_A)]))
+ cg.add(var.set_pga_ib(PGA_GAINS[config.get(CONF_CURRENT_PGA_GAIN_B)]))
+ cg.add(var.set_vgain(config.get(CONF_VOLTAGE_GAIN)))
+ cg.add(var.set_aigain(config.get(CONF_CURRENT_GAIN_A)))
+ cg.add(var.set_bigain(config.get(CONF_CURRENT_GAIN_B)))
+ cg.add(var.set_awgain(config.get(CONF_ACTIVE_POWER_GAIN_A)))
+ cg.add(var.set_bwgain(config.get(CONF_ACTIVE_POWER_GAIN_B)))
+ cg.add(
+ var.set_use_acc_energy_regs(config.get(CONF_USE_ACCUMULATED_ENERGY_REGISTERS))
+ )
+
+ for key in [
+ CONF_VOLTAGE,
+ CONF_FREQUENCY,
+ CONF_CURRENT_A,
+ CONF_CURRENT_B,
+ CONF_POWER_FACTOR_A,
+ CONF_POWER_FACTOR_B,
+ CONF_APPARENT_POWER_A,
+ CONF_APPARENT_POWER_B,
+ CONF_ACTIVE_POWER_A,
+ CONF_ACTIVE_POWER_B,
+ CONF_REACTIVE_POWER_A,
+ CONF_REACTIVE_POWER_B,
+ ]:
+ if key not in config:
+ continue
+ conf = config[key]
+ sens = await sensor.new_sensor(conf)
+ cg.add(getattr(var, f"set_{key}_sensor")(sens))
diff --git a/esphome/components/ade7953_base/ade7953_base.cpp b/esphome/components/ade7953_base/ade7953_base.cpp
new file mode 100644
index 0000000000..2511b4e04c
--- /dev/null
+++ b/esphome/components/ade7953_base/ade7953_base.cpp
@@ -0,0 +1,150 @@
+#include "ade7953_base.h"
+#include "esphome/core/log.h"
+
+#include
+
+namespace esphome {
+namespace ade7953_base {
+
+static const char *const TAG = "ade7953";
+
+static const float ADE_POWER_FACTOR = 154.0f;
+static const float ADE_WATTSEC_POWER_FACTOR = ADE_POWER_FACTOR * ADE_POWER_FACTOR / 3600;
+
+void ADE7953::setup() {
+ if (this->irq_pin_ != nullptr) {
+ this->irq_pin_->setup();
+ }
+
+ // The chip might take up to 100ms to initialise
+ this->set_timeout(100, [this]() {
+ // this->ade_write_8(0x0010, 0x04);
+ this->ade_write_8(0x00FE, 0xAD);
+ this->ade_write_16(0x0120, 0x0030);
+ // Set gains
+ this->ade_write_8(PGA_V_8, pga_v_);
+ this->ade_write_8(PGA_IA_8, pga_ia_);
+ this->ade_write_8(PGA_IB_8, pga_ib_);
+ this->ade_write_32(AVGAIN_32, vgain_);
+ this->ade_write_32(AIGAIN_32, aigain_);
+ this->ade_write_32(BIGAIN_32, bigain_);
+ this->ade_write_32(AWGAIN_32, awgain_);
+ this->ade_write_32(BWGAIN_32, bwgain_);
+ // Read back gains for debugging
+ this->ade_read_8(PGA_V_8, &pga_v_);
+ this->ade_read_8(PGA_IA_8, &pga_ia_);
+ this->ade_read_8(PGA_IB_8, &pga_ib_);
+ this->ade_read_32(AVGAIN_32, &vgain_);
+ this->ade_read_32(AIGAIN_32, &aigain_);
+ this->ade_read_32(BIGAIN_32, &bigain_);
+ this->ade_read_32(AWGAIN_32, &awgain_);
+ this->ade_read_32(BWGAIN_32, &bwgain_);
+ this->last_update_ = millis();
+ this->is_setup_ = true;
+ });
+}
+
+void ADE7953::dump_config() {
+ LOG_PIN(" IRQ Pin: ", irq_pin_);
+ LOG_UPDATE_INTERVAL(this);
+ LOG_SENSOR(" ", "Voltage Sensor", this->voltage_sensor_);
+ LOG_SENSOR(" ", "Current A Sensor", this->current_a_sensor_);
+ LOG_SENSOR(" ", "Current B Sensor", this->current_b_sensor_);
+ LOG_SENSOR(" ", "Power Factor A Sensor", this->power_factor_a_sensor_);
+ LOG_SENSOR(" ", "Power Factor B Sensor", this->power_factor_b_sensor_);
+ LOG_SENSOR(" ", "Apparent Power A Sensor", this->apparent_power_a_sensor_);
+ LOG_SENSOR(" ", "Apparent Power B Sensor", this->apparent_power_b_sensor_);
+ LOG_SENSOR(" ", "Active Power A Sensor", this->active_power_a_sensor_);
+ LOG_SENSOR(" ", "Active Power B Sensor", this->active_power_b_sensor_);
+ LOG_SENSOR(" ", "Rective Power A Sensor", this->reactive_power_a_sensor_);
+ LOG_SENSOR(" ", "Reactive Power B Sensor", this->reactive_power_b_sensor_);
+ ESP_LOGCONFIG(TAG, " USE_ACC_ENERGY_REGS: %d", this->use_acc_energy_regs_);
+ ESP_LOGCONFIG(TAG, " PGA_V_8: 0x%X", pga_v_);
+ ESP_LOGCONFIG(TAG, " PGA_IA_8: 0x%X", pga_ia_);
+ ESP_LOGCONFIG(TAG, " PGA_IB_8: 0x%X", pga_ib_);
+ ESP_LOGCONFIG(TAG, " VGAIN_32: 0x%08jX", (uintmax_t) vgain_);
+ ESP_LOGCONFIG(TAG, " AIGAIN_32: 0x%08jX", (uintmax_t) aigain_);
+ ESP_LOGCONFIG(TAG, " BIGAIN_32: 0x%08jX", (uintmax_t) bigain_);
+ ESP_LOGCONFIG(TAG, " AWGAIN_32: 0x%08jX", (uintmax_t) awgain_);
+ ESP_LOGCONFIG(TAG, " BWGAIN_32: 0x%08jX", (uintmax_t) bwgain_);
+}
+
+#define ADE_PUBLISH_(name, val, factor) \
+ if (err == 0 && this->name##_sensor_) { \
+ float value = (val) / (factor); \
+ this->name##_sensor_->publish_state(value); \
+ }
+#define ADE_PUBLISH(name, val, factor) ADE_PUBLISH_(name, val, factor)
+
+void ADE7953::update() {
+ if (!this->is_setup_)
+ return;
+
+ bool err;
+
+ uint32_t interrupts_a = 0;
+ uint32_t interrupts_b = 0;
+ if (this->irq_pin_ != nullptr) {
+ // Read and reset interrupts
+ this->ade_read_32(0x032E, &interrupts_a);
+ this->ade_read_32(0x0331, &interrupts_b);
+ }
+
+ uint32_t val;
+ uint16_t val_16;
+ uint16_t reg;
+
+ // Power factor
+ err = this->ade_read_16(0x010A, &val_16);
+ ADE_PUBLISH(power_factor_a, (int16_t) val_16, (0x7FFF / 100.0f));
+ err = this->ade_read_16(0x010B, &val_16);
+ ADE_PUBLISH(power_factor_b, (int16_t) val_16, (0x7FFF / 100.0f));
+
+ float pf = ADE_POWER_FACTOR;
+ if (this->use_acc_energy_regs_) {
+ const uint32_t now = millis();
+ const auto diff = now - this->last_update_;
+ this->last_update_ = now;
+ // prevent DIV/0
+ pf = ADE_WATTSEC_POWER_FACTOR * (diff < 10 ? 10 : diff) / 1000;
+ ESP_LOGVV(TAG, "ADE7953::update() diff=%" PRIu32 " pf=%f", diff, pf);
+ }
+
+ // Apparent power
+ reg = this->use_acc_energy_regs_ ? 0x0322 : 0x0310;
+ err = this->ade_read_32(reg, &val);
+ ADE_PUBLISH(apparent_power_a, (int32_t) val, pf);
+ err = this->ade_read_32(reg + 1, &val);
+ ADE_PUBLISH(apparent_power_b, (int32_t) val, pf);
+
+ // Active power
+ reg = this->use_acc_energy_regs_ ? 0x031E : 0x0312;
+ err = this->ade_read_32(reg, &val);
+ ADE_PUBLISH(active_power_a, (int32_t) val, pf);
+ err = this->ade_read_32(reg + 1, &val);
+ ADE_PUBLISH(active_power_b, (int32_t) val, pf);
+
+ // Reactive power
+ reg = this->use_acc_energy_regs_ ? 0x0320 : 0x0314;
+ err = this->ade_read_32(reg, &val);
+ ADE_PUBLISH(reactive_power_a, (int32_t) val, pf);
+ err = this->ade_read_32(reg + 1, &val);
+ ADE_PUBLISH(reactive_power_b, (int32_t) val, pf);
+
+ // Current
+ err = this->ade_read_32(0x031A, &val);
+ ADE_PUBLISH(current_a, (uint32_t) val, 100000.0f);
+ err = this->ade_read_32(0x031B, &val);
+ ADE_PUBLISH(current_b, (uint32_t) val, 100000.0f);
+
+ // Voltage
+ err = this->ade_read_32(0x031C, &val);
+ ADE_PUBLISH(voltage, (uint32_t) val, 26000.0f);
+
+ // Frequency
+ err = this->ade_read_16(0x010E, &val_16);
+ ADE_PUBLISH(frequency, 223750.0f, 1 + val_16);
+}
+
+} // namespace ade7953_base
+} // namespace esphome
diff --git a/esphome/components/ade7953_base/ade7953_base.h b/esphome/components/ade7953_base/ade7953_base.h
new file mode 100644
index 0000000000..d711a5c6be
--- /dev/null
+++ b/esphome/components/ade7953_base/ade7953_base.h
@@ -0,0 +1,125 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/core/hal.h"
+#include "esphome/components/sensor/sensor.h"
+
+#include
+
+namespace esphome {
+namespace ade7953_base {
+
+static const uint8_t PGA_V_8 =
+ 0x007; // PGA_V, (R/W) Default: 0x00, Unsigned, Voltage channel gain configuration (Bits[2:0])
+static const uint8_t PGA_IA_8 =
+ 0x008; // PGA_IA, (R/W) Default: 0x00, Unsigned, Current Channel A gain configuration (Bits[2:0])
+static const uint8_t PGA_IB_8 =
+ 0x009; // PGA_IB, (R/W) Default: 0x00, Unsigned, Current Channel B gain configuration (Bits[2:0])
+
+static const uint32_t AIGAIN_32 =
+ 0x380; // AIGAIN, (R/W) Default: 0x400000, Unsigned,Current channel gain (Current Channel A)(32 bit)
+static const uint32_t AVGAIN_32 = 0x381; // AVGAIN, (R/W) Default: 0x400000, Unsigned,Voltage channel gain(32 bit)
+static const uint32_t AWGAIN_32 =
+ 0x382; // AWGAIN, (R/W) Default: 0x400000, Unsigned,Active power gain (Current Channel A)(32 bit)
+static const uint32_t AVARGAIN_32 =
+ 0x383; // AVARGAIN, (R/W) Default: 0x400000, Unsigned, Reactive power gain (Current Channel A)(32 bit)
+static const uint32_t AVAGAIN_32 =
+ 0x384; // AVAGAIN, (R/W) Default: 0x400000, Unsigned,Apparent power gain (Current Channel A)(32 bit)
+
+static const uint32_t BIGAIN_32 =
+ 0x38C; // BIGAIN, (R/W) Default: 0x400000, Unsigned,Current channel gain (Current Channel B)(32 bit)
+static const uint32_t BVGAIN_32 = 0x38D; // BVGAIN, (R/W) Default: 0x400000, Unsigned,Voltage channel gain(32 bit)
+static const uint32_t BWGAIN_32 =
+ 0x38E; // BWGAIN, (R/W) Default: 0x400000, Unsigned,Active power gain (Current Channel B)(32 bit)
+static const uint32_t BVARGAIN_32 =
+ 0x38F; // BVARGAIN, (R/W) Default: 0x400000, Unsigned, Reactive power gain (Current Channel B)(32 bit)
+static const uint32_t BVAGAIN_32 =
+ 0x390; // BVAGAIN, (R/W) Default: 0x400000, Unsigned,Apparent power gain (Current Channel B)(32 bit)
+
+class ADE7953 : public PollingComponent, public sensor::Sensor {
+ public:
+ void set_irq_pin(InternalGPIOPin *irq_pin) { irq_pin_ = irq_pin; }
+
+ // Set PGA input gains: 0 1x, 1 2x, 0b10 4x
+ void set_pga_v(uint8_t pga_v) { pga_v_ = pga_v; }
+ void set_pga_ia(uint8_t pga_ia) { pga_ia_ = pga_ia; }
+ void set_pga_ib(uint8_t pga_ib) { pga_ib_ = pga_ib; }
+
+ // Set input gains
+ void set_vgain(uint32_t vgain) { vgain_ = vgain; }
+ void set_aigain(uint32_t aigain) { aigain_ = aigain; }
+ void set_bigain(uint32_t bigain) { bigain_ = bigain; }
+ void set_awgain(uint32_t awgain) { awgain_ = awgain; }
+ void set_bwgain(uint32_t bwgain) { bwgain_ = bwgain; }
+
+ void set_use_acc_energy_regs(bool use_acc_energy_regs) { use_acc_energy_regs_ = use_acc_energy_regs; }
+
+ void set_voltage_sensor(sensor::Sensor *voltage_sensor) { voltage_sensor_ = voltage_sensor; }
+ void set_frequency_sensor(sensor::Sensor *frequency_sensor) { frequency_sensor_ = frequency_sensor; }
+
+ void set_power_factor_a_sensor(sensor::Sensor *power_factor_a) { power_factor_a_sensor_ = power_factor_a; }
+ void set_power_factor_b_sensor(sensor::Sensor *power_factor_b) { power_factor_b_sensor_ = power_factor_b; }
+
+ void set_current_a_sensor(sensor::Sensor *current_a_sensor) { current_a_sensor_ = current_a_sensor; }
+ void set_current_b_sensor(sensor::Sensor *current_b_sensor) { current_b_sensor_ = current_b_sensor; }
+
+ void set_apparent_power_a_sensor(sensor::Sensor *apparent_power_a) { apparent_power_a_sensor_ = apparent_power_a; }
+ void set_apparent_power_b_sensor(sensor::Sensor *apparent_power_b) { apparent_power_b_sensor_ = apparent_power_b; }
+
+ void set_active_power_a_sensor(sensor::Sensor *active_power_a_sensor) {
+ active_power_a_sensor_ = active_power_a_sensor;
+ }
+ void set_active_power_b_sensor(sensor::Sensor *active_power_b_sensor) {
+ active_power_b_sensor_ = active_power_b_sensor;
+ }
+
+ void set_reactive_power_a_sensor(sensor::Sensor *reactive_power_a) { reactive_power_a_sensor_ = reactive_power_a; }
+ void set_reactive_power_b_sensor(sensor::Sensor *reactive_power_b) { reactive_power_b_sensor_ = reactive_power_b; }
+
+ void setup() override;
+
+ void dump_config() override;
+
+ void update() override;
+
+ protected:
+ InternalGPIOPin *irq_pin_{nullptr};
+ bool is_setup_{false};
+ sensor::Sensor *voltage_sensor_{nullptr};
+ sensor::Sensor *frequency_sensor_{nullptr};
+ sensor::Sensor *current_a_sensor_{nullptr};
+ sensor::Sensor *current_b_sensor_{nullptr};
+ sensor::Sensor *apparent_power_a_sensor_{nullptr};
+ sensor::Sensor *apparent_power_b_sensor_{nullptr};
+ sensor::Sensor *active_power_a_sensor_{nullptr};
+ sensor::Sensor *active_power_b_sensor_{nullptr};
+ sensor::Sensor *reactive_power_a_sensor_{nullptr};
+ sensor::Sensor *reactive_power_b_sensor_{nullptr};
+ sensor::Sensor *power_factor_a_sensor_{nullptr};
+ sensor::Sensor *power_factor_b_sensor_{nullptr};
+ uint8_t pga_v_;
+ uint8_t pga_ia_;
+ uint8_t pga_ib_;
+ uint32_t vgain_;
+ uint32_t aigain_;
+ uint32_t bigain_;
+ uint32_t awgain_;
+ uint32_t bwgain_;
+ bool use_acc_energy_regs_{false};
+ uint32_t last_update_;
+
+ virtual bool ade_write_8(uint16_t reg, uint8_t value) = 0;
+
+ virtual bool ade_write_16(uint16_t reg, uint16_t value) = 0;
+
+ virtual bool ade_write_32(uint16_t reg, uint32_t value) = 0;
+
+ virtual bool ade_read_8(uint16_t reg, uint8_t *value) = 0;
+
+ virtual bool ade_read_16(uint16_t reg, uint16_t *value) = 0;
+
+ virtual bool ade_read_32(uint16_t reg, uint32_t *value) = 0;
+};
+
+} // namespace ade7953_base
+} // namespace esphome
diff --git a/esphome/components/ade7953_i2c/__init__.py b/esphome/components/ade7953_i2c/__init__.py
new file mode 100644
index 0000000000..d3078a0b67
--- /dev/null
+++ b/esphome/components/ade7953_i2c/__init__.py
@@ -0,0 +1 @@
+CODEOWNERS = ["@angelnu"]
diff --git a/esphome/components/ade7953_i2c/ade7953_i2c.cpp b/esphome/components/ade7953_i2c/ade7953_i2c.cpp
new file mode 100644
index 0000000000..ae381824db
--- /dev/null
+++ b/esphome/components/ade7953_i2c/ade7953_i2c.cpp
@@ -0,0 +1,80 @@
+#include "ade7953_i2c.h"
+#include "esphome/core/log.h"
+#include "esphome/core/helpers.h"
+
+namespace esphome {
+namespace ade7953_i2c {
+
+static const char *const TAG = "ade7953";
+
+void AdE7953I2c::dump_config() {
+ ESP_LOGCONFIG(TAG, "ADE7953_i2c:");
+ LOG_I2C_DEVICE(this);
+ ade7953_base::ADE7953::dump_config();
+}
+bool AdE7953I2c::ade_write_8(uint16_t reg, uint8_t value) {
+ uint8_t data[3];
+ data[0] = reg >> 8;
+ data[1] = reg >> 0;
+ data[2] = value;
+ return this->write(data, 3) != i2c::ERROR_OK;
+}
+bool AdE7953I2c::ade_write_16(uint16_t reg, uint16_t value) {
+ uint8_t data[4];
+ data[0] = reg >> 8;
+ data[1] = reg >> 0;
+ data[2] = value >> 8;
+ data[3] = value >> 0;
+ return this->write(data, 4) != i2c::ERROR_OK;
+}
+bool AdE7953I2c::ade_write_32(uint16_t reg, uint32_t value) {
+ uint8_t data[6];
+ data[0] = reg >> 8;
+ data[1] = reg >> 0;
+ data[2] = value >> 24;
+ data[3] = value >> 16;
+ data[4] = value >> 8;
+ data[5] = value >> 0;
+ return this->write(data, 6) != i2c::ERROR_OK;
+}
+bool AdE7953I2c::ade_read_8(uint16_t reg, uint8_t *value) {
+ uint8_t reg_data[2];
+ reg_data[0] = reg >> 8;
+ reg_data[1] = reg >> 0;
+ i2c::ErrorCode err = this->write(reg_data, 2);
+ if (err != i2c::ERROR_OK)
+ return true;
+ err = this->read(value, 1);
+ return (err != i2c::ERROR_OK);
+}
+bool AdE7953I2c::ade_read_16(uint16_t reg, uint16_t *value) {
+ uint8_t reg_data[2];
+ reg_data[0] = reg >> 8;
+ reg_data[1] = reg >> 0;
+ i2c::ErrorCode err = this->write(reg_data, 2);
+ if (err != i2c::ERROR_OK)
+ return true;
+ uint8_t recv[2];
+ err = this->read(recv, 2);
+ if (err != i2c::ERROR_OK)
+ return true;
+ *value = encode_uint16(recv[0], recv[1]);
+ return false;
+}
+bool AdE7953I2c::ade_read_32(uint16_t reg, uint32_t *value) {
+ uint8_t reg_data[2];
+ reg_data[0] = reg >> 8;
+ reg_data[1] = reg >> 0;
+ i2c::ErrorCode err = this->write(reg_data, 2);
+ if (err != i2c::ERROR_OK)
+ return true;
+ uint8_t recv[4];
+ err = this->read(recv, 4);
+ if (err != i2c::ERROR_OK)
+ return true;
+ *value = encode_uint32(recv[0], recv[1], recv[2], recv[3]);
+ return false;
+}
+
+} // namespace ade7953_i2c
+} // namespace esphome
diff --git a/esphome/components/ade7953_i2c/ade7953_i2c.h b/esphome/components/ade7953_i2c/ade7953_i2c.h
new file mode 100644
index 0000000000..65dc30dddb
--- /dev/null
+++ b/esphome/components/ade7953_i2c/ade7953_i2c.h
@@ -0,0 +1,28 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/core/hal.h"
+#include "esphome/components/i2c/i2c.h"
+#include "esphome/components/sensor/sensor.h"
+#include "esphome/components/ade7953_base/ade7953_base.h"
+
+#include
+
+namespace esphome {
+namespace ade7953_i2c {
+
+class AdE7953I2c : public ade7953_base::ADE7953, public i2c::I2CDevice {
+ public:
+ void dump_config() override;
+
+ protected:
+ bool ade_write_8(uint16_t reg, uint8_t value) override;
+ bool ade_write_16(uint16_t reg, uint16_t value) override;
+ bool ade_write_32(uint16_t reg, uint32_t value) override;
+ bool ade_read_8(uint16_t reg, uint8_t *value) override;
+ bool ade_read_16(uint16_t reg, uint16_t *value) override;
+ bool ade_read_32(uint16_t reg, uint32_t *value) override;
+};
+
+} // namespace ade7953_i2c
+} // namespace esphome
diff --git a/esphome/components/ade7953_i2c/sensor.py b/esphome/components/ade7953_i2c/sensor.py
new file mode 100644
index 0000000000..e52a44eced
--- /dev/null
+++ b/esphome/components/ade7953_i2c/sensor.py
@@ -0,0 +1,27 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import i2c, ade7953_base
+from esphome.const import CONF_ID
+
+
+DEPENDENCIES = ["i2c"]
+AUTO_LOAD = ["ade7953_base"]
+
+ade7953_ns = cg.esphome_ns.namespace("ade7953_i2c")
+ADE7953 = ade7953_ns.class_("AdE7953I2c", ade7953_base.ADE7953, i2c.I2CDevice)
+
+CONFIG_SCHEMA = (
+ cv.Schema(
+ {
+ cv.GenerateID(): cv.declare_id(ADE7953),
+ }
+ )
+ .extend(ade7953_base.ADE7953_CONFIG_SCHEMA)
+ .extend(i2c.i2c_device_schema(0x38))
+)
+
+
+async def to_code(config):
+ var = cg.new_Pvariable(config[CONF_ID])
+ await i2c.register_i2c_device(var, config)
+ await ade7953_base.register_ade7953(var, config)
diff --git a/esphome/components/ade7953_spi/__init__.py b/esphome/components/ade7953_spi/__init__.py
new file mode 100644
index 0000000000..d3078a0b67
--- /dev/null
+++ b/esphome/components/ade7953_spi/__init__.py
@@ -0,0 +1 @@
+CODEOWNERS = ["@angelnu"]
diff --git a/esphome/components/ade7953_spi/ade7953_spi.cpp b/esphome/components/ade7953_spi/ade7953_spi.cpp
new file mode 100644
index 0000000000..77a2a8adc7
--- /dev/null
+++ b/esphome/components/ade7953_spi/ade7953_spi.cpp
@@ -0,0 +1,81 @@
+#include "ade7953_spi.h"
+#include "esphome/core/log.h"
+#include "esphome/core/helpers.h"
+
+namespace esphome {
+namespace ade7953_spi {
+
+static const char *const TAG = "ade7953";
+
+void AdE7953Spi::setup() {
+ this->spi_setup();
+ ade7953_base::ADE7953::setup();
+}
+
+void AdE7953Spi::dump_config() {
+ ESP_LOGCONFIG(TAG, "ADE7953_spi:");
+ LOG_PIN(" CS Pin: ", this->cs_);
+ ade7953_base::ADE7953::dump_config();
+}
+
+bool AdE7953Spi::ade_write_8(uint16_t reg, uint8_t value) {
+ this->enable();
+ this->write_byte16(reg);
+ this->transfer_byte(0);
+ this->transfer_byte(value);
+ this->disable();
+ return false;
+}
+
+bool AdE7953Spi::ade_write_16(uint16_t reg, uint16_t value) {
+ this->enable();
+ this->write_byte16(reg);
+ this->transfer_byte(0);
+ this->write_byte16(value);
+ this->disable();
+ return false;
+}
+
+bool AdE7953Spi::ade_write_32(uint16_t reg, uint32_t value) {
+ this->enable();
+ this->write_byte16(reg);
+ this->transfer_byte(0);
+ this->write_byte16(value >> 16);
+ this->write_byte16(value & 0xFFFF);
+ this->disable();
+ return false;
+}
+
+bool AdE7953Spi::ade_read_8(uint16_t reg, uint8_t *value) {
+ this->enable();
+ this->write_byte16(reg);
+ this->transfer_byte(0x80);
+ *value = this->read_byte();
+ this->disable();
+ return false;
+}
+
+bool AdE7953Spi::ade_read_16(uint16_t reg, uint16_t *value) {
+ this->enable();
+ this->write_byte16(reg);
+ this->transfer_byte(0x80);
+ uint8_t recv[2];
+ this->read_array(recv, 2);
+ *value = encode_uint16(recv[0], recv[1]);
+ this->disable();
+ return false;
+}
+
+bool AdE7953Spi::ade_read_32(uint16_t reg, uint32_t *value) {
+ this->enable();
+ this->write_byte16(reg);
+ this->transfer_byte(0x80);
+ uint8_t recv[4];
+ this->read_array(recv, 4);
+ *value = encode_uint32(recv[0], recv[1], recv[2], recv[3]);
+ this->disable();
+ return false;
+}
+
+} // namespace ade7953_spi
+} // namespace esphome
diff --git a/esphome/components/ade7953_spi/ade7953_spi.h b/esphome/components/ade7953_spi/ade7953_spi.h
new file mode 100644
index 0000000000..d96852b9bb
--- /dev/null
+++ b/esphome/components/ade7953_spi/ade7953_spi.h
@@ -0,0 +1,32 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/core/hal.h"
+#include "esphome/components/spi/spi.h"
+#include "esphome/components/sensor/sensor.h"
+#include "esphome/components/ade7953_base/ade7953_base.h"
+
+#include
+
+namespace esphome {
+namespace ade7953_spi {
+
+class AdE7953Spi : public ade7953_base::ADE7953,
+ public spi::SPIDevice {
+ public:
+ void setup() override;
+
+ void dump_config() override;
+
+ protected:
+ bool ade_write_8(uint16_t reg, uint8_t value) override;
+ bool ade_write_16(uint16_t reg, uint16_t value) override;
+ bool ade_write_32(uint16_t reg, uint32_t value) override;
+ bool ade_read_8(uint16_t reg, uint8_t *value) override;
+ bool ade_read_16(uint16_t reg, uint16_t *value) override;
+ bool ade_read_32(uint16_t reg, uint32_t *value) override;
+};
+
+} // namespace ade7953_spi
+} // namespace esphome
diff --git a/esphome/components/ade7953_spi/sensor.py b/esphome/components/ade7953_spi/sensor.py
new file mode 100644
index 0000000000..5f9682c711
--- /dev/null
+++ b/esphome/components/ade7953_spi/sensor.py
@@ -0,0 +1,27 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import spi, ade7953_base
+from esphome.const import CONF_ID
+
+
+DEPENDENCIES = ["spi"]
+AUTO_LOAD = ["ade7953_base"]
+
+ade7953_ns = cg.esphome_ns.namespace("ade7953_spi")
+ADE7953 = ade7953_ns.class_("AdE7953Spi", ade7953_base.ADE7953, spi.SPIDevice)
+
+CONFIG_SCHEMA = (
+ cv.Schema(
+ {
+ cv.GenerateID(): cv.declare_id(ADE7953),
+ }
+ )
+ .extend(ade7953_base.ADE7953_CONFIG_SCHEMA)
+ .extend(spi.spi_device_schema())
+)
+
+
+async def to_code(config):
+ var = cg.new_Pvariable(config[CONF_ID])
+ await spi.register_spi_device(var, config)
+ await ade7953_base.register_ade7953(var, config)
diff --git a/esphome/components/ads1115/__init__.py b/esphome/components/ads1115/__init__.py
index e8861a2f67..a463d8390d 100644
--- a/esphome/components/ads1115/__init__.py
+++ b/esphome/components/ads1115/__init__.py
@@ -4,13 +4,14 @@ from esphome.components import i2c
from esphome.const import CONF_ID
DEPENDENCIES = ["i2c"]
-AUTO_LOAD = ["sensor", "voltage_sampler"]
MULTI_CONF = True
ads1115_ns = cg.esphome_ns.namespace("ads1115")
ADS1115Component = ads1115_ns.class_("ADS1115Component", cg.Component, i2c.I2CDevice)
CONF_CONTINUOUS_MODE = "continuous_mode"
+CONF_ADS1115_ID = "ads1115_id"
+
CONFIG_SCHEMA = (
cv.Schema(
{
diff --git a/esphome/components/ads1115/ads1115.cpp b/esphome/components/ads1115/ads1115.cpp
index c3f3c00c63..218edc4c81 100644
--- a/esphome/components/ads1115/ads1115.cpp
+++ b/esphome/components/ads1115/ads1115.cpp
@@ -1,6 +1,6 @@
#include "ads1115.h"
-#include "esphome/core/log.h"
#include "esphome/core/hal.h"
+#include "esphome/core/log.h"
namespace esphome {
namespace ads1115 {
@@ -75,25 +75,19 @@ void ADS1115Component::dump_config() {
if (this->is_failed()) {
ESP_LOGE(TAG, "Communication with ADS1115 failed!");
}
-
- for (auto *sensor : this->sensors_) {
- LOG_SENSOR(" ", "Sensor", sensor);
- ESP_LOGCONFIG(TAG, " Multiplexer: %u", sensor->get_multiplexer());
- ESP_LOGCONFIG(TAG, " Gain: %u", sensor->get_gain());
- ESP_LOGCONFIG(TAG, " Resolution: %u", sensor->get_resolution());
- }
}
-float ADS1115Component::request_measurement(ADS1115Sensor *sensor) {
+float ADS1115Component::request_measurement(ADS1115Multiplexer multiplexer, ADS1115Gain gain,
+ ADS1115Resolution resolution) {
uint16_t config = this->prev_config_;
// Multiplexer
// 0bxBBBxxxxxxxxxxxx
config &= 0b1000111111111111;
- config |= (sensor->get_multiplexer() & 0b111) << 12;
+ config |= (multiplexer & 0b111) << 12;
// Gain
// 0bxxxxBBBxxxxxxxxx
config &= 0b1111000111111111;
- config |= (sensor->get_gain() & 0b111) << 9;
+ config |= (gain & 0b111) << 9;
if (!this->continuous_mode_) {
// Start conversion
@@ -132,7 +126,7 @@ float ADS1115Component::request_measurement(ADS1115Sensor *sensor) {
return NAN;
}
- if (sensor->get_resolution() == ADS1015_12_BITS) {
+ if (resolution == ADS1015_12_BITS) {
bool negative = (raw_conversion >> 15) == 1;
// shift raw_conversion as it's only 12-bits, left justified
@@ -151,8 +145,8 @@ float ADS1115Component::request_measurement(ADS1115Sensor *sensor) {
auto signed_conversion = static_cast(raw_conversion);
float millivolts;
- float divider = (sensor->get_resolution() == ADS1115_16_BITS) ? 32768.0f : 2048.0f;
- switch (sensor->get_gain()) {
+ float divider = (resolution == ADS1115_16_BITS) ? 32768.0f : 2048.0f;
+ switch (gain) {
case ADS1115_GAIN_6P144:
millivolts = (signed_conversion * 6144) / divider;
break;
@@ -179,14 +173,5 @@ float ADS1115Component::request_measurement(ADS1115Sensor *sensor) {
return millivolts / 1e3f;
}
-float ADS1115Sensor::sample() { return this->parent_->request_measurement(this); }
-void ADS1115Sensor::update() {
- float v = this->parent_->request_measurement(this);
- if (!std::isnan(v)) {
- ESP_LOGD(TAG, "'%s': Got Voltage=%fV", this->get_name().c_str(), v);
- this->publish_state(v);
- }
-}
-
} // namespace ads1115
} // namespace esphome
diff --git a/esphome/components/ads1115/ads1115.h b/esphome/components/ads1115/ads1115.h
index 0b8bfb339b..509333d2c8 100644
--- a/esphome/components/ads1115/ads1115.h
+++ b/esphome/components/ads1115/ads1115.h
@@ -1,9 +1,7 @@
#pragma once
-#include "esphome/core/component.h"
-#include "esphome/components/sensor/sensor.h"
#include "esphome/components/i2c/i2c.h"
-#include "esphome/components/voltage_sampler/voltage_sampler.h"
+#include "esphome/core/component.h"
#include
@@ -35,12 +33,8 @@ enum ADS1115Resolution {
ADS1015_12_BITS = 12,
};
-class ADS1115Sensor;
-
class ADS1115Component : public Component, public i2c::I2CDevice {
public:
- void register_sensor(ADS1115Sensor *obj) { this->sensors_.push_back(obj); }
- /// Set up the internal sensor array.
void setup() override;
void dump_config() override;
/// HARDWARE_LATE setup priority
@@ -48,33 +42,12 @@ class ADS1115Component : public Component, public i2c::I2CDevice {
void set_continuous_mode(bool continuous_mode) { continuous_mode_ = continuous_mode; }
/// Helper method to request a measurement from a sensor.
- float request_measurement(ADS1115Sensor *sensor);
+ float request_measurement(ADS1115Multiplexer multiplexer, ADS1115Gain gain, ADS1115Resolution resolution);
protected:
- std::vector sensors_;
uint16_t prev_config_{0};
bool continuous_mode_;
};
-/// Internal holder class that is in instance of Sensor so that the hub can create individual sensors.
-class ADS1115Sensor : public sensor::Sensor, public PollingComponent, public voltage_sampler::VoltageSampler {
- public:
- ADS1115Sensor(ADS1115Component *parent) : parent_(parent) {}
- void update() override;
- void set_multiplexer(ADS1115Multiplexer multiplexer) { multiplexer_ = multiplexer; }
- void set_gain(ADS1115Gain gain) { gain_ = gain; }
- void set_resolution(ADS1115Resolution resolution) { resolution_ = resolution; }
- float sample() override;
- uint8_t get_multiplexer() const { return multiplexer_; }
- uint8_t get_gain() const { return gain_; }
- uint8_t get_resolution() const { return resolution_; }
-
- protected:
- ADS1115Component *parent_;
- ADS1115Multiplexer multiplexer_;
- ADS1115Gain gain_;
- ADS1115Resolution resolution_;
-};
-
} // namespace ads1115
} // namespace esphome
diff --git a/esphome/components/ads1115/sensor.py b/esphome/components/ads1115/sensor.py
deleted file mode 100644
index f0d894e2af..0000000000
--- a/esphome/components/ads1115/sensor.py
+++ /dev/null
@@ -1,92 +0,0 @@
-import esphome.codegen as cg
-import esphome.config_validation as cv
-from esphome.components import sensor, voltage_sampler
-from esphome.const import (
- CONF_GAIN,
- CONF_MULTIPLEXER,
- CONF_RESOLUTION,
- DEVICE_CLASS_VOLTAGE,
- STATE_CLASS_MEASUREMENT,
- UNIT_VOLT,
- CONF_ID,
-)
-from . import ads1115_ns, ADS1115Component
-
-DEPENDENCIES = ["ads1115"]
-
-ADS1115Multiplexer = ads1115_ns.enum("ADS1115Multiplexer")
-MUX = {
- "A0_A1": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P0_N1,
- "A0_A3": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P0_N3,
- "A1_A3": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P1_N3,
- "A2_A3": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P2_N3,
- "A0_GND": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P0_NG,
- "A1_GND": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P1_NG,
- "A2_GND": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P2_NG,
- "A3_GND": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P3_NG,
-}
-
-ADS1115Gain = ads1115_ns.enum("ADS1115Gain")
-GAIN = {
- "6.144": ADS1115Gain.ADS1115_GAIN_6P144,
- "4.096": ADS1115Gain.ADS1115_GAIN_4P096,
- "2.048": ADS1115Gain.ADS1115_GAIN_2P048,
- "1.024": ADS1115Gain.ADS1115_GAIN_1P024,
- "0.512": ADS1115Gain.ADS1115_GAIN_0P512,
- "0.256": ADS1115Gain.ADS1115_GAIN_0P256,
-}
-
-ADS1115Resolution = ads1115_ns.enum("ADS1115Resolution")
-RESOLUTION = {
- "16_BITS": ADS1115Resolution.ADS1115_16_BITS,
- "12_BITS": ADS1115Resolution.ADS1015_12_BITS,
-}
-
-
-def validate_gain(value):
- if isinstance(value, float):
- value = f"{value:0.03f}"
- elif not isinstance(value, str):
- raise cv.Invalid(f'invalid gain "{value}"')
-
- return cv.enum(GAIN)(value)
-
-
-ADS1115Sensor = ads1115_ns.class_(
- "ADS1115Sensor", sensor.Sensor, cg.PollingComponent, voltage_sampler.VoltageSampler
-)
-
-CONF_ADS1115_ID = "ads1115_id"
-CONFIG_SCHEMA = (
- sensor.sensor_schema(
- ADS1115Sensor,
- unit_of_measurement=UNIT_VOLT,
- accuracy_decimals=3,
- device_class=DEVICE_CLASS_VOLTAGE,
- state_class=STATE_CLASS_MEASUREMENT,
- )
- .extend(
- {
- cv.GenerateID(CONF_ADS1115_ID): cv.use_id(ADS1115Component),
- cv.Required(CONF_MULTIPLEXER): cv.enum(MUX, upper=True, space="_"),
- cv.Required(CONF_GAIN): validate_gain,
- cv.Optional(CONF_RESOLUTION, default="16_BITS"): cv.enum(
- RESOLUTION, upper=True, space="_"
- ),
- }
- )
- .extend(cv.polling_component_schema("60s"))
-)
-
-
-async def to_code(config):
- paren = await cg.get_variable(config[CONF_ADS1115_ID])
- var = cg.new_Pvariable(config[CONF_ID], paren)
- await sensor.register_sensor(var, config)
- await cg.register_component(var, config)
-
- cg.add(var.set_multiplexer(config[CONF_MULTIPLEXER]))
- cg.add(var.set_gain(config[CONF_GAIN]))
- cg.add(var.set_resolution(config[CONF_RESOLUTION]))
-
- cg.add(paren.register_sensor(var))
diff --git a/esphome/components/ads1115/sensor/__init__.py b/esphome/components/ads1115/sensor/__init__.py
new file mode 100644
index 0000000000..baec31d35c
--- /dev/null
+++ b/esphome/components/ads1115/sensor/__init__.py
@@ -0,0 +1,81 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import sensor, voltage_sampler
+from esphome.const import (
+ CONF_GAIN,
+ CONF_MULTIPLEXER,
+ CONF_RESOLUTION,
+ DEVICE_CLASS_VOLTAGE,
+ STATE_CLASS_MEASUREMENT,
+ UNIT_VOLT,
+ CONF_ID,
+)
+from .. import ads1115_ns, ADS1115Component, CONF_ADS1115_ID
+
+AUTO_LOAD = ["voltage_sampler"]
+DEPENDENCIES = ["ads1115"]
+
+ADS1115Multiplexer = ads1115_ns.enum("ADS1115Multiplexer")
+MUX = {
+ "A0_A1": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P0_N1,
+ "A0_A3": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P0_N3,
+ "A1_A3": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P1_N3,
+ "A2_A3": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P2_N3,
+ "A0_GND": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P0_NG,
+ "A1_GND": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P1_NG,
+ "A2_GND": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P2_NG,
+ "A3_GND": ADS1115Multiplexer.ADS1115_MULTIPLEXER_P3_NG,
+}
+
+ADS1115Gain = ads1115_ns.enum("ADS1115Gain")
+GAIN = {
+ "6.144": ADS1115Gain.ADS1115_GAIN_6P144,
+ "4.096": ADS1115Gain.ADS1115_GAIN_4P096,
+ "2.048": ADS1115Gain.ADS1115_GAIN_2P048,
+ "1.024": ADS1115Gain.ADS1115_GAIN_1P024,
+ "0.512": ADS1115Gain.ADS1115_GAIN_0P512,
+ "0.256": ADS1115Gain.ADS1115_GAIN_0P256,
+}
+
+ADS1115Resolution = ads1115_ns.enum("ADS1115Resolution")
+RESOLUTION = {
+ "16_BITS": ADS1115Resolution.ADS1115_16_BITS,
+ "12_BITS": ADS1115Resolution.ADS1015_12_BITS,
+}
+
+
+ADS1115Sensor = ads1115_ns.class_(
+ "ADS1115Sensor", sensor.Sensor, cg.PollingComponent, voltage_sampler.VoltageSampler
+)
+
+CONFIG_SCHEMA = (
+ sensor.sensor_schema(
+ ADS1115Sensor,
+ unit_of_measurement=UNIT_VOLT,
+ accuracy_decimals=3,
+ device_class=DEVICE_CLASS_VOLTAGE,
+ state_class=STATE_CLASS_MEASUREMENT,
+ )
+ .extend(
+ {
+ cv.GenerateID(CONF_ADS1115_ID): cv.use_id(ADS1115Component),
+ cv.Required(CONF_MULTIPLEXER): cv.enum(MUX, upper=True, space="_"),
+ cv.Required(CONF_GAIN): cv.enum(GAIN, string=True),
+ cv.Optional(CONF_RESOLUTION, default="16_BITS"): cv.enum(
+ RESOLUTION, upper=True, space="_"
+ ),
+ }
+ )
+ .extend(cv.polling_component_schema("60s"))
+)
+
+
+async def to_code(config):
+ var = cg.new_Pvariable(config[CONF_ID])
+ await sensor.register_sensor(var, config)
+ await cg.register_component(var, config)
+ await cg.register_parented(var, config[CONF_ADS1115_ID])
+
+ cg.add(var.set_multiplexer(config[CONF_MULTIPLEXER]))
+ cg.add(var.set_gain(config[CONF_GAIN]))
+ cg.add(var.set_resolution(config[CONF_RESOLUTION]))
diff --git a/esphome/components/ads1115/sensor/ads1115_sensor.cpp b/esphome/components/ads1115/sensor/ads1115_sensor.cpp
new file mode 100644
index 0000000000..335fca4845
--- /dev/null
+++ b/esphome/components/ads1115/sensor/ads1115_sensor.cpp
@@ -0,0 +1,30 @@
+#include "ads1115_sensor.h"
+
+#include "esphome/core/log.h"
+
+namespace esphome {
+namespace ads1115 {
+
+static const char *const TAG = "ads1115.sensor";
+
+float ADS1115Sensor::sample() {
+ return this->parent_->request_measurement(this->multiplexer_, this->gain_, this->resolution_);
+}
+
+void ADS1115Sensor::update() {
+ float v = this->sample();
+ if (!std::isnan(v)) {
+ ESP_LOGD(TAG, "'%s': Got Voltage=%fV", this->get_name().c_str(), v);
+ this->publish_state(v);
+ }
+}
+
+void ADS1115Sensor::dump_config() {
+ LOG_SENSOR(" ", "ADS1115 Sensor", this);
+ ESP_LOGCONFIG(TAG, " Multiplexer: %u", this->multiplexer_);
+ ESP_LOGCONFIG(TAG, " Gain: %u", this->gain_);
+ ESP_LOGCONFIG(TAG, " Resolution: %u", this->resolution_);
+}
+
+} // namespace ads1115
+} // namespace esphome
diff --git a/esphome/components/ads1115/sensor/ads1115_sensor.h b/esphome/components/ads1115/sensor/ads1115_sensor.h
new file mode 100644
index 0000000000..191afc3de6
--- /dev/null
+++ b/esphome/components/ads1115/sensor/ads1115_sensor.h
@@ -0,0 +1,35 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/core/helpers.h"
+
+#include "esphome/components/sensor/sensor.h"
+#include "esphome/components/voltage_sampler/voltage_sampler.h"
+
+#include "../ads1115.h"
+
+namespace esphome {
+namespace ads1115 {
+
+/// Internal holder class that is in instance of Sensor so that the hub can create individual sensors.
+class ADS1115Sensor : public sensor::Sensor,
+ public PollingComponent,
+ public voltage_sampler::VoltageSampler,
+ public Parented {
+ public:
+ void update() override;
+ void set_multiplexer(ADS1115Multiplexer multiplexer) { this->multiplexer_ = multiplexer; }
+ void set_gain(ADS1115Gain gain) { this->gain_ = gain; }
+ void set_resolution(ADS1115Resolution resolution) { this->resolution_ = resolution; }
+ float sample() override;
+
+ void dump_config() override;
+
+ protected:
+ ADS1115Multiplexer multiplexer_;
+ ADS1115Gain gain_;
+ ADS1115Resolution resolution_;
+};
+
+} // namespace ads1115
+} // namespace esphome
diff --git a/esphome/components/ads1118/__init__.py b/esphome/components/ads1118/__init__.py
new file mode 100644
index 0000000000..f8d51101a6
--- /dev/null
+++ b/esphome/components/ads1118/__init__.py
@@ -0,0 +1,25 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import spi
+from esphome.const import CONF_ID
+
+CODEOWNERS = ["@solomondg1"]
+DEPENDENCIES = ["spi"]
+MULTI_CONF = True
+
+CONF_ADS1118_ID = "ads1118_id"
+
+ads1118_ns = cg.esphome_ns.namespace("ads1118")
+ADS1118 = ads1118_ns.class_("ADS1118", cg.Component, spi.SPIDevice)
+
+CONFIG_SCHEMA = cv.Schema(
+ {
+ cv.GenerateID(): cv.declare_id(ADS1118),
+ }
+).extend(spi.spi_device_schema(cs_pin_required=True))
+
+
+async def to_code(config):
+ var = cg.new_Pvariable(config[CONF_ID])
+ await cg.register_component(var, config)
+ await spi.register_spi_device(var, config)
diff --git a/esphome/components/ads1118/ads1118.cpp b/esphome/components/ads1118/ads1118.cpp
new file mode 100644
index 0000000000..7b9d0cc36b
--- /dev/null
+++ b/esphome/components/ads1118/ads1118.cpp
@@ -0,0 +1,126 @@
+#include "ads1118.h"
+#include "esphome/core/log.h"
+
+namespace esphome {
+namespace ads1118 {
+
+static const char *const TAG = "ads1118";
+static const uint8_t ADS1118_DATA_RATE_860_SPS = 0b111;
+
+void ADS1118::setup() {
+ ESP_LOGCONFIG(TAG, "Setting up ads1118");
+ this->spi_setup();
+
+ this->config_ = 0;
+ // Setup multiplexer
+ // 0bx000xxxxxxxxxxxx
+ this->config_ |= ADS1118_MULTIPLEXER_P0_NG << 12;
+
+ // Setup Gain
+ // 0bxxxx000xxxxxxxxx
+ this->config_ |= ADS1118_GAIN_6P144 << 9;
+
+ // Set singleshot mode
+ // 0bxxxxxxx1xxxxxxxx
+ this->config_ |= 0b0000000100000000;
+
+ // Set data rate - 860 samples per second (we're in singleshot mode)
+ // 0bxxxxxxxx100xxxxx
+ this->config_ |= ADS1118_DATA_RATE_860_SPS << 5;
+
+ // Set temperature sensor mode - ADC
+ // 0bxxxxxxxxxxx0xxxx
+ this->config_ |= 0b0000000000000000;
+
+ // Set DOUT pull up - enable
+ // 0bxxxxxxxxxxxx0xxx
+ this->config_ |= 0b0000000000001000;
+
+ // NOP - must be 01
+ // 0bxxxxxxxxxxxxx01x
+ this->config_ |= 0b0000000000000010;
+
+ // Not used - can be 0 or 1, lets be positive
+ // 0bxxxxxxxxxxxxxxx1
+ this->config_ |= 0b0000000000000001;
+}
+
+void ADS1118::dump_config() {
+ ESP_LOGCONFIG(TAG, "ADS1118:");
+ LOG_PIN(" CS Pin:", this->cs_);
+}
+
+float ADS1118::request_measurement(ADS1118Multiplexer multiplexer, ADS1118Gain gain, bool temperature_mode) {
+ uint16_t temp_config = this->config_;
+ // Multiplexer
+ // 0bxBBBxxxxxxxxxxxx
+ temp_config &= 0b1000111111111111;
+ temp_config |= (multiplexer & 0b111) << 12;
+
+ // Gain
+ // 0bxxxxBBBxxxxxxxxx
+ temp_config &= 0b1111000111111111;
+ temp_config |= (gain & 0b111) << 9;
+
+ if (temperature_mode) {
+ // Set temperature sensor mode
+ // 0bxxxxxxxxxxx1xxxx
+ temp_config |= 0b0000000000010000;
+ } else {
+ // Set ADC mode
+ // 0bxxxxxxxxxxx0xxxx
+ temp_config &= 0b1111111111101111;
+ }
+
+ // Start conversion
+ temp_config |= 0b1000000000000000;
+
+ this->enable();
+ this->write_byte16(temp_config);
+ this->disable();
+
+ // about 1.2 ms with 860 samples per second
+ delay(2);
+
+ this->enable();
+ uint8_t adc_first_byte = this->read_byte();
+ uint8_t adc_second_byte = this->read_byte();
+ this->disable();
+ uint16_t raw_conversion = encode_uint16(adc_first_byte, adc_second_byte);
+
+ auto signed_conversion = static_cast(raw_conversion);
+
+ if (temperature_mode) {
+ return (signed_conversion >> 2) * 0.03125f;
+ } else {
+ float millivolts;
+ float divider = 32768.0f;
+ switch (gain) {
+ case ADS1118_GAIN_6P144:
+ millivolts = (signed_conversion * 6144) / divider;
+ break;
+ case ADS1118_GAIN_4P096:
+ millivolts = (signed_conversion * 4096) / divider;
+ break;
+ case ADS1118_GAIN_2P048:
+ millivolts = (signed_conversion * 2048) / divider;
+ break;
+ case ADS1118_GAIN_1P024:
+ millivolts = (signed_conversion * 1024) / divider;
+ break;
+ case ADS1118_GAIN_0P512:
+ millivolts = (signed_conversion * 512) / divider;
+ break;
+ case ADS1118_GAIN_0P256:
+ millivolts = (signed_conversion * 256) / divider;
+ break;
+ default:
+ millivolts = NAN;
+ }
+
+ return millivolts / 1e3f;
+ }
+}
+
+} // namespace ads1118
+} // namespace esphome
diff --git a/esphome/components/ads1118/ads1118.h b/esphome/components/ads1118/ads1118.h
new file mode 100644
index 0000000000..8b9aa15cd2
--- /dev/null
+++ b/esphome/components/ads1118/ads1118.h
@@ -0,0 +1,46 @@
+#pragma once
+
+#include "esphome/components/spi/spi.h"
+#include "esphome/core/component.h"
+#include "esphome/core/hal.h"
+
+namespace esphome {
+namespace ads1118 {
+
+enum ADS1118Multiplexer {
+ ADS1118_MULTIPLEXER_P0_N1 = 0b000,
+ ADS1118_MULTIPLEXER_P0_N3 = 0b001,
+ ADS1118_MULTIPLEXER_P1_N3 = 0b010,
+ ADS1118_MULTIPLEXER_P2_N3 = 0b011,
+ ADS1118_MULTIPLEXER_P0_NG = 0b100,
+ ADS1118_MULTIPLEXER_P1_NG = 0b101,
+ ADS1118_MULTIPLEXER_P2_NG = 0b110,
+ ADS1118_MULTIPLEXER_P3_NG = 0b111,
+};
+
+enum ADS1118Gain {
+ ADS1118_GAIN_6P144 = 0b000,
+ ADS1118_GAIN_4P096 = 0b001,
+ ADS1118_GAIN_2P048 = 0b010,
+ ADS1118_GAIN_1P024 = 0b011,
+ ADS1118_GAIN_0P512 = 0b100,
+ ADS1118_GAIN_0P256 = 0b101,
+};
+
+class ADS1118 : public Component,
+ public spi::SPIDevice {
+ public:
+ ADS1118() = default;
+ void setup() override;
+ void dump_config() override;
+ float get_setup_priority() const override { return setup_priority::DATA; }
+ /// Helper method to request a measurement from a sensor.
+ float request_measurement(ADS1118Multiplexer multiplexer, ADS1118Gain gain, bool temperature_mode);
+
+ protected:
+ uint16_t config_{0};
+};
+
+} // namespace ads1118
+} // namespace esphome
diff --git a/esphome/components/ads1118/sensor/__init__.py b/esphome/components/ads1118/sensor/__init__.py
new file mode 100644
index 0000000000..4e89115447
--- /dev/null
+++ b/esphome/components/ads1118/sensor/__init__.py
@@ -0,0 +1,97 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import sensor, voltage_sampler
+from esphome.const import (
+ CONF_GAIN,
+ CONF_MULTIPLEXER,
+ DEVICE_CLASS_VOLTAGE,
+ DEVICE_CLASS_TEMPERATURE,
+ STATE_CLASS_MEASUREMENT,
+ UNIT_CELSIUS,
+ UNIT_VOLT,
+ CONF_TYPE,
+)
+from .. import ads1118_ns, ADS1118, CONF_ADS1118_ID
+
+AUTO_LOAD = ["voltage_sampler"]
+DEPENDENCIES = ["ads1118"]
+
+ADS1118Multiplexer = ads1118_ns.enum("ADS1118Multiplexer")
+MUX = {
+ "A0_A1": ADS1118Multiplexer.ADS1118_MULTIPLEXER_P0_N1,
+ "A0_A3": ADS1118Multiplexer.ADS1118_MULTIPLEXER_P0_N3,
+ "A1_A3": ADS1118Multiplexer.ADS1118_MULTIPLEXER_P1_N3,
+ "A2_A3": ADS1118Multiplexer.ADS1118_MULTIPLEXER_P2_N3,
+ "A0_GND": ADS1118Multiplexer.ADS1118_MULTIPLEXER_P0_NG,
+ "A1_GND": ADS1118Multiplexer.ADS1118_MULTIPLEXER_P1_NG,
+ "A2_GND": ADS1118Multiplexer.ADS1118_MULTIPLEXER_P2_NG,
+ "A3_GND": ADS1118Multiplexer.ADS1118_MULTIPLEXER_P3_NG,
+}
+
+ADS1118Gain = ads1118_ns.enum("ADS1118Gain")
+GAIN = {
+ "6.144": ADS1118Gain.ADS1118_GAIN_6P144,
+ "4.096": ADS1118Gain.ADS1118_GAIN_4P096,
+ "2.048": ADS1118Gain.ADS1118_GAIN_2P048,
+ "1.024": ADS1118Gain.ADS1118_GAIN_1P024,
+ "0.512": ADS1118Gain.ADS1118_GAIN_0P512,
+ "0.256": ADS1118Gain.ADS1118_GAIN_0P256,
+}
+
+
+ADS1118Sensor = ads1118_ns.class_(
+ "ADS1118Sensor",
+ cg.PollingComponent,
+ sensor.Sensor,
+ voltage_sampler.VoltageSampler,
+ cg.Parented.template(ADS1118),
+)
+
+TYPE_ADC = "adc"
+TYPE_TEMPERATURE = "temperature"
+
+CONFIG_SCHEMA = cv.typed_schema(
+ {
+ TYPE_ADC: sensor.sensor_schema(
+ ADS1118Sensor,
+ unit_of_measurement=UNIT_VOLT,
+ accuracy_decimals=3,
+ device_class=DEVICE_CLASS_VOLTAGE,
+ state_class=STATE_CLASS_MEASUREMENT,
+ )
+ .extend(
+ {
+ cv.GenerateID(CONF_ADS1118_ID): cv.use_id(ADS1118),
+ cv.Required(CONF_MULTIPLEXER): cv.enum(MUX, upper=True, space="_"),
+ cv.Required(CONF_GAIN): cv.enum(GAIN, string=True),
+ }
+ )
+ .extend(cv.polling_component_schema("60s")),
+ TYPE_TEMPERATURE: sensor.sensor_schema(
+ ADS1118Sensor,
+ unit_of_measurement=UNIT_CELSIUS,
+ accuracy_decimals=2,
+ device_class=DEVICE_CLASS_TEMPERATURE,
+ state_class=STATE_CLASS_MEASUREMENT,
+ )
+ .extend(
+ {
+ cv.GenerateID(CONF_ADS1118_ID): cv.use_id(ADS1118),
+ }
+ )
+ .extend(cv.polling_component_schema("60s")),
+ },
+ default_type=TYPE_ADC,
+)
+
+
+async def to_code(config):
+ var = await sensor.new_sensor(config)
+ await cg.register_component(var, config)
+ await cg.register_parented(var, config[CONF_ADS1118_ID])
+
+ if config[CONF_TYPE] == TYPE_ADC:
+ cg.add(var.set_multiplexer(config[CONF_MULTIPLEXER]))
+ cg.add(var.set_gain(config[CONF_GAIN]))
+ if config[CONF_TYPE] == TYPE_TEMPERATURE:
+ cg.add(var.set_temperature_mode(True))
diff --git a/esphome/components/ads1118/sensor/ads1118_sensor.cpp b/esphome/components/ads1118/sensor/ads1118_sensor.cpp
new file mode 100644
index 0000000000..c3ce3bdc9c
--- /dev/null
+++ b/esphome/components/ads1118/sensor/ads1118_sensor.cpp
@@ -0,0 +1,29 @@
+#include "ads1118_sensor.h"
+
+#include "esphome/core/log.h"
+
+namespace esphome {
+namespace ads1118 {
+
+static const char *const TAG = "ads1118.sensor";
+
+void ADS1118Sensor::dump_config() {
+ LOG_SENSOR(" ", "ADS1118 Sensor", this);
+ ESP_LOGCONFIG(TAG, " Multiplexer: %u", this->multiplexer_);
+ ESP_LOGCONFIG(TAG, " Gain: %u", this->gain_);
+}
+
+float ADS1118Sensor::sample() {
+ return this->parent_->request_measurement(this->multiplexer_, this->gain_, this->temperature_mode_);
+}
+
+void ADS1118Sensor::update() {
+ float v = this->sample();
+ if (!std::isnan(v)) {
+ ESP_LOGD(TAG, "'%s': Got Voltage=%fV", this->get_name().c_str(), v);
+ this->publish_state(v);
+ }
+}
+
+} // namespace ads1118
+} // namespace esphome
diff --git a/esphome/components/ads1118/sensor/ads1118_sensor.h b/esphome/components/ads1118/sensor/ads1118_sensor.h
new file mode 100644
index 0000000000..d2d7a03f59
--- /dev/null
+++ b/esphome/components/ads1118/sensor/ads1118_sensor.h
@@ -0,0 +1,36 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/core/helpers.h"
+
+#include "esphome/components/sensor/sensor.h"
+#include "esphome/components/voltage_sampler/voltage_sampler.h"
+
+#include "../ads1118.h"
+
+namespace esphome {
+namespace ads1118 {
+
+class ADS1118Sensor : public PollingComponent,
+ public sensor::Sensor,
+ public voltage_sampler::VoltageSampler,
+ public Parented {
+ public:
+ void update() override;
+
+ void set_multiplexer(ADS1118Multiplexer multiplexer) { this->multiplexer_ = multiplexer; }
+ void set_gain(ADS1118Gain gain) { this->gain_ = gain; }
+ void set_temperature_mode(bool temp) { this->temperature_mode_ = temp; }
+
+ float sample() override;
+
+ void dump_config() override;
+
+ protected:
+ ADS1118Multiplexer multiplexer_{ADS1118_MULTIPLEXER_P0_NG};
+ ADS1118Gain gain_{ADS1118_GAIN_6P144};
+ bool temperature_mode_;
+};
+
+} // namespace ads1118
+} // namespace esphome
diff --git a/esphome/components/ags10/__init__.py b/esphome/components/ags10/__init__.py
new file mode 100644
index 0000000000..37f34d06df
--- /dev/null
+++ b/esphome/components/ags10/__init__.py
@@ -0,0 +1 @@
+CODEOWNERS = ["@mak-42"]
diff --git a/esphome/components/ags10/ags10.cpp b/esphome/components/ags10/ags10.cpp
new file mode 100644
index 0000000000..422380da83
--- /dev/null
+++ b/esphome/components/ags10/ags10.cpp
@@ -0,0 +1,214 @@
+#include "ags10.h"
+
+#include
+
+namespace esphome {
+namespace ags10 {
+static const char *const TAG = "ags10";
+
+// Data acquisition.
+static const uint8_t REG_TVOC = 0x00;
+// Zero-point calibration.
+static const uint8_t REG_CALIBRATION = 0x01;
+// Read version.
+static const uint8_t REG_VERSION = 0x11;
+// Read current resistance.
+static const uint8_t REG_RESISTANCE = 0x20;
+// Modify target address.
+static const uint8_t REG_ADDRESS = 0x21;
+
+// Zero-point calibration with current resistance.
+static const uint16_t ZP_CURRENT = 0x0000;
+// Zero-point reset.
+static const uint16_t ZP_DEFAULT = 0xFFFF;
+
+void AGS10Component::setup() {
+ ESP_LOGCONFIG(TAG, "Setting up ags10...");
+
+ auto version = this->read_version_();
+ if (version) {
+ ESP_LOGD(TAG, "AGS10 Sensor Version: 0x%02X", *version);
+ if (this->version_ != nullptr) {
+ this->version_->publish_state(*version);
+ }
+ } else {
+ ESP_LOGE(TAG, "AGS10 Sensor Version: unknown");
+ }
+
+ auto resistance = this->read_resistance_();
+ if (resistance) {
+ ESP_LOGD(TAG, "AGS10 Sensor Resistance: 0x%08" PRIX32, *resistance);
+ if (this->resistance_ != nullptr) {
+ this->resistance_->publish_state(*resistance);
+ }
+ } else {
+ ESP_LOGE(TAG, "AGS10 Sensor Resistance: unknown");
+ }
+
+ ESP_LOGD(TAG, "Sensor initialized");
+}
+
+void AGS10Component::update() {
+ auto tvoc = this->read_tvoc_();
+ if (tvoc) {
+ this->tvoc_->publish_state(*tvoc);
+ this->status_clear_warning();
+ } else {
+ this->status_set_warning();
+ }
+}
+
+void AGS10Component::dump_config() {
+ ESP_LOGCONFIG(TAG, "AGS10:");
+ LOG_I2C_DEVICE(this);
+ switch (this->error_code_) {
+ case NONE:
+ break;
+ case COMMUNICATION_FAILED:
+ ESP_LOGE(TAG, "Communication with AGS10 failed!");
+ break;
+ case CRC_CHECK_FAILED:
+ ESP_LOGE(TAG, "The crc check failed");
+ break;
+ case ILLEGAL_STATUS:
+ ESP_LOGE(TAG, "AGS10 is not ready to return TVOC data or sensor in pre-heat stage.");
+ break;
+ case UNSUPPORTED_UNITS:
+ ESP_LOGE(TAG, "AGS10 returns TVOC data in unsupported units.");
+ break;
+ default:
+ ESP_LOGE(TAG, "Unknown error: %d", this->error_code_);
+ break;
+ }
+ LOG_UPDATE_INTERVAL(this);
+ LOG_SENSOR(" ", "TVOC Sensor", this->tvoc_);
+ LOG_SENSOR(" ", "Firmware Version Sensor", this->version_);
+ LOG_SENSOR(" ", "Resistance Sensor", this->resistance_);
+}
+
+/**
+ * Sets new I2C address of AGS10.
+ */
+bool AGS10Component::new_i2c_address(uint8_t newaddress) {
+ uint8_t rev_newaddress = ~newaddress;
+ std::array data{newaddress, rev_newaddress, newaddress, rev_newaddress, 0};
+ data[4] = calc_crc8_(data, 4);
+ if (!this->write_bytes(REG_ADDRESS, data)) {
+ this->error_code_ = COMMUNICATION_FAILED;
+ this->status_set_warning();
+ ESP_LOGE(TAG, "couldn't write the new I2C address 0x%02X", newaddress);
+ return false;
+ }
+ this->set_i2c_address(newaddress);
+ ESP_LOGW(TAG, "changed I2C address to 0x%02X", newaddress);
+ this->error_code_ = NONE;
+ this->status_clear_warning();
+ return true;
+}
+
+bool AGS10Component::set_zero_point_with_factory_defaults() { return this->set_zero_point_with(ZP_DEFAULT); }
+
+bool AGS10Component::set_zero_point_with_current_resistance() { return this->set_zero_point_with(ZP_CURRENT); }
+
+bool AGS10Component::set_zero_point_with(uint16_t value) {
+ std::array data{0x00, 0x0C, (uint8_t) ((value >> 8) & 0xFF), (uint8_t) (value & 0xFF), 0};
+ data[4] = calc_crc8_(data, 4);
+ if (!this->write_bytes(REG_CALIBRATION, data)) {
+ this->error_code_ = COMMUNICATION_FAILED;
+ this->status_set_warning();
+ ESP_LOGE(TAG, "unable to set zero-point calibration with 0x%02X", value);
+ return false;
+ }
+ if (value == ZP_CURRENT) {
+ ESP_LOGI(TAG, "zero-point calibration has been set with current resistance");
+ } else if (value == ZP_DEFAULT) {
+ ESP_LOGI(TAG, "zero-point calibration has been reset to the factory defaults");
+ } else {
+ ESP_LOGI(TAG, "zero-point calibration has been set with 0x%02X", value);
+ }
+ this->error_code_ = NONE;
+ this->status_clear_warning();
+ return true;
+}
+
+optional AGS10Component::read_tvoc_() {
+ auto data = this->read_and_check_<5>(REG_TVOC);
+ if (!data) {
+ return nullopt;
+ }
+
+ auto res = *data;
+ auto status_byte = res[0];
+
+ int units = status_byte & 0x0e;
+ int status_bit = status_byte & 0x01;
+
+ if (status_bit != 0) {
+ this->error_code_ = ILLEGAL_STATUS;
+ ESP_LOGW(TAG, "Reading AGS10 data failed: illegal status (not ready or sensor in pre-heat stage)!");
+ return nullopt;
+ }
+
+ if (units != 0) {
+ this->error_code_ = UNSUPPORTED_UNITS;
+ ESP_LOGE(TAG, "Reading AGS10 data failed: unsupported units (%d)!", units);
+ return nullopt;
+ }
+
+ return encode_uint24(res[1], res[2], res[3]);
+}
+
+optional AGS10Component::read_version_() {
+ auto data = this->read_and_check_<5>(REG_VERSION);
+ if (data) {
+ auto res = *data;
+ return res[3];
+ }
+ return nullopt;
+}
+
+optional AGS10Component::read_resistance_() {
+ auto data = this->read_and_check_<5>(REG_RESISTANCE);
+ if (data) {
+ auto res = *data;
+ return encode_uint32(res[0], res[1], res[2], res[3]);
+ }
+ return nullopt;
+}
+
+template optional> AGS10Component::read_and_check_(uint8_t a_register) {
+ auto data = this->read_bytes(a_register);
+ if (!data.has_value()) {
+ this->error_code_ = COMMUNICATION_FAILED;
+ ESP_LOGE(TAG, "Reading AGS10 version failed!");
+ return optional>();
+ }
+ auto len = N - 1;
+ auto res = *data;
+ auto crc_byte = res[len];
+
+ if (crc_byte != calc_crc8_(res, len)) {
+ this->error_code_ = CRC_CHECK_FAILED;
+ ESP_LOGE(TAG, "Reading AGS10 version failed: crc error!");
+ return optional>();
+ }
+
+ return data;
+}
+
+template uint8_t AGS10Component::calc_crc8_(std::array dat, uint8_t num) {
+ uint8_t i, byte1, crc = 0xFF;
+ for (byte1 = 0; byte1 < num; byte1++) {
+ crc ^= (dat[byte1]);
+ for (i = 0; i < 8; i++) {
+ if (crc & 0x80) {
+ crc = (crc << 1) ^ 0x31;
+ } else {
+ crc = (crc << 1);
+ }
+ }
+ }
+ return crc;
+}
+} // namespace ags10
+} // namespace esphome
diff --git a/esphome/components/ags10/ags10.h b/esphome/components/ags10/ags10.h
new file mode 100644
index 0000000000..f2201fe70c
--- /dev/null
+++ b/esphome/components/ags10/ags10.h
@@ -0,0 +1,152 @@
+#pragma once
+
+#include "esphome/core/automation.h"
+#include "esphome/core/component.h"
+#include "esphome/components/sensor/sensor.h"
+#include "esphome/components/i2c/i2c.h"
+
+namespace esphome {
+namespace ags10 {
+
+class AGS10Component : public PollingComponent, public i2c::I2CDevice {
+ public:
+ /**
+ * Sets TVOC sensor.
+ */
+ void set_tvoc(sensor::Sensor *tvoc) { this->tvoc_ = tvoc; }
+
+ /**
+ * Sets version info sensor.
+ */
+ void set_version(sensor::Sensor *version) { this->version_ = version; }
+
+ /**
+ * Sets resistance info sensor.
+ */
+ void set_resistance(sensor::Sensor *resistance) { this->resistance_ = resistance; }
+
+ void setup() override;
+
+ void update() override;
+
+ void dump_config() override;
+
+ float get_setup_priority() const override { return setup_priority::DATA; }
+
+ /**
+ * Modifies target address of AGS10.
+ *
+ * New address is saved and takes effect immediately even after power-off.
+ */
+ bool new_i2c_address(uint8_t newaddress);
+
+ /**
+ * Sets zero-point with factory defaults.
+ */
+ bool set_zero_point_with_factory_defaults();
+
+ /**
+ * Sets zero-point with current sensor resistance.
+ */
+ bool set_zero_point_with_current_resistance();
+
+ /**
+ * Sets zero-point with the value.
+ */
+ bool set_zero_point_with(uint16_t value);
+
+ protected:
+ /**
+ * TVOC.
+ */
+ sensor::Sensor *tvoc_{nullptr};
+
+ /**
+ * Firmvare version.
+ */
+ sensor::Sensor *version_{nullptr};
+
+ /**
+ * Resistance.
+ */
+ sensor::Sensor *resistance_{nullptr};
+
+ /**
+ * Last operation error code.
+ */
+ enum ErrorCode {
+ NONE = 0,
+ COMMUNICATION_FAILED,
+ CRC_CHECK_FAILED,
+ ILLEGAL_STATUS,
+ UNSUPPORTED_UNITS,
+ } error_code_{NONE};
+
+ /**
+ * Reads and returns value of TVOC.
+ */
+ optional read_tvoc_();
+
+ /**
+ * Reads and returns a firmware version of AGS10.
+ */
+ optional read_version_();
+
+ /**
+ * Reads and returns the resistance of AGS10.
+ */
+ optional read_resistance_();
+
+ /**
+ * Read, checks and returns data from the sensor.
+ */
+ template optional> read_and_check_(uint8_t a_register);
+
+ /**
+ * Calculates CRC8 value.
+ *
+ * CRC8 calculation, initial value: 0xFF, polynomial: 0x31 (x8+ x5+ x4+1)
+ *
+ * @param[in] dat the data buffer
+ * @param num number of bytes in the buffer
+ */
+ template uint8_t calc_crc8_(std::array dat, uint8_t num);
+};
+
+template class AGS10NewI2cAddressAction : public Action, public Parented {
+ public:
+ TEMPLATABLE_VALUE(uint8_t, new_address)
+
+ void play(Ts... x) override { this->parent_->new_i2c_address(this->new_address_.value(x...)); }
+};
+
+enum AGS10SetZeroPointActionMode {
+ // Zero-point reset.
+ FACTORY_DEFAULT,
+ // Zero-point calibration with current resistance.
+ CURRENT_VALUE,
+ // Zero-point calibration with custom resistance.
+ CUSTOM_VALUE,
+};
+
+template class AGS10SetZeroPointAction : public Action, public Parented {
+ public:
+ TEMPLATABLE_VALUE(uint16_t, value)
+ TEMPLATABLE_VALUE(AGS10SetZeroPointActionMode, mode)
+
+ void play(Ts... x) override {
+ switch (this->mode_.value(x...)) {
+ case FACTORY_DEFAULT:
+ this->parent_->set_zero_point_with_factory_defaults();
+ break;
+ case CURRENT_VALUE:
+ this->parent_->set_zero_point_with_current_resistance();
+ break;
+ case CUSTOM_VALUE:
+ this->parent_->set_zero_point_with(this->value_.value(x...));
+ break;
+ }
+ }
+};
+} // namespace ags10
+} // namespace esphome
diff --git a/esphome/components/ags10/sensor.py b/esphome/components/ags10/sensor.py
new file mode 100644
index 0000000000..59aebd636b
--- /dev/null
+++ b/esphome/components/ags10/sensor.py
@@ -0,0 +1,132 @@
+import esphome.codegen as cg
+from esphome import automation
+import esphome.config_validation as cv
+from esphome.components import i2c, sensor
+from esphome.const import (
+ CONF_ID,
+ ICON_RADIATOR,
+ ICON_RESTART,
+ DEVICE_CLASS_VOLATILE_ORGANIC_COMPOUNDS_PARTS,
+ ENTITY_CATEGORY_DIAGNOSTIC,
+ STATE_CLASS_MEASUREMENT,
+ UNIT_OHM,
+ UNIT_PARTS_PER_BILLION,
+ CONF_ADDRESS,
+ CONF_TVOC,
+ CONF_VERSION,
+ CONF_MODE,
+ CONF_VALUE,
+)
+
+CONF_RESISTANCE = "resistance"
+
+DEPENDENCIES = ["i2c"]
+
+ags10_ns = cg.esphome_ns.namespace("ags10")
+AGS10Component = ags10_ns.class_("AGS10Component", cg.PollingComponent, i2c.I2CDevice)
+
+# Actions
+AGS10NewI2cAddressAction = ags10_ns.class_(
+ "AGS10NewI2cAddressAction", automation.Action
+)
+AGS10SetZeroPointAction = ags10_ns.class_("AGS10SetZeroPointAction", automation.Action)
+
+CONFIG_SCHEMA = (
+ cv.Schema(
+ {
+ cv.GenerateID(): cv.declare_id(AGS10Component),
+ cv.Optional(CONF_TVOC): sensor.sensor_schema(
+ unit_of_measurement=UNIT_PARTS_PER_BILLION,
+ icon=ICON_RADIATOR,
+ accuracy_decimals=0,
+ device_class=DEVICE_CLASS_VOLATILE_ORGANIC_COMPOUNDS_PARTS,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_VERSION): sensor.sensor_schema(
+ icon=ICON_RESTART,
+ entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
+ ),
+ cv.Optional(CONF_RESISTANCE): sensor.sensor_schema(
+ unit_of_measurement=UNIT_OHM,
+ icon=ICON_RESTART,
+ accuracy_decimals=0,
+ state_class=STATE_CLASS_MEASUREMENT,
+ entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
+ ),
+ }
+ )
+ .extend(cv.polling_component_schema("60s"))
+ .extend(i2c.i2c_device_schema(0x1A))
+)
+
+FINAL_VALIDATE_SCHEMA = i2c.final_validate_device_schema("ags10", max_frequency="15khz")
+
+
+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)
+
+ sens = await sensor.new_sensor(config[CONF_TVOC])
+ cg.add(var.set_tvoc(sens))
+
+ if version_config := config.get(CONF_VERSION):
+ sens = await sensor.new_sensor(version_config)
+ cg.add(var.set_version(sens))
+
+ if resistance_config := config.get(CONF_RESISTANCE):
+ sens = await sensor.new_sensor(resistance_config)
+ cg.add(var.set_resistance(sens))
+
+
+AGS10_NEW_I2C_ADDRESS_SCHEMA = cv.maybe_simple_value(
+ {
+ cv.GenerateID(): cv.use_id(AGS10Component),
+ cv.Required(CONF_ADDRESS): cv.templatable(cv.i2c_address),
+ },
+ key=CONF_ADDRESS,
+)
+
+
+@automation.register_action(
+ "ags10.new_i2c_address",
+ AGS10NewI2cAddressAction,
+ AGS10_NEW_I2C_ADDRESS_SCHEMA,
+)
+async def ags10newi2caddress_to_code(config, action_id, template_arg, args):
+ var = cg.new_Pvariable(action_id, template_arg)
+ await cg.register_parented(var, config[CONF_ID])
+ address = await cg.templatable(config[CONF_ADDRESS], args, int)
+ cg.add(var.set_new_address(address))
+ return var
+
+
+AGS10SetZeroPointActionMode = ags10_ns.enum("AGS10SetZeroPointActionMode")
+AGS10_SET_ZERO_POINT_ACTION_MODE = {
+ "FACTORY_DEFAULT": AGS10SetZeroPointActionMode.FACTORY_DEFAULT,
+ "CURRENT_VALUE": AGS10SetZeroPointActionMode.CURRENT_VALUE,
+ "CUSTOM_VALUE": AGS10SetZeroPointActionMode.CUSTOM_VALUE,
+}
+
+AGS10_SET_ZERO_POINT_SCHEMA = cv.Schema(
+ {
+ cv.GenerateID(): cv.use_id(AGS10Component),
+ cv.Required(CONF_MODE): cv.enum(AGS10_SET_ZERO_POINT_ACTION_MODE, upper=True),
+ cv.Optional(CONF_VALUE, default=0xFFFF): cv.templatable(cv.uint16_t),
+ },
+)
+
+
+@automation.register_action(
+ "ags10.set_zero_point",
+ AGS10SetZeroPointAction,
+ AGS10_SET_ZERO_POINT_SCHEMA,
+)
+async def ags10setzeropoint_to_code(config, action_id, template_arg, args):
+ var = cg.new_Pvariable(action_id, template_arg)
+ await cg.register_parented(var, config[CONF_ID])
+ mode = await cg.templatable(config.get(CONF_MODE), args, enumerate)
+ cg.add(var.set_mode(mode))
+ value = await cg.templatable(config[CONF_VALUE], args, int)
+ cg.add(var.set_value(value))
+ return var
diff --git a/esphome/components/aht10/aht10.cpp b/esphome/components/aht10/aht10.cpp
index ad1a68498b..441c1ac9df 100644
--- a/esphome/components/aht10/aht10.cpp
+++ b/esphome/components/aht10/aht10.cpp
@@ -20,114 +20,140 @@ namespace esphome {
namespace aht10 {
static const char *const TAG = "aht10";
-static const uint8_t AHT10_CALIBRATE_CMD[] = {0xE1};
+static const uint8_t AHT10_INITIALIZE_CMD[] = {0xE1, 0x08, 0x00};
+static const uint8_t AHT20_INITIALIZE_CMD[] = {0xBE, 0x08, 0x00};
static const uint8_t AHT10_MEASURE_CMD[] = {0xAC, 0x33, 0x00};
-static const uint8_t AHT10_DEFAULT_DELAY = 5; // ms, for calibration and temperature measurement
-static const uint8_t AHT10_HUMIDITY_DELAY = 30; // ms
-static const uint8_t AHT10_ATTEMPTS = 3; // safety margin, normally 3 attempts are enough: 3*30=90ms
+static const uint8_t AHT10_SOFTRESET_CMD[] = {0xBA};
+
+static const uint8_t AHT10_DEFAULT_DELAY = 5; // ms, for initialization and temperature measurement
+static const uint8_t AHT10_READ_DELAY = 80; // ms, time to wait for conversion result
+static const uint8_t AHT10_SOFTRESET_DELAY = 30; // ms
+
+static const uint8_t AHT10_ATTEMPTS = 3; // safety margin, normally 3 attempts are enough: 3*30=90ms
+static const uint8_t AHT10_INIT_ATTEMPTS = 10;
+
+static const uint8_t AHT10_STATUS_BUSY = 0x80;
void AHT10Component::setup() {
- ESP_LOGCONFIG(TAG, "Setting up AHT10...");
+ if (this->write(AHT10_SOFTRESET_CMD, sizeof(AHT10_SOFTRESET_CMD)) != i2c::ERROR_OK) {
+ ESP_LOGE(TAG, "Reset AHT10 failed!");
+ }
+ delay(AHT10_SOFTRESET_DELAY);
- if (!this->write_bytes(0, AHT10_CALIBRATE_CMD, sizeof(AHT10_CALIBRATE_CMD))) {
+ i2c::ErrorCode error_code = i2c::ERROR_INVALID_ARGUMENT;
+ switch (this->variant_) {
+ case AHT10Variant::AHT20:
+ ESP_LOGCONFIG(TAG, "Setting up AHT20");
+ error_code = this->write(AHT20_INITIALIZE_CMD, sizeof(AHT20_INITIALIZE_CMD));
+ break;
+ case AHT10Variant::AHT10:
+ ESP_LOGCONFIG(TAG, "Setting up AHT10");
+ error_code = this->write(AHT10_INITIALIZE_CMD, sizeof(AHT10_INITIALIZE_CMD));
+ break;
+ }
+ if (error_code != i2c::ERROR_OK) {
ESP_LOGE(TAG, "Communication with AHT10 failed!");
this->mark_failed();
return;
}
- uint8_t data = 0;
- if (this->write(&data, 1) != i2c::ERROR_OK) {
- ESP_LOGD(TAG, "Communication with AHT10 failed!");
- this->mark_failed();
- return;
- }
- delay(AHT10_DEFAULT_DELAY);
- if (this->read(&data, 1) != i2c::ERROR_OK) {
- ESP_LOGD(TAG, "Communication with AHT10 failed!");
- this->mark_failed();
- return;
- }
- if (this->read(&data, 1) != i2c::ERROR_OK) {
- ESP_LOGD(TAG, "Communication with AHT10 failed!");
- this->mark_failed();
- return;
+ uint8_t data = AHT10_STATUS_BUSY;
+ int cal_attempts = 0;
+ while (data & AHT10_STATUS_BUSY) {
+ delay(AHT10_DEFAULT_DELAY);
+ if (this->read(&data, 1) != i2c::ERROR_OK) {
+ ESP_LOGE(TAG, "Communication with AHT10 failed!");
+ this->mark_failed();
+ return;
+ }
+ ++cal_attempts;
+ if (cal_attempts > AHT10_INIT_ATTEMPTS) {
+ ESP_LOGE(TAG, "AHT10 initialization timed out!");
+ this->mark_failed();
+ return;
+ }
}
if ((data & 0x68) != 0x08) { // Bit[6:5] = 0b00, NORMAL mode and Bit[3] = 0b1, CALIBRATED
- ESP_LOGE(TAG, "AHT10 calibration failed!");
+ ESP_LOGE(TAG, "AHT10 initialization failed!");
this->mark_failed();
return;
}
- ESP_LOGV(TAG, "AHT10 calibrated");
+ ESP_LOGV(TAG, "AHT10 initialization");
}
-void AHT10Component::update() {
- if (!this->write_bytes(0, AHT10_MEASURE_CMD, sizeof(AHT10_MEASURE_CMD))) {
- ESP_LOGE(TAG, "Communication with AHT10 failed!");
- this->status_set_warning();
+void AHT10Component::restart_read_() {
+ if (this->read_count_ == AHT10_ATTEMPTS) {
+ this->read_count_ = 0;
+ this->status_set_error("Measurements reading timed-out!");
return;
}
+ this->read_count_++;
+ this->set_timeout(AHT10_READ_DELAY, [this]() { this->read_data_(); });
+}
+
+void AHT10Component::read_data_() {
uint8_t data[6];
- uint8_t delay_ms = AHT10_DEFAULT_DELAY;
- if (this->humidity_sensor_ != nullptr)
- delay_ms = AHT10_HUMIDITY_DELAY;
- bool success = false;
- for (int i = 0; i < AHT10_ATTEMPTS; ++i) {
- ESP_LOGVV(TAG, "Attempt %d at %6u", i, millis());
- delay(delay_ms);
- if (this->read(data, 6) != i2c::ERROR_OK) {
- ESP_LOGD(TAG, "Communication with AHT10 failed, waiting...");
- continue;
- }
-
- if ((data[0] & 0x80) == 0x80) { // Bit[7] = 0b1, device is busy
- ESP_LOGD(TAG, "AHT10 is busy, waiting...");
- } else if (data[1] == 0x0 && data[2] == 0x0 && (data[3] >> 4) == 0x0) {
- // Unrealistic humidity (0x0)
- if (this->humidity_sensor_ == nullptr) {
- ESP_LOGVV(TAG, "ATH10 Unrealistic humidity (0x0), but humidity is not required");
- break;
- } else {
- ESP_LOGD(TAG, "ATH10 Unrealistic humidity (0x0), retrying...");
- if (!this->write_bytes(0, AHT10_MEASURE_CMD, sizeof(AHT10_MEASURE_CMD))) {
- ESP_LOGE(TAG, "Communication with AHT10 failed!");
- this->status_set_warning();
- return;
- }
- }
- } else {
- // data is valid, we can break the loop
- ESP_LOGVV(TAG, "Answer at %6u", millis());
- success = true;
- break;
- }
+ if (this->read_count_ > 1) {
+ ESP_LOGD(TAG, "Read attempt %d at %ums", this->read_count_, (unsigned) (millis() - this->start_time_));
}
- if (!success || (data[0] & 0x80) == 0x80) {
- ESP_LOGE(TAG, "Measurements reading timed-out!");
- this->status_set_warning();
+ if (this->read(data, 6) != i2c::ERROR_OK) {
+ this->status_set_warning("AHT10 read failed, retrying soon");
+ this->restart_read_();
return;
}
+ if ((data[0] & 0x80) == 0x80) { // Bit[7] = 0b1, device is busy
+ ESP_LOGD(TAG, "AHT10 is busy, waiting...");
+ this->restart_read_();
+ return;
+ }
+ if (data[1] == 0x0 && data[2] == 0x0 && (data[3] >> 4) == 0x0) {
+ // Unrealistic humidity (0x0)
+ if (this->humidity_sensor_ == nullptr) {
+ ESP_LOGV(TAG, "ATH10 Unrealistic humidity (0x0), but humidity is not required");
+ } else {
+ ESP_LOGD(TAG, "ATH10 Unrealistic humidity (0x0), retrying...");
+ if (this->write(AHT10_MEASURE_CMD, sizeof(AHT10_MEASURE_CMD)) != i2c::ERROR_OK) {
+ this->status_set_warning("Communication with AHT10 failed!");
+ }
+ this->restart_read_();
+ return;
+ }
+ }
+ if (this->read_count_ > 1) {
+ ESP_LOGD(TAG, "Success at %ums", (unsigned) (millis() - this->start_time_));
+ }
uint32_t raw_temperature = ((data[3] & 0x0F) << 16) | (data[4] << 8) | data[5];
uint32_t raw_humidity = ((data[1] << 16) | (data[2] << 8) | data[3]) >> 4;
- float temperature = ((200.0f * (float) raw_temperature) / 1048576.0f) - 50.0f;
- float humidity;
- if (raw_humidity == 0) { // unrealistic value
- humidity = NAN;
- } else {
- humidity = (float) raw_humidity * 100.0f / 1048576.0f;
- }
-
if (this->temperature_sensor_ != nullptr) {
+ float temperature = ((200.0f * (float) raw_temperature) / 1048576.0f) - 50.0f;
this->temperature_sensor_->publish_state(temperature);
}
if (this->humidity_sensor_ != nullptr) {
+ float humidity;
+ if (raw_humidity == 0) { // unrealistic value
+ humidity = NAN;
+ } else {
+ humidity = (float) raw_humidity * 100.0f / 1048576.0f;
+ }
if (std::isnan(humidity)) {
ESP_LOGW(TAG, "Invalid humidity! Sensor reported 0%% Hum");
}
this->humidity_sensor_->publish_state(humidity);
}
this->status_clear_warning();
+ this->read_count_ = 0;
+}
+void AHT10Component::update() {
+ if (this->read_count_ != 0)
+ return;
+ this->start_time_ = millis();
+ if (this->write(AHT10_MEASURE_CMD, sizeof(AHT10_MEASURE_CMD)) != i2c::ERROR_OK) {
+ this->status_set_warning("Communication with AHT10 failed!");
+ return;
+ }
+ this->restart_read_();
}
float AHT10Component::get_setup_priority() const { return setup_priority::DATA; }
diff --git a/esphome/components/aht10/aht10.h b/esphome/components/aht10/aht10.h
index 4d0eaa5919..a3320c77e0 100644
--- a/esphome/components/aht10/aht10.h
+++ b/esphome/components/aht10/aht10.h
@@ -1,5 +1,7 @@
#pragma once
+#include
+
#include "esphome/core/component.h"
#include "esphome/components/sensor/sensor.h"
#include "esphome/components/i2c/i2c.h"
@@ -7,12 +9,15 @@
namespace esphome {
namespace aht10 {
+enum AHT10Variant { AHT10, AHT20 };
+
class AHT10Component : public PollingComponent, public i2c::I2CDevice {
public:
void setup() override;
void update() override;
void dump_config() override;
float get_setup_priority() const override;
+ void set_variant(AHT10Variant variant) { this->variant_ = variant; }
void set_temperature_sensor(sensor::Sensor *temperature_sensor) { temperature_sensor_ = temperature_sensor; }
void set_humidity_sensor(sensor::Sensor *humidity_sensor) { humidity_sensor_ = humidity_sensor; }
@@ -20,6 +25,11 @@ class AHT10Component : public PollingComponent, public i2c::I2CDevice {
protected:
sensor::Sensor *temperature_sensor_{nullptr};
sensor::Sensor *humidity_sensor_{nullptr};
+ AHT10Variant variant_{};
+ unsigned read_count_{};
+ void read_data_();
+ void restart_read_();
+ uint32_t start_time_{};
};
} // namespace aht10
diff --git a/esphome/components/aht10/sensor.py b/esphome/components/aht10/sensor.py
index 654d645966..31b07c0e73 100644
--- a/esphome/components/aht10/sensor.py
+++ b/esphome/components/aht10/sensor.py
@@ -10,6 +10,7 @@ from esphome.const import (
STATE_CLASS_MEASUREMENT,
UNIT_CELSIUS,
UNIT_PERCENT,
+ CONF_VARIANT,
)
DEPENDENCIES = ["i2c"]
@@ -17,6 +18,12 @@ DEPENDENCIES = ["i2c"]
aht10_ns = cg.esphome_ns.namespace("aht10")
AHT10Component = aht10_ns.class_("AHT10Component", cg.PollingComponent, i2c.I2CDevice)
+AHT10Variant = aht10_ns.enum("AHT10Variant")
+AHT10_VARIANTS = {
+ "AHT10": AHT10Variant.AHT10,
+ "AHT20": AHT10Variant.AHT20,
+}
+
CONFIG_SCHEMA = (
cv.Schema(
{
@@ -33,6 +40,9 @@ CONFIG_SCHEMA = (
device_class=DEVICE_CLASS_HUMIDITY,
state_class=STATE_CLASS_MEASUREMENT,
),
+ cv.Optional(CONF_VARIANT, default="AHT10"): cv.enum(
+ AHT10_VARIANTS, upper=True
+ ),
}
)
.extend(cv.polling_component_schema("60s"))
@@ -44,11 +54,12 @@ 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_variant(config[CONF_VARIANT]))
- if CONF_TEMPERATURE in config:
- sens = await sensor.new_sensor(config[CONF_TEMPERATURE])
+ if temperature := config.get(CONF_TEMPERATURE):
+ sens = await sensor.new_sensor(temperature)
cg.add(var.set_temperature_sensor(sens))
- if CONF_HUMIDITY in config:
- sens = await sensor.new_sensor(config[CONF_HUMIDITY])
+ if humidity := config.get(CONF_HUMIDITY):
+ sens = await sensor.new_sensor(humidity)
cg.add(var.set_humidity_sensor(sens))
diff --git a/esphome/components/bme280/__init__.py b/esphome/components/aic3204/__init__.py
similarity index 100%
rename from esphome/components/bme280/__init__.py
rename to esphome/components/aic3204/__init__.py
diff --git a/esphome/components/aic3204/aic3204.cpp b/esphome/components/aic3204/aic3204.cpp
new file mode 100644
index 0000000000..0560f2366b
--- /dev/null
+++ b/esphome/components/aic3204/aic3204.cpp
@@ -0,0 +1,173 @@
+#include "aic3204.h"
+
+#include "esphome/core/defines.h"
+#include "esphome/core/helpers.h"
+#include "esphome/core/log.h"
+
+namespace esphome {
+namespace aic3204 {
+
+static const char *const TAG = "aic3204";
+
+#define ERROR_CHECK(err, msg) \
+ if (!(err)) { \
+ ESP_LOGE(TAG, msg); \
+ this->mark_failed(); \
+ return; \
+ }
+
+void AIC3204::setup() {
+ ESP_LOGCONFIG(TAG, "Setting up AIC3204...");
+
+ // Set register page to 0
+ ERROR_CHECK(this->write_byte(AIC3204_PAGE_CTRL, 0x00), "Set page 0 failed");
+ // Initiate SW reset (PLL is powered off as part of reset)
+ ERROR_CHECK(this->write_byte(AIC3204_SW_RST, 0x01), "Software reset failed");
+ // *** Program clock settings ***
+ // Default is CODEC_CLKIN is from MCLK pin. Don't need to change this.
+ // MDAC*NDAC*FOSR*48Khz = mClk (24.576 MHz when the XMOS is expecting 48kHz audio)
+ // (See page 51 of https://www.ti.com/lit/ml/slaa557/slaa557.pdf)
+ // We do need MDAC*DOSR/32 >= the resource compute level for the processing block
+ // So here 2*128/32 = 8, which is equal to processing block 1 's resource compute
+ // See page 5 of https://www.ti.com/lit/an/slaa404c/slaa404c.pdf for the workflow
+ // for determining these settings.
+
+ // Power up NDAC and set to 2
+ ERROR_CHECK(this->write_byte(AIC3204_NDAC, 0x82), "Set NDAC failed");
+ // Power up MDAC and set to 2
+ ERROR_CHECK(this->write_byte(AIC3204_MDAC, 0x82), "Set MDAC failed");
+ // Program DOSR = 128
+ ERROR_CHECK(this->write_byte(AIC3204_DOSR, 0x80), "Set DOSR failed");
+ // Set Audio Interface Config: I2S, 32 bits, DOUT always driving
+ ERROR_CHECK(this->write_byte(AIC3204_CODEC_IF, 0x30), "Set CODEC_IF failed");
+ // For I2S Firmware only, set SCLK/MFP3 pin as Audio Data In
+ ERROR_CHECK(this->write_byte(AIC3204_SCLK_MFP3, 0x02), "Set SCLK/MFP3 failed");
+ ERROR_CHECK(this->write_byte(AIC3204_AUDIO_IF_4, 0x01), "Set AUDIO_IF_4 failed");
+ ERROR_CHECK(this->write_byte(AIC3204_AUDIO_IF_5, 0x01), "Set AUDIO_IF_5 failed");
+ // Program the DAC processing block to be used - PRB_P1
+ ERROR_CHECK(this->write_byte(AIC3204_DAC_SIG_PROC, 0x01), "Set DAC_SIG_PROC failed");
+
+ // *** Select Page 1 ***
+ ERROR_CHECK(this->write_byte(AIC3204_PAGE_CTRL, 0x01), "Set page 1 failed");
+ // Enable the internal AVDD_LDO:
+ ERROR_CHECK(this->write_byte(AIC3204_LDO_CTRL, 0x09), "Set LDO_CTRL failed");
+ // *** Program Analog Blocks ***
+ // Disable Internal Crude AVdd in presence of external AVdd supply or before powering up internal AVdd LDO
+ ERROR_CHECK(this->write_byte(AIC3204_PWR_CFG, 0x08), "Set PWR_CFG failed");
+ // Enable Master Analog Power Control
+ ERROR_CHECK(this->write_byte(AIC3204_LDO_CTRL, 0x01), "Set LDO_CTRL failed");
+ // Page 125: Common mode control register, set d6 to 1 to make the full chip common mode = 0.75 v
+ // We are using the internal AVdd regulator with a nominal output of 1.72 V (see LDO_CTRL_REGISTER on page 123)
+ // Page 86 says to only set the common mode voltage to 0.9 v if AVdd >= 1.8... but it isn't on our hardware
+ // We also adjust the HPL and HPR gains to -2dB gian later in this config flow compensate (see page 47)
+ // (All pages refer to the TLV320AIC3204 Application Reference Guide)
+ ERROR_CHECK(this->write_byte(AIC3204_CM_CTRL, 0x40), "Set CM_CTRL failed");
+ // *** Set PowerTune Modes ***
+ // Set the Left & Right DAC PowerTune mode to PTM_P3/4. Use Class-AB driver.
+ ERROR_CHECK(this->write_byte(AIC3204_PLAY_CFG1, 0x00), "Set PLAY_CFG1 failed");
+ ERROR_CHECK(this->write_byte(AIC3204_PLAY_CFG2, 0x00), "Set PLAY_CFG2 failed");
+ // Set the REF charging time to 40ms
+ ERROR_CHECK(this->write_byte(AIC3204_REF_STARTUP, 0x01), "Set REF_STARTUP failed");
+ // HP soft stepping settings for optimal pop performance at power up
+ // Rpop used is 6k with N = 6 and soft step = 20usec. This should work with 47uF coupling
+ // capacitor. Can try N=5,6 or 7 time constants as well. Trade-off delay vs “pop” sound.
+ ERROR_CHECK(this->write_byte(AIC3204_HP_START, 0x25), "Set HP_START failed");
+ // Route Left DAC to HPL
+ ERROR_CHECK(this->write_byte(AIC3204_HPL_ROUTE, 0x08), "Set HPL_ROUTE failed");
+ // Route Right DAC to HPR
+ ERROR_CHECK(this->write_byte(AIC3204_HPR_ROUTE, 0x08), "Set HPR_ROUTE failed");
+ // Route Left DAC to LOL
+ ERROR_CHECK(this->write_byte(AIC3204_LOL_ROUTE, 0x08), "Set LOL_ROUTE failed");
+ // Route Right DAC to LOR
+ ERROR_CHECK(this->write_byte(AIC3204_LOR_ROUTE, 0x08), "Set LOR_ROUTE failed");
+
+ // Unmute HPL and set gain to -2dB (see comment before configuring the AIC3204_CM_CTRL register)
+ ERROR_CHECK(this->write_byte(AIC3204_HPL_GAIN, 0x3e), "Set HPL_GAIN failed");
+ // Unmute HPR and set gain to -2dB (see comment before configuring the AIC3204_CM_CTRL register)
+ ERROR_CHECK(this->write_byte(AIC3204_HPR_GAIN, 0x3e), "Set HPR_GAIN failed");
+ // Unmute LOL and set gain to 0dB
+ ERROR_CHECK(this->write_byte(AIC3204_LOL_DRV_GAIN, 0x00), "Set LOL_DRV_GAIN failed");
+ // Unmute LOR and set gain to 0dB
+ ERROR_CHECK(this->write_byte(AIC3204_LOR_DRV_GAIN, 0x00), "Set LOR_DRV_GAIN failed");
+
+ // Power up HPL and HPR, LOL and LOR drivers
+ ERROR_CHECK(this->write_byte(AIC3204_OP_PWR_CTRL, 0x3C), "Set OP_PWR_CTRL failed");
+
+ // Wait for 2.5 sec for soft stepping to take effect before attempting power-up
+ this->set_timeout(2500, [this]() {
+ // *** Power Up DAC ***
+ // Select Page 0
+ ERROR_CHECK(this->write_byte(AIC3204_PAGE_CTRL, 0x00), "Set PAGE_CTRL failed");
+ // Power up the Left and Right DAC Channels. Route Left data to Left DAC and Right data to Right DAC.
+ // DAC Vol control soft step 1 step per DAC word clock.
+ ERROR_CHECK(this->write_byte(AIC3204_DAC_CH_SET1, 0xd4), "Set DAC_CH_SET1 failed");
+ // Set left and right DAC digital volume control
+ ERROR_CHECK(this->write_volume_(), "Set volume failed");
+ // Unmute left and right channels
+ ERROR_CHECK(this->write_mute_(), "Set mute failed");
+ });
+}
+
+void AIC3204::dump_config() {
+ ESP_LOGCONFIG(TAG, "AIC3204:");
+ LOG_I2C_DEVICE(this);
+
+ if (this->is_failed()) {
+ ESP_LOGE(TAG, "Communication with AIC3204 failed");
+ }
+}
+
+bool AIC3204::set_mute_off() {
+ this->is_muted_ = false;
+ return this->write_mute_();
+}
+
+bool AIC3204::set_mute_on() {
+ this->is_muted_ = true;
+ return this->write_mute_();
+}
+
+bool AIC3204::set_auto_mute_mode(uint8_t auto_mute_mode) {
+ this->auto_mute_mode_ = auto_mute_mode & 0x07;
+ ESP_LOGVV(TAG, "Setting auto_mute_mode to 0x%.2x", this->auto_mute_mode_);
+ return this->write_mute_();
+}
+
+bool AIC3204::set_volume(float volume) {
+ this->volume_ = clamp(volume, 0.0, 1.0);
+ return this->write_volume_();
+}
+
+bool AIC3204::is_muted() { return this->is_muted_; }
+
+float AIC3204::volume() { return this->volume_; }
+
+bool AIC3204::write_mute_() {
+ uint8_t mute_mode_byte = this->auto_mute_mode_ << 4; // auto-mute control is bits 4-6
+ mute_mode_byte |= this->is_muted_ ? 0x0c : 0x00; // mute bits are 2-3
+ if (!this->write_byte(AIC3204_PAGE_CTRL, 0x00) || !this->write_byte(AIC3204_DAC_CH_SET2, mute_mode_byte)) {
+ ESP_LOGE(TAG, "Writing mute modes failed");
+ return false;
+ }
+ return true;
+}
+
+bool AIC3204::write_volume_() {
+ const int8_t dvc_min_byte = -127;
+ const int8_t dvc_max_byte = 48;
+
+ int8_t volume_byte = dvc_min_byte + (this->volume_ * (dvc_max_byte - dvc_min_byte));
+ volume_byte = clamp(volume_byte, dvc_min_byte, dvc_max_byte);
+
+ ESP_LOGVV(TAG, "Setting volume to 0x%.2x", volume_byte & 0xFF);
+
+ if ((!this->write_byte(AIC3204_PAGE_CTRL, 0x00)) || (!this->write_byte(AIC3204_DACL_VOL_D, volume_byte)) ||
+ (!this->write_byte(AIC3204_DACR_VOL_D, volume_byte))) {
+ ESP_LOGE(TAG, "Writing volume failed");
+ return false;
+ }
+ return true;
+}
+
+} // namespace aic3204
+} // namespace esphome
diff --git a/esphome/components/aic3204/aic3204.h b/esphome/components/aic3204/aic3204.h
new file mode 100644
index 0000000000..783a58a2b9
--- /dev/null
+++ b/esphome/components/aic3204/aic3204.h
@@ -0,0 +1,88 @@
+#pragma once
+
+#include "esphome/components/audio_dac/audio_dac.h"
+#include "esphome/components/i2c/i2c.h"
+#include "esphome/core/component.h"
+#include "esphome/core/defines.h"
+#include "esphome/core/hal.h"
+
+namespace esphome {
+namespace aic3204 {
+
+// TLV320AIC3204 Register Addresses
+// Page 0
+static const uint8_t AIC3204_PAGE_CTRL = 0x00; // Register 0 - Page Control
+static const uint8_t AIC3204_SW_RST = 0x01; // Register 1 - Software Reset
+static const uint8_t AIC3204_CLK_PLL1 = 0x04; // Register 4 - Clock Setting Register 1, Multiplexers
+static const uint8_t AIC3204_CLK_PLL2 = 0x05; // Register 5 - Clock Setting Register 2, P and R values
+static const uint8_t AIC3204_CLK_PLL3 = 0x06; // Register 6 - Clock Setting Register 3, J values
+static const uint8_t AIC3204_NDAC = 0x0B; // Register 11 - NDAC Divider Value
+static const uint8_t AIC3204_MDAC = 0x0C; // Register 12 - MDAC Divider Value
+static const uint8_t AIC3204_DOSR = 0x0E; // Register 14 - DOSR Divider Value (LS Byte)
+static const uint8_t AIC3204_NADC = 0x12; // Register 18 - NADC Divider Value
+static const uint8_t AIC3204_MADC = 0x13; // Register 19 - MADC Divider Value
+static const uint8_t AIC3204_AOSR = 0x14; // Register 20 - AOSR Divider Value
+static const uint8_t AIC3204_CODEC_IF = 0x1B; // Register 27 - CODEC Interface Control
+static const uint8_t AIC3204_AUDIO_IF_4 = 0x1F; // Register 31 - Audio Interface Setting Register 4
+static const uint8_t AIC3204_AUDIO_IF_5 = 0x20; // Register 32 - Audio Interface Setting Register 5
+static const uint8_t AIC3204_SCLK_MFP3 = 0x38; // Register 56 - SCLK/MFP3 Function Control
+static const uint8_t AIC3204_DAC_SIG_PROC = 0x3C; // Register 60 - DAC Sig Processing Block Control
+static const uint8_t AIC3204_ADC_SIG_PROC = 0x3D; // Register 61 - ADC Sig Processing Block Control
+static const uint8_t AIC3204_DAC_CH_SET1 = 0x3F; // Register 63 - DAC Channel Setup 1
+static const uint8_t AIC3204_DAC_CH_SET2 = 0x40; // Register 64 - DAC Channel Setup 2
+static const uint8_t AIC3204_DACL_VOL_D = 0x41; // Register 65 - DAC Left Digital Vol Control
+static const uint8_t AIC3204_DACR_VOL_D = 0x42; // Register 66 - DAC Right Digital Vol Control
+static const uint8_t AIC3204_DRC_ENABLE = 0x44;
+static const uint8_t AIC3204_ADC_CH_SET = 0x51; // Register 81 - ADC Channel Setup
+static const uint8_t AIC3204_ADC_FGA_MUTE = 0x52; // Register 82 - ADC Fine Gain Adjust/Mute
+
+// Page 1
+static const uint8_t AIC3204_PWR_CFG = 0x01; // Register 1 - Power Config
+static const uint8_t AIC3204_LDO_CTRL = 0x02; // Register 2 - LDO Control
+static const uint8_t AIC3204_PLAY_CFG1 = 0x03; // Register 3 - Playback Config 1
+static const uint8_t AIC3204_PLAY_CFG2 = 0x04; // Register 4 - Playback Config 2
+static const uint8_t AIC3204_OP_PWR_CTRL = 0x09; // Register 9 - Output Driver Power Control
+static const uint8_t AIC3204_CM_CTRL = 0x0A; // Register 10 - Common Mode Control
+static const uint8_t AIC3204_HPL_ROUTE = 0x0C; // Register 12 - HPL Routing Select
+static const uint8_t AIC3204_HPR_ROUTE = 0x0D; // Register 13 - HPR Routing Select
+static const uint8_t AIC3204_LOL_ROUTE = 0x0E; // Register 14 - LOL Routing Selection
+static const uint8_t AIC3204_LOR_ROUTE = 0x0F; // Register 15 - LOR Routing Selection
+static const uint8_t AIC3204_HPL_GAIN = 0x10; // Register 16 - HPL Driver Gain
+static const uint8_t AIC3204_HPR_GAIN = 0x11; // Register 17 - HPR Driver Gain
+static const uint8_t AIC3204_LOL_DRV_GAIN = 0x12; // Register 18 - LOL Driver Gain Setting
+static const uint8_t AIC3204_LOR_DRV_GAIN = 0x13; // Register 19 - LOR Driver Gain Setting
+static const uint8_t AIC3204_HP_START = 0x14; // Register 20 - Headphone Driver Startup
+static const uint8_t AIC3204_LPGA_P_ROUTE = 0x34; // Register 52 - Left PGA Positive Input Route
+static const uint8_t AIC3204_LPGA_N_ROUTE = 0x36; // Register 54 - Left PGA Negative Input Route
+static const uint8_t AIC3204_RPGA_P_ROUTE = 0x37; // Register 55 - Right PGA Positive Input Route
+static const uint8_t AIC3204_RPGA_N_ROUTE = 0x39; // Register 57 - Right PGA Negative Input Route
+static const uint8_t AIC3204_LPGA_VOL = 0x3B; // Register 59 - Left PGA Volume
+static const uint8_t AIC3204_RPGA_VOL = 0x3C; // Register 60 - Right PGA Volume
+static const uint8_t AIC3204_ADC_PTM = 0x3D; // Register 61 - ADC Power Tune Config
+static const uint8_t AIC3204_AN_IN_CHRG = 0x47; // Register 71 - Analog Input Quick Charging Config
+static const uint8_t AIC3204_REF_STARTUP = 0x7B; // Register 123 - Reference Power Up Config
+
+class AIC3204 : public audio_dac::AudioDac, public Component, public i2c::I2CDevice {
+ public:
+ void setup() override;
+ void dump_config() override;
+ float get_setup_priority() const override { return setup_priority::DATA; }
+
+ bool set_mute_off() override;
+ bool set_mute_on() override;
+ bool set_auto_mute_mode(uint8_t auto_mute_mode);
+ bool set_volume(float volume) override;
+
+ bool is_muted() override;
+ float volume() override;
+
+ protected:
+ bool write_mute_();
+ bool write_volume_();
+
+ uint8_t auto_mute_mode_{0};
+ float volume_{0};
+};
+
+} // namespace aic3204
+} // namespace esphome
diff --git a/esphome/components/aic3204/audio_dac.py b/esphome/components/aic3204/audio_dac.py
new file mode 100644
index 0000000000..da7a54df54
--- /dev/null
+++ b/esphome/components/aic3204/audio_dac.py
@@ -0,0 +1,52 @@
+from esphome import automation
+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_ID, CONF_MODE
+
+CODEOWNERS = ["@kbx81"]
+DEPENDENCIES = ["i2c"]
+
+aic3204_ns = cg.esphome_ns.namespace("aic3204")
+AIC3204 = aic3204_ns.class_("AIC3204", AudioDac, cg.Component, i2c.I2CDevice)
+
+SetAutoMuteAction = aic3204_ns.class_("SetAutoMuteAction", automation.Action)
+
+CONFIG_SCHEMA = (
+ cv.Schema(
+ {
+ cv.GenerateID(): cv.declare_id(AIC3204),
+ }
+ )
+ .extend(cv.COMPONENT_SCHEMA)
+ .extend(i2c.i2c_device_schema(0x18))
+)
+
+
+SET_AUTO_MUTE_ACTION_SCHEMA = cv.maybe_simple_value(
+ {
+ cv.GenerateID(): cv.use_id(AIC3204),
+ cv.Required(CONF_MODE): cv.templatable(cv.int_range(max=7, min=0)),
+ },
+ key=CONF_MODE,
+)
+
+
+@automation.register_action(
+ "aic3204.set_auto_mute_mode", SetAutoMuteAction, SET_AUTO_MUTE_ACTION_SCHEMA
+)
+async def aic3204_set_volume_to_code(config, action_id, template_arg, args):
+ paren = await cg.get_variable(config[CONF_ID])
+ var = cg.new_Pvariable(action_id, template_arg, paren)
+
+ template_ = await cg.templatable(config.get(CONF_MODE), args, int)
+ cg.add(var.set_auto_mute_mode(template_))
+
+ return var
+
+
+async def to_code(config):
+ var = cg.new_Pvariable(config[CONF_ID])
+ await cg.register_component(var, config)
+ await i2c.register_i2c_device(var, config)
diff --git a/esphome/components/aic3204/automation.h b/esphome/components/aic3204/automation.h
new file mode 100644
index 0000000000..416a88fa12
--- /dev/null
+++ b/esphome/components/aic3204/automation.h
@@ -0,0 +1,23 @@
+#pragma once
+
+#include "esphome/core/automation.h"
+#include "esphome/core/component.h"
+#include "aic3204.h"
+
+namespace esphome {
+namespace aic3204 {
+
+template class SetAutoMuteAction : public Action {
+ public:
+ explicit SetAutoMuteAction(AIC3204 *aic3204) : aic3204_(aic3204) {}
+
+ TEMPLATABLE_VALUE(uint8_t, auto_mute_mode)
+
+ void play(Ts... x) override { this->aic3204_->set_auto_mute_mode(this->auto_mute_mode_.value(x...)); }
+
+ protected:
+ AIC3204 *aic3204_;
+};
+
+} // namespace aic3204
+} // namespace esphome
diff --git a/esphome/components/airthings_ble/airthings_listener.cpp b/esphome/components/airthings_ble/airthings_listener.cpp
index 951961cb1b..a36d614df5 100644
--- a/esphome/components/airthings_ble/airthings_listener.cpp
+++ b/esphome/components/airthings_ble/airthings_listener.cpp
@@ -1,5 +1,6 @@
#include "airthings_listener.h"
#include "esphome/core/log.h"
+#include
#ifdef USE_ESP32
@@ -19,7 +20,7 @@ bool AirthingsListener::parse_device(const esp32_ble_tracker::ESPBTDevice &devic
sn |= ((uint32_t) it.data[2] << 16);
sn |= ((uint32_t) it.data[3] << 24);
- ESP_LOGD(TAG, "Found AirThings device Serial:%u (MAC: %s)", sn, device.address_str().c_str());
+ ESP_LOGD(TAG, "Found AirThings device Serial:%" PRIu32 " (MAC: %s)", sn, device.address_str().c_str());
return true;
}
}
diff --git a/esphome/components/airthings_wave_base/__init__.py b/esphome/components/airthings_wave_base/__init__.py
new file mode 100644
index 0000000000..d9b97f1c8d
--- /dev/null
+++ b/esphome/components/airthings_wave_base/__init__.py
@@ -0,0 +1,103 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import sensor, ble_client
+
+from esphome.const import (
+ CONF_BATTERY_VOLTAGE,
+ CONF_HUMIDITY,
+ CONF_PRESSURE,
+ CONF_TEMPERATURE,
+ CONF_TVOC,
+ DEVICE_CLASS_VOLTAGE,
+ DEVICE_CLASS_HUMIDITY,
+ DEVICE_CLASS_PRESSURE,
+ DEVICE_CLASS_TEMPERATURE,
+ DEVICE_CLASS_VOLATILE_ORGANIC_COMPOUNDS_PARTS,
+ ENTITY_CATEGORY_DIAGNOSTIC,
+ STATE_CLASS_MEASUREMENT,
+ UNIT_CELSIUS,
+ UNIT_HECTOPASCAL,
+ UNIT_PARTS_PER_BILLION,
+ UNIT_PERCENT,
+ UNIT_VOLT,
+)
+
+CODEOWNERS = ["@ncareau", "@jeromelaban", "@kpfleming"]
+
+DEPENDENCIES = ["ble_client"]
+
+CONF_BATTERY_UPDATE_INTERVAL = "battery_update_interval"
+
+airthings_wave_base_ns = cg.esphome_ns.namespace("airthings_wave_base")
+AirthingsWaveBase = airthings_wave_base_ns.class_(
+ "AirthingsWaveBase", cg.PollingComponent, ble_client.BLEClientNode
+)
+
+
+BASE_SCHEMA = (
+ sensor.SENSOR_SCHEMA.extend(
+ {
+ cv.Optional(CONF_HUMIDITY): sensor.sensor_schema(
+ unit_of_measurement=UNIT_PERCENT,
+ accuracy_decimals=0,
+ device_class=DEVICE_CLASS_HUMIDITY,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema(
+ unit_of_measurement=UNIT_CELSIUS,
+ accuracy_decimals=2,
+ device_class=DEVICE_CLASS_TEMPERATURE,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_PRESSURE): sensor.sensor_schema(
+ unit_of_measurement=UNIT_HECTOPASCAL,
+ accuracy_decimals=1,
+ device_class=DEVICE_CLASS_PRESSURE,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_TVOC): sensor.sensor_schema(
+ unit_of_measurement=UNIT_PARTS_PER_BILLION,
+ accuracy_decimals=0,
+ device_class=DEVICE_CLASS_VOLATILE_ORGANIC_COMPOUNDS_PARTS,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_BATTERY_VOLTAGE): sensor.sensor_schema(
+ unit_of_measurement=UNIT_VOLT,
+ accuracy_decimals=3,
+ device_class=DEVICE_CLASS_VOLTAGE,
+ state_class=STATE_CLASS_MEASUREMENT,
+ entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
+ ),
+ cv.Optional(
+ CONF_BATTERY_UPDATE_INTERVAL,
+ default="24h",
+ ): cv.update_interval,
+ }
+ )
+ .extend(cv.polling_component_schema("5min"))
+ .extend(ble_client.BLE_CLIENT_SCHEMA)
+)
+
+
+async def wave_base_to_code(var, config):
+ await cg.register_component(var, config)
+
+ await ble_client.register_ble_node(var, config)
+
+ if config_humidity := config.get(CONF_HUMIDITY):
+ sens = await sensor.new_sensor(config_humidity)
+ cg.add(var.set_humidity(sens))
+ if config_temperature := config.get(CONF_TEMPERATURE):
+ sens = await sensor.new_sensor(config_temperature)
+ cg.add(var.set_temperature(sens))
+ if config_pressure := config.get(CONF_PRESSURE):
+ sens = await sensor.new_sensor(config_pressure)
+ cg.add(var.set_pressure(sens))
+ if config_tvoc := config.get(CONF_TVOC):
+ sens = await sensor.new_sensor(config_tvoc)
+ cg.add(var.set_tvoc(sens))
+ if config_battery_voltage := config.get(CONF_BATTERY_VOLTAGE):
+ sens = await sensor.new_sensor(config_battery_voltage)
+ cg.add(var.set_battery_voltage(sens))
+ if config_battery_update_interval := config.get(CONF_BATTERY_UPDATE_INTERVAL):
+ cg.add(var.set_battery_update_interval(config_battery_update_interval))
diff --git a/esphome/components/airthings_wave_base/airthings_wave_base.cpp b/esphome/components/airthings_wave_base/airthings_wave_base.cpp
new file mode 100644
index 0000000000..16789ff454
--- /dev/null
+++ b/esphome/components/airthings_wave_base/airthings_wave_base.cpp
@@ -0,0 +1,211 @@
+#include "airthings_wave_base.h"
+
+// All information related to reading battery information came from the sensors.airthings_wave
+// project by Sverre Hamre (https://github.com/sverrham/sensor.airthings_wave)
+
+#ifdef USE_ESP32
+
+namespace esphome {
+namespace airthings_wave_base {
+
+static const char *const TAG = "airthings_wave_base";
+
+void AirthingsWaveBase::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
+ esp_ble_gattc_cb_param_t *param) {
+ switch (event) {
+ case ESP_GATTC_OPEN_EVT: {
+ if (param->open.status == ESP_GATT_OK) {
+ ESP_LOGI(TAG, "Connected successfully!");
+ }
+ break;
+ }
+
+ case ESP_GATTC_DISCONNECT_EVT: {
+ this->handle_ = 0;
+ this->acp_handle_ = 0;
+ this->cccd_handle_ = 0;
+ ESP_LOGW(TAG, "Disconnected!");
+ break;
+ }
+
+ case ESP_GATTC_SEARCH_CMPL_EVT: {
+ if (this->request_read_values_()) {
+ if (!this->read_battery_next_update_) {
+ this->node_state = espbt::ClientState::ESTABLISHED;
+ } else {
+ // delay setting node_state to ESTABLISHED until confirmation of the notify registration
+ this->request_battery_();
+ }
+ }
+
+ // ensure that the client will be disconnected even if no responses arrive
+ this->set_response_timeout_();
+
+ break;
+ }
+
+ case ESP_GATTC_READ_CHAR_EVT: {
+ if (param->read.conn_id != this->parent()->get_conn_id())
+ break;
+ if (param->read.status != ESP_GATT_OK) {
+ ESP_LOGW(TAG, "Error reading char at handle %d, status=%d", param->read.handle, param->read.status);
+ break;
+ }
+ if (param->read.handle == this->handle_) {
+ this->read_sensors(param->read.value, param->read.value_len);
+ }
+ break;
+ }
+
+ case ESP_GATTC_REG_FOR_NOTIFY_EVT: {
+ this->node_state = espbt::ClientState::ESTABLISHED;
+ break;
+ }
+
+ case ESP_GATTC_NOTIFY_EVT: {
+ if (param->notify.conn_id != this->parent()->get_conn_id())
+ break;
+ if (param->notify.handle == this->acp_handle_) {
+ this->read_battery_(param->notify.value, param->notify.value_len);
+ }
+ break;
+ }
+
+ default:
+ break;
+ }
+}
+
+bool AirthingsWaveBase::is_valid_voc_value_(uint16_t voc) { return voc <= 16383; }
+
+void AirthingsWaveBase::update() {
+ if (this->node_state != espbt::ClientState::ESTABLISHED) {
+ if (!this->parent()->enabled) {
+ ESP_LOGW(TAG, "Reconnecting to device");
+ this->parent()->set_enabled(true);
+ this->parent()->connect();
+ } else {
+ ESP_LOGW(TAG, "Connection in progress");
+ }
+ }
+}
+
+bool AirthingsWaveBase::request_read_values_() {
+ auto *chr = this->parent()->get_characteristic(this->service_uuid_, this->sensors_data_characteristic_uuid_);
+ if (chr == nullptr) {
+ ESP_LOGW(TAG, "No sensor characteristic found at service %s char %s", this->service_uuid_.to_string().c_str(),
+ this->sensors_data_characteristic_uuid_.to_string().c_str());
+ return false;
+ }
+
+ this->handle_ = chr->handle;
+
+ auto status = esp_ble_gattc_read_char(this->parent()->get_gattc_if(), this->parent()->get_conn_id(), this->handle_,
+ ESP_GATT_AUTH_REQ_NONE);
+ if (status) {
+ ESP_LOGW(TAG, "Error sending read request for sensor, status=%d", status);
+ return false;
+ }
+
+ this->response_pending_();
+ return true;
+}
+
+bool AirthingsWaveBase::request_battery_() {
+ uint8_t battery_command = ACCESS_CONTROL_POINT_COMMAND;
+ uint8_t cccd_value[2] = {1, 0};
+
+ auto *chr = this->parent()->get_characteristic(this->service_uuid_, this->access_control_point_characteristic_uuid_);
+ if (chr == nullptr) {
+ ESP_LOGW(TAG, "No access control point characteristic found at service %s char %s",
+ this->service_uuid_.to_string().c_str(),
+ this->access_control_point_characteristic_uuid_.to_string().c_str());
+ return false;
+ }
+
+ auto *descr = this->parent()->get_descriptor(this->service_uuid_, this->access_control_point_characteristic_uuid_,
+ CLIENT_CHARACTERISTIC_CONFIGURATION_DESCRIPTOR_UUID);
+ if (descr == nullptr) {
+ ESP_LOGW(TAG, "No CCC descriptor found at service %s char %s", this->service_uuid_.to_string().c_str(),
+ this->access_control_point_characteristic_uuid_.to_string().c_str());
+ return false;
+ }
+
+ auto reg_status =
+ esp_ble_gattc_register_for_notify(this->parent()->get_gattc_if(), this->parent()->get_remote_bda(), chr->handle);
+ if (reg_status) {
+ ESP_LOGW(TAG, "esp_ble_gattc_register_for_notify failed, status=%d", reg_status);
+ return false;
+ }
+
+ this->acp_handle_ = chr->handle;
+ this->cccd_handle_ = descr->handle;
+
+ auto descr_status =
+ esp_ble_gattc_write_char_descr(this->parent()->get_gattc_if(), this->parent()->get_conn_id(), this->cccd_handle_,
+ 2, cccd_value, ESP_GATT_WRITE_TYPE_RSP, ESP_GATT_AUTH_REQ_NONE);
+ if (descr_status) {
+ ESP_LOGW(TAG, "Error sending CCC descriptor write request, status=%d", descr_status);
+ return false;
+ }
+
+ auto chr_status =
+ esp_ble_gattc_write_char(this->parent()->get_gattc_if(), this->parent()->get_conn_id(), this->acp_handle_, 1,
+ &battery_command, ESP_GATT_WRITE_TYPE_RSP, ESP_GATT_AUTH_REQ_NONE);
+ if (chr_status) {
+ ESP_LOGW(TAG, "Error sending read request for battery, status=%d", chr_status);
+ return false;
+ }
+
+ this->response_pending_();
+ return true;
+}
+
+void AirthingsWaveBase::read_battery_(uint8_t *raw_value, uint16_t value_len) {
+ auto *value = (AccessControlPointResponse *) (&raw_value[2]);
+
+ if ((value_len >= (sizeof(AccessControlPointResponse) + 2)) && (raw_value[0] == ACCESS_CONTROL_POINT_COMMAND)) {
+ ESP_LOGD(TAG, "Battery received: %u mV", (unsigned int) value->battery);
+
+ if (this->battery_voltage_ != nullptr) {
+ float voltage = value->battery / 1000.0f;
+
+ this->battery_voltage_->publish_state(voltage);
+ }
+
+ // read the battery again at the configured update interval
+ if (this->battery_update_interval_ != this->update_interval_) {
+ this->read_battery_next_update_ = false;
+ this->set_timeout("battery", this->battery_update_interval_,
+ [this]() { this->read_battery_next_update_ = true; });
+ }
+ }
+
+ this->response_received_();
+}
+
+void AirthingsWaveBase::response_pending_() {
+ this->responses_pending_++;
+ this->set_response_timeout_();
+}
+
+void AirthingsWaveBase::response_received_() {
+ if (--this->responses_pending_ == 0) {
+ // This instance must not stay connected
+ // so other clients can connect to it (e.g. the
+ // mobile app).
+ this->parent()->set_enabled(false);
+ }
+}
+
+void AirthingsWaveBase::set_response_timeout_() {
+ this->set_timeout("response_timeout", 30 * 1000, [this]() {
+ this->responses_pending_ = 1;
+ this->response_received_();
+ });
+}
+
+} // namespace airthings_wave_base
+} // namespace esphome
+
+#endif // USE_ESP32
diff --git a/esphome/components/airthings_wave_base/airthings_wave_base.h b/esphome/components/airthings_wave_base/airthings_wave_base.h
new file mode 100644
index 0000000000..1dc2e1f71f
--- /dev/null
+++ b/esphome/components/airthings_wave_base/airthings_wave_base.h
@@ -0,0 +1,90 @@
+#pragma once
+
+// All information related to reading battery levels came from the sensors.airthings_wave
+// project by Sverre Hamre (https://github.com/sverrham/sensor.airthings_wave)
+
+#ifdef USE_ESP32
+
+#include
+#include
+#include
+#include "esphome/components/ble_client/ble_client.h"
+#include "esphome/components/esp32_ble_tracker/esp32_ble_tracker.h"
+#include "esphome/components/sensor/sensor.h"
+#include "esphome/core/component.h"
+#include "esphome/core/log.h"
+
+namespace esphome {
+namespace airthings_wave_base {
+
+namespace espbt = esphome::esp32_ble_tracker;
+
+static const uint8_t ACCESS_CONTROL_POINT_COMMAND = 0x6d;
+static const auto CLIENT_CHARACTERISTIC_CONFIGURATION_DESCRIPTOR_UUID = espbt::ESPBTUUID::from_uint16(0x2902);
+
+class AirthingsWaveBase : public PollingComponent, public ble_client::BLEClientNode {
+ public:
+ AirthingsWaveBase() = default;
+
+ void update() override;
+
+ void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
+ esp_ble_gattc_cb_param_t *param) override;
+
+ void set_temperature(sensor::Sensor *temperature) { temperature_sensor_ = temperature; }
+ void set_humidity(sensor::Sensor *humidity) { humidity_sensor_ = humidity; }
+ void set_pressure(sensor::Sensor *pressure) { pressure_sensor_ = pressure; }
+ void set_tvoc(sensor::Sensor *tvoc) { tvoc_sensor_ = tvoc; }
+ void set_battery_voltage(sensor::Sensor *voltage) {
+ battery_voltage_ = voltage;
+ this->read_battery_next_update_ = true;
+ }
+ void set_battery_update_interval(uint32_t interval) { battery_update_interval_ = interval; }
+
+ protected:
+ bool is_valid_voc_value_(uint16_t voc);
+
+ bool request_read_values_();
+ virtual void read_sensors(uint8_t *raw_value, uint16_t value_len) = 0;
+
+ sensor::Sensor *temperature_sensor_{nullptr};
+ sensor::Sensor *humidity_sensor_{nullptr};
+ sensor::Sensor *pressure_sensor_{nullptr};
+ sensor::Sensor *tvoc_sensor_{nullptr};
+ sensor::Sensor *battery_voltage_{nullptr};
+
+ uint16_t handle_;
+ espbt::ESPBTUUID service_uuid_;
+ espbt::ESPBTUUID sensors_data_characteristic_uuid_;
+
+ uint16_t acp_handle_{0};
+ uint16_t cccd_handle_{0};
+ espbt::ESPBTUUID access_control_point_characteristic_uuid_;
+
+ uint8_t responses_pending_{0};
+ void response_pending_();
+ void response_received_();
+ void set_response_timeout_();
+
+ // default to *not* reading battery voltage from the device; the
+ // set_* function for the battery sensor will set this to 'true'
+ bool read_battery_next_update_{false};
+ bool request_battery_();
+ void read_battery_(uint8_t *raw_value, uint16_t value_len);
+ uint32_t battery_update_interval_{};
+
+ struct AccessControlPointResponse {
+ uint32_t unused1;
+ uint8_t unused2;
+ uint8_t illuminance;
+ uint8_t unused3[10];
+ uint16_t unused4[4];
+ uint16_t battery;
+ uint16_t unused5;
+ };
+};
+
+} // namespace airthings_wave_base
+} // namespace esphome
+
+#endif // USE_ESP32
diff --git a/esphome/components/airthings_wave_mini/airthings_wave_mini.cpp b/esphome/components/airthings_wave_mini/airthings_wave_mini.cpp
index 40873ec005..873826d06c 100644
--- a/esphome/components/airthings_wave_mini/airthings_wave_mini.cpp
+++ b/esphome/components/airthings_wave_mini/airthings_wave_mini.cpp
@@ -7,105 +7,47 @@ namespace airthings_wave_mini {
static const char *const TAG = "airthings_wave_mini";
-void AirthingsWaveMini::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
- esp_ble_gattc_cb_param_t *param) {
- switch (event) {
- case ESP_GATTC_OPEN_EVT: {
- if (param->open.status == ESP_GATT_OK) {
- ESP_LOGI(TAG, "Connected successfully!");
- }
- break;
- }
-
- case ESP_GATTC_DISCONNECT_EVT: {
- ESP_LOGW(TAG, "Disconnected!");
- break;
- }
-
- case ESP_GATTC_SEARCH_CMPL_EVT: {
- this->handle_ = 0;
- auto *chr = this->parent()->get_characteristic(service_uuid_, sensors_data_characteristic_uuid_);
- if (chr == nullptr) {
- ESP_LOGW(TAG, "No sensor characteristic found at service %s char %s", service_uuid_.to_string().c_str(),
- sensors_data_characteristic_uuid_.to_string().c_str());
- break;
- }
- this->handle_ = chr->handle;
- this->node_state = esp32_ble_tracker::ClientState::ESTABLISHED;
-
- request_read_values_();
- break;
- }
-
- case ESP_GATTC_READ_CHAR_EVT: {
- if (param->read.conn_id != this->parent()->get_conn_id())
- break;
- if (param->read.status != ESP_GATT_OK) {
- ESP_LOGW(TAG, "Error reading char at handle %d, status=%d", param->read.handle, param->read.status);
- break;
- }
- if (param->read.handle == this->handle_) {
- read_sensors_(param->read.value, param->read.value_len);
- }
- break;
- }
-
- default:
- break;
- }
-}
-
-void AirthingsWaveMini::read_sensors_(uint8_t *raw_value, uint16_t value_len) {
+void AirthingsWaveMini::read_sensors(uint8_t *raw_value, uint16_t value_len) {
auto *value = (WaveMiniReadings *) raw_value;
if (sizeof(WaveMiniReadings) <= value_len) {
- this->humidity_sensor_->publish_state(value->humidity / 100.0f);
- this->pressure_sensor_->publish_state(value->pressure / 50.0f);
- this->temperature_sensor_->publish_state(value->temperature / 100.0f - 273.15f);
- if (is_valid_voc_value_(value->voc)) {
+ if (this->humidity_sensor_ != nullptr) {
+ this->humidity_sensor_->publish_state(value->humidity / 100.0f);
+ }
+
+ if (this->pressure_sensor_ != nullptr) {
+ this->pressure_sensor_->publish_state(value->pressure / 50.0f);
+ }
+
+ if (this->temperature_sensor_ != nullptr) {
+ this->temperature_sensor_->publish_state(value->temperature / 100.0f - 273.15f);
+ }
+
+ if ((this->tvoc_sensor_ != nullptr) && this->is_valid_voc_value_(value->voc)) {
this->tvoc_sensor_->publish_state(value->voc);
}
-
- // This instance must not stay connected
- // so other clients can connect to it (e.g. the
- // mobile app).
- parent()->set_enabled(false);
}
-}
-bool AirthingsWaveMini::is_valid_voc_value_(uint16_t voc) { return 0 <= voc && voc <= 16383; }
-
-void AirthingsWaveMini::update() {
- if (this->node_state != esp32_ble_tracker::ClientState::ESTABLISHED) {
- if (!parent()->enabled) {
- ESP_LOGW(TAG, "Reconnecting to device");
- parent()->set_enabled(true);
- parent()->connect();
- } else {
- ESP_LOGW(TAG, "Connection in progress");
- }
- }
-}
-
-void AirthingsWaveMini::request_read_values_() {
- auto status = esp_ble_gattc_read_char(this->parent()->get_gattc_if(), this->parent()->get_conn_id(), this->handle_,
- ESP_GATT_AUTH_REQ_NONE);
- if (status) {
- ESP_LOGW(TAG, "Error sending read request for sensor, status=%d", status);
- }
+ this->response_received_();
}
void AirthingsWaveMini::dump_config() {
+ // these really don't belong here, but there doesn't seem to be a
+ // practical way to have the base class use LOG_SENSOR and include
+ // the TAG from this component
LOG_SENSOR(" ", "Humidity", this->humidity_sensor_);
LOG_SENSOR(" ", "Temperature", this->temperature_sensor_);
LOG_SENSOR(" ", "Pressure", this->pressure_sensor_);
LOG_SENSOR(" ", "TVOC", this->tvoc_sensor_);
+ LOG_SENSOR(" ", "Battery Voltage", this->battery_voltage_);
}
-AirthingsWaveMini::AirthingsWaveMini()
- : PollingComponent(10000),
- service_uuid_(esp32_ble_tracker::ESPBTUUID::from_raw(SERVICE_UUID)),
- sensors_data_characteristic_uuid_(esp32_ble_tracker::ESPBTUUID::from_raw(CHARACTERISTIC_UUID)) {}
+AirthingsWaveMini::AirthingsWaveMini() {
+ this->service_uuid_ = espbt::ESPBTUUID::from_raw(SERVICE_UUID);
+ this->sensors_data_characteristic_uuid_ = espbt::ESPBTUUID::from_raw(CHARACTERISTIC_UUID);
+ this->access_control_point_characteristic_uuid_ =
+ espbt::ESPBTUUID::from_raw(ACCESS_CONTROL_POINT_CHARACTERISTIC_UUID);
+}
} // namespace airthings_wave_mini
} // namespace esphome
diff --git a/esphome/components/airthings_wave_mini/airthings_wave_mini.h b/esphome/components/airthings_wave_mini/airthings_wave_mini.h
index 128774f9cb..825ddbdc69 100644
--- a/esphome/components/airthings_wave_mini/airthings_wave_mini.h
+++ b/esphome/components/airthings_wave_mini/airthings_wave_mini.h
@@ -2,50 +2,25 @@
#ifdef USE_ESP32
-#include
-#include
-#include
-#include "esphome/components/ble_client/ble_client.h"
-#include "esphome/components/esp32_ble_tracker/esp32_ble_tracker.h"
-#include "esphome/components/sensor/sensor.h"
-#include "esphome/core/component.h"
-#include "esphome/core/log.h"
+#include "esphome/components/airthings_wave_base/airthings_wave_base.h"
namespace esphome {
namespace airthings_wave_mini {
+namespace espbt = esphome::esp32_ble_tracker;
+
static const char *const SERVICE_UUID = "b42e3882-ade7-11e4-89d3-123b93f75cba";
static const char *const CHARACTERISTIC_UUID = "b42e3b98-ade7-11e4-89d3-123b93f75cba";
+static const char *const ACCESS_CONTROL_POINT_CHARACTERISTIC_UUID = "b42e3ef4-ade7-11e4-89d3-123b93f75cba";
-class AirthingsWaveMini : public PollingComponent, public ble_client::BLEClientNode {
+class AirthingsWaveMini : public airthings_wave_base::AirthingsWaveBase {
public:
AirthingsWaveMini();
void dump_config() override;
- void update() override;
-
- void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
- esp_ble_gattc_cb_param_t *param) override;
-
- void set_temperature(sensor::Sensor *temperature) { temperature_sensor_ = temperature; }
- void set_humidity(sensor::Sensor *humidity) { humidity_sensor_ = humidity; }
- void set_pressure(sensor::Sensor *pressure) { pressure_sensor_ = pressure; }
- void set_tvoc(sensor::Sensor *tvoc) { tvoc_sensor_ = tvoc; }
protected:
- bool is_valid_voc_value_(uint16_t voc);
-
- void read_sensors_(uint8_t *value, uint16_t value_len);
- void request_read_values_();
-
- sensor::Sensor *temperature_sensor_{nullptr};
- sensor::Sensor *humidity_sensor_{nullptr};
- sensor::Sensor *pressure_sensor_{nullptr};
- sensor::Sensor *tvoc_sensor_{nullptr};
-
- uint16_t handle_;
- esp32_ble_tracker::ESPBTUUID service_uuid_;
- esp32_ble_tracker::ESPBTUUID sensors_data_characteristic_uuid_;
+ void read_sensors(uint8_t *raw_value, uint16_t value_len) override;
struct WaveMiniReadings {
uint16_t unused01;
diff --git a/esphome/components/airthings_wave_mini/sensor.py b/esphome/components/airthings_wave_mini/sensor.py
index d38354fa84..0f4fd1a13a 100644
--- a/esphome/components/airthings_wave_mini/sensor.py
+++ b/esphome/components/airthings_wave_mini/sensor.py
@@ -1,82 +1,28 @@
import esphome.codegen as cg
import esphome.config_validation as cv
-from esphome.components import sensor, ble_client
+from esphome.components import airthings_wave_base
from esphome.const import (
- DEVICE_CLASS_HUMIDITY,
- DEVICE_CLASS_TEMPERATURE,
- DEVICE_CLASS_PRESSURE,
- STATE_CLASS_MEASUREMENT,
- UNIT_PERCENT,
- UNIT_CELSIUS,
- UNIT_HECTOPASCAL,
CONF_ID,
- CONF_HUMIDITY,
- CONF_TVOC,
- CONF_PRESSURE,
- CONF_TEMPERATURE,
- UNIT_PARTS_PER_BILLION,
- ICON_RADIATOR,
)
-DEPENDENCIES = ["ble_client"]
+DEPENDENCIES = airthings_wave_base.DEPENDENCIES
+
+AUTO_LOAD = ["airthings_wave_base"]
airthings_wave_mini_ns = cg.esphome_ns.namespace("airthings_wave_mini")
AirthingsWaveMini = airthings_wave_mini_ns.class_(
- "AirthingsWaveMini", cg.PollingComponent, ble_client.BLEClientNode
+ "AirthingsWaveMini", airthings_wave_base.AirthingsWaveBase
)
-CONFIG_SCHEMA = cv.All(
- cv.Schema(
- {
- cv.GenerateID(): cv.declare_id(AirthingsWaveMini),
- cv.Optional(CONF_HUMIDITY): sensor.sensor_schema(
- unit_of_measurement=UNIT_PERCENT,
- device_class=DEVICE_CLASS_HUMIDITY,
- state_class=STATE_CLASS_MEASUREMENT,
- accuracy_decimals=2,
- ),
- cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema(
- unit_of_measurement=UNIT_CELSIUS,
- accuracy_decimals=2,
- device_class=DEVICE_CLASS_TEMPERATURE,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- cv.Optional(CONF_PRESSURE): sensor.sensor_schema(
- unit_of_measurement=UNIT_HECTOPASCAL,
- accuracy_decimals=2,
- device_class=DEVICE_CLASS_PRESSURE,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- cv.Optional(CONF_TVOC): sensor.sensor_schema(
- unit_of_measurement=UNIT_PARTS_PER_BILLION,
- icon=ICON_RADIATOR,
- accuracy_decimals=0,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- }
- )
- .extend(cv.polling_component_schema("5min"))
- .extend(ble_client.BLE_CLIENT_SCHEMA),
+CONFIG_SCHEMA = airthings_wave_base.BASE_SCHEMA.extend(
+ {
+ cv.GenerateID(): cv.declare_id(AirthingsWaveMini),
+ }
)
async def to_code(config):
var = cg.new_Pvariable(config[CONF_ID])
- await cg.register_component(var, config)
-
- await ble_client.register_ble_node(var, config)
-
- if CONF_HUMIDITY in config:
- sens = await sensor.new_sensor(config[CONF_HUMIDITY])
- cg.add(var.set_humidity(sens))
- if CONF_TEMPERATURE in config:
- sens = await sensor.new_sensor(config[CONF_TEMPERATURE])
- cg.add(var.set_temperature(sens))
- if CONF_PRESSURE in config:
- sens = await sensor.new_sensor(config[CONF_PRESSURE])
- cg.add(var.set_pressure(sens))
- if CONF_TVOC in config:
- sens = await sensor.new_sensor(config[CONF_TVOC])
- cg.add(var.set_tvoc(sens))
+ await airthings_wave_base.wave_base_to_code(var, config)
diff --git a/esphome/components/airthings_wave_plus/airthings_wave_plus.cpp b/esphome/components/airthings_wave_plus/airthings_wave_plus.cpp
index 11f86307fe..8c8c514fdb 100644
--- a/esphome/components/airthings_wave_plus/airthings_wave_plus.cpp
+++ b/esphome/components/airthings_wave_plus/airthings_wave_plus.cpp
@@ -7,129 +7,78 @@ namespace airthings_wave_plus {
static const char *const TAG = "airthings_wave_plus";
-void AirthingsWavePlus::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
- esp_ble_gattc_cb_param_t *param) {
- switch (event) {
- case ESP_GATTC_OPEN_EVT: {
- if (param->open.status == ESP_GATT_OK) {
- ESP_LOGI(TAG, "Connected successfully!");
- }
- break;
- }
-
- case ESP_GATTC_DISCONNECT_EVT: {
- ESP_LOGW(TAG, "Disconnected!");
- break;
- }
-
- case ESP_GATTC_SEARCH_CMPL_EVT: {
- this->handle_ = 0;
- auto *chr = this->parent()->get_characteristic(service_uuid_, sensors_data_characteristic_uuid_);
- if (chr == nullptr) {
- ESP_LOGW(TAG, "No sensor characteristic found at service %s char %s", service_uuid_.to_string().c_str(),
- sensors_data_characteristic_uuid_.to_string().c_str());
- break;
- }
- this->handle_ = chr->handle;
- this->node_state = esp32_ble_tracker::ClientState::ESTABLISHED;
-
- request_read_values_();
- break;
- }
-
- case ESP_GATTC_READ_CHAR_EVT: {
- if (param->read.conn_id != this->parent()->get_conn_id())
- break;
- if (param->read.status != ESP_GATT_OK) {
- ESP_LOGW(TAG, "Error reading char at handle %d, status=%d", param->read.handle, param->read.status);
- break;
- }
- if (param->read.handle == this->handle_) {
- read_sensors_(param->read.value, param->read.value_len);
- }
- break;
- }
-
- default:
- break;
- }
-}
-
-void AirthingsWavePlus::read_sensors_(uint8_t *raw_value, uint16_t value_len) {
+void AirthingsWavePlus::read_sensors(uint8_t *raw_value, uint16_t value_len) {
auto *value = (WavePlusReadings *) raw_value;
if (sizeof(WavePlusReadings) <= value_len) {
ESP_LOGD(TAG, "version = %d", value->version);
if (value->version == 1) {
- ESP_LOGD(TAG, "ambient light = %d", value->ambientLight);
+ if (this->humidity_sensor_ != nullptr) {
+ this->humidity_sensor_->publish_state(value->humidity / 2.0f);
+ }
- this->humidity_sensor_->publish_state(value->humidity / 2.0f);
- if (is_valid_radon_value_(value->radon)) {
+ if ((this->radon_sensor_ != nullptr) && this->is_valid_radon_value_(value->radon)) {
this->radon_sensor_->publish_state(value->radon);
}
- if (is_valid_radon_value_(value->radon_lt)) {
+
+ if ((this->radon_long_term_sensor_ != nullptr) && this->is_valid_radon_value_(value->radon_lt)) {
this->radon_long_term_sensor_->publish_state(value->radon_lt);
}
- this->temperature_sensor_->publish_state(value->temperature / 100.0f);
- this->pressure_sensor_->publish_state(value->pressure / 50.0f);
- if (is_valid_co2_value_(value->co2)) {
+
+ if (this->temperature_sensor_ != nullptr) {
+ this->temperature_sensor_->publish_state(value->temperature / 100.0f);
+ }
+
+ if (this->pressure_sensor_ != nullptr) {
+ this->pressure_sensor_->publish_state(value->pressure / 50.0f);
+ }
+
+ if ((this->co2_sensor_ != nullptr) && this->is_valid_co2_value_(value->co2)) {
this->co2_sensor_->publish_state(value->co2);
}
- if (is_valid_voc_value_(value->voc)) {
+
+ if ((this->tvoc_sensor_ != nullptr) && this->is_valid_voc_value_(value->voc)) {
this->tvoc_sensor_->publish_state(value->voc);
}
- // This instance must not stay connected
- // so other clients can connect to it (e.g. the
- // mobile app).
- parent()->set_enabled(false);
+ if (this->illuminance_sensor_ != nullptr) {
+ this->illuminance_sensor_->publish_state(value->ambientLight);
+ }
} else {
ESP_LOGE(TAG, "Invalid payload version (%d != 1, newer version or not a Wave Plus?)", value->version);
}
}
+
+ this->response_received_();
}
-bool AirthingsWavePlus::is_valid_radon_value_(uint16_t radon) { return 0 <= radon && radon <= 16383; }
+bool AirthingsWavePlus::is_valid_radon_value_(uint16_t radon) { return radon <= 16383; }
-bool AirthingsWavePlus::is_valid_voc_value_(uint16_t voc) { return 0 <= voc && voc <= 16383; }
-
-bool AirthingsWavePlus::is_valid_co2_value_(uint16_t co2) { return 0 <= co2 && co2 <= 16383; }
-
-void AirthingsWavePlus::update() {
- if (this->node_state != esp32_ble_tracker::ClientState::ESTABLISHED) {
- if (!parent()->enabled) {
- ESP_LOGW(TAG, "Reconnecting to device");
- parent()->set_enabled(true);
- parent()->connect();
- } else {
- ESP_LOGW(TAG, "Connection in progress");
- }
- }
-}
-
-void AirthingsWavePlus::request_read_values_() {
- auto status = esp_ble_gattc_read_char(this->parent()->get_gattc_if(), this->parent()->get_conn_id(), this->handle_,
- ESP_GATT_AUTH_REQ_NONE);
- if (status) {
- ESP_LOGW(TAG, "Error sending read request for sensor, status=%d", status);
- }
-}
+bool AirthingsWavePlus::is_valid_co2_value_(uint16_t co2) { return co2 <= 16383; }
void AirthingsWavePlus::dump_config() {
+ // these really don't belong here, but there doesn't seem to be a
+ // practical way to have the base class use LOG_SENSOR and include
+ // the TAG from this component
LOG_SENSOR(" ", "Humidity", this->humidity_sensor_);
- LOG_SENSOR(" ", "Radon", this->radon_sensor_);
- LOG_SENSOR(" ", "Radon Long Term", this->radon_long_term_sensor_);
LOG_SENSOR(" ", "Temperature", this->temperature_sensor_);
LOG_SENSOR(" ", "Pressure", this->pressure_sensor_);
- LOG_SENSOR(" ", "CO2", this->co2_sensor_);
LOG_SENSOR(" ", "TVOC", this->tvoc_sensor_);
+ LOG_SENSOR(" ", "Battery Voltage", this->battery_voltage_);
+
+ LOG_SENSOR(" ", "Radon", this->radon_sensor_);
+ LOG_SENSOR(" ", "Radon Long Term", this->radon_long_term_sensor_);
+ LOG_SENSOR(" ", "CO2", this->co2_sensor_);
+ LOG_SENSOR(" ", "Illuminance", this->illuminance_sensor_);
}
-AirthingsWavePlus::AirthingsWavePlus()
- : PollingComponent(10000),
- service_uuid_(esp32_ble_tracker::ESPBTUUID::from_raw(SERVICE_UUID)),
- sensors_data_characteristic_uuid_(esp32_ble_tracker::ESPBTUUID::from_raw(CHARACTERISTIC_UUID)) {}
+AirthingsWavePlus::AirthingsWavePlus() {
+ this->service_uuid_ = espbt::ESPBTUUID::from_raw(SERVICE_UUID);
+ this->sensors_data_characteristic_uuid_ = espbt::ESPBTUUID::from_raw(CHARACTERISTIC_UUID);
+ this->access_control_point_characteristic_uuid_ =
+ espbt::ESPBTUUID::from_raw(ACCESS_CONTROL_POINT_CHARACTERISTIC_UUID);
+}
} // namespace airthings_wave_plus
} // namespace esphome
diff --git a/esphome/components/airthings_wave_plus/airthings_wave_plus.h b/esphome/components/airthings_wave_plus/airthings_wave_plus.h
index 9dd6ed92d5..bd7a40ef8b 100644
--- a/esphome/components/airthings_wave_plus/airthings_wave_plus.h
+++ b/esphome/components/airthings_wave_plus/airthings_wave_plus.h
@@ -2,58 +2,38 @@
#ifdef USE_ESP32
-#include
-#include
-#include
-#include "esphome/components/ble_client/ble_client.h"
-#include "esphome/components/esp32_ble_tracker/esp32_ble_tracker.h"
-#include "esphome/components/sensor/sensor.h"
-#include "esphome/core/component.h"
-#include "esphome/core/log.h"
+#include "esphome/components/airthings_wave_base/airthings_wave_base.h"
namespace esphome {
namespace airthings_wave_plus {
+namespace espbt = esphome::esp32_ble_tracker;
+
static const char *const SERVICE_UUID = "b42e1c08-ade7-11e4-89d3-123b93f75cba";
static const char *const CHARACTERISTIC_UUID = "b42e2a68-ade7-11e4-89d3-123b93f75cba";
+static const char *const ACCESS_CONTROL_POINT_CHARACTERISTIC_UUID = "b42e2d06-ade7-11e4-89d3-123b93f75cba";
-class AirthingsWavePlus : public PollingComponent, public ble_client::BLEClientNode {
+class AirthingsWavePlus : public airthings_wave_base::AirthingsWaveBase {
public:
AirthingsWavePlus();
void dump_config() override;
- void update() override;
- void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
- esp_ble_gattc_cb_param_t *param) override;
-
- void set_temperature(sensor::Sensor *temperature) { temperature_sensor_ = temperature; }
void set_radon(sensor::Sensor *radon) { radon_sensor_ = radon; }
void set_radon_long_term(sensor::Sensor *radon_long_term) { radon_long_term_sensor_ = radon_long_term; }
- void set_humidity(sensor::Sensor *humidity) { humidity_sensor_ = humidity; }
- void set_pressure(sensor::Sensor *pressure) { pressure_sensor_ = pressure; }
void set_co2(sensor::Sensor *co2) { co2_sensor_ = co2; }
- void set_tvoc(sensor::Sensor *tvoc) { tvoc_sensor_ = tvoc; }
+ void set_illuminance(sensor::Sensor *illuminance) { illuminance_sensor_ = illuminance; }
protected:
bool is_valid_radon_value_(uint16_t radon);
- bool is_valid_voc_value_(uint16_t voc);
bool is_valid_co2_value_(uint16_t co2);
- void read_sensors_(uint8_t *value, uint16_t value_len);
- void request_read_values_();
+ void read_sensors(uint8_t *raw_value, uint16_t value_len) override;
- sensor::Sensor *temperature_sensor_{nullptr};
sensor::Sensor *radon_sensor_{nullptr};
sensor::Sensor *radon_long_term_sensor_{nullptr};
- sensor::Sensor *humidity_sensor_{nullptr};
- sensor::Sensor *pressure_sensor_{nullptr};
sensor::Sensor *co2_sensor_{nullptr};
- sensor::Sensor *tvoc_sensor_{nullptr};
-
- uint16_t handle_;
- esp32_ble_tracker::ESPBTUUID service_uuid_;
- esp32_ble_tracker::ESPBTUUID sensors_data_characteristic_uuid_;
+ sensor::Sensor *illuminance_sensor_{nullptr};
struct WavePlusReadings {
uint8_t version;
diff --git a/esphome/components/airthings_wave_plus/sensor.py b/esphome/components/airthings_wave_plus/sensor.py
index 727fbe15fb..d28c7e2abc 100644
--- a/esphome/components/airthings_wave_plus/sensor.py
+++ b/esphome/components/airthings_wave_plus/sensor.py
@@ -1,116 +1,76 @@
import esphome.codegen as cg
import esphome.config_validation as cv
-from esphome.components import sensor, ble_client
+from esphome.components import sensor, airthings_wave_base
from esphome.const import (
DEVICE_CLASS_CARBON_DIOXIDE,
- DEVICE_CLASS_HUMIDITY,
- DEVICE_CLASS_TEMPERATURE,
- DEVICE_CLASS_PRESSURE,
STATE_CLASS_MEASUREMENT,
- UNIT_PERCENT,
- UNIT_CELSIUS,
- UNIT_HECTOPASCAL,
ICON_RADIOACTIVE,
CONF_ID,
CONF_RADON,
CONF_RADON_LONG_TERM,
- CONF_HUMIDITY,
- CONF_TVOC,
CONF_CO2,
- CONF_PRESSURE,
- CONF_TEMPERATURE,
UNIT_BECQUEREL_PER_CUBIC_METER,
UNIT_PARTS_PER_MILLION,
- UNIT_PARTS_PER_BILLION,
- ICON_RADIATOR,
+ CONF_ILLUMINANCE,
+ UNIT_LUX,
+ DEVICE_CLASS_ILLUMINANCE,
)
-DEPENDENCIES = ["ble_client"]
+DEPENDENCIES = airthings_wave_base.DEPENDENCIES
+
+AUTO_LOAD = ["airthings_wave_base"]
airthings_wave_plus_ns = cg.esphome_ns.namespace("airthings_wave_plus")
AirthingsWavePlus = airthings_wave_plus_ns.class_(
- "AirthingsWavePlus", cg.PollingComponent, ble_client.BLEClientNode
+ "AirthingsWavePlus", airthings_wave_base.AirthingsWaveBase
)
-CONFIG_SCHEMA = cv.All(
- cv.Schema(
- {
- cv.GenerateID(): cv.declare_id(AirthingsWavePlus),
- cv.Optional(CONF_HUMIDITY): sensor.sensor_schema(
- unit_of_measurement=UNIT_PERCENT,
- device_class=DEVICE_CLASS_HUMIDITY,
- state_class=STATE_CLASS_MEASUREMENT,
- accuracy_decimals=0,
- ),
- cv.Optional(CONF_RADON): sensor.sensor_schema(
- unit_of_measurement=UNIT_BECQUEREL_PER_CUBIC_METER,
- icon=ICON_RADIOACTIVE,
- accuracy_decimals=0,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- cv.Optional(CONF_RADON_LONG_TERM): sensor.sensor_schema(
- unit_of_measurement=UNIT_BECQUEREL_PER_CUBIC_METER,
- icon=ICON_RADIOACTIVE,
- accuracy_decimals=0,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- cv.Optional(CONF_TEMPERATURE): sensor.sensor_schema(
- unit_of_measurement=UNIT_CELSIUS,
- accuracy_decimals=2,
- device_class=DEVICE_CLASS_TEMPERATURE,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- cv.Optional(CONF_PRESSURE): sensor.sensor_schema(
- unit_of_measurement=UNIT_HECTOPASCAL,
- accuracy_decimals=1,
- device_class=DEVICE_CLASS_PRESSURE,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- cv.Optional(CONF_CO2): sensor.sensor_schema(
- unit_of_measurement=UNIT_PARTS_PER_MILLION,
- accuracy_decimals=0,
- device_class=DEVICE_CLASS_CARBON_DIOXIDE,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- cv.Optional(CONF_TVOC): sensor.sensor_schema(
- unit_of_measurement=UNIT_PARTS_PER_BILLION,
- icon=ICON_RADIATOR,
- accuracy_decimals=0,
- state_class=STATE_CLASS_MEASUREMENT,
- ),
- }
- )
- .extend(cv.polling_component_schema("5min"))
- .extend(ble_client.BLE_CLIENT_SCHEMA),
+CONFIG_SCHEMA = airthings_wave_base.BASE_SCHEMA.extend(
+ {
+ cv.GenerateID(): cv.declare_id(AirthingsWavePlus),
+ cv.Optional(CONF_RADON): sensor.sensor_schema(
+ unit_of_measurement=UNIT_BECQUEREL_PER_CUBIC_METER,
+ icon=ICON_RADIOACTIVE,
+ accuracy_decimals=0,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_RADON_LONG_TERM): sensor.sensor_schema(
+ unit_of_measurement=UNIT_BECQUEREL_PER_CUBIC_METER,
+ icon=ICON_RADIOACTIVE,
+ accuracy_decimals=0,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_CO2): sensor.sensor_schema(
+ unit_of_measurement=UNIT_PARTS_PER_MILLION,
+ accuracy_decimals=0,
+ device_class=DEVICE_CLASS_CARBON_DIOXIDE,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ cv.Optional(CONF_ILLUMINANCE): sensor.sensor_schema(
+ unit_of_measurement=UNIT_LUX,
+ accuracy_decimals=0,
+ device_class=DEVICE_CLASS_ILLUMINANCE,
+ state_class=STATE_CLASS_MEASUREMENT,
+ ),
+ }
)
async def to_code(config):
var = cg.new_Pvariable(config[CONF_ID])
- await cg.register_component(var, config)
+ await airthings_wave_base.wave_base_to_code(var, config)
- await ble_client.register_ble_node(var, config)
-
- if CONF_HUMIDITY in config:
- sens = await sensor.new_sensor(config[CONF_HUMIDITY])
- cg.add(var.set_humidity(sens))
- if CONF_RADON in config:
- sens = await sensor.new_sensor(config[CONF_RADON])
+ if config_radon := config.get(CONF_RADON):
+ sens = await sensor.new_sensor(config_radon)
cg.add(var.set_radon(sens))
- if CONF_RADON_LONG_TERM in config:
- sens = await sensor.new_sensor(config[CONF_RADON_LONG_TERM])
+ if config_radon_long_term := config.get(CONF_RADON_LONG_TERM):
+ sens = await sensor.new_sensor(config_radon_long_term)
cg.add(var.set_radon_long_term(sens))
- if CONF_TEMPERATURE in config:
- sens = await sensor.new_sensor(config[CONF_TEMPERATURE])
- cg.add(var.set_temperature(sens))
- if CONF_PRESSURE in config:
- sens = await sensor.new_sensor(config[CONF_PRESSURE])
- cg.add(var.set_pressure(sens))
- if CONF_CO2 in config:
- sens = await sensor.new_sensor(config[CONF_CO2])
+ if config_co2 := config.get(CONF_CO2):
+ sens = await sensor.new_sensor(config_co2)
cg.add(var.set_co2(sens))
- if CONF_TVOC in config:
- sens = await sensor.new_sensor(config[CONF_TVOC])
- cg.add(var.set_tvoc(sens))
+ if config_illuminance := config.get(CONF_ILLUMINANCE):
+ sens = await sensor.new_sensor(config_illuminance)
+ cg.add(var.set_illuminance(sens))
diff --git a/esphome/components/alarm_control_panel/__init__.py b/esphome/components/alarm_control_panel/__init__.py
new file mode 100644
index 0000000000..379fbf32f9
--- /dev/null
+++ b/esphome/components/alarm_control_panel/__init__.py
@@ -0,0 +1,316 @@
+from esphome import automation
+from esphome.automation import maybe_simple_id
+import esphome.codegen as cg
+from esphome.components import mqtt, web_server
+import esphome.config_validation as cv
+from esphome.const import (
+ CONF_CODE,
+ CONF_ID,
+ CONF_MQTT_ID,
+ CONF_ON_STATE,
+ CONF_TRIGGER_ID,
+ CONF_WEB_SERVER,
+)
+from esphome.core import CORE, coroutine_with_priority
+from esphome.cpp_helpers import setup_entity
+
+CODEOWNERS = ["@grahambrown11", "@hwstar"]
+IS_PLATFORM_COMPONENT = True
+
+CONF_ON_TRIGGERED = "on_triggered"
+CONF_ON_CLEARED = "on_cleared"
+CONF_ON_ARMING = "on_arming"
+CONF_ON_PENDING = "on_pending"
+CONF_ON_ARMED_HOME = "on_armed_home"
+CONF_ON_ARMED_NIGHT = "on_armed_night"
+CONF_ON_ARMED_AWAY = "on_armed_away"
+CONF_ON_DISARMED = "on_disarmed"
+CONF_ON_CHIME = "on_chime"
+CONF_ON_READY = "on_ready"
+
+alarm_control_panel_ns = cg.esphome_ns.namespace("alarm_control_panel")
+AlarmControlPanel = alarm_control_panel_ns.class_("AlarmControlPanel", cg.EntityBase)
+
+StateTrigger = alarm_control_panel_ns.class_(
+ "StateTrigger", automation.Trigger.template()
+)
+TriggeredTrigger = alarm_control_panel_ns.class_(
+ "TriggeredTrigger", automation.Trigger.template()
+)
+ClearedTrigger = alarm_control_panel_ns.class_(
+ "ClearedTrigger", automation.Trigger.template()
+)
+ArmingTrigger = alarm_control_panel_ns.class_(
+ "ArmingTrigger", automation.Trigger.template()
+)
+PendingTrigger = alarm_control_panel_ns.class_(
+ "PendingTrigger", automation.Trigger.template()
+)
+ArmedHomeTrigger = alarm_control_panel_ns.class_(
+ "ArmedHomeTrigger", automation.Trigger.template()
+)
+ArmedNightTrigger = alarm_control_panel_ns.class_(
+ "ArmedNightTrigger", automation.Trigger.template()
+)
+ArmedAwayTrigger = alarm_control_panel_ns.class_(
+ "ArmedAwayTrigger", automation.Trigger.template()
+)
+DisarmedTrigger = alarm_control_panel_ns.class_(
+ "DisarmedTrigger", automation.Trigger.template()
+)
+ChimeTrigger = alarm_control_panel_ns.class_(
+ "ChimeTrigger", automation.Trigger.template()
+)
+ReadyTrigger = alarm_control_panel_ns.class_(
+ "ReadyTrigger", automation.Trigger.template()
+)
+
+ArmAwayAction = alarm_control_panel_ns.class_("ArmAwayAction", automation.Action)
+ArmHomeAction = alarm_control_panel_ns.class_("ArmHomeAction", automation.Action)
+ArmNightAction = alarm_control_panel_ns.class_("ArmNightAction", automation.Action)
+DisarmAction = alarm_control_panel_ns.class_("DisarmAction", automation.Action)
+PendingAction = alarm_control_panel_ns.class_("PendingAction", automation.Action)
+TriggeredAction = alarm_control_panel_ns.class_("TriggeredAction", automation.Action)
+ChimeAction = alarm_control_panel_ns.class_("ChimeAction", automation.Action)
+ReadyAction = alarm_control_panel_ns.class_("ReadyAction", automation.Action)
+
+AlarmControlPanelCondition = alarm_control_panel_ns.class_(
+ "AlarmControlPanelCondition", automation.Condition
+)
+
+ALARM_CONTROL_PANEL_SCHEMA = (
+ cv.ENTITY_BASE_SCHEMA.extend(web_server.WEBSERVER_SORTING_SCHEMA)
+ .extend(cv.MQTT_COMMAND_COMPONENT_SCHEMA)
+ .extend(
+ {
+ cv.GenerateID(): cv.declare_id(AlarmControlPanel),
+ cv.OnlyWith(CONF_MQTT_ID, "mqtt"): cv.declare_id(
+ mqtt.MQTTAlarmControlPanelComponent
+ ),
+ cv.Optional(CONF_ON_STATE): automation.validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(StateTrigger),
+ }
+ ),
+ cv.Optional(CONF_ON_TRIGGERED): automation.validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(TriggeredTrigger),
+ }
+ ),
+ cv.Optional(CONF_ON_ARMING): automation.validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(ArmingTrigger),
+ }
+ ),
+ cv.Optional(CONF_ON_PENDING): automation.validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(PendingTrigger),
+ }
+ ),
+ cv.Optional(CONF_ON_ARMED_HOME): automation.validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(ArmedHomeTrigger),
+ }
+ ),
+ cv.Optional(CONF_ON_ARMED_NIGHT): automation.validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(ArmedNightTrigger),
+ }
+ ),
+ cv.Optional(CONF_ON_ARMED_AWAY): automation.validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(ArmedAwayTrigger),
+ }
+ ),
+ cv.Optional(CONF_ON_DISARMED): automation.validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(DisarmedTrigger),
+ }
+ ),
+ cv.Optional(CONF_ON_CLEARED): automation.validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(ClearedTrigger),
+ }
+ ),
+ cv.Optional(CONF_ON_CHIME): automation.validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(ChimeTrigger),
+ }
+ ),
+ cv.Optional(CONF_ON_READY): automation.validate_automation(
+ {
+ cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(ReadyTrigger),
+ }
+ ),
+ }
+ )
+)
+
+ALARM_CONTROL_PANEL_ACTION_SCHEMA = maybe_simple_id(
+ {
+ cv.GenerateID(): cv.use_id(AlarmControlPanel),
+ cv.Optional(CONF_CODE): cv.templatable(cv.string),
+ }
+)
+
+ALARM_CONTROL_PANEL_CONDITION_SCHEMA = maybe_simple_id(
+ {
+ cv.GenerateID(): cv.use_id(AlarmControlPanel),
+ }
+)
+
+
+async def setup_alarm_control_panel_core_(var, config):
+ await setup_entity(var, config)
+ for conf in config.get(CONF_ON_STATE, []):
+ trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+ await automation.build_automation(trigger, [], conf)
+ for conf in config.get(CONF_ON_TRIGGERED, []):
+ trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+ await automation.build_automation(trigger, [], conf)
+ for conf in config.get(CONF_ON_ARMING, []):
+ trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+ await automation.build_automation(trigger, [], conf)
+ for conf in config.get(CONF_ON_PENDING, []):
+ trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+ await automation.build_automation(trigger, [], conf)
+ for conf in config.get(CONF_ON_ARMED_HOME, []):
+ trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+ await automation.build_automation(trigger, [], conf)
+ for conf in config.get(CONF_ON_ARMED_NIGHT, []):
+ trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+ await automation.build_automation(trigger, [], conf)
+ for conf in config.get(CONF_ON_ARMED_AWAY, []):
+ trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+ await automation.build_automation(trigger, [], conf)
+ for conf in config.get(CONF_ON_DISARMED, []):
+ trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+ await automation.build_automation(trigger, [], conf)
+ for conf in config.get(CONF_ON_CLEARED, []):
+ trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+ await automation.build_automation(trigger, [], conf)
+ for conf in config.get(CONF_ON_CHIME, []):
+ trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+ await automation.build_automation(trigger, [], conf)
+ for conf in config.get(CONF_ON_READY, []):
+ trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+ await automation.build_automation(trigger, [], conf)
+ if web_server_config := config.get(CONF_WEB_SERVER):
+ await web_server.add_entity_config(var, web_server_config)
+ if mqtt_id := config.get(CONF_MQTT_ID):
+ mqtt_ = cg.new_Pvariable(mqtt_id, var)
+ await mqtt.register_mqtt_component(mqtt_, config)
+
+
+async def register_alarm_control_panel(var, config):
+ if not CORE.has_id(config[CONF_ID]):
+ var = cg.Pvariable(config[CONF_ID], var)
+ cg.add(cg.App.register_alarm_control_panel(var))
+ await setup_alarm_control_panel_core_(var, config)
+
+
+@automation.register_action(
+ "alarm_control_panel.arm_away", ArmAwayAction, ALARM_CONTROL_PANEL_ACTION_SCHEMA
+)
+async def alarm_action_arm_away_to_code(config, action_id, template_arg, args):
+ paren = await cg.get_variable(config[CONF_ID])
+ var = cg.new_Pvariable(action_id, template_arg, paren)
+ if code_config := config.get(CONF_CODE):
+ templatable_ = await cg.templatable(code_config, args, cg.std_string)
+ cg.add(var.set_code(templatable_))
+ return var
+
+
+@automation.register_action(
+ "alarm_control_panel.arm_home", ArmHomeAction, ALARM_CONTROL_PANEL_ACTION_SCHEMA
+)
+async def alarm_action_arm_home_to_code(config, action_id, template_arg, args):
+ paren = await cg.get_variable(config[CONF_ID])
+ var = cg.new_Pvariable(action_id, template_arg, paren)
+ if code_config := config.get(CONF_CODE):
+ templatable_ = await cg.templatable(code_config, args, cg.std_string)
+ cg.add(var.set_code(templatable_))
+ return var
+
+
+@automation.register_action(
+ "alarm_control_panel.arm_night", ArmNightAction, ALARM_CONTROL_PANEL_ACTION_SCHEMA
+)
+async def alarm_action_arm_night_to_code(config, action_id, template_arg, args):
+ paren = await cg.get_variable(config[CONF_ID])
+ var = cg.new_Pvariable(action_id, template_arg, paren)
+ if CONF_CODE in config:
+ templatable_ = await cg.templatable(config[CONF_CODE], args, cg.std_string)
+ cg.add(var.set_code(templatable_))
+ return var
+
+
+@automation.register_action(
+ "alarm_control_panel.disarm", DisarmAction, ALARM_CONTROL_PANEL_ACTION_SCHEMA
+)
+async def alarm_action_disarm_to_code(config, action_id, template_arg, args):
+ paren = await cg.get_variable(config[CONF_ID])
+ var = cg.new_Pvariable(action_id, template_arg, paren)
+ if code_config := config.get(CONF_CODE):
+ templatable_ = await cg.templatable(code_config, args, cg.std_string)
+ cg.add(var.set_code(templatable_))
+ return var
+
+
+@automation.register_action(
+ "alarm_control_panel.pending", PendingAction, ALARM_CONTROL_PANEL_ACTION_SCHEMA
+)
+async def alarm_action_pending_to_code(config, action_id, template_arg, args):
+ paren = await cg.get_variable(config[CONF_ID])
+ var = cg.new_Pvariable(action_id, template_arg, paren)
+ return var
+
+
+@automation.register_action(
+ "alarm_control_panel.triggered", TriggeredAction, ALARM_CONTROL_PANEL_ACTION_SCHEMA
+)
+async def alarm_action_trigger_to_code(config, action_id, template_arg, args):
+ paren = await cg.get_variable(config[CONF_ID])
+ var = cg.new_Pvariable(action_id, template_arg, paren)
+ return var
+
+
+@automation.register_action(
+ "alarm_control_panel.chime", ChimeAction, ALARM_CONTROL_PANEL_ACTION_SCHEMA
+)
+async def alarm_action_chime_to_code(config, action_id, template_arg, args):
+ paren = await cg.get_variable(config[CONF_ID])
+ var = cg.new_Pvariable(action_id, template_arg, paren)
+ return var
+
+
+@automation.register_action(
+ "alarm_control_panel.ready", ReadyAction, ALARM_CONTROL_PANEL_ACTION_SCHEMA
+)
+@automation.register_condition(
+ "alarm_control_panel.ready",
+ AlarmControlPanelCondition,
+ ALARM_CONTROL_PANEL_CONDITION_SCHEMA,
+)
+async def alarm_action_ready_to_code(config, action_id, template_arg, args):
+ paren = await cg.get_variable(config[CONF_ID])
+ var = cg.new_Pvariable(action_id, template_arg, paren)
+ return var
+
+
+@automation.register_condition(
+ "alarm_control_panel.is_armed",
+ AlarmControlPanelCondition,
+ ALARM_CONTROL_PANEL_CONDITION_SCHEMA,
+)
+async def alarm_control_panel_is_armed_to_code(
+ config, condition_id, template_arg, args
+):
+ paren = await cg.get_variable(config[CONF_ID])
+ return cg.new_Pvariable(condition_id, template_arg, paren)
+
+
+@coroutine_with_priority(100.0)
+async def to_code(config):
+ cg.add_global(alarm_control_panel_ns.using)
+ cg.add_define("USE_ALARM_CONTROL_PANEL")
diff --git a/esphome/components/alarm_control_panel/alarm_control_panel.cpp b/esphome/components/alarm_control_panel/alarm_control_panel.cpp
new file mode 100644
index 0000000000..9f1485ee90
--- /dev/null
+++ b/esphome/components/alarm_control_panel/alarm_control_panel.cpp
@@ -0,0 +1,156 @@
+#include
+
+#include "alarm_control_panel.h"
+
+#include "esphome/core/application.h"
+#include "esphome/core/helpers.h"
+#include "esphome/core/log.h"
+
+namespace esphome {
+namespace alarm_control_panel {
+
+static const char *const TAG = "alarm_control_panel";
+
+AlarmControlPanelCall AlarmControlPanel::make_call() { return AlarmControlPanelCall(this); }
+
+bool AlarmControlPanel::is_state_armed(AlarmControlPanelState state) {
+ switch (state) {
+ case ACP_STATE_ARMED_AWAY:
+ case ACP_STATE_ARMED_HOME:
+ case ACP_STATE_ARMED_NIGHT:
+ case ACP_STATE_ARMED_VACATION:
+ case ACP_STATE_ARMED_CUSTOM_BYPASS:
+ return true;
+ default:
+ return false;
+ }
+};
+
+void AlarmControlPanel::publish_state(AlarmControlPanelState state) {
+ this->last_update_ = millis();
+ if (state != this->current_state_) {
+ auto prev_state = this->current_state_;
+ ESP_LOGD(TAG, "Set state to: %s, previous: %s", LOG_STR_ARG(alarm_control_panel_state_to_string(state)),
+ LOG_STR_ARG(alarm_control_panel_state_to_string(prev_state)));
+ this->current_state_ = state;
+ this->state_callback_.call();
+ if (state == ACP_STATE_TRIGGERED) {
+ this->triggered_callback_.call();
+ } else if (state == ACP_STATE_ARMING) {
+ this->arming_callback_.call();
+ } else if (state == ACP_STATE_PENDING) {
+ this->pending_callback_.call();
+ } else if (state == ACP_STATE_ARMED_HOME) {
+ this->armed_home_callback_.call();
+ } else if (state == ACP_STATE_ARMED_NIGHT) {
+ this->armed_night_callback_.call();
+ } else if (state == ACP_STATE_ARMED_AWAY) {
+ this->armed_away_callback_.call();
+ } else if (state == ACP_STATE_DISARMED) {
+ this->disarmed_callback_.call();
+ }
+
+ if (prev_state == ACP_STATE_TRIGGERED) {
+ this->cleared_callback_.call();
+ }
+ if (state == this->desired_state_) {
+ // only store when in the desired state
+ this->pref_.save(&state);
+ }
+ }
+}
+
+void AlarmControlPanel::add_on_state_callback(std::function &&callback) {
+ this->state_callback_.add(std::move(callback));
+}
+
+void AlarmControlPanel::add_on_triggered_callback(std::function &&callback) {
+ this->triggered_callback_.add(std::move(callback));
+}
+
+void AlarmControlPanel::add_on_arming_callback(std::function &&callback) {
+ this->arming_callback_.add(std::move(callback));
+}
+
+void AlarmControlPanel::add_on_armed_home_callback(std::function &&callback) {
+ this->armed_home_callback_.add(std::move(callback));
+}
+
+void AlarmControlPanel::add_on_armed_night_callback(std::function &&callback) {
+ this->armed_night_callback_.add(std::move(callback));
+}
+
+void AlarmControlPanel::add_on_armed_away_callback(std::function &&callback) {
+ this->armed_away_callback_.add(std::move(callback));
+}
+
+void AlarmControlPanel::add_on_pending_callback(std::function &&callback) {
+ this->pending_callback_.add(std::move(callback));
+}
+
+void AlarmControlPanel::add_on_disarmed_callback(std::function &&callback) {
+ this->disarmed_callback_.add(std::move(callback));
+}
+
+void AlarmControlPanel::add_on_cleared_callback(std::function &&callback) {
+ this->cleared_callback_.add(std::move(callback));
+}
+
+void AlarmControlPanel::add_on_chime_callback(std::function &&callback) {
+ this->chime_callback_.add(std::move(callback));
+}
+
+void AlarmControlPanel::add_on_ready_callback(std::function &&callback) {
+ this->ready_callback_.add(std::move(callback));
+}
+
+void AlarmControlPanel::arm_away(optional code) {
+ auto call = this->make_call();
+ call.arm_away();
+ if (code.has_value())
+ call.set_code(code.value());
+ call.perform();
+}
+
+void AlarmControlPanel::arm_home(optional code) {
+ auto call = this->make_call();
+ call.arm_home();
+ if (code.has_value())
+ call.set_code(code.value());
+ call.perform();
+}
+
+void AlarmControlPanel::arm_night(optional code) {
+ auto call = this->make_call();
+ call.arm_night();
+ if (code.has_value())
+ call.set_code(code.value());
+ call.perform();
+}
+
+void AlarmControlPanel::arm_vacation(optional code) {
+ auto call = this->make_call();
+ call.arm_vacation();
+ if (code.has_value())
+ call.set_code(code.value());
+ call.perform();
+}
+
+void AlarmControlPanel::arm_custom_bypass(optional code) {
+ auto call = this->make_call();
+ call.arm_custom_bypass();
+ if (code.has_value())
+ call.set_code(code.value());
+ call.perform();
+}
+
+void AlarmControlPanel::disarm(optional code) {
+ auto call = this->make_call();
+ call.disarm();
+ if (code.has_value())
+ call.set_code(code.value());
+ call.perform();
+}
+
+} // namespace alarm_control_panel
+} // namespace esphome
diff --git a/esphome/components/alarm_control_panel/alarm_control_panel.h b/esphome/components/alarm_control_panel/alarm_control_panel.h
new file mode 100644
index 0000000000..85c2b2148e
--- /dev/null
+++ b/esphome/components/alarm_control_panel/alarm_control_panel.h
@@ -0,0 +1,200 @@
+#pragma once
+
+#include